all: autogenerated update (2017-10-12)
Update:
- cloudfunctions/v1beta2
- container/v1beta1
- content/v2
- dataproc/v1beta2
- dlp/v2beta1
- firebasedynamiclinks/v1
- monitoring/v3
- servicecontrol/v1
- servicemanagement/v1
- serviceuser/v1
- speech/v1
- testing/v1
diff --git a/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json b/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json
index 9774c51..e51dc0f 100644
--- a/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json
+++ b/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json
@@ -1,17 +1,28 @@
{
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "acceleratedmobilepageurl",
+ "batchPath": "batch",
+ "revision": "20170926",
+ "documentationLink": "https://developers.google.com/amp/cache/",
+ "id": "acceleratedmobilepageurl:v1",
+ "title": "Accelerated Mobile Pages (AMP) URL API",
+ "discoveryVersion": "v1",
+ "ownerName": "Google",
+ "version_module": true,
"resources": {
"ampUrls": {
"methods": {
"batchGet": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
"response": {
"$ref": "BatchGetAmpUrlsResponse"
},
- "parameterOrder": [],
- "httpMethod": "POST",
"parameters": {},
"flatPath": "v1/ampUrls:batchGet",
- "id": "acceleratedmobilepageurl.ampUrls.batchGet",
"path": "v1/ampUrls:batchGet",
+ "id": "acceleratedmobilepageurl.ampUrls.batchGet",
"description": "Returns AMP URL(s) and equivalent\n[AMP Cache URL(s)](/amp/cache/overview#amp-cache-url-format).",
"request": {
"$ref": "BatchGetAmpUrlsRequest"
@@ -21,31 +32,16 @@
}
},
"parameters": {
- "access_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth access token."
- },
- "key": {
- "type": "string",
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
- },
- "quotaUser": {
- "type": "string",
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
- },
"pp": {
- "default": "true",
- "type": "boolean",
"location": "query",
- "description": "Pretty-print response."
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
},
"bearer_token": {
+ "type": "string",
"location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
+ "description": "OAuth bearer token."
},
"oauth_token": {
"type": "string",
@@ -106,6 +102,21 @@
"location": "query",
"description": "Data format for response.",
"default": "json"
+ },
+ "access_token": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth access token."
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
}
},
"schemas": {
@@ -114,11 +125,11 @@
"type": "object",
"properties": {
"urlErrors": {
+ "description": "The errors for requested URLs that have no AMP URL.",
"items": {
"$ref": "AmpUrlError"
},
- "type": "array",
- "description": "The errors for requested URLs that have no AMP URL."
+ "type": "array"
},
"ampUrls": {
"items": {
@@ -131,42 +142,37 @@
"id": "BatchGetAmpUrlsResponse"
},
"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"
+ "type": "string",
+ "description": "The [AMP Cache URL](/amp/cache/overview#amp-cache-url-format) pointing to\nthe cached document in the Google AMP Cache."
},
"ampUrl": {
- "description": "The AMP URL pointing to the publisher's web server.",
- "type": "string"
+ "type": "string",
+ "description": "The AMP URL pointing to the publisher's web server."
},
"originalUrl": {
"type": "string",
"description": "The original non-AMP URL."
}
},
- "id": "AmpUrl",
- "description": "AMP URL response for a requested URL."
+ "id": "AmpUrl"
},
"AmpUrlError": {
"description": "AMP URL Error resource for a requested URL that couldn't be found.",
"type": "object",
"properties": {
+ "originalUrl": {
+ "description": "The original non-AMP URL.",
+ "type": "string"
+ },
"errorMessage": {
"type": "string",
"description": "An optional descriptive error message."
},
"errorCode": {
- "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",
"enumDescriptions": [
"Not specified error.",
@@ -175,62 +181,56 @@
"Indicates some kind of application error occurred at the server.\nClient advised to retry.",
"DEPRECATED: Indicates the requested URL is a valid AMP URL. This is a\nnon-error state, should not be relied upon as a sign of success or\nfailure. It will be removed in future versions of the API.",
"Indicates that an AMP URL has been found that corresponds to the request\nURL, but it is not valid AMP HTML."
- ]
- },
- "originalUrl": {
- "description": "The original non-AMP URL.",
- "type": "string"
+ ],
+ "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."
}
},
"id": "AmpUrlError"
},
"BatchGetAmpUrlsRequest": {
+ "description": "AMP URL request for a batch of URLs.",
"type": "object",
"properties": {
- "lookupStrategy": {
- "enum": [
- "FETCH_LIVE_DOC",
- "IN_INDEX_DOC"
- ],
- "description": "The lookup_strategy being requested.",
- "type": "string",
- "enumDescriptions": [
- "FETCH_LIVE_DOC strategy involves live document fetch of URLs not found in\nthe index. Any request URL not found in the index is crawled in realtime\nto validate if there is a corresponding AMP URL. This strategy has higher\ncoverage but with extra latency introduced by realtime crawling. This is\nthe default strategy. Applications using this strategy should set higher\nHTTP timeouts of the API calls.",
- "IN_INDEX_DOC strategy skips fetching live documents of URL(s) not found\nin index. For applications which need low latency use of IN_INDEX_DOC\nstrategy is recommended."
- ]
- },
"urls": {
"items": {
"type": "string"
},
"type": "array",
"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))."
+ },
+ "lookupStrategy": {
+ "type": "string",
+ "enumDescriptions": [
+ "FETCH_LIVE_DOC strategy involves live document fetch of URLs not found in\nthe index. Any request URL not found in the index is crawled in realtime\nto validate if there is a corresponding AMP URL. This strategy has higher\ncoverage but with extra latency introduced by realtime crawling. This is\nthe default strategy. Applications using this strategy should set higher\nHTTP timeouts of the API calls.",
+ "IN_INDEX_DOC strategy skips fetching live documents of URL(s) not found\nin index. For applications which need low latency use of IN_INDEX_DOC\nstrategy is recommended."
+ ],
+ "enum": [
+ "FETCH_LIVE_DOC",
+ "IN_INDEX_DOC"
+ ],
+ "description": "The lookup_strategy being requested."
}
},
- "id": "BatchGetAmpUrlsRequest",
- "description": "AMP URL request for a batch of URLs."
+ "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"
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"version": "v1",
"baseUrl": "https://acceleratedmobilepageurl.googleapis.com/",
"servicePath": "",
"description": "Retrieves the list of AMP URLs (and equivalent AMP Cache URLs) for a given list of public URL(s).\n",
"kind": "discovery#restDescription",
- "rootUrl": "https://acceleratedmobilepageurl.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "acceleratedmobilepageurl",
- "batchPath": "batch",
- "revision": "20170926",
- "documentationLink": "https://developers.google.com/amp/cache/",
- "id": "acceleratedmobilepageurl:v1",
- "title": "Accelerated Mobile Pages (AMP) URL API",
- "discoveryVersion": "v1",
- "ownerName": "Google",
- "version_module": true
+ "rootUrl": "https://acceleratedmobilepageurl.googleapis.com/"
}
diff --git a/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json b/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json
index 6b574ca..3765ef0 100644
--- a/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json
+++ b/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json
@@ -1,15 +1,887 @@
{
- "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest/reference/rest/",
- "revision": "20171006",
+ "servicePath": "",
+ "description": "Accesses the latest features for managing Ad Exchange accounts, Real-Time Bidding configurations and auction metrics, and Marketplace programmatic deals.",
+ "kind": "discovery#restDescription",
+ "basePath": "",
"id": "adexchangebuyer2:v2beta1",
+ "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest/reference/rest/",
+ "revision": "20171011",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "RowDimensions": {
+ "description": "A response may include multiple rows, breaking down along various dimensions.\nEncapsulates the values of all dimensions for a given row.",
+ "type": "object",
+ "properties": {
+ "timeInterval": {
+ "$ref": "TimeInterval",
+ "description": "The time interval that this row represents."
+ }
+ },
+ "id": "RowDimensions"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\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"
+ },
+ "AppContext": {
+ "description": "@OutputOnly The app type the restriction applies to for mobile device.",
+ "type": "object",
+ "properties": {
+ "appTypes": {
+ "description": "The app types this restriction applies to.",
+ "items": {
+ "enum": [
+ "NATIVE",
+ "WEB"
+ ],
+ "type": "string"
+ },
+ "type": "array",
+ "enumDescriptions": [
+ "Native app context.",
+ "Mobile web app context."
+ ]
+ }
+ },
+ "id": "AppContext"
+ },
+ "ListFilteredBidsResponse": {
+ "description": "Response message for listing all reasons that bids were filtered from the\nauction.",
+ "type": "object",
+ "properties": {
+ "creativeStatusRows": {
+ "description": "List of rows, with counts of filtered bids aggregated by filtering reason\n(i.e. creative status).",
+ "items": {
+ "$ref": "CreativeStatusRow"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListFilteredBidsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.filteredBids.list\nmethod to retrieve the next page of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListFilteredBidsResponse"
+ },
+ "SecurityContext": {
+ "description": "@OutputOnly A security context.",
+ "type": "object",
+ "properties": {
+ "securities": {
+ "enumDescriptions": [
+ "Matches impressions that require insecure compatibility.",
+ "Matches impressions that require SSL compatibility."
+ ],
+ "description": "The security types in this context.",
+ "items": {
+ "type": "string",
+ "enum": [
+ "INSECURE",
+ "SSL"
+ ]
+ },
+ "type": "array"
+ }
+ },
+ "id": "SecurityContext"
+ },
+ "ListFilteredBidRequestsResponse": {
+ "description": "Response message for listing all reasons that bid requests were filtered and\nnot sent to the buyer.",
+ "type": "object",
+ "properties": {
+ "calloutStatusRows": {
+ "description": "List of rows, with counts of filtered bid requests aggregated by callout\nstatus.",
+ "items": {
+ "$ref": "CalloutStatusRow"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListFilteredBidRequestsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.filteredBidRequests.list\nmethod to retrieve the next page of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListFilteredBidRequestsResponse"
+ },
+ "ListCreativesResponse": {
+ "description": "A response for listing creatives.",
+ "type": "object",
+ "properties": {
+ "creatives": {
+ "description": "The list of creatives.",
+ "items": {
+ "$ref": "Creative"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativesRequest.page_token\nfield in the subsequent call to `ListCreatives` method to retrieve the next\npage of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListCreativesResponse"
+ },
+ "HtmlContent": {
+ "description": "HTML content for a creative.",
+ "type": "object",
+ "properties": {
+ "width": {
+ "format": "int32",
+ "description": "The width of the HTML snippet in pixels.",
+ "type": "integer"
+ },
+ "snippet": {
+ "description": "The HTML snippet that displays the ad when inserted in the web page.",
+ "type": "string"
+ },
+ "height": {
+ "format": "int32",
+ "description": "The height of the HTML snippet in pixels.",
+ "type": "integer"
+ }
+ },
+ "id": "HtmlContent"
+ },
+ "ListBidMetricsResponse": {
+ "description": "Response message for listing the metrics that are measured in number of bids.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListBidMetricsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.bidMetrics.list\nmethod to retrieve the next page of results.",
+ "type": "string"
+ },
+ "bidMetricsRows": {
+ "description": "List of rows, each containing a set of bid metrics.",
+ "items": {
+ "$ref": "BidMetricsRow"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListBidMetricsResponse"
+ },
+ "Reason": {
+ "description": "A specific filtering status and how many times it occurred.",
+ "type": "object",
+ "properties": {
+ "status": {
+ "format": "int32",
+ "description": "The filtering status code. Please refer to the\n[creative-status-codes.txt](https://storage.googleapis.com/adx-rtb-dictionaries/creative-status-codes.txt)\nfile for different statuses.",
+ "type": "integer"
+ },
+ "count": {
+ "format": "int64",
+ "description": "The number of times the creative was filtered for the status. The\ncount is aggregated across all publishers on the exchange.",
+ "type": "string"
+ }
+ },
+ "id": "Reason"
+ },
+ "ListNonBillableWinningBidsResponse": {
+ "description": "Response message for listing all reasons for which a buyer was not billed for\na winning bid.",
+ "type": "object",
+ "properties": {
+ "nonBillableWinningBidStatusRows": {
+ "description": "List of rows, with counts of bids not billed aggregated by reason.",
+ "items": {
+ "$ref": "NonBillableWinningBidStatusRow"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListNonBillableWinningBidsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.nonBillableWinningBids.list\nmethod to retrieve the next page of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListNonBillableWinningBidsResponse"
+ },
+ "ListLosingBidsResponse": {
+ "description": "Response message for listing all reasons that bids lost in the auction.",
+ "type": "object",
+ "properties": {
+ "creativeStatusRows": {
+ "description": "List of rows, with counts of losing bids aggregated by loss reason (i.e.\ncreative status).",
+ "items": {
+ "$ref": "CreativeStatusRow"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListLosingBidsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.losingBids.list\nmethod to retrieve the next page of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListLosingBidsResponse"
+ },
+ "VideoContent": {
+ "description": "Video content for a creative.",
+ "type": "object",
+ "properties": {
+ "videoUrl": {
+ "description": "The URL to fetch a video ad.",
+ "type": "string"
+ }
+ },
+ "id": "VideoContent"
+ },
+ "ImpressionMetricsRow": {
+ "description": "The set of metrics that are measured in numbers of impressions, representing\nhow many impressions with the specified dimension values were considered\neligible at each stage of the bidding funnel.",
+ "type": "object",
+ "properties": {
+ "successfulResponses": {
+ "$ref": "MetricValue",
+ "description": "The number of impressions for which the buyer successfully sent a response\nto Ad Exchange."
+ },
+ "availableImpressions": {
+ "description": "The number of impressions available to the buyer on Ad Exchange.\nIn some cases this value may be unavailable.",
+ "$ref": "MetricValue"
+ },
+ "rowDimensions": {
+ "description": "The values of all dimensions associated with metric values in this row.",
+ "$ref": "RowDimensions"
+ },
+ "inventoryMatches": {
+ "description": "The number of impressions that match the buyer's inventory pretargeting.",
+ "$ref": "MetricValue"
+ },
+ "bidRequests": {
+ "description": "The number of impressions for which Ad Exchange sent the buyer a bid\nrequest.",
+ "$ref": "MetricValue"
+ },
+ "responsesWithBids": {
+ "description": "The number of impressions for which Ad Exchange received a response from\nthe buyer that contained at least one applicable bid.",
+ "$ref": "MetricValue"
+ }
+ },
+ "id": "ImpressionMetricsRow"
+ },
+ "AuctionContext": {
+ "description": "@OutputOnly The auction type the restriction applies to.",
+ "type": "object",
+ "properties": {
+ "auctionTypes": {
+ "enumDescriptions": [
+ "The restriction applies to open auction.",
+ "The restriction applies to direct deals."
+ ],
+ "description": "The auction types this restriction applies to.",
+ "items": {
+ "enum": [
+ "OPEN_AUCTION",
+ "DIRECT_DEALS"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "AuctionContext"
+ },
+ "ListImpressionMetricsResponse": {
+ "description": "Response message for listing the metrics that are measured in number of\nimpressions.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListImpressionMetricsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.impressionMetrics.list\nmethod to retrieve the next page of results.",
+ "type": "string"
+ },
+ "impressionMetricsRows": {
+ "description": "List of rows, each containing a set of impression metrics.",
+ "items": {
+ "$ref": "ImpressionMetricsRow"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListImpressionMetricsResponse"
+ },
+ "BidMetricsRow": {
+ "description": "The set of metrics that are measured in numbers of bids, representing how\nmany bids with the specified dimension values were considered eligible at\neach stage of the bidding funnel;",
+ "type": "object",
+ "properties": {
+ "viewableImpressions": {
+ "description": "The number of bids for which the corresponding impression was viewable (as\ndefined by Active View).",
+ "$ref": "MetricValue"
+ },
+ "impressionsWon": {
+ "$ref": "MetricValue",
+ "description": "The number of bids that won an impression."
+ },
+ "measurableImpressions": {
+ "$ref": "MetricValue",
+ "description": "The number of bids for which the corresponding impression was measurable\nfor viewability (as defined by Active View)."
+ },
+ "bids": {
+ "description": "The number of bids that Ad Exchange received from the buyer.",
+ "$ref": "MetricValue"
+ },
+ "billedImpressions": {
+ "$ref": "MetricValue",
+ "description": "The number of bids for which the buyer was billed."
+ },
+ "bidsInAuction": {
+ "$ref": "MetricValue",
+ "description": "The number of bids that were permitted to compete in the auction."
+ },
+ "rowDimensions": {
+ "$ref": "RowDimensions",
+ "description": "The values of all dimensions associated with metric values in this row."
+ }
+ },
+ "id": "BidMetricsRow"
+ },
+ "ListBidResponseErrorsResponse": {
+ "description": "Response message for listing all reasons that bid responses resulted in an\nerror.",
+ "type": "object",
+ "properties": {
+ "calloutStatusRows": {
+ "description": "List of rows, with counts of bid responses aggregated by callout status.",
+ "items": {
+ "$ref": "CalloutStatusRow"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListBidResponseErrorsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.bidResponseErrors.list\nmethod to retrieve the next page of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListBidResponseErrorsResponse"
+ },
+ "CreativeStatusRow": {
+ "description": "The number of bids with the specified dimension values that did not win the\nauction (either were filtered pre-auction or lost the auction), as described\nby the specified creative status.",
+ "type": "object",
+ "properties": {
+ "bidCount": {
+ "$ref": "MetricValue",
+ "description": "The number of bids with the specified status."
+ },
+ "rowDimensions": {
+ "$ref": "RowDimensions",
+ "description": "The values of all dimensions associated with metric values in this row."
+ },
+ "creativeStatusId": {
+ "format": "int32",
+ "description": "The ID of the creative status.\nSee [creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).",
+ "type": "integer"
+ }
+ },
+ "id": "CreativeStatusRow"
+ },
+ "RealtimeTimeRange": {
+ "description": "An open-ended realtime time range specified by the start timestamp.\nFor filter sets that specify a realtime time range RTB metrics continue to\nbe aggregated throughout the lifetime of the filter set.",
+ "type": "object",
+ "properties": {
+ "startTimestamp": {
+ "format": "google-datetime",
+ "description": "The start timestamp of the real-time RTB metrics aggregation.",
+ "type": "string"
+ }
+ },
+ "id": "RealtimeTimeRange"
+ },
+ "NonBillableWinningBidStatusRow": {
+ "description": "The number of winning bids with the specified dimension values for which the\nbuyer was not billed, as described by the specified status.",
+ "type": "object",
+ "properties": {
+ "bidCount": {
+ "description": "The number of bids with the specified status.",
+ "$ref": "MetricValue"
+ },
+ "status": {
+ "enumDescriptions": [
+ "A placeholder for an undefined status.\nThis value will never be returned in responses.",
+ "The buyer was not billed because the ad was not rendered by the\npublisher.",
+ "The buyer was not billed because the impression won by the bid was\ndetermined to be invalid."
+ ],
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "AD_NOT_RENDERED",
+ "INVALID_IMPRESSION"
+ ],
+ "description": "The status specifying why the winning bids were not billed.",
+ "type": "string"
+ },
+ "rowDimensions": {
+ "description": "The values of all dimensions associated with metric values in this row.",
+ "$ref": "RowDimensions"
+ }
+ },
+ "id": "NonBillableWinningBidStatusRow"
+ },
+ "FilteredBidDetailRow": {
+ "description": "The number of filtered bids with the specified dimension values, among those\nfiltered due to the requested filtering reason (i.e. creative status), that\nhave the specified detail.",
+ "type": "object",
+ "properties": {
+ "rowDimensions": {
+ "description": "The values of all dimensions associated with metric values in this row.",
+ "$ref": "RowDimensions"
+ },
+ "detailId": {
+ "format": "int32",
+ "description": "The ID of the detail. The associated value can be looked up in the\ndictionary file corresponding to the DetailType in the response message.",
+ "type": "integer"
+ },
+ "bidCount": {
+ "description": "The number of bids with the specified detail.",
+ "$ref": "MetricValue"
+ }
+ },
+ "id": "FilteredBidDetailRow"
+ },
+ "AbsoluteDateRange": {
+ "description": "An absolute date range, specified by its start date and end date.\nThe supported range of dates begins 30 days before today and ends today.\nValidity checked upon filter set creation. If a filter set with an absolute\ndate range is run at a later date more than 30 days after start_date, it will\nfail.",
+ "type": "object",
+ "properties": {
+ "endDate": {
+ "description": "The end date of the range (inclusive).\nMust be within the 30 days leading up to current date, and must be equal to\nor after start_date.",
+ "$ref": "Date"
+ },
+ "startDate": {
+ "description": "The start date of the range (inclusive).\nMust be within the 30 days leading up to current date, and must be equal to\nor before end_date.",
+ "$ref": "Date"
+ }
+ },
+ "id": "AbsoluteDateRange"
+ },
+ "AddDealAssociationRequest": {
+ "description": "A request for associating a deal and a creative.",
+ "type": "object",
+ "properties": {
+ "association": {
+ "$ref": "CreativeDealAssociation",
+ "description": "The association between a creative and a deal that should be added."
+ }
+ },
+ "id": "AddDealAssociationRequest"
+ },
+ "WatchCreativeRequest": {
+ "description": "A request for watching changes to creative Status.",
+ "type": "object",
+ "properties": {
+ "topic": {
+ "description": "The Pub/Sub topic to publish notifications to.\nThis topic must already exist and must give permission to\nad-exchange-buyside-reports@google.com to write to the topic.\nThis should be the full resource name in\n\"projects/{project_id}/topics/{topic_id}\" format.",
+ "type": "string"
+ }
+ },
+ "id": "WatchCreativeRequest"
+ },
+ "TimeInterval": {
+ "description": "An interval of time, with an absolute start and end.",
+ "type": "object",
+ "properties": {
+ "endTime": {
+ "format": "google-datetime",
+ "description": "The timestamp marking the end of the range (exclusive) for which data is\nincluded.",
+ "type": "string"
+ },
+ "startTime": {
+ "format": "google-datetime",
+ "description": "The timestamp marking the start of the range (inclusive) for which data is\nincluded.",
+ "type": "string"
+ }
+ },
+ "id": "TimeInterval"
+ },
+ "FilteredBidCreativeRow": {
+ "description": "The number of filtered bids with the specified dimension values that have the\nspecified creative.",
+ "type": "object",
+ "properties": {
+ "bidCount": {
+ "$ref": "MetricValue",
+ "description": "The number of bids with the specified creative."
+ },
+ "creativeId": {
+ "description": "The ID of the creative.",
+ "type": "string"
+ },
+ "rowDimensions": {
+ "description": "The values of all dimensions associated with metric values in this row.",
+ "$ref": "RowDimensions"
+ }
+ },
+ "id": "FilteredBidCreativeRow"
+ },
+ "RelativeDateRange": {
+ "description": "A relative date range, specified by an offset and a duration.\nThe supported range of dates begins 30 days before today and ends today.\nI.e. the limits for these values are:\noffset_days \u003e= 0\nduration_days \u003e= 1\noffset_days + duration_days \u003c= 30",
+ "type": "object",
+ "properties": {
+ "durationDays": {
+ "format": "int32",
+ "description": "The number of days in the requested date range. E.g. for a range spanning\ntoday, 1. For a range spanning the last 7 days, 7.",
+ "type": "integer"
+ },
+ "offsetDays": {
+ "format": "int32",
+ "description": "The end date of the filter set, specified as the number of days before\ntoday. E.g. for a range where the last date is today, 0.",
+ "type": "integer"
+ }
+ },
+ "id": "RelativeDateRange"
+ },
+ "ListClientsResponse": {
+ "type": "object",
+ "properties": {
+ "clients": {
+ "description": "The returned list of clients.",
+ "items": {
+ "$ref": "Client"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientsRequest.pageToken\nfield in the subsequent call to the\naccounts.clients.list method\nto retrieve the next page of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListClientsResponse"
+ },
+ "NativeContent": {
+ "description": "Native content for a creative.",
+ "type": "object",
+ "properties": {
+ "body": {
+ "description": "A long description of the ad.",
+ "type": "string"
+ },
+ "starRating": {
+ "format": "double",
+ "description": "The app rating in the app store. Must be in the range [0-5].",
+ "type": "number"
+ },
+ "videoUrl": {
+ "description": "The URL to fetch a native video ad.",
+ "type": "string"
+ },
+ "clickLinkUrl": {
+ "description": "The URL that the browser/SDK will load when the user clicks the ad.",
+ "type": "string"
+ },
+ "logo": {
+ "description": "A smaller image, for the advertiser's logo.",
+ "$ref": "Image"
+ },
+ "priceDisplayText": {
+ "description": "The price of the promoted app including currency info.",
+ "type": "string"
+ },
+ "clickTrackingUrl": {
+ "description": "The URL to use for click tracking.",
+ "type": "string"
+ },
+ "image": {
+ "$ref": "Image",
+ "description": "A large image."
+ },
+ "advertiserName": {
+ "description": "The name of the advertiser or sponsor, to be displayed in the ad creative.",
+ "type": "string"
+ },
+ "storeUrl": {
+ "description": "The URL to the app store to purchase/download the promoted app.",
+ "type": "string"
+ },
+ "headline": {
+ "description": "A short title for the ad.",
+ "type": "string"
+ },
+ "appIcon": {
+ "$ref": "Image",
+ "description": "The app icon, for app download ads."
+ },
+ "callToAction": {
+ "description": "A label for the button that the user is supposed to click.",
+ "type": "string"
+ }
+ },
+ "id": "NativeContent"
+ },
+ "ListBidResponsesWithoutBidsResponse": {
+ "description": "Response message for listing all reasons that bid responses were considered\nto have no applicable bids.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListBidResponsesWithoutBidsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.bidResponsesWithoutBids.list\nmethod to retrieve the next page of results.",
+ "type": "string"
+ },
+ "bidResponseWithoutBidsStatusRows": {
+ "description": "List of rows, with counts of bid responses without bids aggregated by\nstatus.",
+ "items": {
+ "$ref": "BidResponseWithoutBidsStatusRow"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListBidResponsesWithoutBidsResponse"
+ },
+ "ServingContext": {
+ "description": "The serving context for this restriction.",
+ "type": "object",
+ "properties": {
+ "appType": {
+ "$ref": "AppContext",
+ "description": "Matches impressions for a particular app type."
+ },
+ "securityType": {
+ "$ref": "SecurityContext",
+ "description": "Matches impressions for a particular security type."
+ },
+ "platform": {
+ "$ref": "PlatformContext",
+ "description": "Matches impressions coming from a particular platform."
+ },
+ "location": {
+ "$ref": "LocationContext",
+ "description": "Matches impressions coming from users *or* publishers in a specific\nlocation."
+ },
+ "auctionType": {
+ "$ref": "AuctionContext",
+ "description": "Matches impressions for a particular auction type."
+ },
+ "all": {
+ "enumDescriptions": [
+ "A simple context."
+ ],
+ "enum": [
+ "SIMPLE_CONTEXT"
+ ],
+ "description": "Matches all contexts.",
+ "type": "string"
+ }
+ },
+ "id": "ServingContext"
+ },
+ "Image": {
+ "description": "An image resource. You may provide a larger image than was requested,\nso long as the aspect ratio is preserved.",
+ "type": "object",
+ "properties": {
+ "width": {
+ "format": "int32",
+ "description": "Image width in pixels.",
+ "type": "integer"
+ },
+ "url": {
+ "description": "The URL of the image.",
+ "type": "string"
+ },
+ "height": {
+ "format": "int32",
+ "description": "Image height in pixels.",
+ "type": "integer"
+ }
+ },
+ "id": "Image"
+ },
+ "ListFilterSetsResponse": {
+ "description": "Response message for listing filter sets.",
+ "type": "object",
+ "properties": {
+ "filterSets": {
+ "description": "The filter sets belonging to the buyer.",
+ "items": {
+ "$ref": "FilterSet"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListFilterSetsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.list\nmethod to retrieve the next page of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListFilterSetsResponse"
+ },
+ "BidResponseWithoutBidsStatusRow": {
+ "description": "The number of impressions with the specified dimension values that were\nconsidered to have no applicable bids, as described by the specified status.",
+ "type": "object",
+ "properties": {
+ "impressionCount": {
+ "$ref": "MetricValue",
+ "description": "The number of impressions for which there was a bid response with the\nspecified status."
+ },
+ "status": {
+ "description": "The status specifying why the bid responses were considered to have no\napplicable bids.",
+ "type": "string",
+ "enumDescriptions": [
+ "A placeholder for an undefined status.\nThis value will never be returned in responses.",
+ "The response had no bids.",
+ "The response had no bids for the specified account, though it may have\nincluded bids on behalf of other accounts.",
+ "The response had no bids for the specified deal, though it may have\nincluded bids on other deals on behalf of the account to which the deal\nbelongs."
+ ],
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "RESPONSES_WITHOUT_BIDS",
+ "RESPONSES_WITHOUT_BIDS_FOR_ACCOUNT",
+ "RESPONSES_WITHOUT_BIDS_FOR_DEAL"
+ ]
+ },
+ "rowDimensions": {
+ "$ref": "RowDimensions",
+ "description": "The values of all dimensions associated with metric values in this row."
+ }
+ },
+ "id": "BidResponseWithoutBidsStatusRow"
+ },
+ "ClientUserInvitation": {
+ "description": "An invitation for a new client user to get access to the Ad Exchange\nBuyer UI.\nAll fields are required unless otherwise specified.",
+ "type": "object",
+ "properties": {
+ "clientAccountId": {
+ "format": "int64",
+ "description": "Numerical account ID of the client buyer\nthat the invited user is associated with.\nThe value of this field is ignored in create operations.",
+ "type": "string"
+ },
+ "invitationId": {
+ "format": "int64",
+ "description": "The unique numerical ID of the invitation that is sent to the user.\nThe value of this field is ignored in create operations.",
+ "type": "string"
+ },
+ "email": {
+ "description": "The email address to which the invitation is sent. Email\naddresses should be unique among all client users under each sponsor\nbuyer.",
+ "type": "string"
+ }
+ },
+ "id": "ClientUserInvitation"
+ },
+ "ListCreativeStatusBreakdownByDetailResponse": {
+ "description": "Response message for listing all details associated with a given filtered bid\nreason.",
+ "type": "object",
+ "properties": {
+ "detailType": {
+ "description": "The type of detail that the detail IDs represent.",
+ "type": "string",
+ "enumDescriptions": [
+ "A placeholder for an undefined status.\nThis value will never be returned in responses.",
+ "Indicates that the detail ID refers to a creative attribute; see\n[publisher-excludable-creative-attributes](https://developers.google.com/ad-exchange/rtb/downloads/publisher-excludable-creative-attributes).",
+ "Indicates that the detail ID refers to a vendor; see\n[vendors](https://developers.google.com/ad-exchange/rtb/downloads/vendors).",
+ "Indicates that the detail ID refers to a sensitive category; see\n[ad-sensitive-categories](https://developers.google.com/ad-exchange/rtb/downloads/ad-sensitive-categories).",
+ "Indicates that the detail ID refers to a product category; see\n[ad-product-categories](https://developers.google.com/ad-exchange/rtb/downloads/ad-product-categories).",
+ "Indicates that the detail ID refers to a disapproval reason; see\nDisapprovalReason enum in [snippet-status-report-proto](https://developers.google.com/ad-exchange/rtb/downloads/snippet-status-report-proto)."
+ ],
+ "enum": [
+ "DETAIL_TYPE_UNSPECIFIED",
+ "CREATIVE_ATTRIBUTE",
+ "VENDOR",
+ "SENSITIVE_CATEGORY",
+ "PRODUCT_CATEGORY",
+ "DISAPPROVAL_REASON"
+ ]
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativeStatusBreakdownByDetailRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.filteredBids.details.list\nmethod to retrieve the next page of results.",
+ "type": "string"
+ },
+ "filteredBidDetailRows": {
+ "description": "List of rows, with counts of bids with a given creative status aggregated\nby detail.",
+ "items": {
+ "$ref": "FilteredBidDetailRow"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListCreativeStatusBreakdownByDetailResponse"
+ },
+ "ListClientUsersResponse": {
+ "type": "object",
+ "properties": {
+ "users": {
+ "description": "The returned list of client users.",
+ "items": {
+ "$ref": "ClientUser"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientUsersRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListClientUsersResponse"
+ },
+ "ListClientUserInvitationsResponse": {
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientUserInvitationsRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results.",
+ "type": "string"
+ },
+ "invitations": {
+ "description": "The returned list of client users.",
+ "items": {
+ "$ref": "ClientUserInvitation"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListClientUserInvitationsResponse"
+ },
+ "LocationContext": {
+ "description": "@OutputOnly The Geo criteria the restriction applies to.",
+ "type": "object",
+ "properties": {
+ "geoCriteriaIds": {
+ "description": "IDs representing the geo location for this context.\nPlease refer to the\n[geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv)\nfile for different geo criteria IDs.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ }
+ },
+ "id": "LocationContext"
+ },
+ "PlatformContext": {
+ "description": "@OutputOnly The type of platform the restriction applies to.",
+ "type": "object",
+ "properties": {
+ "platforms": {
+ "enumDescriptions": [
+ "Desktop platform.",
+ "Android platform.",
+ "iOS platform."
+ ],
+ "description": "The platforms this restriction applies to.",
+ "items": {
+ "enum": [
+ "DESKTOP",
+ "ANDROID",
+ "IOS"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "PlatformContext"
+ },
+ "MetricValue": {
+ "description": "A metric value, with an expected value and a variance; represents a count\nthat may be either exact or estimated (i.e. when sampled).",
+ "type": "object",
+ "properties": {
+ "variance": {
+ "format": "int64",
+ "description": "The variance (i.e. square of the standard deviation) of the metric value.\nIf value is exact, variance is 0.\nCan be used to calculate margin of error as a percentage of value, using\nthe following formula, where Z is the standard constant that depends on the\ndesired size of the confidence interval (e.g. for 90% confidence interval,\nuse Z = 1.645):\n\n marginOfError = 100 * Z * sqrt(variance) / value",
+ "type": "string"
+ },
+ "value": {
+ "format": "int64",
+ "description": "The expected value of the metric.",
+ "type": "string"
+ }
+ },
+ "id": "MetricValue"
+ },
"ClientUser": {
- "id": "ClientUser",
"description": "A client user is created under a client buyer and has restricted access to\nthe Ad Exchange Marketplace and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngranted to the associated client buyer.\n\nThe only way a new client user can be created is via accepting an\nemail invitation\n(see the\naccounts.clients.invitations.create\nmethod).\n\nAll fields are required unless otherwise specified.",
"type": "object",
"properties": {
+ "clientAccountId": {
+ "format": "int64",
+ "description": "Numerical account ID of the client buyer\nwith which the user is associated; the\nbuyer must be a client of the current sponsor buyer.\nThe value of this field is ignored in an update operation.",
+ "type": "string"
+ },
"status": {
"description": "The status of the client user.",
"type": "string",
@@ -34,13 +906,9 @@
"format": "int64",
"description": "The unique numerical ID of the client user\nthat has accepted an invitation.\nThe value of this field is ignored in an update operation.",
"type": "string"
- },
- "clientAccountId": {
- "format": "int64",
- "description": "Numerical account ID of the client buyer\nwith which the user is associated; the\nbuyer must be a client of the current sponsor buyer.\nThe value of this field is ignored in an update operation.",
- "type": "string"
}
- }
+ },
+ "id": "ClientUser"
},
"CreativeDealAssociation": {
"description": "The association between a creative and a deal.",
@@ -62,17 +930,36 @@
"id": "CreativeDealAssociation"
},
"Creative": {
- "id": "Creative",
"description": "A creative and its classification data.",
"type": "object",
"properties": {
+ "advertiserName": {
+ "description": "The name of the company being advertised in the creative.",
+ "type": "string"
+ },
+ "detectedAdvertiserIds": {
+ "description": "@OutputOnly Detected advertiser IDs, if any.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "detectedDomains": {
+ "description": "@OutputOnly\nThe detected domains for this creative.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
"filteringStats": {
- "$ref": "FilteringStats",
- "description": "@OutputOnly The filtering stats for this creative."
+ "description": "@OutputOnly The filtering stats for this creative.",
+ "$ref": "FilteringStats"
},
"attributes": {
"description": "All attributes for the ads that may be shown from this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
"items": {
+ "type": "string",
"enum": [
"ATTRIBUTE_UNSPECIFIED",
"IS_TAGGED",
@@ -98,8 +985,7 @@
"NATIVE_ELIGIBILITY_ELIGIBLE",
"NATIVE_ELIGIBILITY_NOT_ELIGIBLE",
"RENDERING_SIZELESS_ADX"
- ],
- "type": "string"
+ ]
},
"type": "array",
"enumDescriptions": [
@@ -150,12 +1036,12 @@
"type": "string"
},
"native": {
- "description": "A native creative.",
- "$ref": "NativeContent"
+ "$ref": "NativeContent",
+ "description": "A native creative."
},
"video": {
- "$ref": "VideoContent",
- "description": "A video creative."
+ "description": "A video creative.",
+ "$ref": "VideoContent"
},
"servingRestrictions": {
"description": "@OutputOnly The granular status of this ad in specific contexts.\nA context here relates to where something ultimately serves (for example,\na physical location, a platform, an HTTPS vs HTTP request, or the type\nof auction).",
@@ -176,6 +1062,10 @@
},
"type": "array"
},
+ "adChoicesDestinationUrl": {
+ "description": "The link to AdChoices destination page.",
+ "type": "string"
+ },
"detectedSensitiveCategories": {
"description": "@OutputOnly Detected sensitive categories, if any.\nSee the ad-sensitive-categories.txt file in the technical documentation for\na list of IDs. You should use these IDs along with the\nexcluded-sensitive-category field in the bid request to filter your bids.",
"items": {
@@ -184,11 +1074,11 @@
},
"type": "array"
},
- "adChoicesDestinationUrl": {
- "description": "The link to AdChoices destination page.",
- "type": "string"
- },
"restrictedCategories": {
+ "enumDescriptions": [
+ "The ad has no restricted categories",
+ "The alcohol restricted category."
+ ],
"description": "All restricted categories for the ads that may be shown from this creative.",
"items": {
"enum": [
@@ -197,11 +1087,7 @@
],
"type": "string"
},
- "type": "array",
- "enumDescriptions": [
- "The ad has no restricted categories",
- "The alcohol restricted category."
- ]
+ "type": "array"
},
"corrections": {
"description": "@OutputOnly Shows any corrections that were applied to this creative.",
@@ -234,14 +1120,6 @@
"$ref": "HtmlContent",
"description": "An HTML creative."
},
- "detectedProductCategories": {
- "description": "@OutputOnly Detected product categories, if any.\nSee the ad-product-categories.txt file in the technical documentation\nfor a list of IDs.",
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
- },
"dealsStatus": {
"enumDescriptions": [
"The status is unknown.",
@@ -260,6 +1138,14 @@
"description": "@OutputOnly The top-level deals status of this creative.\nIf disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanced with other contextual restrictions, in which case,\nit may be preferable to read from serving_restrictions directly.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
"type": "string"
},
+ "detectedProductCategories": {
+ "description": "@OutputOnly Detected product categories, if any.\nSee the ad-product-categories.txt file in the technical documentation\nfor a list of IDs.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
"openAuctionStatus": {
"enumDescriptions": [
"The status is unknown.",
@@ -277,30 +1163,11 @@
],
"description": "@OutputOnly The top-level open auction status of this creative.\nIf disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanced with other contextual restrictions, in which case,\nit may be preferable to read from serving_restrictions directly.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
"type": "string"
- },
- "advertiserName": {
- "description": "The name of the company being advertised in the creative.",
- "type": "string"
- },
- "detectedDomains": {
- "description": "@OutputOnly\nThe detected domains for this creative.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "detectedAdvertiserIds": {
- "description": "@OutputOnly Detected advertiser IDs, if any.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
}
- }
+ },
+ "id": "Creative"
},
"FilteringStats": {
- "id": "FilteringStats",
"description": "@OutputOnly Filtering reasons for this creative during a period of a single\nday (from midnight to midnight Pacific).",
"type": "object",
"properties": {
@@ -312,13 +1179,13 @@
"type": "array"
},
"date": {
- "description": "The day during which the data was collected.\nThe data is collected from 00:00:00 to 23:59:59 PT.\nDuring switches from PST to PDT and back, the day may\ncontain 23 or 25 hours of data instead of the usual 24.",
- "$ref": "Date"
+ "$ref": "Date",
+ "description": "The day during which the data was collected.\nThe data is collected from 00:00:00 to 23:59:59 PT.\nDuring switches from PST to PDT and back, the day may\ncontain 23 or 25 hours of data instead of the usual 24."
}
- }
+ },
+ "id": "FilteringStats"
},
"RemoveDealAssociationRequest": {
- "id": "RemoveDealAssociationRequest",
"description": "A request for removing the association between a deal and a creative.",
"type": "object",
"properties": {
@@ -326,22 +1193,23 @@
"description": "The association between a creative and a deal that should be removed.",
"$ref": "CreativeDealAssociation"
}
- }
+ },
+ "id": "RemoveDealAssociationRequest"
},
"ListCreativeStatusBreakdownByCreativeResponse": {
"description": "Response message for listing all creatives associated with a given filtered\nbid reason.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativeStatusBreakdownByCreativeRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.filteredBids.creatives.list\nmethod to retrieve the next page of results.",
+ "type": "string"
+ },
"filteredBidCreativeRows": {
"description": "List of rows, with counts of bids with a given creative status aggregated\nby creative.",
"items": {
"$ref": "FilteredBidCreativeRow"
},
"type": "array"
- },
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativeStatusBreakdownByCreativeRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.filteredBids.creatives.list\nmethod to retrieve the next page of results.",
- "type": "string"
}
},
"id": "ListCreativeStatusBreakdownByCreativeResponse"
@@ -350,6 +1218,29 @@
"description": "A client resource represents a client buyer—an agency,\na brand, or an advertiser customer of the sponsor buyer.\nUsers associated with the client buyer have restricted access to\nthe Ad Exchange Marketplace and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngranted to the client buyer.\nAll fields are required unless otherwise specified.",
"type": "object",
"properties": {
+ "clientAccountId": {
+ "format": "int64",
+ "description": "The globally-unique numerical ID of the client.\nThe value of this field is ignored in create and update operations.",
+ "type": "string"
+ },
+ "entityName": {
+ "description": "The name of the entity. This field is automatically fetched based on\nthe type and ID.\nThe value of this field is ignored in create and update operations.",
+ "type": "string"
+ },
+ "status": {
+ "description": "The status of the client buyer.",
+ "type": "string",
+ "enumDescriptions": [
+ "A placeholder for an undefined client status.",
+ "A client that is currently disabled.",
+ "A client that is currently active."
+ ],
+ "enum": [
+ "CLIENT_STATUS_UNSPECIFIED",
+ "DISABLED",
+ "ACTIVE"
+ ]
+ },
"entityType": {
"description": "The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.",
"type": "string",
@@ -394,29 +1285,6 @@
"format": "int64",
"description": "Numerical identifier of the client entity.\nThe entity can be an advertiser, a brand, or an agency.\nThis identifier is unique among all the entities with the same type.\n\nA list of all known advertisers with their identifiers is available in the\n[advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)\nfile.\n\nA list of all known brands with their identifiers is available in the\n[brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)\nfile.\n\nA list of all known agencies with their identifiers is available in the\n[agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)\nfile.",
"type": "string"
- },
- "clientAccountId": {
- "format": "int64",
- "description": "The globally-unique numerical ID of the client.\nThe value of this field is ignored in create and update operations.",
- "type": "string"
- },
- "entityName": {
- "description": "The name of the entity. This field is automatically fetched based on\nthe type and ID.\nThe value of this field is ignored in create and update operations.",
- "type": "string"
- },
- "status": {
- "description": "The status of the client buyer.",
- "type": "string",
- "enumDescriptions": [
- "A placeholder for an undefined client status.",
- "A client that is currently disabled.",
- "A client that is currently active."
- ],
- "enum": [
- "CLIENT_STATUS_UNSPECIFIED",
- "DISABLED",
- "ACTIVE"
- ]
}
},
"id": "Client"
@@ -425,13 +1293,6 @@
"description": "@OutputOnly Shows any corrections that were applied to this creative.",
"type": "object",
"properties": {
- "details": {
- "description": "Additional details about what was corrected.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
"type": {
"description": "The type of correction that was applied to the creative.",
"type": "string",
@@ -470,6 +1331,13 @@
"$ref": "ServingContext"
},
"type": "array"
+ },
+ "details": {
+ "description": "Additional details about what was corrected.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
},
"id": "Correction"
@@ -493,6 +1361,8 @@
]
},
"format": {
+ "description": "The format on which to filter; optional.",
+ "type": "string",
"enumDescriptions": [
"A placeholder for an undefined format; indicates that no format filter\nwill be applied.",
"The ad impression is display format (i.e. an image).",
@@ -502,9 +1372,7 @@
"FORMAT_UNSPECIFIED",
"DISPLAY",
"VIDEO"
- ],
- "description": "The format on which to filter; optional.",
- "type": "string"
+ ]
},
"dealId": {
"format": "int64",
@@ -512,8 +1380,6 @@
"type": "string"
},
"timeSeriesGranularity": {
- "description": "The granularity of time intervals if a time series breakdown is desired;\noptional.",
- "type": "string",
"enumDescriptions": [
"A placeholder for an unspecified interval; no time series is applied.\nAll rows in response will contain data for the entire requested time range.",
"Indicates that data will be broken down by the hour.",
@@ -523,7 +1389,9 @@
"TIME_SERIES_GRANULARITY_UNSPECIFIED",
"HOURLY",
"DAILY"
- ]
+ ],
+ "description": "The granularity of time intervals if a time series breakdown is desired;\noptional.",
+ "type": "string"
},
"filterSetId": {
"format": "int64",
@@ -531,8 +1399,8 @@
"type": "string"
},
"realtimeTimeRange": {
- "$ref": "RealtimeTimeRange",
- "description": "An open-ended realtime time range, defined by the aggregation start\ntimestamp."
+ "description": "An open-ended realtime time range, defined by the aggregation start\ntimestamp.",
+ "$ref": "RealtimeTimeRange"
},
"creativeId": {
"description": "The ID of the creative on which to filter; optional.",
@@ -590,32 +1458,13 @@
},
"id": "FilterSet"
},
- "ListDealAssociationsResponse": {
- "description": "A response for listing creative and deal associations",
- "type": "object",
- "properties": {
- "associations": {
- "description": "The list of associations.",
- "items": {
- "$ref": "CreativeDealAssociation"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListDealAssociationsRequest.page_token\nfield in the subsequent call to 'ListDealAssociation' method to retrieve\nthe next page of results.",
- "type": "string"
- }
- },
- "id": "ListDealAssociationsResponse"
- },
"CalloutStatusRow": {
- "id": "CalloutStatusRow",
"description": "The number of impressions with the specified dimension values where the\ncorresponding bid request or bid response was not successful, as described by\nthe specified callout status.",
"type": "object",
"properties": {
"impressionCount": {
- "$ref": "MetricValue",
- "description": "The number of impressions for which there was a bid request or bid response\nwith the specified callout status."
+ "description": "The number of impressions for which there was a bid request or bid response\nwith the specified callout status.",
+ "$ref": "MetricValue"
},
"rowDimensions": {
"description": "The values of all dimensions associated with metric values in this row.",
@@ -626,14 +1475,41 @@
"description": "The ID of the callout status.\nSee [callout-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/callout-status-codes).",
"type": "integer"
}
- }
+ },
+ "id": "CalloutStatusRow"
+ },
+ "ListDealAssociationsResponse": {
+ "description": "A response for listing creative and deal associations",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListDealAssociationsRequest.page_token\nfield in the subsequent call to 'ListDealAssociation' method to retrieve\nthe next page of results.",
+ "type": "string"
+ },
+ "associations": {
+ "description": "The list of associations.",
+ "items": {
+ "$ref": "CreativeDealAssociation"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListDealAssociationsResponse"
},
"Disapproval": {
- "id": "Disapproval",
"description": "@OutputOnly The reason and details for a disapproval.",
"type": "object",
"properties": {
+ "details": {
+ "description": "Additional details about the reason for disapproval.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
"reason": {
+ "description": "The categorized reason for disapproval.",
+ "type": "string",
"enumDescriptions": [
"The length of the image animation is longer than allowed.",
"The click through URL doesn't work properly.",
@@ -825,24 +1701,16 @@
"MAXIMUM_NUMBER_OF_COOKIES_EXCEEDED",
"PERSONAL_LOANS",
"UNSUPPORTED_FLASH_CONTENT"
- ],
- "description": "The categorized reason for disapproval.",
- "type": "string"
- },
- "details": {
- "description": "Additional details about the reason for disapproval.",
- "items": {
- "type": "string"
- },
- "type": "array"
+ ]
}
- }
+ },
+ "id": "Disapproval"
},
"StopWatchingCreativeRequest": {
- "id": "StopWatchingCreativeRequest",
"description": "A request for stopping notifications for changes to creative Status.",
"type": "object",
- "properties": {}
+ "properties": {},
+ "id": "StopWatchingCreativeRequest"
},
"ServingRestriction": {
"description": "@OutputOnly A representation of the status of an ad in a\nspecific context. A context here relates to where something ultimately serves\n(for example, a user or publisher geo, a platform, an HTTPS vs HTTP request,\nor the type of auction).",
@@ -880,7 +1748,6 @@
"id": "ServingRestriction"
},
"Date": {
- "id": "Date",
"description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
"type": "object",
"properties": {
@@ -899,878 +1766,15 @@
"description": "Month of year. Must be from 1 to 12.",
"type": "integer"
}
- }
- },
- "RowDimensions": {
- "id": "RowDimensions",
- "description": "A response may include multiple rows, breaking down along various dimensions.\nEncapsulates the values of all dimensions for a given row.",
- "type": "object",
- "properties": {
- "timeInterval": {
- "$ref": "TimeInterval",
- "description": "The time interval that this row represents."
- }
- }
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\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"
- },
- "AppContext": {
- "description": "@OutputOnly The app type the restriction applies to for mobile device.",
- "type": "object",
- "properties": {
- "appTypes": {
- "description": "The app types this restriction applies to.",
- "items": {
- "enum": [
- "NATIVE",
- "WEB"
- ],
- "type": "string"
- },
- "type": "array",
- "enumDescriptions": [
- "Native app context.",
- "Mobile web app context."
- ]
- }
},
- "id": "AppContext"
- },
- "ListFilteredBidsResponse": {
- "description": "Response message for listing all reasons that bids were filtered from the\nauction.",
- "type": "object",
- "properties": {
- "creativeStatusRows": {
- "description": "List of rows, with counts of filtered bids aggregated by filtering reason\n(i.e. creative status).",
- "items": {
- "$ref": "CreativeStatusRow"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListFilteredBidsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.filteredBids.list\nmethod to retrieve the next page of results.",
- "type": "string"
- }
- },
- "id": "ListFilteredBidsResponse"
- },
- "SecurityContext": {
- "id": "SecurityContext",
- "description": "@OutputOnly A security context.",
- "type": "object",
- "properties": {
- "securities": {
- "description": "The security types in this context.",
- "items": {
- "enum": [
- "INSECURE",
- "SSL"
- ],
- "type": "string"
- },
- "type": "array",
- "enumDescriptions": [
- "Matches impressions that require insecure compatibility.",
- "Matches impressions that require SSL compatibility."
- ]
- }
- }
- },
- "HtmlContent": {
- "id": "HtmlContent",
- "description": "HTML content for a creative.",
- "type": "object",
- "properties": {
- "snippet": {
- "description": "The HTML snippet that displays the ad when inserted in the web page.",
- "type": "string"
- },
- "height": {
- "format": "int32",
- "description": "The height of the HTML snippet in pixels.",
- "type": "integer"
- },
- "width": {
- "format": "int32",
- "description": "The width of the HTML snippet in pixels.",
- "type": "integer"
- }
- }
- },
- "ListCreativesResponse": {
- "id": "ListCreativesResponse",
- "description": "A response for listing creatives.",
- "type": "object",
- "properties": {
- "creatives": {
- "description": "The list of creatives.",
- "items": {
- "$ref": "Creative"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativesRequest.page_token\nfield in the subsequent call to `ListCreatives` method to retrieve the next\npage of results.",
- "type": "string"
- }
- }
- },
- "ListFilteredBidRequestsResponse": {
- "id": "ListFilteredBidRequestsResponse",
- "description": "Response message for listing all reasons that bid requests were filtered and\nnot sent to the buyer.",
- "type": "object",
- "properties": {
- "calloutStatusRows": {
- "description": "List of rows, with counts of filtered bid requests aggregated by callout\nstatus.",
- "items": {
- "$ref": "CalloutStatusRow"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListFilteredBidRequestsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.filteredBidRequests.list\nmethod to retrieve the next page of results.",
- "type": "string"
- }
- }
- },
- "ListBidMetricsResponse": {
- "description": "Response message for listing the metrics that are measured in number of bids.",
- "type": "object",
- "properties": {
- "bidMetricsRows": {
- "description": "List of rows, each containing a set of bid metrics.",
- "items": {
- "$ref": "BidMetricsRow"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListBidMetricsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.bidMetrics.list\nmethod to retrieve the next page of results.",
- "type": "string"
- }
- },
- "id": "ListBidMetricsResponse"
- },
- "Reason": {
- "description": "A specific filtering status and how many times it occurred.",
- "type": "object",
- "properties": {
- "status": {
- "format": "int32",
- "description": "The filtering status code. Please refer to the\n[creative-status-codes.txt](https://storage.googleapis.com/adx-rtb-dictionaries/creative-status-codes.txt)\nfile for different statuses.",
- "type": "integer"
- },
- "count": {
- "format": "int64",
- "description": "The number of times the creative was filtered for the status. The\ncount is aggregated across all publishers on the exchange.",
- "type": "string"
- }
- },
- "id": "Reason"
- },
- "VideoContent": {
- "id": "VideoContent",
- "description": "Video content for a creative.",
- "type": "object",
- "properties": {
- "videoUrl": {
- "description": "The URL to fetch a video ad.",
- "type": "string"
- }
- }
- },
- "ListLosingBidsResponse": {
- "description": "Response message for listing all reasons that bids lost in the auction.",
- "type": "object",
- "properties": {
- "creativeStatusRows": {
- "description": "List of rows, with counts of losing bids aggregated by loss reason (i.e.\ncreative status).",
- "items": {
- "$ref": "CreativeStatusRow"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListLosingBidsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.losingBids.list\nmethod to retrieve the next page of results.",
- "type": "string"
- }
- },
- "id": "ListLosingBidsResponse"
- },
- "ListNonBillableWinningBidsResponse": {
- "description": "Response message for listing all reasons for which a buyer was not billed for\na winning bid.",
- "type": "object",
- "properties": {
- "nonBillableWinningBidStatusRows": {
- "description": "List of rows, with counts of bids not billed aggregated by reason.",
- "items": {
- "$ref": "NonBillableWinningBidStatusRow"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListNonBillableWinningBidsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.nonBillableWinningBids.list\nmethod to retrieve the next page of results.",
- "type": "string"
- }
- },
- "id": "ListNonBillableWinningBidsResponse"
- },
- "ImpressionMetricsRow": {
- "description": "The set of metrics that are measured in numbers of impressions, representing\nhow many impressions with the specified dimension values were considered\neligible at each stage of the bidding funnel.",
- "type": "object",
- "properties": {
- "rowDimensions": {
- "$ref": "RowDimensions",
- "description": "The values of all dimensions associated with metric values in this row."
- },
- "availableImpressions": {
- "description": "The number of impressions available to the buyer on Ad Exchange.\nIn some cases this value may be unavailable.",
- "$ref": "MetricValue"
- },
- "bidRequests": {
- "$ref": "MetricValue",
- "description": "The number of impressions for which Ad Exchange sent the buyer a bid\nrequest."
- },
- "inventoryMatches": {
- "$ref": "MetricValue",
- "description": "The number of impressions that match the buyer's inventory pretargeting."
- },
- "responsesWithBids": {
- "$ref": "MetricValue",
- "description": "The number of impressions for which Ad Exchange received a response from\nthe buyer that contained at least one applicable bid."
- },
- "successfulResponses": {
- "$ref": "MetricValue",
- "description": "The number of impressions for which the buyer successfully sent a response\nto Ad Exchange."
- }
- },
- "id": "ImpressionMetricsRow"
- },
- "AuctionContext": {
- "id": "AuctionContext",
- "description": "@OutputOnly The auction type the restriction applies to.",
- "type": "object",
- "properties": {
- "auctionTypes": {
- "enumDescriptions": [
- "The restriction applies to open auction.",
- "The restriction applies to direct deals."
- ],
- "description": "The auction types this restriction applies to.",
- "items": {
- "type": "string",
- "enum": [
- "OPEN_AUCTION",
- "DIRECT_DEALS"
- ]
- },
- "type": "array"
- }
- }
- },
- "ListImpressionMetricsResponse": {
- "description": "Response message for listing the metrics that are measured in number of\nimpressions.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListImpressionMetricsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.impressionMetrics.list\nmethod to retrieve the next page of results.",
- "type": "string"
- },
- "impressionMetricsRows": {
- "description": "List of rows, each containing a set of impression metrics.",
- "items": {
- "$ref": "ImpressionMetricsRow"
- },
- "type": "array"
- }
- },
- "id": "ListImpressionMetricsResponse"
- },
- "BidMetricsRow": {
- "description": "The set of metrics that are measured in numbers of bids, representing how\nmany bids with the specified dimension values were considered eligible at\neach stage of the bidding funnel;",
- "type": "object",
- "properties": {
- "measurableImpressions": {
- "$ref": "MetricValue",
- "description": "The number of bids for which the corresponding impression was measurable\nfor viewability (as defined by Active View)."
- },
- "bids": {
- "description": "The number of bids that Ad Exchange received from the buyer.",
- "$ref": "MetricValue"
- },
- "billedImpressions": {
- "$ref": "MetricValue",
- "description": "The number of bids for which the buyer was billed."
- },
- "bidsInAuction": {
- "$ref": "MetricValue",
- "description": "The number of bids that were permitted to compete in the auction."
- },
- "rowDimensions": {
- "$ref": "RowDimensions",
- "description": "The values of all dimensions associated with metric values in this row."
- },
- "impressionsWon": {
- "$ref": "MetricValue",
- "description": "The number of bids that won an impression."
- },
- "viewableImpressions": {
- "description": "The number of bids for which the corresponding impression was viewable (as\ndefined by Active View).",
- "$ref": "MetricValue"
- }
- },
- "id": "BidMetricsRow"
- },
- "ListBidResponseErrorsResponse": {
- "id": "ListBidResponseErrorsResponse",
- "description": "Response message for listing all reasons that bid responses resulted in an\nerror.",
- "type": "object",
- "properties": {
- "calloutStatusRows": {
- "description": "List of rows, with counts of bid responses aggregated by callout status.",
- "items": {
- "$ref": "CalloutStatusRow"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListBidResponseErrorsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.bidResponseErrors.list\nmethod to retrieve the next page of results.",
- "type": "string"
- }
- }
- },
- "CreativeStatusRow": {
- "description": "The number of bids with the specified dimension values that did not win the\nauction (either were filtered pre-auction or lost the auction), as described\nby the specified creative status.",
- "type": "object",
- "properties": {
- "rowDimensions": {
- "$ref": "RowDimensions",
- "description": "The values of all dimensions associated with metric values in this row."
- },
- "creativeStatusId": {
- "format": "int32",
- "description": "The ID of the creative status.\nSee [creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).",
- "type": "integer"
- },
- "bidCount": {
- "$ref": "MetricValue",
- "description": "The number of bids with the specified status."
- }
- },
- "id": "CreativeStatusRow"
- },
- "RealtimeTimeRange": {
- "description": "An open-ended realtime time range specified by the start timestamp.\nFor filter sets that specify a realtime time range RTB metrics continue to\nbe aggregated throughout the lifetime of the filter set.",
- "type": "object",
- "properties": {
- "startTimestamp": {
- "format": "google-datetime",
- "description": "The start timestamp of the real-time RTB metrics aggregation.",
- "type": "string"
- }
- },
- "id": "RealtimeTimeRange"
- },
- "NonBillableWinningBidStatusRow": {
- "description": "The number of winning bids with the specified dimension values for which the\nbuyer was not billed, as described by the specified status.",
- "type": "object",
- "properties": {
- "status": {
- "enumDescriptions": [
- "A placeholder for an undefined status.\nThis value will never be returned in responses.",
- "The buyer was not billed because the ad was not rendered by the\npublisher.",
- "The buyer was not billed because the impression won by the bid was\ndetermined to be invalid."
- ],
- "enum": [
- "STATUS_UNSPECIFIED",
- "AD_NOT_RENDERED",
- "INVALID_IMPRESSION"
- ],
- "description": "The status specifying why the winning bids were not billed.",
- "type": "string"
- },
- "rowDimensions": {
- "$ref": "RowDimensions",
- "description": "The values of all dimensions associated with metric values in this row."
- },
- "bidCount": {
- "$ref": "MetricValue",
- "description": "The number of bids with the specified status."
- }
- },
- "id": "NonBillableWinningBidStatusRow"
- },
- "FilteredBidDetailRow": {
- "description": "The number of filtered bids with the specified dimension values, among those\nfiltered due to the requested filtering reason (i.e. creative status), that\nhave the specified detail.",
- "type": "object",
- "properties": {
- "rowDimensions": {
- "description": "The values of all dimensions associated with metric values in this row.",
- "$ref": "RowDimensions"
- },
- "detailId": {
- "format": "int32",
- "description": "The ID of the detail. The associated value can be looked up in the\ndictionary file corresponding to the DetailType in the response message.",
- "type": "integer"
- },
- "bidCount": {
- "description": "The number of bids with the specified detail.",
- "$ref": "MetricValue"
- }
- },
- "id": "FilteredBidDetailRow"
- },
- "AbsoluteDateRange": {
- "description": "An absolute date range, specified by its start date and end date.\nThe supported range of dates begins 30 days before today and ends today.\nValidity checked upon filter set creation. If a filter set with an absolute\ndate range is run at a later date more than 30 days after start_date, it will\nfail.",
- "type": "object",
- "properties": {
- "endDate": {
- "description": "The end date of the range (inclusive).\nMust be within the 30 days leading up to current date, and must be equal to\nor after start_date.",
- "$ref": "Date"
- },
- "startDate": {
- "description": "The start date of the range (inclusive).\nMust be within the 30 days leading up to current date, and must be equal to\nor before end_date.",
- "$ref": "Date"
- }
- },
- "id": "AbsoluteDateRange"
- },
- "AddDealAssociationRequest": {
- "description": "A request for associating a deal and a creative.",
- "type": "object",
- "properties": {
- "association": {
- "description": "The association between a creative and a deal that should be added.",
- "$ref": "CreativeDealAssociation"
- }
- },
- "id": "AddDealAssociationRequest"
- },
- "WatchCreativeRequest": {
- "id": "WatchCreativeRequest",
- "description": "A request for watching changes to creative Status.",
- "type": "object",
- "properties": {
- "topic": {
- "description": "The Pub/Sub topic to publish notifications to.\nThis topic must already exist and must give permission to\nad-exchange-buyside-reports@google.com to write to the topic.\nThis should be the full resource name in\n\"projects/{project_id}/topics/{topic_id}\" format.",
- "type": "string"
- }
- }
- },
- "TimeInterval": {
- "id": "TimeInterval",
- "description": "An interval of time, with an absolute start and end.",
- "type": "object",
- "properties": {
- "startTime": {
- "format": "google-datetime",
- "description": "The timestamp marking the start of the range (inclusive) for which data is\nincluded.",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "The timestamp marking the end of the range (exclusive) for which data is\nincluded.",
- "type": "string"
- }
- }
- },
- "FilteredBidCreativeRow": {
- "description": "The number of filtered bids with the specified dimension values that have the\nspecified creative.",
- "type": "object",
- "properties": {
- "rowDimensions": {
- "$ref": "RowDimensions",
- "description": "The values of all dimensions associated with metric values in this row."
- },
- "bidCount": {
- "$ref": "MetricValue",
- "description": "The number of bids with the specified creative."
- },
- "creativeId": {
- "description": "The ID of the creative.",
- "type": "string"
- }
- },
- "id": "FilteredBidCreativeRow"
- },
- "RelativeDateRange": {
- "id": "RelativeDateRange",
- "description": "A relative date range, specified by an offset and a duration.\nThe supported range of dates begins 30 days before today and ends today.\nI.e. the limits for these values are:\noffset_days \u003e= 0\nduration_days \u003e= 1\noffset_days + duration_days \u003c= 30",
- "type": "object",
- "properties": {
- "offsetDays": {
- "format": "int32",
- "description": "The end date of the filter set, specified as the number of days before\ntoday. E.g. for a range where the last date is today, 0.",
- "type": "integer"
- },
- "durationDays": {
- "format": "int32",
- "description": "The number of days in the requested date range. E.g. for a range spanning\ntoday, 1. For a range spanning the last 7 days, 7.",
- "type": "integer"
- }
- }
- },
- "ListClientsResponse": {
- "id": "ListClientsResponse",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientsRequest.pageToken\nfield in the subsequent call to the\naccounts.clients.list method\nto retrieve the next page of results.",
- "type": "string"
- },
- "clients": {
- "description": "The returned list of clients.",
- "items": {
- "$ref": "Client"
- },
- "type": "array"
- }
- }
- },
- "NativeContent": {
- "description": "Native content for a creative.",
- "type": "object",
- "properties": {
- "logo": {
- "$ref": "Image",
- "description": "A smaller image, for the advertiser's logo."
- },
- "clickLinkUrl": {
- "description": "The URL that the browser/SDK will load when the user clicks the ad.",
- "type": "string"
- },
- "priceDisplayText": {
- "description": "The price of the promoted app including currency info.",
- "type": "string"
- },
- "image": {
- "$ref": "Image",
- "description": "A large image."
- },
- "clickTrackingUrl": {
- "description": "The URL to use for click tracking.",
- "type": "string"
- },
- "advertiserName": {
- "description": "The name of the advertiser or sponsor, to be displayed in the ad creative.",
- "type": "string"
- },
- "storeUrl": {
- "description": "The URL to the app store to purchase/download the promoted app.",
- "type": "string"
- },
- "headline": {
- "description": "A short title for the ad.",
- "type": "string"
- },
- "appIcon": {
- "$ref": "Image",
- "description": "The app icon, for app download ads."
- },
- "callToAction": {
- "description": "A label for the button that the user is supposed to click.",
- "type": "string"
- },
- "body": {
- "description": "A long description of the ad.",
- "type": "string"
- },
- "starRating": {
- "format": "double",
- "description": "The app rating in the app store. Must be in the range [0-5].",
- "type": "number"
- },
- "videoUrl": {
- "description": "The URL to fetch a native video ad.",
- "type": "string"
- }
- },
- "id": "NativeContent"
- },
- "ListBidResponsesWithoutBidsResponse": {
- "description": "Response message for listing all reasons that bid responses were considered\nto have no applicable bids.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListBidResponsesWithoutBidsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.bidResponsesWithoutBids.list\nmethod to retrieve the next page of results.",
- "type": "string"
- },
- "bidResponseWithoutBidsStatusRows": {
- "description": "List of rows, with counts of bid responses without bids aggregated by\nstatus.",
- "items": {
- "$ref": "BidResponseWithoutBidsStatusRow"
- },
- "type": "array"
- }
- },
- "id": "ListBidResponsesWithoutBidsResponse"
- },
- "ServingContext": {
- "description": "The serving context for this restriction.",
- "type": "object",
- "properties": {
- "auctionType": {
- "$ref": "AuctionContext",
- "description": "Matches impressions for a particular auction type."
- },
- "all": {
- "description": "Matches all contexts.",
- "type": "string",
- "enumDescriptions": [
- "A simple context."
- ],
- "enum": [
- "SIMPLE_CONTEXT"
- ]
- },
- "appType": {
- "description": "Matches impressions for a particular app type.",
- "$ref": "AppContext"
- },
- "securityType": {
- "$ref": "SecurityContext",
- "description": "Matches impressions for a particular security type."
- },
- "platform": {
- "$ref": "PlatformContext",
- "description": "Matches impressions coming from a particular platform."
- },
- "location": {
- "description": "Matches impressions coming from users *or* publishers in a specific\nlocation.",
- "$ref": "LocationContext"
- }
- },
- "id": "ServingContext"
- },
- "Image": {
- "description": "An image resource. You may provide a larger image than was requested,\nso long as the aspect ratio is preserved.",
- "type": "object",
- "properties": {
- "url": {
- "description": "The URL of the image.",
- "type": "string"
- },
- "height": {
- "format": "int32",
- "description": "Image height in pixels.",
- "type": "integer"
- },
- "width": {
- "format": "int32",
- "description": "Image width in pixels.",
- "type": "integer"
- }
- },
- "id": "Image"
- },
- "ListFilterSetsResponse": {
- "id": "ListFilterSetsResponse",
- "description": "Response message for listing filter sets.",
- "type": "object",
- "properties": {
- "filterSets": {
- "description": "The filter sets belonging to the buyer.",
- "items": {
- "$ref": "FilterSet"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListFilterSetsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.list\nmethod to retrieve the next page of results.",
- "type": "string"
- }
- }
- },
- "BidResponseWithoutBidsStatusRow": {
- "description": "The number of impressions with the specified dimension values that were\nconsidered to have no applicable bids, as described by the specified status.",
- "type": "object",
- "properties": {
- "impressionCount": {
- "$ref": "MetricValue",
- "description": "The number of impressions for which there was a bid response with the\nspecified status."
- },
- "status": {
- "description": "The status specifying why the bid responses were considered to have no\napplicable bids.",
- "type": "string",
- "enumDescriptions": [
- "A placeholder for an undefined status.\nThis value will never be returned in responses.",
- "The response had no bids.",
- "The response had no bids for the specified account, though it may have\nincluded bids on behalf of other accounts.",
- "The response had no bids for the specified deal, though it may have\nincluded bids on other deals on behalf of the account to which the deal\nbelongs."
- ],
- "enum": [
- "STATUS_UNSPECIFIED",
- "RESPONSES_WITHOUT_BIDS",
- "RESPONSES_WITHOUT_BIDS_FOR_ACCOUNT",
- "RESPONSES_WITHOUT_BIDS_FOR_DEAL"
- ]
- },
- "rowDimensions": {
- "$ref": "RowDimensions",
- "description": "The values of all dimensions associated with metric values in this row."
- }
- },
- "id": "BidResponseWithoutBidsStatusRow"
- },
- "ClientUserInvitation": {
- "description": "An invitation for a new client user to get access to the Ad Exchange\nBuyer UI.\nAll fields are required unless otherwise specified.",
- "type": "object",
- "properties": {
- "email": {
- "description": "The email address to which the invitation is sent. Email\naddresses should be unique among all client users under each sponsor\nbuyer.",
- "type": "string"
- },
- "clientAccountId": {
- "format": "int64",
- "description": "Numerical account ID of the client buyer\nthat the invited user is associated with.\nThe value of this field is ignored in create operations.",
- "type": "string"
- },
- "invitationId": {
- "format": "int64",
- "description": "The unique numerical ID of the invitation that is sent to the user.\nThe value of this field is ignored in create operations.",
- "type": "string"
- }
- },
- "id": "ClientUserInvitation"
- },
- "ListCreativeStatusBreakdownByDetailResponse": {
- "id": "ListCreativeStatusBreakdownByDetailResponse",
- "description": "Response message for listing all details associated with a given filtered bid\nreason.",
- "type": "object",
- "properties": {
- "detailType": {
- "description": "The type of detail that the detail IDs represent.",
- "type": "string",
- "enumDescriptions": [
- "A placeholder for an undefined status.\nThis value will never be returned in responses.",
- "Indicates that the detail ID refers to a creative attribute; see\n[publisher-excludable-creative-attributes](https://developers.google.com/ad-exchange/rtb/downloads/publisher-excludable-creative-attributes).",
- "Indicates that the detail ID refers to a vendor; see\n[vendors](https://developers.google.com/ad-exchange/rtb/downloads/vendors).",
- "Indicates that the detail ID refers to a sensitive category; see\n[ad-sensitive-categories](https://developers.google.com/ad-exchange/rtb/downloads/ad-sensitive-categories).",
- "Indicates that the detail ID refers to a product category; see\n[ad-product-categories](https://developers.google.com/ad-exchange/rtb/downloads/ad-product-categories).",
- "Indicates that the detail ID refers to a disapproval reason; see\nDisapprovalReason enum in [snippet-status-report-proto](https://developers.google.com/ad-exchange/rtb/downloads/snippet-status-report-proto)."
- ],
- "enum": [
- "DETAIL_TYPE_UNSPECIFIED",
- "CREATIVE_ATTRIBUTE",
- "VENDOR",
- "SENSITIVE_CATEGORY",
- "PRODUCT_CATEGORY",
- "DISAPPROVAL_REASON"
- ]
- },
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativeStatusBreakdownByDetailRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.filteredBids.details.list\nmethod to retrieve the next page of results.",
- "type": "string"
- },
- "filteredBidDetailRows": {
- "description": "List of rows, with counts of bids with a given creative status aggregated\nby detail.",
- "items": {
- "$ref": "FilteredBidDetailRow"
- },
- "type": "array"
- }
- }
- },
- "ListClientUsersResponse": {
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientUsersRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results.",
- "type": "string"
- },
- "users": {
- "description": "The returned list of client users.",
- "items": {
- "$ref": "ClientUser"
- },
- "type": "array"
- }
- },
- "id": "ListClientUsersResponse"
- },
- "ListClientUserInvitationsResponse": {
- "id": "ListClientUserInvitationsResponse",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientUserInvitationsRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results.",
- "type": "string"
- },
- "invitations": {
- "description": "The returned list of client users.",
- "items": {
- "$ref": "ClientUserInvitation"
- },
- "type": "array"
- }
- }
- },
- "LocationContext": {
- "id": "LocationContext",
- "description": "@OutputOnly The Geo criteria the restriction applies to.",
- "type": "object",
- "properties": {
- "geoCriteriaIds": {
- "description": "IDs representing the geo location for this context.\nPlease refer to the\n[geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv)\nfile for different geo criteria IDs.",
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
- }
- }
- },
- "PlatformContext": {
- "id": "PlatformContext",
- "description": "@OutputOnly The type of platform the restriction applies to.",
- "type": "object",
- "properties": {
- "platforms": {
- "enumDescriptions": [
- "Desktop platform.",
- "Android platform.",
- "iOS platform."
- ],
- "description": "The platforms this restriction applies to.",
- "items": {
- "enum": [
- "DESKTOP",
- "ANDROID",
- "IOS"
- ],
- "type": "string"
- },
- "type": "array"
- }
- }
- },
- "MetricValue": {
- "id": "MetricValue",
- "description": "A metric value, with an expected value and a variance; represents a count\nthat may be either exact or estimated (i.e. when sampled).",
- "type": "object",
- "properties": {
- "value": {
- "format": "int64",
- "description": "The expected value of the metric.",
- "type": "string"
- },
- "variance": {
- "format": "int64",
- "description": "The variance (i.e. square of the standard deviation) of the metric value.\nIf value is exact, variance is 0.\nCan be used to calculate margin of error as a percentage of value, using\nthe following formula, where Z is the standard constant that depends on the\ndesired size of the confidence interval (e.g. for 90% confidence interval,\nuse Z = 1.645):\n\n marginOfError = 100 * Z * sqrt(variance) / value",
- "type": "string"
- }
- }
+ "id": "Date"
}
},
- "protocol": "rest",
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
+ "protocol": "rest",
"canonicalName": "AdExchangeBuyerII",
"auth": {
"oauth2": {
@@ -1790,1018 +1794,22 @@
"resources": {
"accounts": {
"resources": {
- "creatives": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListCreativesResponse"
- },
- "parameterOrder": [
- "accountId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativesResponse.next_page_token\nreturned from the previous call to 'ListCreatives' method.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Requested page size. The server may return fewer creatives than requested\n(due to timeout constraint) even if more are available via another call.\nIf unspecified, server will pick an appropriate default.\nAcceptable values are 1 to 1000, inclusive.",
- "type": "integer"
- },
- "accountId": {
- "description": "The account to list the creatives from.\nSpecify \"-\" to list all creatives the current user has access to.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "query": {
- "description": "An optional query string to filter creatives. If no filter is specified,\nall active creatives will be returned.\nSupported queries are:\n\u003cul\u003e\n\u003cli\u003eaccountId=\u003ci\u003eaccount_id_string\u003c/i\u003e\n\u003cli\u003ecreativeId=\u003ci\u003ecreative_id_string\u003c/i\u003e\n\u003cli\u003edealsStatus: {approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eopenAuctionStatus: {approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eattribute: {a numeric attribute from the list of attributes}\n\u003cli\u003edisapprovalReason: {a reason from\nDisapprovalReason\n\u003c/ul\u003e\nExample: 'accountId=12345 AND (dealsStatus:disapproved AND\ndisapprovalReason:unacceptable_content) OR attribute:47'",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/creatives",
- "id": "adexchangebuyer2.accounts.creatives.list",
- "path": "v2beta1/accounts/{accountId}/creatives",
- "description": "Lists creatives."
- },
- "create": {
- "path": "v2beta1/accounts/{accountId}/creatives",
- "id": "adexchangebuyer2.accounts.creatives.create",
- "description": "Creates a creative.",
- "request": {
- "$ref": "Creative"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "Creative"
- },
- "parameters": {
- "accountId": {
- "location": "path",
- "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
- "type": "string",
- "required": true
- },
- "duplicateIdMode": {
- "location": "query",
- "enum": [
- "NO_DUPLICATES",
- "FORCE_ENABLE_DUPLICATE_IDS"
- ],
- "description": "Indicates if multiple creatives can share an ID or not. Default is\nNO_DUPLICATES (one ID per creative).",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/creatives"
- },
- "stopWatching": {
- "parameters": {
- "accountId": {
- "description": "The account of the creative to stop notifications for.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "creativeId": {
- "description": "The creative ID of the creative to stop notifications for.\nSpecify \"-\" to specify stopping account level notifications.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching",
- "id": "adexchangebuyer2.accounts.creatives.stopWatching",
- "description": "Stops watching a creative. Will stop push notifications being sent to the\ntopics when the creative changes status.",
- "request": {
- "$ref": "StopWatchingCreativeRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "accountId",
- "creativeId"
- ],
- "response": {
- "$ref": "Empty"
- }
- },
- "get": {
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "accountId": {
- "location": "path",
- "description": "The account the creative belongs to.",
- "type": "string",
- "required": true
- },
- "creativeId": {
- "description": "The ID of the creative to retrieve.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
- "id": "adexchangebuyer2.accounts.creatives.get",
- "description": "Gets a creative.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Creative"
- },
- "parameterOrder": [
- "accountId",
- "creativeId"
- ]
- },
- "watch": {
- "description": "Watches a creative. Will result in push notifications being sent to the\ntopic when the creative changes status.",
- "request": {
- "$ref": "WatchCreativeRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "accountId",
- "creativeId"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "accountId": {
- "description": "The account of the creative to watch.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "creativeId": {
- "description": "The creative ID to watch for status changes.\nSpecify \"-\" to watch all creatives under the above account.\nIf both creative-level and account-level notifications are\nsent, only a single notification will be sent to the\ncreative-level notification topic.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:watch",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:watch",
- "id": "adexchangebuyer2.accounts.creatives.watch"
- },
- "update": {
- "parameters": {
- "accountId": {
- "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "creativeId": {
- "description": "The buyer-defined creative ID of this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
- "id": "adexchangebuyer2.accounts.creatives.update",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
- "description": "Updates a creative.",
- "request": {
- "$ref": "Creative"
- },
- "response": {
- "$ref": "Creative"
- },
- "parameterOrder": [
- "accountId",
- "creativeId"
- ],
- "httpMethod": "PUT"
- }
- },
- "resources": {
- "dealAssociations": {
- "methods": {
- "remove": {
- "description": "Remove the association between a deal and a creative.",
- "request": {
- "$ref": "RemoveDealAssociationRequest"
- },
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "accountId",
- "creativeId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "accountId": {
- "location": "path",
- "description": "The account the creative belongs to.",
- "type": "string",
- "required": true
- },
- "creativeId": {
- "location": "path",
- "description": "The ID of the creative associated with the deal.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:remove",
- "id": "adexchangebuyer2.accounts.creatives.dealAssociations.remove",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:remove"
- },
- "add": {
- "id": "adexchangebuyer2.accounts.creatives.dealAssociations.add",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add",
- "description": "Associate an existing deal with a creative.",
- "request": {
- "$ref": "AddDealAssociationRequest"
- },
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "accountId",
- "creativeId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "accountId": {
- "description": "The account the creative belongs to.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "creativeId": {
- "description": "The ID of the creative associated with the deal.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add"
- },
- "list": {
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations",
- "id": "adexchangebuyer2.accounts.creatives.dealAssociations.list",
- "description": "List all creative-deal associations.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListDealAssociationsResponse"
- },
- "parameterOrder": [
- "accountId",
- "creativeId"
- ],
- "parameters": {
- "pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListDealAssociationsResponse.next_page_token\nreturned from the previous call to 'ListDealAssociations' method.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Requested page size. Server may return fewer associations than requested.\nIf unspecified, server will pick an appropriate default.",
- "type": "integer"
- },
- "accountId": {
- "location": "path",
- "description": "The account to list the associations from.\nSpecify \"-\" to list all creatives the current user has access to.",
- "type": "string",
- "required": true
- },
- "query": {
- "location": "query",
- "description": "An optional query string to filter deal associations. If no filter is\nspecified, all associations will be returned.\nSupported queries are:\n\u003cul\u003e\n\u003cli\u003eaccountId=\u003ci\u003eaccount_id_string\u003c/i\u003e\n\u003cli\u003ecreativeId=\u003ci\u003ecreative_id_string\u003c/i\u003e\n\u003cli\u003edealsId=\u003ci\u003edeals_id_string\u003c/i\u003e\n\u003cli\u003edealsStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eopenAuctionStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n\u003c/ul\u003e\nExample: 'dealsId=12345 AND dealsStatus:disapproved'",
- "type": "string"
- },
- "creativeId": {
- "location": "path",
- "description": "The creative ID to list the associations from.\nSpecify \"-\" to list all creatives under the above account.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations"
- }
- }
- }
- }
- },
- "filterSets": {
- "methods": {
- "delete": {
- "description": "Deletes the requested filter set from the account with the given account\nID.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "accountId",
- "filterSetId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "accountId": {
- "location": "path",
- "format": "int64",
- "description": "Account ID of the buyer.",
- "type": "string",
- "required": true
- },
- "filterSetId": {
- "location": "path",
- "format": "int64",
- "description": "The ID of the filter set to delete.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}",
- "id": "adexchangebuyer2.accounts.filterSets.delete",
- "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}"
- },
- "list": {
- "path": "v2beta1/accounts/{accountId}/filterSets",
- "id": "adexchangebuyer2.accounts.filterSets.list",
- "description": "Lists all filter sets for the account with the given account ID.",
- "httpMethod": "GET",
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "ListFilterSetsResponse"
- },
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilterSetsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.list\nmethod.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "type": "integer"
- },
- "accountId": {
- "location": "path",
- "format": "int64",
- "description": "Account ID of the buyer.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/filterSets"
- },
- "get": {
- "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}",
- "id": "adexchangebuyer2.accounts.filterSets.get",
- "description": "Retrieves the requested filter set for the account with the given account\nID.",
- "httpMethod": "GET",
- "parameterOrder": [
- "accountId",
- "filterSetId"
- ],
- "response": {
- "$ref": "FilterSet"
- },
- "parameters": {
- "accountId": {
- "format": "int64",
- "description": "Account ID of the buyer.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "filterSetId": {
- "format": "int64",
- "description": "The ID of the filter set to get.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}"
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "FilterSet"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "isTransient": {
- "description": "Whether the filter set is transient, or should be persisted indefinitely.\nBy default, filter sets are not transient.\nIf transient, it will be available for at least 1 hour after creation.",
- "type": "boolean",
- "location": "query"
- },
- "accountId": {
- "format": "int64",
- "description": "Account ID of the buyer.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/filterSets",
- "path": "v2beta1/accounts/{accountId}/filterSets",
- "id": "adexchangebuyer2.accounts.filterSets.create",
- "request": {
- "$ref": "FilterSet"
- },
- "description": "Creates the specified filter set for the account with the given account ID."
- }
- },
- "resources": {
- "bidResponseErrors": {
- "methods": {
- "list": {
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponseErrorsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.bidResponseErrors.list\nmethod.",
- "type": "string"
- },
- "pageSize": {
- "format": "int32",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "type": "integer",
- "location": "query"
- },
- "accountId": {
- "location": "path",
- "format": "int64",
- "description": "Account ID of the buyer.",
- "type": "string",
- "required": true
- },
- "filterSetId": {
- "format": "int64",
- "description": "The ID of the filter set to apply.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidResponseErrors",
- "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidResponseErrors",
- "id": "adexchangebuyer2.accounts.filterSets.bidResponseErrors.list",
- "description": "List all errors that occurred in bid responses, with the number of bid\nresponses affected for each reason.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListBidResponseErrorsResponse"
- },
- "parameterOrder": [
- "accountId",
- "filterSetId"
- ]
- }
- }
- },
- "bidResponsesWithoutBids": {
- "methods": {
- "list": {
- "id": "adexchangebuyer2.accounts.filterSets.bidResponsesWithoutBids.list",
- "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidResponsesWithoutBids",
- "description": "List all reasons for which bid responses were considered to have no\napplicable bids, with the number of bid responses affected for each reason.",
- "response": {
- "$ref": "ListBidResponsesWithoutBidsResponse"
- },
- "parameterOrder": [
- "accountId",
- "filterSetId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponsesWithoutBidsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.bidResponsesWithoutBids.list\nmethod.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "type": "integer"
- },
- "accountId": {
- "location": "path",
- "format": "int64",
- "description": "Account ID of the buyer.",
- "type": "string",
- "required": true
- },
- "filterSetId": {
- "location": "path",
- "format": "int64",
- "description": "The ID of the filter set to apply.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidResponsesWithoutBids"
- }
- }
- },
- "filteredBidRequests": {
- "methods": {
- "list": {
- "description": "List all reasons that caused a bid request not to be sent for an\nimpression, with the number of bid requests not sent for each reason.",
- "response": {
- "$ref": "ListFilteredBidRequestsResponse"
- },
- "parameterOrder": [
- "accountId",
- "filterSetId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidRequestsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredBidRequests.list\nmethod.",
- "type": "string"
- },
- "pageSize": {
- "format": "int32",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "type": "integer",
- "location": "query"
- },
- "accountId": {
- "location": "path",
- "format": "int64",
- "description": "Account ID of the buyer.",
- "type": "string",
- "required": true
- },
- "filterSetId": {
- "location": "path",
- "format": "int64",
- "description": "The ID of the filter set to apply.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBidRequests",
- "id": "adexchangebuyer2.accounts.filterSets.filteredBidRequests.list",
- "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBidRequests"
- }
- }
- },
- "nonBillableWinningBids": {
- "methods": {
- "list": {
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListNonBillableWinningBidsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.nonBillableWinningBids.list\nmethod.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "type": "integer"
- },
- "accountId": {
- "location": "path",
- "format": "int64",
- "description": "Account ID of the buyer.",
- "type": "string",
- "required": true
- },
- "filterSetId": {
- "location": "path",
- "format": "int64",
- "description": "The ID of the filter set to apply.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/nonBillableWinningBids",
- "id": "adexchangebuyer2.accounts.filterSets.nonBillableWinningBids.list",
- "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/nonBillableWinningBids",
- "description": "List all reasons for which winning bids were not billable, with the number\nof bids not billed for each reason.",
- "response": {
- "$ref": "ListNonBillableWinningBidsResponse"
- },
- "parameterOrder": [
- "accountId",
- "filterSetId"
- ],
- "httpMethod": "GET"
- }
- }
- },
- "filteredBids": {
- "methods": {
- "list": {
- "parameters": {
- "pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredBids.list\nmethod.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "type": "integer"
- },
- "accountId": {
- "format": "int64",
- "description": "Account ID of the buyer.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "filterSetId": {
- "location": "path",
- "format": "int64",
- "description": "The ID of the filter set to apply.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids",
- "id": "adexchangebuyer2.accounts.filterSets.filteredBids.list",
- "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids",
- "description": "List all reasons for which bids were filtered, with the number of bids\nfiltered for each reason.",
- "response": {
- "$ref": "ListFilteredBidsResponse"
- },
- "parameterOrder": [
- "accountId",
- "filterSetId"
- ],
- "httpMethod": "GET"
- }
- },
- "resources": {
- "creatives": {
- "methods": {
- "list": {
- "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/creatives",
- "id": "adexchangebuyer2.accounts.filterSets.filteredBids.creatives.list",
- "description": "List all creatives associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each creative.",
- "httpMethod": "GET",
- "parameterOrder": [
- "accountId",
- "filterSetId",
- "creativeStatusId"
- ],
- "response": {
- "$ref": "ListCreativeStatusBreakdownByCreativeResponse"
- },
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusBreakdownByCreativeResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredBids.creatives.list\nmethod.",
- "type": "string"
- },
- "creativeStatusId": {
- "format": "int32",
- "description": "The ID of the creative status for which to retrieve a breakdown by\ncreative.\nSee\n[creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).",
- "type": "integer",
- "required": true,
- "location": "path"
- },
- "pageSize": {
- "format": "int32",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "type": "integer",
- "location": "query"
- },
- "accountId": {
- "location": "path",
- "format": "int64",
- "description": "Account ID of the buyer.",
- "type": "string",
- "required": true
- },
- "filterSetId": {
- "format": "int64",
- "description": "The ID of the filter set to apply.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/creatives"
- }
- }
- },
- "details": {
- "methods": {
- "list": {
- "id": "adexchangebuyer2.accounts.filterSets.filteredBids.details.list",
- "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/details",
- "description": "List all details associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each detail.",
- "response": {
- "$ref": "ListCreativeStatusBreakdownByDetailResponse"
- },
- "parameterOrder": [
- "accountId",
- "filterSetId",
- "creativeStatusId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusBreakdownByDetailResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredBids.details.list\nmethod.",
- "type": "string"
- },
- "creativeStatusId": {
- "format": "int32",
- "description": "The ID of the creative status for which to retrieve a breakdown by detail.\nSee\n[creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).\nDetails are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87.",
- "type": "integer",
- "required": true,
- "location": "path"
- },
- "pageSize": {
- "format": "int32",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "type": "integer",
- "location": "query"
- },
- "accountId": {
- "format": "int64",
- "description": "Account ID of the buyer.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "filterSetId": {
- "location": "path",
- "format": "int64",
- "description": "The ID of the filter set to apply.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/details"
- }
- }
- }
- }
- },
- "losingBids": {
- "methods": {
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "accountId",
- "filterSetId"
- ],
- "response": {
- "$ref": "ListLosingBidsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListLosingBidsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.losingBids.list\nmethod.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "type": "integer"
- },
- "accountId": {
- "format": "int64",
- "description": "Account ID of the buyer.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "filterSetId": {
- "format": "int64",
- "description": "The ID of the filter set to apply.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/losingBids",
- "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/losingBids",
- "id": "adexchangebuyer2.accounts.filterSets.losingBids.list",
- "description": "List all reasons for which bids lost in the auction, with the number of\nbids that lost for each reason."
- }
- }
- },
- "impressionMetrics": {
- "methods": {
- "list": {
- "parameters": {
- "pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListImpressionMetricsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.impressionMetrics.list\nmethod.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "type": "integer"
- },
- "accountId": {
- "format": "int64",
- "description": "Account ID of the buyer.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "filterSetId": {
- "location": "path",
- "format": "int64",
- "description": "The ID of the filter set to apply.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/impressionMetrics",
- "id": "adexchangebuyer2.accounts.filterSets.impressionMetrics.list",
- "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/impressionMetrics",
- "description": "Lists all metrics that are measured in terms of number of impressions.",
- "response": {
- "$ref": "ListImpressionMetricsResponse"
- },
- "httpMethod": "GET",
- "parameterOrder": [
- "accountId",
- "filterSetId"
- ]
- }
- }
- },
- "bidMetrics": {
- "methods": {
- "list": {
- "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidMetrics",
- "id": "adexchangebuyer2.accounts.filterSets.bidMetrics.list",
- "description": "Lists all metrics that are measured in terms of number of bids.",
- "httpMethod": "GET",
- "parameterOrder": [
- "accountId",
- "filterSetId"
- ],
- "response": {
- "$ref": "ListBidMetricsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidMetricsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.bidMetrics.list\nmethod.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "type": "integer"
- },
- "accountId": {
- "location": "path",
- "format": "int64",
- "description": "Account ID of the buyer.",
- "type": "string",
- "required": true
- },
- "filterSetId": {
- "format": "int64",
- "description": "The ID of the filter set to apply.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidMetrics"
- }
- }
- }
- }
- },
"clients": {
"methods": {
- "create": {
- "id": "adexchangebuyer2.accounts.clients.create",
- "path": "v2beta1/accounts/{accountId}/clients",
- "description": "Creates a new client buyer.",
- "request": {
- "$ref": "Client"
- },
- "response": {
- "$ref": "Client"
- },
+ "list": {
+ "description": "Lists all the clients for the current sponsor buyer.",
+ "httpMethod": "GET",
"parameterOrder": [
"accountId"
],
- "httpMethod": "POST",
- "parameters": {
- "accountId": {
- "format": "int64",
- "description": "Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to create a client for. (required)",
- "type": "string",
- "required": true,
- "location": "path"
- }
+ "response": {
+ "$ref": "ListClientsResponse"
},
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/clients"
- },
- "list": {
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
"parameters": {
"pageToken": {
+ "location": "query",
"description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientsResponse.nextPageToken\nreturned from the previous call to the\naccounts.clients.list method.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pageSize": {
"location": "query",
@@ -2810,29 +1818,29 @@
"type": "integer"
},
"accountId": {
- "location": "path",
"format": "int64",
"description": "Unique numerical account ID of the sponsor buyer to list the clients for.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
}
},
- "flatPath": "v2beta1/accounts/{accountId}/clients",
- "id": "adexchangebuyer2.accounts.clients.list",
- "path": "v2beta1/accounts/{accountId}/clients",
- "description": "Lists all the clients for the current sponsor buyer.",
- "response": {
- "$ref": "ListClientsResponse"
- },
- "parameterOrder": [
- "accountId"
- ],
- "httpMethod": "GET"
- },
- "get": {
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
+ "flatPath": "v2beta1/accounts/{accountId}/clients",
+ "path": "v2beta1/accounts/{accountId}/clients",
+ "id": "adexchangebuyer2.accounts.clients.list"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "accountId",
+ "clientAccountId"
+ ],
+ "response": {
+ "$ref": "Client"
+ },
"parameters": {
"accountId": {
"location": "path",
@@ -2849,10 +1857,22 @@
"required": true
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
"flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
- "id": "adexchangebuyer2.accounts.clients.get",
"path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
- "description": "Gets a client buyer with a given client account ID.",
+ "id": "adexchangebuyer2.accounts.clients.get",
+ "description": "Gets a client buyer with a given client account ID."
+ },
+ "update": {
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
+ "id": "adexchangebuyer2.accounts.clients.update",
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
+ "description": "Updates an existing client buyer.",
+ "request": {
+ "$ref": "Client"
+ },
"response": {
"$ref": "Client"
},
@@ -2860,9 +1880,35 @@
"accountId",
"clientAccountId"
],
- "httpMethod": "GET"
+ "httpMethod": "PUT",
+ "parameters": {
+ "accountId": {
+ "format": "int64",
+ "description": "Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to update a client for. (required)",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clientAccountId": {
+ "format": "int64",
+ "description": "Unique numerical account ID of the client to update. (required)",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
},
- "update": {
+ "create": {
+ "response": {
+ "$ref": "Client"
+ },
+ "parameterOrder": [
+ "accountId"
+ ],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
@@ -2870,62 +1916,41 @@
"accountId": {
"location": "path",
"format": "int64",
- "description": "Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to update a client for. (required)",
- "type": "string",
- "required": true
- },
- "clientAccountId": {
- "location": "path",
- "format": "int64",
- "description": "Unique numerical account ID of the client to update. (required)",
+ "description": "Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to create a client for. (required)",
"type": "string",
"required": true
}
},
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
- "id": "adexchangebuyer2.accounts.clients.update",
+ "flatPath": "v2beta1/accounts/{accountId}/clients",
+ "id": "adexchangebuyer2.accounts.clients.create",
+ "path": "v2beta1/accounts/{accountId}/clients",
"request": {
"$ref": "Client"
},
- "description": "Updates an existing client buyer.",
- "httpMethod": "PUT",
- "parameterOrder": [
- "accountId",
- "clientAccountId"
- ],
- "response": {
- "$ref": "Client"
- }
+ "description": "Creates a new client buyer."
}
},
"resources": {
- "invitations": {
+ "users": {
"methods": {
- "list": {
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
- "id": "adexchangebuyer2.accounts.clients.invitations.list",
- "description": "Lists all the client users invitations for a client\nwith a given account ID.",
- "httpMethod": "GET",
+ "get": {
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
+ "id": "adexchangebuyer2.accounts.clients.users.get",
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
+ "description": "Retrieves an existing client user.",
"parameterOrder": [
"accountId",
- "clientAccountId"
+ "clientAccountId",
+ "userId"
],
"response": {
- "$ref": "ListClientUserInvitationsResponse"
+ "$ref": "ClientUser"
},
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
"parameters": {
- "pageToken": {
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientUserInvitationsResponse.nextPageToken\nreturned from the previous call to the\nclients.invitations.list\nmethod.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Requested page size. Server may return fewer clients than requested.\nIf unspecified, server will pick an appropriate default.",
- "type": "integer"
- },
"accountId": {
"format": "int64",
"description": "Numerical account ID of the client's sponsor buyer. (required)",
@@ -2934,31 +1959,169 @@
"location": "path"
},
"clientAccountId": {
- "description": "Numerical account ID of the client buyer to list invitations for.\n(required)\nYou must either specify a string representation of a\nnumerical account identifier or the `-` character\nto list all the invitations for all the clients\nof a given sponsor buyer.",
+ "location": "path",
+ "format": "int64",
+ "description": "Numerical account ID of the client buyer\nthat the user to be retrieved is associated with. (required)",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
+ },
+ "userId": {
+ "location": "path",
+ "format": "int64",
+ "description": "Numerical identifier of the user to retrieve. (required)",
+ "type": "string",
+ "required": true
}
+ }
+ },
+ "list": {
+ "response": {
+ "$ref": "ListClientUsersResponse"
},
+ "parameterOrder": [
+ "accountId",
+ "clientAccountId"
+ ],
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations"
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Requested page size. The server may return fewer clients than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "type": "integer"
+ },
+ "accountId": {
+ "location": "path",
+ "format": "int64",
+ "description": "Numerical account ID of the sponsor buyer of the client to list users for.\n(required)",
+ "type": "string",
+ "required": true
+ },
+ "clientAccountId": {
+ "location": "path",
+ "description": "The account ID of the client buyer to list users for. (required)\nYou must specify either a string representation of a\nnumerical account identifier or the `-` character\nto list all the client users for all the clients\nof a given sponsor buyer.",
+ "type": "string",
+ "required": true
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientUsersResponse.nextPageToken\nreturned from the previous call to the\naccounts.clients.users.list method.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users",
+ "id": "adexchangebuyer2.accounts.clients.users.list",
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users",
+ "description": "Lists all the known client users for a specified\nsponsor buyer account ID."
+ },
+ "update": {
+ "response": {
+ "$ref": "ClientUser"
+ },
+ "parameterOrder": [
+ "accountId",
+ "clientAccountId",
+ "userId"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "parameters": {
+ "accountId": {
+ "format": "int64",
+ "description": "Numerical account ID of the client's sponsor buyer. (required)",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clientAccountId": {
+ "format": "int64",
+ "description": "Numerical account ID of the client buyer that the user to be retrieved\nis associated with. (required)",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "userId": {
+ "location": "path",
+ "format": "int64",
+ "description": "Numerical identifier of the user to retrieve. (required)",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
+ "id": "adexchangebuyer2.accounts.clients.users.update",
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
+ "request": {
+ "$ref": "ClientUser"
+ },
+ "description": "Updates an existing client user.\nOnly the user status can be changed on update."
+ }
+ }
+ },
+ "invitations": {
+ "methods": {
+ "list": {
+ "description": "Lists all the client users invitations for a client\nwith a given account ID.",
+ "response": {
+ "$ref": "ListClientUserInvitationsResponse"
+ },
+ "parameterOrder": [
+ "accountId",
+ "clientAccountId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Requested page size. Server may return fewer clients than requested.\nIf unspecified, server will pick an appropriate default.",
+ "type": "integer"
+ },
+ "accountId": {
+ "location": "path",
+ "format": "int64",
+ "description": "Numerical account ID of the client's sponsor buyer. (required)",
+ "type": "string",
+ "required": true
+ },
+ "clientAccountId": {
+ "location": "path",
+ "description": "Numerical account ID of the client buyer to list invitations for.\n(required)\nYou must either specify a string representation of a\nnumerical account identifier or the `-` character\nto list all the invitations for all the clients\nof a given sponsor buyer.",
+ "type": "string",
+ "required": true
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientUserInvitationsResponse.nextPageToken\nreturned from the previous call to the\nclients.invitations.list\nmethod.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
+ "id": "adexchangebuyer2.accounts.clients.invitations.list",
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations"
},
"get": {
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}",
+ "id": "adexchangebuyer2.accounts.clients.invitations.get",
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}",
"description": "Retrieves an existing client user invitation.",
- "httpMethod": "GET",
+ "response": {
+ "$ref": "ClientUserInvitation"
+ },
"parameterOrder": [
"accountId",
"clientAccountId",
"invitationId"
],
- "response": {
- "$ref": "ClientUserInvitation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
+ "httpMethod": "GET",
"parameters": {
"accountId": {
"location": "path",
@@ -2982,169 +2145,1007 @@
"location": "path"
}
},
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}",
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}",
- "id": "adexchangebuyer2.accounts.clients.invitations.get"
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
},
"create": {
- "id": "adexchangebuyer2.accounts.clients.invitations.create",
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
"path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
+ "id": "adexchangebuyer2.accounts.clients.invitations.create",
+ "description": "Creates and sends out an email invitation to access\nan Ad Exchange client buyer account.",
"request": {
"$ref": "ClientUserInvitation"
},
- "description": "Creates and sends out an email invitation to access\nan Ad Exchange client buyer account.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "accountId",
+ "clientAccountId"
+ ],
"response": {
"$ref": "ClientUserInvitation"
},
- "parameterOrder": [
- "accountId",
- "clientAccountId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
"parameters": {
"accountId": {
- "location": "path",
"format": "int64",
"description": "Numerical account ID of the client's sponsor buyer. (required)",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
},
"clientAccountId": {
+ "location": "path",
"format": "int64",
"description": "Numerical account ID of the client buyer that the user\nshould be associated with. (required)",
"type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations"
- }
- }
- },
- "users": {
- "methods": {
- "get": {
- "description": "Retrieves an existing client user.",
- "parameterOrder": [
- "accountId",
- "clientAccountId",
- "userId"
- ],
- "response": {
- "$ref": "ClientUser"
- },
- "httpMethod": "GET",
- "parameters": {
- "userId": {
- "location": "path",
- "format": "int64",
- "description": "Numerical identifier of the user to retrieve. (required)",
- "type": "string",
"required": true
- },
- "accountId": {
- "location": "path",
- "format": "int64",
- "description": "Numerical account ID of the client's sponsor buyer. (required)",
- "type": "string",
- "required": true
- },
- "clientAccountId": {
- "format": "int64",
- "description": "Numerical account ID of the client buyer\nthat the user to be retrieved is associated with. (required)",
- "type": "string",
- "required": true,
- "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
- "id": "adexchangebuyer2.accounts.clients.users.get",
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "creatives": {
+ "methods": {
+ "stopWatching": {
+ "description": "Stops watching a creative. Will stop push notifications being sent to the\ntopics when the creative changes status.",
+ "request": {
+ "$ref": "StopWatchingCreativeRequest"
+ },
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "accountId",
+ "creativeId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "accountId": {
+ "location": "path",
+ "description": "The account of the creative to stop notifications for.",
+ "type": "string",
+ "required": true
},
+ "creativeId": {
+ "description": "The creative ID of the creative to stop notifications for.\nSpecify \"-\" to specify stopping account level notifications.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching",
+ "id": "adexchangebuyer2.accounts.creatives.stopWatching",
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching"
+ },
+ "get": {
+ "description": "Gets a creative.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Creative"
+ },
+ "parameterOrder": [
+ "accountId",
+ "creativeId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "parameters": {
+ "accountId": {
+ "location": "path",
+ "description": "The account the creative belongs to.",
+ "type": "string",
+ "required": true
+ },
+ "creativeId": {
+ "description": "The ID of the creative to retrieve.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
+ "id": "adexchangebuyer2.accounts.creatives.get"
+ },
+ "watch": {
+ "request": {
+ "$ref": "WatchCreativeRequest"
+ },
+ "description": "Watches a creative. Will result in push notifications being sent to the\ntopic when the creative changes status.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "accountId",
+ "creativeId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "parameters": {
+ "accountId": {
+ "location": "path",
+ "description": "The account of the creative to watch.",
+ "type": "string",
+ "required": true
+ },
+ "creativeId": {
+ "location": "path",
+ "description": "The creative ID to watch for status changes.\nSpecify \"-\" to watch all creatives under the above account.\nIf both creative-level and account-level notifications are\nsent, only a single notification will be sent to the\ncreative-level notification topic.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:watch",
+ "id": "adexchangebuyer2.accounts.creatives.watch",
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:watch"
+ },
+ "update": {
+ "response": {
+ "$ref": "Creative"
+ },
+ "parameterOrder": [
+ "accountId",
+ "creativeId"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "creativeId": {
+ "location": "path",
+ "description": "The buyer-defined creative ID of this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
+ "id": "adexchangebuyer2.accounts.creatives.update",
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
+ "request": {
+ "$ref": "Creative"
+ },
+ "description": "Updates a creative."
+ },
+ "list": {
+ "flatPath": "v2beta1/accounts/{accountId}/creatives",
+ "id": "adexchangebuyer2.accounts.creatives.list",
+ "path": "v2beta1/accounts/{accountId}/creatives",
+ "description": "Lists creatives.",
+ "response": {
+ "$ref": "ListCreativesResponse"
+ },
+ "parameterOrder": [
+ "accountId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativesResponse.next_page_token\nreturned from the previous call to 'ListCreatives' method.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Requested page size. The server may return fewer creatives than requested\n(due to timeout constraint) even if more are available via another call.\nIf unspecified, server will pick an appropriate default.\nAcceptable values are 1 to 1000, inclusive.",
+ "type": "integer"
+ },
+ "accountId": {
+ "location": "path",
+ "description": "The account to list the creatives from.\nSpecify \"-\" to list all creatives the current user has access to.",
+ "type": "string",
+ "required": true
+ },
+ "query": {
+ "location": "query",
+ "description": "An optional query string to filter creatives. If no filter is specified,\nall active creatives will be returned.\nSupported queries are:\n\u003cul\u003e\n\u003cli\u003eaccountId=\u003ci\u003eaccount_id_string\u003c/i\u003e\n\u003cli\u003ecreativeId=\u003ci\u003ecreative_id_string\u003c/i\u003e\n\u003cli\u003edealsStatus: {approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eopenAuctionStatus: {approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eattribute: {a numeric attribute from the list of attributes}\n\u003cli\u003edisapprovalReason: {a reason from\nDisapprovalReason\n\u003c/ul\u003e\nExample: 'accountId=12345 AND (dealsStatus:disapproved AND\ndisapprovalReason:unacceptable_content) OR attribute:47'",
+ "type": "string"
+ }
+ }
+ },
+ "create": {
+ "description": "Creates a creative.",
+ "request": {
+ "$ref": "Creative"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "response": {
+ "$ref": "Creative"
+ },
+ "parameters": {
+ "duplicateIdMode": {
+ "description": "Indicates if multiple creatives can share an ID or not. Default is\nNO_DUPLICATES (one ID per creative).",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "NO_DUPLICATES",
+ "FORCE_ENABLE_DUPLICATE_IDS"
+ ]
+ },
+ "accountId": {
+ "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/creatives",
+ "path": "v2beta1/accounts/{accountId}/creatives",
+ "id": "adexchangebuyer2.accounts.creatives.create"
+ }
+ },
+ "resources": {
+ "dealAssociations": {
+ "methods": {
"list": {
- "response": {
- "$ref": "ListClientUsersResponse"
- },
+ "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations",
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations",
+ "id": "adexchangebuyer2.accounts.creatives.dealAssociations.list",
+ "description": "List all creative-deal associations.",
+ "httpMethod": "GET",
"parameterOrder": [
"accountId",
- "clientAccountId"
+ "creativeId"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "ListDealAssociationsResponse"
+ },
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"parameters": {
"pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientUsersResponse.nextPageToken\nreturned from the previous call to the\naccounts.clients.users.list method.",
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListDealAssociationsResponse.next_page_token\nreturned from the previous call to 'ListDealAssociations' method.",
"type": "string",
"location": "query"
},
"pageSize": {
"format": "int32",
- "description": "Requested page size. The server may return fewer clients than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "description": "Requested page size. Server may return fewer associations than requested.\nIf unspecified, server will pick an appropriate default.",
+ "type": "integer",
+ "location": "query"
+ },
+ "accountId": {
+ "location": "path",
+ "description": "The account to list the associations from.\nSpecify \"-\" to list all creatives the current user has access to.",
+ "type": "string",
+ "required": true
+ },
+ "query": {
+ "location": "query",
+ "description": "An optional query string to filter deal associations. If no filter is\nspecified, all associations will be returned.\nSupported queries are:\n\u003cul\u003e\n\u003cli\u003eaccountId=\u003ci\u003eaccount_id_string\u003c/i\u003e\n\u003cli\u003ecreativeId=\u003ci\u003ecreative_id_string\u003c/i\u003e\n\u003cli\u003edealsId=\u003ci\u003edeals_id_string\u003c/i\u003e\n\u003cli\u003edealsStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eopenAuctionStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n\u003c/ul\u003e\nExample: 'dealsId=12345 AND dealsStatus:disapproved'",
+ "type": "string"
+ },
+ "creativeId": {
+ "location": "path",
+ "description": "The creative ID to list the associations from.\nSpecify \"-\" to list all creatives under the above account.",
+ "type": "string",
+ "required": true
+ }
+ }
+ },
+ "remove": {
+ "description": "Remove the association between a deal and a creative.",
+ "request": {
+ "$ref": "RemoveDealAssociationRequest"
+ },
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "accountId",
+ "creativeId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "accountId": {
+ "description": "The account the creative belongs to.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "creativeId": {
+ "location": "path",
+ "description": "The ID of the creative associated with the deal.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:remove",
+ "id": "adexchangebuyer2.accounts.creatives.dealAssociations.remove",
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:remove"
+ },
+ "add": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "accountId",
+ "creativeId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "accountId": {
+ "description": "The account the creative belongs to.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "creativeId": {
+ "description": "The ID of the creative associated with the deal.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add",
+ "id": "adexchangebuyer2.accounts.creatives.dealAssociations.add",
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add",
+ "description": "Associate an existing deal with a creative.",
+ "request": {
+ "$ref": "AddDealAssociationRequest"
+ }
+ }
+ }
+ }
+ }
+ },
+ "filterSets": {
+ "methods": {
+ "list": {
+ "description": "Lists all filter sets for the account with the given account ID.",
+ "response": {
+ "$ref": "ListFilterSetsResponse"
+ },
+ "parameterOrder": [
+ "accountId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageSize": {
+ "format": "int32",
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "type": "integer",
+ "location": "query"
+ },
+ "accountId": {
+ "format": "int64",
+ "description": "Account ID of the buyer.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilterSetsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.list\nmethod.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/filterSets",
+ "id": "adexchangebuyer2.accounts.filterSets.list",
+ "path": "v2beta1/accounts/{accountId}/filterSets"
+ },
+ "get": {
+ "description": "Retrieves the requested filter set for the account with the given account\nID.",
+ "response": {
+ "$ref": "FilterSet"
+ },
+ "parameterOrder": [
+ "accountId",
+ "filterSetId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "accountId": {
+ "location": "path",
+ "format": "int64",
+ "description": "Account ID of the buyer.",
+ "type": "string",
+ "required": true
+ },
+ "filterSetId": {
+ "format": "int64",
+ "description": "The ID of the filter set to get.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}",
+ "id": "adexchangebuyer2.accounts.filterSets.get",
+ "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}"
+ },
+ "create": {
+ "description": "Creates the specified filter set for the account with the given account ID.",
+ "request": {
+ "$ref": "FilterSet"
+ },
+ "response": {
+ "$ref": "FilterSet"
+ },
+ "parameterOrder": [
+ "accountId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "isTransient": {
+ "description": "Whether the filter set is transient, or should be persisted indefinitely.\nBy default, filter sets are not transient.\nIf transient, it will be available for at least 1 hour after creation.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "accountId": {
+ "format": "int64",
+ "description": "Account ID of the buyer.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/filterSets",
+ "id": "adexchangebuyer2.accounts.filterSets.create",
+ "path": "v2beta1/accounts/{accountId}/filterSets"
+ },
+ "delete": {
+ "description": "Deletes the requested filter set from the account with the given account\nID.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "accountId",
+ "filterSetId"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "accountId": {
+ "format": "int64",
+ "description": "Account ID of the buyer.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "filterSetId": {
+ "format": "int64",
+ "description": "The ID of the filter set to delete.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}",
+ "id": "adexchangebuyer2.accounts.filterSets.delete",
+ "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}"
+ }
+ },
+ "resources": {
+ "bidResponseErrors": {
+ "methods": {
+ "list": {
+ "description": "List all errors that occurred in bid responses, with the number of bid\nresponses affected for each reason.",
+ "response": {
+ "$ref": "ListBidResponseErrorsResponse"
+ },
+ "parameterOrder": [
+ "accountId",
+ "filterSetId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageSize": {
+ "format": "int32",
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"type": "integer",
"location": "query"
},
"accountId": {
"location": "path",
"format": "int64",
- "description": "Numerical account ID of the sponsor buyer of the client to list users for.\n(required)",
+ "description": "Account ID of the buyer.",
"type": "string",
"required": true
},
- "clientAccountId": {
- "location": "path",
- "description": "The account ID of the client buyer to list users for. (required)\nYou must specify either a string representation of a\nnumerical account identifier or the `-` character\nto list all the client users for all the clients\nof a given sponsor buyer.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users",
- "id": "adexchangebuyer2.accounts.clients.users.list",
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users",
- "description": "Lists all the known client users for a specified\nsponsor buyer account ID."
- },
- "update": {
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
- "id": "adexchangebuyer2.accounts.clients.users.update",
- "description": "Updates an existing client user.\nOnly the user status can be changed on update.",
- "request": {
- "$ref": "ClientUser"
- },
- "httpMethod": "PUT",
- "parameterOrder": [
- "accountId",
- "clientAccountId",
- "userId"
- ],
- "response": {
- "$ref": "ClientUser"
- },
- "parameters": {
- "userId": {
- "location": "path",
+ "filterSetId": {
"format": "int64",
- "description": "Numerical identifier of the user to retrieve. (required)",
- "type": "string",
- "required": true
- },
- "accountId": {
- "format": "int64",
- "description": "Numerical account ID of the client's sponsor buyer. (required)",
+ "description": "The ID of the filter set to apply.",
"type": "string",
"required": true,
"location": "path"
},
- "clientAccountId": {
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponseErrorsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.bidResponseErrors.list\nmethod.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidResponseErrors",
+ "id": "adexchangebuyer2.accounts.filterSets.bidResponseErrors.list",
+ "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidResponseErrors"
+ }
+ }
+ },
+ "bidResponsesWithoutBids": {
+ "methods": {
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListBidResponsesWithoutBidsResponse"
+ },
+ "parameterOrder": [
+ "accountId",
+ "filterSetId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "parameters": {
+ "pageSize": {
+ "format": "int32",
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "type": "integer",
+ "location": "query"
+ },
+ "accountId": {
"location": "path",
"format": "int64",
- "description": "Numerical account ID of the client buyer that the user to be retrieved\nis associated with. (required)",
+ "description": "Account ID of the buyer.",
+ "type": "string",
+ "required": true
+ },
+ "filterSetId": {
+ "format": "int64",
+ "description": "The ID of the filter set to apply.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponsesWithoutBidsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.bidResponsesWithoutBids.list\nmethod.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidResponsesWithoutBids",
+ "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidResponsesWithoutBids",
+ "id": "adexchangebuyer2.accounts.filterSets.bidResponsesWithoutBids.list",
+ "description": "List all reasons for which bid responses were considered to have no\napplicable bids, with the number of bid responses affected for each reason."
+ }
+ }
+ },
+ "filteredBidRequests": {
+ "methods": {
+ "list": {
+ "description": "List all reasons that caused a bid request not to be sent for an\nimpression, with the number of bid requests not sent for each reason.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "accountId",
+ "filterSetId"
+ ],
+ "response": {
+ "$ref": "ListFilteredBidRequestsResponse"
+ },
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidRequestsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredBidRequests.list\nmethod.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "type": "integer"
+ },
+ "accountId": {
+ "location": "path",
+ "format": "int64",
+ "description": "Account ID of the buyer.",
+ "type": "string",
+ "required": true
+ },
+ "filterSetId": {
+ "format": "int64",
+ "description": "The ID of the filter set to apply.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBidRequests",
+ "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBidRequests",
+ "id": "adexchangebuyer2.accounts.filterSets.filteredBidRequests.list"
+ }
+ }
+ },
+ "nonBillableWinningBids": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListNonBillableWinningBidsResponse"
+ },
+ "parameterOrder": [
+ "accountId",
+ "filterSetId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageSize": {
+ "format": "int32",
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "type": "integer",
+ "location": "query"
+ },
+ "accountId": {
+ "location": "path",
+ "format": "int64",
+ "description": "Account ID of the buyer.",
+ "type": "string",
+ "required": true
+ },
+ "filterSetId": {
+ "format": "int64",
+ "description": "The ID of the filter set to apply.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListNonBillableWinningBidsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.nonBillableWinningBids.list\nmethod.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/nonBillableWinningBids",
+ "id": "adexchangebuyer2.accounts.filterSets.nonBillableWinningBids.list",
+ "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/nonBillableWinningBids",
+ "description": "List all reasons for which winning bids were not billable, with the number\nof bids not billed for each reason."
+ }
+ }
+ },
+ "filteredBids": {
+ "methods": {
+ "list": {
+ "description": "List all reasons for which bids were filtered, with the number of bids\nfiltered for each reason.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "accountId",
+ "filterSetId"
+ ],
+ "response": {
+ "$ref": "ListFilteredBidsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredBids.list\nmethod.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "type": "integer"
+ },
+ "accountId": {
+ "format": "int64",
+ "description": "Account ID of the buyer.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "filterSetId": {
+ "format": "int64",
+ "description": "The ID of the filter set to apply.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids",
+ "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids",
+ "id": "adexchangebuyer2.accounts.filterSets.filteredBids.list"
+ }
+ },
+ "resources": {
+ "creatives": {
+ "methods": {
+ "list": {
+ "description": "List all creatives associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each creative.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "accountId",
+ "filterSetId",
+ "creativeStatusId"
+ ],
+ "response": {
+ "$ref": "ListCreativeStatusBreakdownByCreativeResponse"
+ },
+ "parameters": {
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusBreakdownByCreativeResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredBids.creatives.list\nmethod.",
+ "type": "string",
+ "location": "query"
+ },
+ "creativeStatusId": {
+ "location": "path",
+ "format": "int32",
+ "description": "The ID of the creative status for which to retrieve a breakdown by\ncreative.\nSee\n[creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).",
+ "type": "integer",
+ "required": true
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "type": "integer"
+ },
+ "accountId": {
+ "location": "path",
+ "format": "int64",
+ "description": "Account ID of the buyer.",
+ "type": "string",
+ "required": true
+ },
+ "filterSetId": {
+ "location": "path",
+ "format": "int64",
+ "description": "The ID of the filter set to apply.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/creatives",
+ "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/creatives",
+ "id": "adexchangebuyer2.accounts.filterSets.filteredBids.creatives.list"
+ }
+ }
+ },
+ "details": {
+ "methods": {
+ "list": {
+ "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/details",
+ "id": "adexchangebuyer2.accounts.filterSets.filteredBids.details.list",
+ "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/details",
+ "description": "List all details associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each detail.",
+ "parameterOrder": [
+ "accountId",
+ "filterSetId",
+ "creativeStatusId"
+ ],
+ "response": {
+ "$ref": "ListCreativeStatusBreakdownByDetailResponse"
+ },
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "parameters": {
+ "pageSize": {
+ "format": "int32",
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "type": "integer",
+ "location": "query"
+ },
+ "accountId": {
+ "format": "int64",
+ "description": "Account ID of the buyer.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "filterSetId": {
+ "format": "int64",
+ "description": "The ID of the filter set to apply.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusBreakdownByDetailResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredBids.details.list\nmethod.",
+ "type": "string",
+ "location": "query"
+ },
+ "creativeStatusId": {
+ "format": "int32",
+ "description": "The ID of the creative status for which to retrieve a breakdown by detail.\nSee\n[creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).\nDetails are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87.",
+ "type": "integer",
+ "required": true,
+ "location": "path"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "losingBids": {
+ "methods": {
+ "list": {
+ "description": "List all reasons for which bids lost in the auction, with the number of\nbids that lost for each reason.",
+ "response": {
+ "$ref": "ListLosingBidsResponse"
+ },
+ "parameterOrder": [
+ "accountId",
+ "filterSetId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "type": "integer"
+ },
+ "accountId": {
+ "format": "int64",
+ "description": "Account ID of the buyer.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "filterSetId": {
+ "location": "path",
+ "format": "int64",
+ "description": "The ID of the filter set to apply.",
+ "type": "string",
+ "required": true
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListLosingBidsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.losingBids.list\nmethod.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/losingBids",
+ "id": "adexchangebuyer2.accounts.filterSets.losingBids.list",
+ "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/losingBids"
+ }
+ }
+ },
+ "bidMetrics": {
+ "methods": {
+ "list": {
+ "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidMetrics",
+ "id": "adexchangebuyer2.accounts.filterSets.bidMetrics.list",
+ "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidMetrics",
+ "description": "Lists all metrics that are measured in terms of number of bids.",
+ "response": {
+ "$ref": "ListBidMetricsResponse"
+ },
+ "parameterOrder": [
+ "accountId",
+ "filterSetId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidMetricsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.bidMetrics.list\nmethod.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "type": "integer"
+ },
+ "accountId": {
+ "format": "int64",
+ "description": "Account ID of the buyer.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "filterSetId": {
+ "format": "int64",
+ "description": "The ID of the filter set to apply.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ }
+ }
+ },
+ "impressionMetrics": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListImpressionMetricsResponse"
+ },
+ "parameterOrder": [
+ "accountId",
+ "filterSetId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListImpressionMetricsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.impressionMetrics.list\nmethod.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "type": "integer"
+ },
+ "accountId": {
+ "location": "path",
+ "format": "int64",
+ "description": "Account ID of the buyer.",
+ "type": "string",
+ "required": true
+ },
+ "filterSetId": {
+ "location": "path",
+ "format": "int64",
+ "description": "The ID of the filter set to apply.",
"type": "string",
"required": true
}
@@ -3152,7 +3153,10 @@
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}"
+ "flatPath": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/impressionMetrics",
+ "id": "adexchangebuyer2.accounts.filterSets.impressionMetrics.list",
+ "path": "v2beta1/accounts/{accountId}/filterSets/{filterSetId}/impressionMetrics",
+ "description": "Lists all metrics that are measured in terms of number of impressions."
}
}
}
@@ -3162,6 +3166,42 @@
}
},
"parameters": {
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
"$.xgafv": {
"description": "V1 error format.",
"type": "string",
@@ -3175,11 +3215,6 @@
"2"
]
},
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
"alt": {
"enumDescriptions": [
"Responses with Content-Type of application/json",
@@ -3202,9 +3237,9 @@
"type": "string"
},
"key": {
+ "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
@@ -3216,43 +3251,8 @@
"description": "Pretty-print response.",
"default": "true",
"type": "boolean"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
}
},
"version": "v2beta1",
- "baseUrl": "https://adexchangebuyer.googleapis.com/",
- "description": "Accesses the latest features for managing Ad Exchange accounts, Real-Time Bidding configurations and auction metrics, and Marketplace programmatic deals.",
- "kind": "discovery#restDescription",
- "servicePath": "",
- "basePath": ""
+ "baseUrl": "https://adexchangebuyer.googleapis.com/"
}
diff --git a/adexperiencereport/v1/adexperiencereport-api.json b/adexperiencereport/v1/adexperiencereport-api.json
index 54eff27..66126b5 100644
--- a/adexperiencereport/v1/adexperiencereport-api.json
+++ b/adexperiencereport/v1/adexperiencereport-api.json
@@ -1,11 +1,4 @@
{
- "kind": "discovery#restDescription",
- "description": "View Ad Experience Report data, and get a list of sites that have a significant number of annoying ads.",
- "servicePath": "",
- "basePath": "",
- "id": "adexperiencereport:v1",
- "documentationLink": "https://developers.google.com/ad-experience-report/",
- "revision": "20171002",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
@@ -32,12 +25,12 @@
"type": "string"
},
"desktopSummary": {
- "description": "Summary for the desktop review of the site.",
- "$ref": "PlatformSummary"
+ "$ref": "PlatformSummary",
+ "description": "Summary for the desktop review of the site."
},
"mobileSummary": {
- "description": "Summary for the mobile review of the site.",
- "$ref": "PlatformSummary"
+ "$ref": "PlatformSummary",
+ "description": "Summary for the mobile review of the site."
}
},
"id": "SiteSummaryResponse"
@@ -46,14 +39,20 @@
"description": "Summary of the ad experience rating of a site for a specific platform.",
"type": "object",
"properties": {
+ "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": {
"format": "google-datetime",
"description": "The last time that the site changed status.",
"type": "string"
},
"betterAdsStatus": {
- "description": "The status of the site reviewed for the Better Ads Standards.",
- "type": "string",
"enumDescriptions": [
"Not reviewed.",
"Passing.",
@@ -65,7 +64,9 @@
"PASSING",
"WARNING",
"FAILING"
- ]
+ ],
+ "description": "The status of the site reviewed for the Better Ads Standards.",
+ "type": "string"
},
"enforcementTime": {
"format": "google-datetime",
@@ -73,23 +74,25 @@
"type": "string"
},
"region": {
- "description": "The assigned regions for the site and platform.",
- "items": {
- "type": "string",
- "enum": [
- "REGION_UNKNOWN",
- "REGION_A",
- "REGION_B"
- ]
- },
- "type": "array",
"enumDescriptions": [
"Ad standard not yet defined for your region.",
"Region A.",
"Region B."
- ]
+ ],
+ "description": "The assigned regions for the site and platform.",
+ "items": {
+ "enum": [
+ "REGION_UNKNOWN",
+ "REGION_A",
+ "REGION_B"
+ ],
+ "type": "string"
+ },
+ "type": "array"
},
"filterStatus": {
+ "description": "The ad filtering status of the site.",
+ "type": "string",
"enumDescriptions": [
"N/A.",
"Ad filtering is on.",
@@ -103,27 +106,17 @@
"OFF",
"PAUSED",
"PENDING"
- ],
- "description": "The ad filtering status of the site.",
- "type": "string"
- },
- "underReview": {
- "description": "Whether the site is currently under review.",
- "type": "boolean"
- },
- "reportUrl": {
- "description": "A link that leads to a full ad experience report.",
- "type": "string"
+ ]
}
},
"id": "PlatformSummary"
}
},
- "protocol": "rest",
"icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
},
+ "protocol": "rest",
"canonicalName": "Ad Experience Report",
"auth": {
"oauth2": {
@@ -144,6 +137,10 @@
"sites": {
"methods": {
"get": {
+ "flatPath": "v1/sites/{sitesId}",
+ "id": "adexperiencereport.sites.get",
+ "path": "v1/{+name}",
+ "description": "Gets a summary of the ad experience rating of a site.",
"response": {
"$ref": "SiteSummaryResponse"
},
@@ -151,46 +148,73 @@
"name"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/xapi.zoo"
- ],
"parameters": {
"name": {
+ "location": "path",
"description": "The required site name. It should be the site property whose ad experiences\nmay have been reviewed, and it should be URL-encoded. For example,\nsites/https%3A%2F%2Fwww.google.com. The server will return an error of\nBAD_REQUEST if this field is not filled in. Note that if the site property\nis not yet verified in Search Console, the reportUrl field returned by the\nAPI will lead to the verification page, prompting the user to go through\nthat process before they can gain access to the Ad Experience Report.",
"type": "string",
"required": true,
- "pattern": "^sites/[^/]+$",
- "location": "path"
+ "pattern": "^sites/[^/]+$"
}
},
- "flatPath": "v1/sites/{sitesId}",
- "id": "adexperiencereport.sites.get",
- "path": "v1/{+name}",
- "description": "Gets a summary of the ad experience rating of a site."
+ "scopes": [
+ "https://www.googleapis.com/auth/xapi.zoo"
+ ]
}
}
},
"violatingSites": {
"methods": {
"list": {
- "flatPath": "v1/violatingSites",
- "id": "adexperiencereport.violatingSites.list",
- "path": "v1/violatingSites",
- "description": "Lists sites with Ad Experience Report statuses of \"Failing\" or \"Warning\".",
+ "httpMethod": "GET",
+ "parameterOrder": [],
"response": {
"$ref": "ViolatingSitesResponse"
},
- "parameterOrder": [],
- "httpMethod": "GET",
+ "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/xapi.zoo"
],
- "parameters": {}
+ "flatPath": "v1/violatingSites",
+ "path": "v1/violatingSites",
+ "id": "adexperiencereport.violatingSites.list",
+ "description": "Lists sites with Ad Experience Report statuses of \"Failing\" or \"Warning\"."
}
}
}
},
"parameters": {
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
"upload_protocol": {
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
@@ -202,17 +226,24 @@
"default": "true",
"type": "boolean"
},
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
},
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
"$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -221,14 +252,7 @@
"enum": [
"1",
"2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
+ ]
},
"alt": {
"enum": [
@@ -245,39 +269,15 @@
"location": "query",
"description": "Data format for response.",
"default": "json"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
}
},
"version": "v1",
- "baseUrl": "https://adexperiencereport.googleapis.com/"
+ "baseUrl": "https://adexperiencereport.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "View Ad Experience Report data, and get a list of sites that have a significant number of annoying ads.",
+ "servicePath": "",
+ "basePath": "",
+ "id": "adexperiencereport:v1",
+ "documentationLink": "https://developers.google.com/ad-experience-report/",
+ "revision": "20171002"
}
diff --git a/analytics/v3/analytics-api.json b/analytics/v3/analytics-api.json
index dd5559a..a5e3aec 100644
--- a/analytics/v3/analytics-api.json
+++ b/analytics/v3/analytics-api.json
@@ -20,7 +20,7 @@
"basePath": "/analytics/v3/",
"rootUrl": "https://www.googleapis.com/",
"servicePath": "analytics/v3/",
- "batchPath": "batch/analytics/v3",
+ "batchPath": "batch",
"parameters": {
"alt": {
"type": "string",
diff --git a/analyticsreporting/v4/analyticsreporting-api.json b/analyticsreporting/v4/analyticsreporting-api.json
index 8540834..2830ebc 100644
--- a/analyticsreporting/v4/analyticsreporting-api.json
+++ b/analyticsreporting/v4/analyticsreporting-api.json
@@ -1,123 +1,4 @@
{
- "rootUrl": "https://analyticsreporting.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "analyticsreporting",
- "batchPath": "batch",
- "title": "Google Analytics Reporting API",
- "ownerName": "Google",
- "resources": {
- "reports": {
- "methods": {
- "batchGet": {
- "request": {
- "$ref": "GetReportsRequest"
- },
- "description": "Returns the Analytics data.",
- "response": {
- "$ref": "GetReportsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.readonly"
- ],
- "parameters": {},
- "flatPath": "v4/reports:batchGet",
- "id": "analyticsreporting.reports.batchGet",
- "path": "v4/reports:batchGet"
- }
- }
- }
- },
- "parameters": {
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "alt": {
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- }
- },
"version": "v4",
"baseUrl": "https://analyticsreporting.googleapis.com/",
"kind": "discovery#restDescription",
@@ -130,38 +11,13 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "PivotHeaderEntry": {
- "description": "The headers for the each of the metric column corresponding to the metrics\nrequested in the pivots section of the response.",
- "type": "object",
- "properties": {
- "metric": {
- "$ref": "MetricHeaderEntry",
- "description": "The metric header for the metric in the pivot."
- },
- "dimensionNames": {
- "description": "The name of the dimensions in the pivot response.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "dimensionValues": {
- "description": "The values for the dimensions in the pivot.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "PivotHeaderEntry"
- },
"SegmentFilter": {
"description": "SegmentFilter defines the segment to be either a simple or a sequence\nsegment. A simple segment condition contains dimension and metric conditions\nto select the sessions or users. A sequence segment condition can be used to\nselect users or sessions based on sequential conditions.",
"type": "object",
"properties": {
"sequenceSegment": {
- "description": "Sequence conditions consist of one or more steps, where each step is\ndefined by one or more dimension/metric conditions. Multiple steps can\nbe combined with special sequence operators.",
- "$ref": "SequenceSegment"
+ "$ref": "SequenceSegment",
+ "description": "Sequence conditions consist of one or more steps, where each step is\ndefined by one or more dimension/metric conditions. Multiple steps can\nbe combined with special sequence operators."
},
"not": {
"description": "If true, match the complement of simple or sequence segment.\nFor example, to match all visits not from \"New York\", we can define the\nsegment as follows:\n\n \"sessionSegment\": {\n \"segmentFilters\": [{\n \"simpleSegment\" :{\n \"orFiltersForSegment\": [{\n \"segmentFilterClauses\":[{\n \"dimensionFilter\": {\n \"dimensionName\": \"ga:city\",\n \"expressions\": [\"New York\"]\n }\n }]\n }]\n },\n \"not\": \"True\"\n }]\n },",
@@ -175,6 +31,7 @@
"id": "SegmentFilter"
},
"SegmentDefinition": {
+ "id": "SegmentDefinition",
"description": "SegmentDefinition defines the segment to be a set of SegmentFilters which\nare combined together with a logical `AND` operation.",
"type": "object",
"properties": {
@@ -185,16 +42,18 @@
},
"type": "array"
}
- },
- "id": "SegmentDefinition"
+ }
},
"MetricHeaderEntry": {
+ "id": "MetricHeaderEntry",
"description": "Header for the metrics.",
"type": "object",
"properties": {
+ "name": {
+ "description": "The name of the header.",
+ "type": "string"
+ },
"type": {
- "description": "The type of the metric, for example `INTEGER`.",
- "type": "string",
"enumDescriptions": [
"Metric type is unspecified.",
"Integer metric.",
@@ -210,19 +69,22 @@
"CURRENCY",
"PERCENT",
"TIME"
- ]
- },
- "name": {
- "description": "The name of the header.",
+ ],
+ "description": "The type of the metric, for example `INTEGER`.",
"type": "string"
}
- },
- "id": "MetricHeaderEntry"
+ }
},
"ReportData": {
+ "id": "ReportData",
"description": "The data part of the report.",
"type": "object",
"properties": {
+ "dataLastRefreshed": {
+ "format": "google-datetime",
+ "description": "The last time the data in the report was refreshed. All the hits received\nbefore this timestamp are included in the calculation of the report.",
+ "type": "string"
+ },
"maximums": {
"description": "Minimum and maximum values seen over all matching rows. These are both\nempty when `hideValueRanges` in the request is false, or when\nrowCount is zero.",
"items": {
@@ -275,14 +137,8 @@
"isDataGolden": {
"description": "Indicates if response to this request is golden or not. Data is\ngolden when the exact same request will not produce any new results if\nasked at a later point in time.",
"type": "boolean"
- },
- "dataLastRefreshed": {
- "format": "google-datetime",
- "description": "The last time the data in the report was refreshed. All the hits received\nbefore this timestamp are included in the calculation of the report.",
- "type": "string"
}
- },
- "id": "ReportData"
+ }
},
"DimensionFilter": {
"description": "Dimension filter specifies the filtering options on a dimension.",
@@ -338,82 +194,15 @@
},
"id": "DimensionFilter"
},
- "Segment": {
- "description": "The segment definition, if the report needs to be segmented.\nA Segment is a subset of the Analytics data. For example, of the entire\nset of users, one Segment might be users from a particular country or city.",
- "type": "object",
- "properties": {
- "segmentId": {
- "description": "The segment ID of a built-in or custom segment, for example `gaid::-3`.",
- "type": "string"
- },
- "dynamicSegment": {
- "$ref": "DynamicSegment",
- "description": "A dynamic segment definition in the request."
- }
- },
- "id": "Segment"
- },
- "OrderBy": {
- "description": "Specifies the sorting options.",
- "type": "object",
- "properties": {
- "sortOrder": {
- "description": "The sorting order for the field.",
- "type": "string",
- "enumDescriptions": [
- "If the sort order is unspecified, the default is ascending.",
- "Ascending sort. The field will be sorted in an ascending manner.",
- "Descending sort. The field will be sorted in a descending manner."
- ],
- "enum": [
- "SORT_ORDER_UNSPECIFIED",
- "ASCENDING",
- "DESCENDING"
- ]
- },
- "orderType": {
- "enumDescriptions": [
- "Unspecified order type will be treated as sort based on value.",
- "The sort order is based on the value of the chosen column; looks only at\nthe first date range.",
- "The sort order is based on the difference of the values of the chosen\ncolumn between the first two date ranges. Usable only if there are\nexactly two date ranges.",
- "The sort order is based on weighted value of the chosen column. If\ncolumn has n/d format, then weighted value of this ratio will\nbe `(n + totals.n)/(d + totals.d)` Usable only for metrics that\nrepresent ratios.",
- "Histogram order type is applicable only to dimension columns with\nnon-empty histogram-buckets.",
- "If the dimensions are fixed length numbers, ordinary sort would just\nwork fine. `DIMENSION_AS_INTEGER` can be used if the dimensions are\nvariable length numbers."
- ],
- "enum": [
- "ORDER_TYPE_UNSPECIFIED",
- "VALUE",
- "DELTA",
- "SMART",
- "HISTOGRAM_BUCKET",
- "DIMENSION_AS_INTEGER"
- ],
- "description": "The order type. The default orderType is `VALUE`.",
- "type": "string"
- },
- "fieldName": {
- "description": "The field which to sort by. The default sort order is ascending. Example:\n`ga:browser`.\nNote, that you can only specify one field for sort here. For example,\n`ga:browser, ga:city` is not valid.",
- "type": "string"
- }
- },
- "id": "OrderBy"
- },
"SegmentDimensionFilter": {
+ "id": "SegmentDimensionFilter",
"description": "Dimension filter specifies the filtering options on a dimension.",
"type": "object",
"properties": {
- "minComparisonValue": {
- "description": "Minimum comparison values for `BETWEEN` match type.",
- "type": "string"
- },
"maxComparisonValue": {
"description": "Maximum comparison values for `BETWEEN` match type.",
"type": "string"
},
- "dimensionName": {
- "description": "Name of the dimension for which the filter is being applied.",
- "type": "string"
- },
"operator": {
"enumDescriptions": [
"If the match type is unspecified, it is treated as a REGEXP.",
@@ -442,6 +231,10 @@
"description": "The operator to use to match the dimension with the expressions.",
"type": "string"
},
+ "dimensionName": {
+ "description": "Name of the dimension for which the filter is being applied.",
+ "type": "string"
+ },
"expressions": {
"description": "The list of expressions, only the first element is used for all operators",
"items": {
@@ -452,11 +245,75 @@
"caseSensitive": {
"description": "Should the match be case sensitive, ignored for `IN_LIST` operator.",
"type": "boolean"
+ },
+ "minComparisonValue": {
+ "description": "Minimum comparison values for `BETWEEN` match type.",
+ "type": "string"
+ }
+ }
+ },
+ "OrderBy": {
+ "description": "Specifies the sorting options.",
+ "type": "object",
+ "properties": {
+ "orderType": {
+ "description": "The order type. The default orderType is `VALUE`.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified order type will be treated as sort based on value.",
+ "The sort order is based on the value of the chosen column; looks only at\nthe first date range.",
+ "The sort order is based on the difference of the values of the chosen\ncolumn between the first two date ranges. Usable only if there are\nexactly two date ranges.",
+ "The sort order is based on weighted value of the chosen column. If\ncolumn has n/d format, then weighted value of this ratio will\nbe `(n + totals.n)/(d + totals.d)` Usable only for metrics that\nrepresent ratios.",
+ "Histogram order type is applicable only to dimension columns with\nnon-empty histogram-buckets.",
+ "If the dimensions are fixed length numbers, ordinary sort would just\nwork fine. `DIMENSION_AS_INTEGER` can be used if the dimensions are\nvariable length numbers."
+ ],
+ "enum": [
+ "ORDER_TYPE_UNSPECIFIED",
+ "VALUE",
+ "DELTA",
+ "SMART",
+ "HISTOGRAM_BUCKET",
+ "DIMENSION_AS_INTEGER"
+ ]
+ },
+ "fieldName": {
+ "description": "The field which to sort by. The default sort order is ascending. Example:\n`ga:browser`.\nNote, that you can only specify one field for sort here. For example,\n`ga:browser, ga:city` is not valid.",
+ "type": "string"
+ },
+ "sortOrder": {
+ "enumDescriptions": [
+ "If the sort order is unspecified, the default is ascending.",
+ "Ascending sort. The field will be sorted in an ascending manner.",
+ "Descending sort. The field will be sorted in a descending manner."
+ ],
+ "enum": [
+ "SORT_ORDER_UNSPECIFIED",
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "description": "The sorting order for the field.",
+ "type": "string"
}
},
- "id": "SegmentDimensionFilter"
+ "id": "OrderBy"
+ },
+ "Segment": {
+ "description": "The segment definition, if the report needs to be segmented.\nA Segment is a subset of the Analytics data. For example, of the entire\nset of users, one Segment might be users from a particular country or city.",
+ "type": "object",
+ "properties": {
+ "dynamicSegment": {
+ "$ref": "DynamicSegment",
+ "description": "A dynamic segment definition in the request."
+ },
+ "segmentId": {
+ "description": "The segment ID of a built-in or custom segment, for example `gaid::-3`.",
+ "type": "string"
+ }
+ },
+ "id": "Segment"
},
"SegmentSequenceStep": {
+ "id": "SegmentSequenceStep",
"description": "A segment sequence definition.",
"type": "object",
"properties": {
@@ -481,17 +338,12 @@
"IMMEDIATELY_PRECEDES"
]
}
- },
- "id": "SegmentSequenceStep"
+ }
},
"Metric": {
"description": "[Metrics](https://support.google.com/analytics/answer/1033861)\nare the quantitative measurements. For example, the metric `ga:users`\nindicates the total number of users for the requested time period.",
"type": "object",
"properties": {
- "expression": {
- "description": "A metric expression in the request. An expression is constructed from one\nor more metrics and numbers. Accepted operators include: Plus (+), Minus\n(-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis,\nPositive cardinal numbers (0-9), can include decimals and is limited to\n1024 characters. Example `ga:totalRefunds/ga:users`, in most cases the\nmetric expression is just a single metric name like `ga:users`.\nAdding mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics\nwill result in unexpected results.",
- "type": "string"
- },
"formattingType": {
"enumDescriptions": [
"Metric type is unspecified.",
@@ -515,6 +367,10 @@
"alias": {
"description": "An alias for the metric expression is an alternate name for the\nexpression. The alias can be used for filtering and sorting. This field\nis optional and is useful if the expression is not a single metric but\na complex expression which cannot be used in filtering and sorting.\nThe alias is also used in the response column header.",
"type": "string"
+ },
+ "expression": {
+ "description": "A metric expression in the request. An expression is constructed from one\nor more metrics and numbers. Accepted operators include: Plus (+), Minus\n(-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis,\nPositive cardinal numbers (0-9), can include decimals and is limited to\n1024 characters. Example `ga:totalRefunds/ga:users`, in most cases the\nmetric expression is just a single metric name like `ga:users`.\nAdding mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics\nwill result in unexpected results.",
+ "type": "string"
}
},
"id": "Metric"
@@ -534,23 +390,23 @@
"id": "PivotValueRegion"
},
"Report": {
+ "id": "Report",
"description": "The data response corresponding to the request.",
"type": "object",
"properties": {
- "columnHeader": {
- "$ref": "ColumnHeader",
- "description": "The column headers."
- },
"nextPageToken": {
"description": "Page token to retrieve the next page of results in the list.",
"type": "string"
},
"data": {
- "$ref": "ReportData",
- "description": "Response data."
+ "description": "Response data.",
+ "$ref": "ReportData"
+ },
+ "columnHeader": {
+ "description": "The column headers.",
+ "$ref": "ColumnHeader"
}
- },
- "id": "Report"
+ }
},
"PivotHeader": {
"description": "The headers for each of the pivot sections defined in the request.",
@@ -572,6 +428,7 @@
"id": "PivotHeader"
},
"DateRange": {
+ "id": "DateRange",
"description": "A contiguous set of days: startDate, startDate + 1 day, ..., endDate.\nThe start and end dates are specified in\n[ISO8601](https://en.wikipedia.org/wiki/ISO_8601) date format `YYYY-MM-DD`.",
"type": "object",
"properties": {
@@ -583,13 +440,20 @@
"description": "The start date for the query in the format `YYYY-MM-DD`.",
"type": "string"
}
- },
- "id": "DateRange"
+ }
},
"MetricFilter": {
"description": "MetricFilter specifies the filter on a metric.",
"type": "object",
"properties": {
+ "not": {
+ "description": "Logical `NOT` operator. If this boolean is set to true, then the matching\nmetric values will be excluded in the report. The default is false.",
+ "type": "boolean"
+ },
+ "metricName": {
+ "description": "The metric that will be filtered on. A metricFilter must contain a metric\nname. A metric name can be an alias earlier defined as a metric or it can\nalso be a metric expression.",
+ "type": "string"
+ },
"comparisonValue": {
"description": "The value to compare against.",
"type": "string"
@@ -611,59 +475,15 @@
"GREATER_THAN",
"IS_MISSING"
]
- },
- "not": {
- "description": "Logical `NOT` operator. If this boolean is set to true, then the matching\nmetric values will be excluded in the report. The default is false.",
- "type": "boolean"
- },
- "metricName": {
- "description": "The metric that will be filtered on. A metricFilter must contain a metric\nname. A metric name can be an alias earlier defined as a metric or it can\nalso be a metric expression.",
- "type": "string"
}
},
"id": "MetricFilter"
},
"ReportRequest": {
+ "id": "ReportRequest",
"description": "The main request class which specifies the Reporting API request.",
"type": "object",
"properties": {
- "orderBys": {
- "description": "Sort order on output rows. To compare two rows, the elements of the\nfollowing are applied in order until a difference is found. All date\nranges in the output get the same row order.",
- "items": {
- "$ref": "OrderBy"
- },
- "type": "array"
- },
- "segments": {
- "description": "Segment the data returned for the request. A segment definition helps look\nat a subset of the segment request. A request can contain up to four\nsegments. Every [ReportRequest](#ReportRequest) within a\n`batchGet` method must contain the same `segments` definition. Requests\nwith segments must have the `ga:segment` dimension.",
- "items": {
- "$ref": "Segment"
- },
- "type": "array"
- },
- "samplingLevel": {
- "enumDescriptions": [
- "If the `samplingLevel` field is unspecified the `DEFAULT` sampling level\nis used.",
- "Returns response with a sample size that balances speed and\naccuracy.",
- "It returns a fast response with a smaller sampling size.",
- "Returns a more accurate response using a large sampling size. But this\nmay result in response being slower."
- ],
- "enum": [
- "SAMPLING_UNSPECIFIED",
- "DEFAULT",
- "SMALL",
- "LARGE"
- ],
- "description": "The desired report\n[sample](https://support.google.com/analytics/answer/2637192) size.\nIf the the `samplingLevel` field is unspecified the `DEFAULT` sampling\nlevel is used. Every [ReportRequest](#ReportRequest) within a\n`batchGet` method must contain the same `samplingLevel` definition. See\n[developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)\n for details.",
- "type": "string"
- },
- "dimensions": {
- "description": "The dimensions requested.\nRequests can have a total of 7 dimensions.",
- "items": {
- "$ref": "Dimension"
- },
- "type": "array"
- },
"pageToken": {
"description": "A continuation token to get the next page of the results. Adding this to\nthe request will return the rows after the pageToken. The pageToken should\nbe the value returned in the nextPageToken parameter in the response to\nthe GetReports request.",
"type": "string"
@@ -698,17 +518,17 @@
"description": "Page size is for paging and specifies the maximum number of returned rows.\nPage size should be \u003e= 0. A query returns the default of 1,000 rows.\nThe Analytics Core Reporting API returns a maximum of 10,000 rows per\nrequest, no matter how many you ask for. It can also return fewer rows\nthan requested, if there aren't as many dimension segments as you expect.\nFor instance, there are fewer than 300 possible values for `ga:country`,\nso when segmenting only by country, you can't get more than 300 rows,\neven if you set `pageSize` to a higher value.",
"type": "integer"
},
- "hideTotals": {
- "description": "If set to true, hides the total of all metrics for all the matching rows,\nfor every date range. The default false and will return the totals.",
- "type": "boolean"
- },
"hideValueRanges": {
"description": "If set to true, hides the minimum and maximum across all matching rows.\nThe default is false and the value ranges are returned.",
"type": "boolean"
},
+ "hideTotals": {
+ "description": "If set to true, hides the total of all metrics for all the matching rows,\nfor every date range. The default false and will return the totals.",
+ "type": "boolean"
+ },
"cohortGroup": {
- "description": "Cohort group associated with this request. If there is a cohort group\nin the request the `ga:cohort` dimension must be present.\nEvery [ReportRequest](#ReportRequest) within a `batchGet` method must\ncontain the same `cohortGroup` definition.",
- "$ref": "CohortGroup"
+ "$ref": "CohortGroup",
+ "description": "Cohort group associated with this request. If there is a cohort group\nin the request the `ga:cohort` dimension must be present.\nEvery [ReportRequest](#ReportRequest) within a `batchGet` method must\ncontain the same `cohortGroup` definition."
},
"filtersExpression": {
"description": "Dimension or metric filters that restrict the data returned for your\nrequest. To use the `filtersExpression`, supply a dimension or metric on\nwhich to filter, followed by the filter expression. For example, the\nfollowing expression selects `ga:browser` dimension which starts with\nFirefox; `ga:browser=~^Firefox`. For more information on dimensions\nand metric filters, see\n[Filters reference](https://developers.google.com/analytics/devguides/reporting/core/v3/reference#filters).",
@@ -731,14 +551,55 @@
"$ref": "DimensionFilterClause"
},
"type": "array"
+ },
+ "orderBys": {
+ "description": "Sort order on output rows. To compare two rows, the elements of the\nfollowing are applied in order until a difference is found. All date\nranges in the output get the same row order.",
+ "items": {
+ "$ref": "OrderBy"
+ },
+ "type": "array"
+ },
+ "segments": {
+ "description": "Segment the data returned for the request. A segment definition helps look\nat a subset of the segment request. A request can contain up to four\nsegments. Every [ReportRequest](#ReportRequest) within a\n`batchGet` method must contain the same `segments` definition. Requests\nwith segments must have the `ga:segment` dimension.",
+ "items": {
+ "$ref": "Segment"
+ },
+ "type": "array"
+ },
+ "samplingLevel": {
+ "description": "The desired report\n[sample](https://support.google.com/analytics/answer/2637192) size.\nIf the the `samplingLevel` field is unspecified the `DEFAULT` sampling\nlevel is used. Every [ReportRequest](#ReportRequest) within a\n`batchGet` method must contain the same `samplingLevel` definition. See\n[developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)\n for details.",
+ "type": "string",
+ "enumDescriptions": [
+ "If the `samplingLevel` field is unspecified the `DEFAULT` sampling level\nis used.",
+ "Returns response with a sample size that balances speed and\naccuracy.",
+ "It returns a fast response with a smaller sampling size.",
+ "Returns a more accurate response using a large sampling size. But this\nmay result in response being slower."
+ ],
+ "enum": [
+ "SAMPLING_UNSPECIFIED",
+ "DEFAULT",
+ "SMALL",
+ "LARGE"
+ ]
+ },
+ "dimensions": {
+ "description": "The dimensions requested.\nRequests can have a total of 7 dimensions.",
+ "items": {
+ "$ref": "Dimension"
+ },
+ "type": "array"
}
- },
- "id": "ReportRequest"
+ }
},
"Dimension": {
+ "id": "Dimension",
"description": "[Dimensions](https://support.google.com/analytics/answer/1033861)\nare attributes of your data. For example, the dimension `ga:city`\nindicates the city, for example, \"Paris\" or \"New York\", from which\na session originates.",
"type": "object",
"properties": {
+ "name": {
+ "description": "Name of the dimension to fetch, for example `ga:browser`.",
+ "type": "string"
+ },
"histogramBuckets": {
"description": "If non-empty, we place dimension values into buckets after string to\nint64. Dimension values that are not the string representation of an\nintegral value will be converted to zero. The bucket values have to be in\nincreasing order. Each bucket is closed on the lower end, and open on the\nupper end. The \"first\" bucket includes all values less than the first\nboundary, the \"last\" bucket includes all values up to infinity. Dimension\nvalues that fall in a bucket get transformed to a new dimension value. For\nexample, if one gives a list of \"0, 1, 3, 4, 7\", then we return the\nfollowing buckets:\n\n- bucket #1: values \u003c 0, dimension value \"\u003c0\"\n- bucket #2: values in [0,1), dimension value \"0\"\n- bucket #3: values in [1,3), dimension value \"1-2\"\n- bucket #4: values in [3,4), dimension value \"3\"\n- bucket #5: values in [4,7), dimension value \"4-6\"\n- bucket #6: values \u003e= 7, dimension value \"7+\"\n\nNOTE: If you are applying histogram mutation on any dimension, and using\nthat dimension in sort, you will want to use the sort type\n`HISTOGRAM_BUCKET` for that purpose. Without that the dimension values\nwill be sorted according to dictionary\n(lexicographic) order. For example the ascending dictionary order is:\n\n \"\u003c50\", \"1001+\", \"121-1000\", \"50-120\"\n\nAnd the ascending `HISTOGRAM_BUCKET` order is:\n\n \"\u003c50\", \"50-120\", \"121-1000\", \"1001+\"\n\nThe client has to explicitly request `\"orderType\": \"HISTOGRAM_BUCKET\"`\nfor a histogram-mutated dimension.",
"items": {
@@ -746,15 +607,11 @@
"type": "string"
},
"type": "array"
- },
- "name": {
- "description": "Name of the dimension to fetch, for example `ga:browser`.",
- "type": "string"
}
- },
- "id": "Dimension"
+ }
},
"SimpleSegment": {
+ "id": "SimpleSegment",
"description": "A Simple segment conditions consist of one or more dimension/metric\nconditions that can be combined.",
"type": "object",
"properties": {
@@ -765,47 +622,47 @@
},
"type": "array"
}
- },
- "id": "SimpleSegment"
+ }
},
"DynamicSegment": {
+ "id": "DynamicSegment",
"description": "Dynamic segment definition for defining the segment within the request.\nA segment can select users, sessions or both.",
"type": "object",
"properties": {
+ "name": {
+ "description": "The name of the dynamic segment.",
+ "type": "string"
+ },
"userSegment": {
"description": "User Segment to select users to include in the segment.",
"$ref": "SegmentDefinition"
},
"sessionSegment": {
- "$ref": "SegmentDefinition",
- "description": "Session Segment to select sessions to include in the segment."
- },
- "name": {
- "description": "The name of the dynamic segment.",
- "type": "string"
+ "description": "Session Segment to select sessions to include in the segment.",
+ "$ref": "SegmentDefinition"
}
- },
- "id": "DynamicSegment"
+ }
},
"ColumnHeader": {
+ "id": "ColumnHeader",
"description": "Column headers.",
"type": "object",
"properties": {
- "metricHeader": {
- "description": "Metric headers for the metrics in the response.",
- "$ref": "MetricHeader"
- },
"dimensions": {
"description": "The dimension names in the response.",
"items": {
"type": "string"
},
"type": "array"
+ },
+ "metricHeader": {
+ "description": "Metric headers for the metrics in the response.",
+ "$ref": "MetricHeader"
}
- },
- "id": "ColumnHeader"
+ }
},
"SegmentFilterClause": {
+ "id": "SegmentFilterClause",
"description": "Filter Clause to be used in a segment definition, can be wither a metric or\na dimension filter.",
"type": "object",
"properties": {
@@ -818,11 +675,10 @@
"type": "boolean"
},
"dimensionFilter": {
- "description": "Dimension Filter for the segment definition.",
- "$ref": "SegmentDimensionFilter"
+ "$ref": "SegmentDimensionFilter",
+ "description": "Dimension Filter for the segment definition."
}
- },
- "id": "SegmentFilterClause"
+ }
},
"ReportRow": {
"description": "A row in the report.",
@@ -845,7 +701,35 @@
},
"id": "ReportRow"
},
+ "Cohort": {
+ "id": "Cohort",
+ "description": "Defines a cohort. A cohort is a group of users who share a common\ncharacteristic. For example, all users with the same acquisition date\nbelong to the same cohort.",
+ "type": "object",
+ "properties": {
+ "dateRange": {
+ "description": "This is used for `FIRST_VISIT_DATE` cohort, the cohort selects users\nwhose first visit date is between start date and end date defined in the\nDateRange. The date ranges should be aligned for cohort requests. If the\nrequest contains `ga:cohortNthDay` it should be exactly one day long,\nif `ga:cohortNthWeek` it should be aligned to the week boundary (starting\nat Sunday and ending Saturday), and for `ga:cohortNthMonth` the date range\nshould be aligned to the month (starting at the first and ending on the\nlast day of the month).\nFor LTV requests there are no such restrictions.\nYou do not need to supply a date range for the\n`reportsRequest.dateRanges` field.",
+ "$ref": "DateRange"
+ },
+ "name": {
+ "description": "A unique name for the cohort. If not defined name will be auto-generated\nwith values cohort_[1234...].",
+ "type": "string"
+ },
+ "type": {
+ "enumDescriptions": [
+ "If unspecified it's treated as `FIRST_VISIT_DATE`.",
+ "Cohorts that are selected based on first visit date."
+ ],
+ "enum": [
+ "UNSPECIFIED_COHORT_TYPE",
+ "FIRST_VISIT_DATE"
+ ],
+ "description": "Type of the cohort. The only supported type as of now is\n`FIRST_VISIT_DATE`. If this field is unspecified the cohort is treated\nas `FIRST_VISIT_DATE` type cohort.",
+ "type": "string"
+ }
+ }
+ },
"MetricFilterClause": {
+ "id": "MetricFilterClause",
"description": "Represents a group of metric filters.\nSet the operator value to specify how the filters are logically combined.",
"type": "object",
"properties": {
@@ -870,37 +754,10 @@
"AND"
]
}
- },
- "id": "MetricFilterClause"
- },
- "Cohort": {
- "description": "Defines a cohort. A cohort is a group of users who share a common\ncharacteristic. For example, all users with the same acquisition date\nbelong to the same cohort.",
- "type": "object",
- "properties": {
- "type": {
- "description": "Type of the cohort. The only supported type as of now is\n`FIRST_VISIT_DATE`. If this field is unspecified the cohort is treated\nas `FIRST_VISIT_DATE` type cohort.",
- "type": "string",
- "enumDescriptions": [
- "If unspecified it's treated as `FIRST_VISIT_DATE`.",
- "Cohorts that are selected based on first visit date."
- ],
- "enum": [
- "UNSPECIFIED_COHORT_TYPE",
- "FIRST_VISIT_DATE"
- ]
- },
- "dateRange": {
- "$ref": "DateRange",
- "description": "This is used for `FIRST_VISIT_DATE` cohort, the cohort selects users\nwhose first visit date is between start date and end date defined in the\nDateRange. The date ranges should be aligned for cohort requests. If the\nrequest contains `ga:cohortNthDay` it should be exactly one day long,\nif `ga:cohortNthWeek` it should be aligned to the week boundary (starting\nat Sunday and ending Saturday), and for `ga:cohortNthMonth` the date range\nshould be aligned to the month (starting at the first and ending on the\nlast day of the month).\nFor LTV requests there are no such restrictions.\nYou do not need to supply a date range for the\n`reportsRequest.dateRanges` field."
- },
- "name": {
- "description": "A unique name for the cohort. If not defined name will be auto-generated\nwith values cohort_[1234...].",
- "type": "string"
- }
- },
- "id": "Cohort"
+ }
},
"OrFiltersForSegment": {
+ "id": "OrFiltersForSegment",
"description": "A list of segment filters in the `OR` group are combined with the logical OR\noperator.",
"type": "object",
"properties": {
@@ -911,10 +768,10 @@
},
"type": "array"
}
- },
- "id": "OrFiltersForSegment"
+ }
},
"MetricHeader": {
+ "id": "MetricHeader",
"description": "The headers for the metrics.",
"type": "object",
"properties": {
@@ -932,10 +789,10 @@
},
"type": "array"
}
- },
- "id": "MetricHeader"
+ }
},
"DimensionFilterClause": {
+ "id": "DimensionFilterClause",
"description": "A group of dimension filters. Set the operator value to specify how\nthe filters are logically combined.",
"type": "object",
"properties": {
@@ -947,6 +804,8 @@
"type": "array"
},
"operator": {
+ "description": "The operator for combining multiple dimension filters. If unspecified, it\nis treated as an `OR`.",
+ "type": "string",
"enumDescriptions": [
"Unspecified operator. It is treated as an `OR`.",
"The logical `OR` operator.",
@@ -956,14 +815,12 @@
"OPERATOR_UNSPECIFIED",
"OR",
"AND"
- ],
- "description": "The operator for combining multiple dimension filters. If unspecified, it\nis treated as an `OR`.",
- "type": "string"
+ ]
}
- },
- "id": "DimensionFilterClause"
+ }
},
"GetReportsResponse": {
+ "id": "GetReportsResponse",
"description": "The main response class which holds the reports from the Reporting API\n`batchGet` call.",
"type": "object",
"properties": {
@@ -974,8 +831,7 @@
},
"type": "array"
}
- },
- "id": "GetReportsResponse"
+ }
},
"SequenceSegment": {
"description": "Sequence conditions consist of one or more steps, where each step is defined\nby one or more dimension/metric conditions. Multiple steps can be combined\nwith special sequence operators.",
@@ -999,13 +855,7 @@
"description": "Metric filter to be used in a segment filter clause.",
"type": "object",
"properties": {
- "metricName": {
- "description": "The metric that will be filtered on. A `metricFilter` must contain a\nmetric name.",
- "type": "string"
- },
"scope": {
- "description": "Scope for a metric defines the level at which that metric is defined. The\nspecified metric scope must be equal to or greater than its primary scope\nas defined in the data model. The primary scope is defined by if the\nsegment is selecting users or sessions.",
- "type": "string",
"enumDescriptions": [
"If the scope is unspecified, it defaults to the condition scope,\n`USER` or `SESSION` depending on if the segment is trying to choose\nusers or sessions.",
"Product scope.",
@@ -1019,7 +869,9 @@
"HIT",
"SESSION",
"USER"
- ]
+ ],
+ "description": "Scope for a metric defines the level at which that metric is defined. The\nspecified metric scope must be equal to or greater than its primary scope\nas defined in the data model. The primary scope is defined by if the\nsegment is selecting users or sessions.",
+ "type": "string"
},
"maxComparisonValue": {
"description": "Max comparison value is only used for `BETWEEN` operator.",
@@ -1046,11 +898,16 @@
"EQUAL",
"BETWEEN"
]
+ },
+ "metricName": {
+ "description": "The metric that will be filtered on. A `metricFilter` must contain a\nmetric name.",
+ "type": "string"
}
},
"id": "SegmentMetricFilter"
},
"DateRangeValues": {
+ "id": "DateRangeValues",
"description": "Used to return a list of metrics for a single DateRange / dimension\ncombination",
"type": "object",
"properties": {
@@ -1068,8 +925,7 @@
},
"type": "array"
}
- },
- "id": "DateRangeValues"
+ }
},
"CohortGroup": {
"description": "Defines a cohort group.\nFor example:\n\n \"cohortGroup\": {\n \"cohorts\": [{\n \"name\": \"cohort 1\",\n \"type\": \"FIRST_VISIT_DATE\",\n \"dateRange\": { \"startDate\": \"2015-08-01\", \"endDate\": \"2015-08-01\" }\n },{\n \"name\": \"cohort 2\"\n \"type\": \"FIRST_VISIT_DATE\"\n \"dateRange\": { \"startDate\": \"2015-07-01\", \"endDate\": \"2015-07-01\" }\n }]\n }",
@@ -1104,14 +960,10 @@
"id": "GetReportsRequest"
},
"Pivot": {
+ "id": "Pivot",
"description": "The Pivot describes the pivot section in the request.\nThe Pivot helps rearrange the information in the table for certain reports\nby pivoting your data on a second dimension.",
"type": "object",
"properties": {
- "maxGroupCount": {
- "format": "int32",
- "description": "Specifies the maximum number of groups to return.\nThe default value is 10, also the maximum value is 1,000.",
- "type": "integer"
- },
"startGroup": {
"format": "int32",
"description": "If k metrics were requested, then the response will contain some\ndata-dependent multiple of k columns in the report. E.g., if you pivoted\non the dimension `ga:browser` then you'd get k columns for \"Firefox\", k\ncolumns for \"IE\", k columns for \"Chrome\", etc. The ordering of the groups\nof columns is determined by descending order of \"total\" for the first of\nthe k values. Ties are broken by lexicographic ordering of the first\npivot dimension, then lexicographic ordering of the second pivot\ndimension, and so on. E.g., if the totals for the first value for\nFirefox, IE, and Chrome were 8, 2, 8, respectively, the order of columns\nwould be Chrome, Firefox, IE.\n\nThe following let you choose which of the groups of k columns are\nincluded in the response.",
@@ -1137,14 +989,43 @@
"$ref": "Dimension"
},
"type": "array"
+ },
+ "maxGroupCount": {
+ "format": "int32",
+ "description": "Specifies the maximum number of groups to return.\nThe default value is 10, also the maximum value is 1,000.",
+ "type": "integer"
+ }
+ }
+ },
+ "PivotHeaderEntry": {
+ "description": "The headers for the each of the metric column corresponding to the metrics\nrequested in the pivots section of the response.",
+ "type": "object",
+ "properties": {
+ "metric": {
+ "description": "The metric header for the metric in the pivot.",
+ "$ref": "MetricHeaderEntry"
+ },
+ "dimensionNames": {
+ "description": "The name of the dimensions in the pivot response.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "dimensionValues": {
+ "description": "The values for the dimensions in the pivot.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
},
- "id": "Pivot"
+ "id": "PivotHeaderEntry"
}
},
"icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"protocol": "rest",
"canonicalName": "AnalyticsReporting",
@@ -1159,5 +1040,124 @@
}
}
}
+ },
+ "rootUrl": "https://analyticsreporting.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "analyticsreporting",
+ "batchPath": "batch",
+ "title": "Google Analytics Reporting API",
+ "ownerName": "Google",
+ "resources": {
+ "reports": {
+ "methods": {
+ "batchGet": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "GetReportsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ],
+ "parameters": {},
+ "flatPath": "v4/reports:batchGet",
+ "path": "v4/reports:batchGet",
+ "id": "analyticsreporting.reports.batchGet",
+ "request": {
+ "$ref": "GetReportsRequest"
+ },
+ "description": "Returns the Analytics data."
+ }
+ }
+ }
+ },
+ "parameters": {
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "alt": {
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
+ }
}
}
diff --git a/androiddeviceprovisioning/v1/androiddeviceprovisioning-api.json b/androiddeviceprovisioning/v1/androiddeviceprovisioning-api.json
index 7e71bb5..0d00438 100644
--- a/androiddeviceprovisioning/v1/androiddeviceprovisioning-api.json
+++ b/androiddeviceprovisioning/v1/androiddeviceprovisioning-api.json
@@ -1,685 +1,24 @@
{
- "schemas": {
- "DevicesLongRunningOperationResponse": {
- "properties": {
- "successCount": {
- "description": "Number of succeesfully processed ones.",
- "format": "int32",
- "type": "integer"
- },
- "perDeviceStatus": {
- "description": "Processing status for each device.\nOne `PerDeviceStatus` per device. The order is the same as in your requests.",
- "type": "array",
- "items": {
- "$ref": "OperationPerDevice"
- }
- }
- },
- "id": "DevicesLongRunningOperationResponse",
- "description": "Long running operation response.",
- "type": "object"
- },
- "DeviceClaim": {
- "properties": {
- "ownerCompanyId": {
- "description": "Owner ID.",
- "format": "int64",
- "type": "string"
- },
- "sectionType": {
- "description": "Section type of the device claim.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified section type.",
- "Zero touch section type."
- ],
- "enum": [
- "SECTION_TYPE_UNSPECIFIED",
- "SECTION_TYPE_ZERO_TOUCH"
- ]
- }
- },
- "id": "DeviceClaim",
- "description": "Information about a device claimed for a partner.",
- "type": "object"
- },
- "PerDeviceStatusInBatch": {
- "description": "Stores the processing result for each device.",
- "type": "object",
- "properties": {
- "errorMessage": {
- "description": "Error message.",
- "type": "string"
- },
- "deviceId": {
- "description": "Device ID of the device if process succeeds.",
- "format": "int64",
- "type": "string"
- },
- "status": {
- "enum": [
- "SINGLE_DEVICE_STATUS_UNSPECIFIED",
- "SINGLE_DEVICE_STATUS_UNKNOWN_ERROR",
- "SINGLE_DEVICE_STATUS_OTHER_ERROR",
- "SINGLE_DEVICE_STATUS_SUCCESS",
- "SINGLE_DEVICE_STATUS_PERMISSION_DENIED",
- "SINGLE_DEVICE_STATUS_INVALID_DEVICE_IDENTIFIER",
- "SINGLE_DEVICE_STATUS_INVALID_SECTION_TYPE",
- "SINGLE_DEVICE_STATUS_SECTION_NOT_YOURS"
- ],
- "description": "Process result.",
- "type": "string",
- "enumDescriptions": [
- "Invalid code. Shouldn't be used.",
- "Unknown error.\nWe don't expect this error to occur here.",
- "Other error.\nWe know/expect this error, but there's no defined error code for the\nerror.",
- "Success.",
- "Permission denied.",
- "Invalid device identifier.",
- "Invalid section type.",
- "This section is claimed by another company."
- ]
- },
- "errorIdentifier": {
- "description": "Error identifier.",
- "type": "string"
- }
- },
- "id": "PerDeviceStatusInBatch"
- },
- "FindDevicesByOwnerRequest": {
- "description": "Request to find devices by customers.",
- "type": "object",
- "properties": {
- "pageToken": {
- "description": "Page token.",
- "type": "string"
- },
- "sectionType": {
- "description": "The section type.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified section type.",
- "Zero touch section type."
- ],
- "enum": [
- "SECTION_TYPE_UNSPECIFIED",
- "SECTION_TYPE_ZERO_TOUCH"
- ]
- },
- "customerId": {
- "description": "List of customer IDs to search for.",
- "type": "array",
- "items": {
- "format": "int64",
- "type": "string"
- }
- },
- "limit": {
- "description": "The number of devices to show in the result.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "FindDevicesByOwnerRequest"
- },
- "ClaimDevicesRequest": {
- "description": "Request to claim devices asynchronously in batch.",
- "type": "object",
- "properties": {
- "claims": {
- "description": "List of claims.",
- "type": "array",
- "items": {
- "$ref": "PartnerClaim"
- }
- }
- },
- "id": "ClaimDevicesRequest"
- },
- "DeviceIdentifier": {
- "properties": {
- "meid": {
- "description": "MEID number.",
- "type": "string"
- },
- "manufacturer": {
- "description": "Manufacturer name to match `android.os.Build.MANUFACTURER` (required).\nAllowed values listed in\n[manufacturer names](/zero-touch/resources/manufacturer-names).",
- "type": "string"
- },
- "serialNumber": {
- "description": "Serial number (optional).",
- "type": "string"
- },
- "imei": {
- "description": "IMEI number.",
- "type": "string"
- }
- },
- "id": "DeviceIdentifier",
- "description": "Identifies a unique device.",
- "type": "object"
- },
- "Operation": {
- "properties": {
- "error": {
- "$ref": "Status",
- "description": "This field will always be not set if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. In this case, error information for each device is set in `response.perDeviceStatus.result.status`."
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.",
- "type": "object"
- },
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- },
- "response": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.",
- "type": "object"
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
- "type": "string"
- }
- },
- "id": "Operation",
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object"
- },
- "UnclaimDevicesRequest": {
- "description": "Request to unclaim devices asynchronously in batch.",
- "type": "object",
- "properties": {
- "unclaims": {
- "description": "List of devices to unclaim.",
- "type": "array",
- "items": {
- "$ref": "PartnerUnclaim"
- }
- }
- },
- "id": "UnclaimDevicesRequest"
- },
- "FindDevicesByDeviceIdentifierRequest": {
- "description": "Request to find devices.",
- "type": "object",
- "properties": {
- "limit": {
- "description": "Number of devices to show.",
- "format": "int64",
- "type": "string"
- },
- "deviceIdentifier": {
- "description": "The device identifier to search.",
- "$ref": "DeviceIdentifier"
- },
- "pageToken": {
- "description": "Page token.",
- "type": "string"
- }
- },
- "id": "FindDevicesByDeviceIdentifierRequest"
- },
- "Status": {
- "properties": {
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "type": "array",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- }
- }
- },
- "id": "Status",
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object"
- },
- "OperationPerDevice": {
- "description": "Operation the server received for every device.",
- "type": "object",
- "properties": {
- "updateMetadata": {
- "$ref": "UpdateMetadataArguments",
- "description": "Request to set metadata for a device."
- },
- "unclaim": {
- "$ref": "PartnerUnclaim",
- "description": "Request to unclaim a device."
- },
- "result": {
- "$ref": "PerDeviceStatusInBatch",
- "description": "Processing result for every device."
- },
- "claim": {
- "$ref": "PartnerClaim",
- "description": "Request to claim a device."
- }
- },
- "id": "OperationPerDevice"
- },
- "FindDevicesByOwnerResponse": {
- "description": "Response containing found devices.",
- "type": "object",
- "properties": {
- "devices": {
- "description": "Devices found.",
- "type": "array",
- "items": {
- "$ref": "Device"
- }
- },
- "nextPageToken": {
- "description": "Page token of the next page.",
- "type": "string"
- }
- },
- "id": "FindDevicesByOwnerResponse"
- },
- "ClaimDeviceRequest": {
- "properties": {
- "deviceIdentifier": {
- "description": "The device identifier of the device to claim.",
- "$ref": "DeviceIdentifier"
- },
- "sectionType": {
- "enumDescriptions": [
- "Unspecified section type.",
- "Zero touch section type."
- ],
- "enum": [
- "SECTION_TYPE_UNSPECIFIED",
- "SECTION_TYPE_ZERO_TOUCH"
- ],
- "description": "The section to claim.",
- "type": "string"
- },
- "customerId": {
- "description": "The customer to claim for.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "ClaimDeviceRequest",
- "description": "Request message to claim a device on behalf of a customer.",
- "type": "object"
- },
- "DevicesLongRunningOperationMetadata": {
- "description": "Long running operation metadata.",
- "type": "object",
- "properties": {
- "processingStatus": {
- "enum": [
- "BATCH_PROCESS_STATUS_UNSPECIFIED",
- "BATCH_PROCESS_PENDING",
- "BATCH_PROCESS_IN_PROGRESS",
- "BATCH_PROCESS_PROCESSED"
- ],
- "description": "The overall processing status.",
- "type": "string",
- "enumDescriptions": [
- "Invalid code. Shouldn't be used.",
- "Pending.",
- "In progress.",
- "Processed.\nThis doesn't mean all items were processed sucessfully, you should\ncheck the `response` field for the result of every item."
- ]
- },
- "progress": {
- "description": "Processing progress from 0 to 100.",
- "format": "int32",
- "type": "integer"
- },
- "devicesCount": {
- "description": "Number of devices parsed in your requests.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DevicesLongRunningOperationMetadata"
- },
- "UpdateDeviceMetadataInBatchRequest": {
- "properties": {
- "updates": {
- "description": "List of metadata updates.",
- "type": "array",
- "items": {
- "$ref": "UpdateMetadataArguments"
- }
- }
- },
- "id": "UpdateDeviceMetadataInBatchRequest",
- "description": "Request to update device metadata in batch.",
- "type": "object"
- },
- "ListCustomersResponse": {
- "description": "Response message of all customers related to this partner.",
- "type": "object",
- "properties": {
- "customers": {
- "description": "List of customers related to this partner.",
- "type": "array",
- "items": {
- "$ref": "Company"
- }
- }
- },
- "id": "ListCustomersResponse"
- },
- "ClaimDeviceResponse": {
- "description": "Response message containing device id of the claim.",
- "type": "object",
- "properties": {
- "deviceId": {
- "description": "The device ID of the claimed device.",
- "format": "int64",
- "type": "string"
- },
- "deviceName": {
- "description": "The resource name of the device in the format\n`partners/[PARTNER_ID]/devices/[DEVICE_ID]`.",
- "type": "string"
- }
- },
- "id": "ClaimDeviceResponse"
- },
- "UpdateMetadataArguments": {
- "description": "Identifies metdata updates to one device.",
- "type": "object",
- "properties": {
- "deviceIdentifier": {
- "$ref": "DeviceIdentifier",
- "description": "Device identifier."
- },
- "deviceMetadata": {
- "$ref": "DeviceMetadata",
- "description": "The metadata to update."
- },
- "deviceId": {
- "description": "Device ID of the device.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "UpdateMetadataArguments"
- },
- "Device": {
- "properties": {
- "configuration": {
- "description": "The resource name of the configuration.\nOnly set for customers.",
- "type": "string"
- },
- "claims": {
- "description": "Claims.",
- "type": "array",
- "items": {
- "$ref": "DeviceClaim"
- }
- },
- "deviceIdentifier": {
- "description": "Device identifier.",
- "$ref": "DeviceIdentifier"
- },
- "deviceMetadata": {
- "description": "Device metadata.",
- "$ref": "DeviceMetadata"
- },
- "name": {
- "description": "Resource name in `partners/[PARTNER_ID]/devices/[DEVICE_ID]`.",
- "type": "string"
- },
- "deviceId": {
- "description": "Device ID.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "Device",
- "description": "An Android device.",
- "type": "object"
- },
- "CreateCustomerRequest": {
- "description": "Request message to create a customer.",
- "type": "object",
- "properties": {
- "customer": {
- "description": "Required. The company data to populate the new customer. Must contain a\nvalue for `companyName` and at least one `owner_email` that's associated\nwith a Google Account. The values for `companyId` and `name` must be empty.",
- "$ref": "Company"
- }
- },
- "id": "CreateCustomerRequest"
- },
- "Company": {
- "description": "A customer resource in the zero-touch enrollment API.",
- "type": "object",
- "properties": {
- "ownerEmails": {
- "description": "Input only. Email address of customer's users in the owner role. At least\none `owner_email` is required. Each email address must be associated with a\nGoogle Account. Owners share the same access as admins but can also add,\ndelete, and edit your organization's portal users.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "companyId": {
- "description": "Output only. The ID of the company. Assigned by the server.",
- "format": "int64",
- "type": "string"
- },
- "companyName": {
- "description": "Required. The name of the company. For example _XYZ Corp_. Characters\nallowed are: Latin letters, numerals, hyphens, and spaces. Displayed to the\ncustomer's employees in the zero-touch enrollment portal.",
- "type": "string"
- },
- "name": {
- "description": "Output only. The API resource name of the company in the format\n`partners/[PARTNER_ID]/customers/[CUSTOMER_ID]`. Assigned by the server.",
- "type": "string"
- },
- "adminEmails": {
- "description": "Input only. Optional. Email address of customer's users in the admin role.\nEach email address must be associated with a Google Account.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "Company"
- },
- "UpdateDeviceMetadataRequest": {
- "description": "Request to set metadata for a device.",
- "type": "object",
- "properties": {
- "deviceMetadata": {
- "$ref": "DeviceMetadata",
- "description": "The metdata to set."
- }
- },
- "id": "UpdateDeviceMetadataRequest"
- },
- "PartnerUnclaim": {
- "properties": {
- "deviceIdentifier": {
- "$ref": "DeviceIdentifier",
- "description": "Device identifier of the device."
- },
- "sectionType": {
- "enumDescriptions": [
- "Unspecified section type.",
- "Zero touch section type."
- ],
- "enum": [
- "SECTION_TYPE_UNSPECIFIED",
- "SECTION_TYPE_ZERO_TOUCH"
- ],
- "description": "Section type to unclaim.",
- "type": "string"
- },
- "deviceId": {
- "description": "Device ID of the device.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "PartnerUnclaim",
- "description": "Identifies one unclaim request.",
- "type": "object"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "FindDevicesByDeviceIdentifierResponse": {
- "description": "Response containing found devices.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Page token of the next page.",
- "type": "string"
- },
- "devices": {
- "description": "Found devices.",
- "type": "array",
- "items": {
- "$ref": "Device"
- }
- }
- },
- "id": "FindDevicesByDeviceIdentifierResponse"
- },
- "PartnerClaim": {
- "description": "Identifies one claim request.",
- "type": "object",
- "properties": {
- "customerId": {
- "description": "Customer ID to claim for.",
- "format": "int64",
- "type": "string"
- },
- "deviceIdentifier": {
- "description": "Device identifier of the device.",
- "$ref": "DeviceIdentifier"
- },
- "deviceMetadata": {
- "$ref": "DeviceMetadata",
- "description": "Metadata to set at claim."
- },
- "sectionType": {
- "enumDescriptions": [
- "Unspecified section type.",
- "Zero touch section type."
- ],
- "enum": [
- "SECTION_TYPE_UNSPECIFIED",
- "SECTION_TYPE_ZERO_TOUCH"
- ],
- "description": "Section type to claim.",
- "type": "string"
- }
- },
- "id": "PartnerClaim"
- },
- "UnclaimDeviceRequest": {
- "description": "Request message to unclaim a device.",
- "type": "object",
- "properties": {
- "deviceId": {
- "description": "The device ID returned by `ClaimDevice`.",
- "format": "int64",
- "type": "string"
- },
- "deviceIdentifier": {
- "$ref": "DeviceIdentifier",
- "description": "The device identifier you used when you claimed this device."
- },
- "sectionType": {
- "description": "The section type to unclaim for.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified section type.",
- "Zero touch section type."
- ],
- "enum": [
- "SECTION_TYPE_UNSPECIFIED",
- "SECTION_TYPE_ZERO_TOUCH"
- ]
- }
- },
- "id": "UnclaimDeviceRequest"
- },
- "DeviceMetadata": {
- "description": "A key-value pair of the device metadata.",
- "type": "object",
- "properties": {
- "entries": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Metadata entries",
- "type": "object"
- }
- },
- "id": "DeviceMetadata"
- }
- },
- "protocol": "rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "version": "v1",
- "baseUrl": "https://androiddeviceprovisioning.googleapis.com/",
- "canonicalName": "Android Provisioning Partner",
- "kind": "discovery#restDescription",
- "description": "Automates reseller integration into zero-touch enrollment by assigning devices to customers and creating device reports.",
- "servicePath": "",
- "rootUrl": "https://androiddeviceprovisioning.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "androiddeviceprovisioning",
- "batchPath": "batch",
- "id": "androiddeviceprovisioning:v1",
- "documentationLink": "https://developers.google.com/zero-touch/",
- "revision": "20171007",
- "title": "Android Device Provisioning Partner API",
- "ownerName": "Google",
"discoveryVersion": "v1",
+ "ownerName": "Google",
"version_module": true,
"resources": {
"partners": {
"resources": {
"devices": {
"methods": {
- "claimAsync": {
+ "updateMetadataAsync": {
+ "description": "Set metadata in batch asynchronously.",
"request": {
- "$ref": "ClaimDevicesRequest"
+ "$ref": "UpdateDeviceMetadataInBatchRequest"
},
- "description": "Claim devices asynchronously.",
- "httpMethod": "POST",
- "parameterOrder": [
- "partnerId"
- ],
"response": {
"$ref": "Operation"
},
+ "parameterOrder": [
+ "partnerId"
+ ],
+ "httpMethod": "POST",
"parameters": {
"partnerId": {
"description": "Partner ID.",
@@ -690,126 +29,11 @@
"location": "path"
}
},
- "flatPath": "v1/partners/{partnersId}/devices:claimAsync",
- "id": "androiddeviceprovisioning.partners.devices.claimAsync",
- "path": "v1/partners/{+partnerId}/devices:claimAsync"
- },
- "findByIdentifier": {
- "flatPath": "v1/partners/{partnersId}/devices:findByIdentifier",
- "id": "androiddeviceprovisioning.partners.devices.findByIdentifier",
- "path": "v1/partners/{+partnerId}/devices:findByIdentifier",
- "request": {
- "$ref": "FindDevicesByDeviceIdentifierRequest"
- },
- "description": "Find devices by device identifier.",
- "httpMethod": "POST",
- "parameterOrder": [
- "partnerId"
- ],
- "response": {
- "$ref": "FindDevicesByDeviceIdentifierResponse"
- },
- "parameters": {
- "partnerId": {
- "format": "int64",
- "type": "string",
- "required": true,
- "location": "path",
- "description": "ID of the partner.",
- "pattern": "^[^/]+$"
- }
- }
- },
- "unclaimAsync": {
- "request": {
- "$ref": "UnclaimDevicesRequest"
- },
- "description": "Unclaim devices asynchronously.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "partnerId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "partnerId": {
- "format": "int64",
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Partner ID.",
- "pattern": "^[^/]+$"
- }
- },
- "flatPath": "v1/partners/{partnersId}/devices:unclaimAsync",
- "path": "v1/partners/{+partnerId}/devices:unclaimAsync",
- "id": "androiddeviceprovisioning.partners.devices.unclaimAsync"
- },
- "metadata": {
- "request": {
- "$ref": "UpdateDeviceMetadataRequest"
- },
- "description": "Update the metadata.",
- "httpMethod": "POST",
- "parameterOrder": [
- "metadataOwnerId",
- "deviceId"
- ],
- "response": {
- "$ref": "DeviceMetadata"
- },
- "parameters": {
- "metadataOwnerId": {
- "format": "int64",
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The owner of the newly set metadata. Set this to the partner ID.",
- "pattern": "^[^/]+$"
- },
- "deviceId": {
- "format": "int64",
- "required": true,
- "type": "string",
- "location": "path",
- "description": "ID of the partner.",
- "pattern": "^[^/]+$"
- }
- },
- "flatPath": "v1/partners/{partnersId}/devices/{devicesId}/metadata",
- "id": "androiddeviceprovisioning.partners.devices.metadata",
- "path": "v1/partners/{+metadataOwnerId}/devices/{+deviceId}/metadata"
- },
- "updateMetadataAsync": {
- "request": {
- "$ref": "UpdateDeviceMetadataInBatchRequest"
- },
- "description": "Set metadata in batch asynchronously.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "partnerId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "partnerId": {
- "format": "int64",
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Partner ID.",
- "pattern": "^[^/]+$"
- }
- },
"flatPath": "v1/partners/{partnersId}/devices:updateMetadataAsync",
"path": "v1/partners/{+partnerId}/devices:updateMetadataAsync",
"id": "androiddeviceprovisioning.partners.devices.updateMetadataAsync"
},
"get": {
- "path": "v1/{+name}",
- "id": "androiddeviceprovisioning.partners.devices.get",
"description": "Get a device.",
"response": {
"$ref": "Device"
@@ -827,9 +51,15 @@
"pattern": "^partners/[^/]+/devices/[^/]+$"
}
},
- "flatPath": "v1/partners/{partnersId}/devices/{devicesId}"
+ "flatPath": "v1/partners/{partnersId}/devices/{devicesId}",
+ "path": "v1/{+name}",
+ "id": "androiddeviceprovisioning.partners.devices.get"
},
"unclaim": {
+ "description": "Unclaim the device identified by the `device_id` or the `deviceIdentifier`.",
+ "request": {
+ "$ref": "UnclaimDeviceRequest"
+ },
"response": {
"$ref": "Empty"
},
@@ -839,53 +69,45 @@
"httpMethod": "POST",
"parameters": {
"partnerId": {
- "pattern": "^[^/]+$",
- "format": "int64",
- "type": "string",
- "required": true,
"location": "path",
- "description": "ID of the partner."
- }
- },
- "flatPath": "v1/partners/{partnersId}/devices:unclaim",
- "path": "v1/partners/{+partnerId}/devices:unclaim",
- "id": "androiddeviceprovisioning.partners.devices.unclaim",
- "description": "Unclaim the device identified by the `device_id` or the `deviceIdentifier`.",
- "request": {
- "$ref": "UnclaimDeviceRequest"
- }
- },
- "findByOwner": {
- "request": {
- "$ref": "FindDevicesByOwnerRequest"
- },
- "description": "Find devices by ownership.",
- "httpMethod": "POST",
- "parameterOrder": [
- "partnerId"
- ],
- "response": {
- "$ref": "FindDevicesByOwnerResponse"
- },
- "parameters": {
- "partnerId": {
"description": "ID of the partner.",
"pattern": "^[^/]+$",
"format": "int64",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
}
},
+ "flatPath": "v1/partners/{partnersId}/devices:unclaim",
+ "path": "v1/partners/{+partnerId}/devices:unclaim",
+ "id": "androiddeviceprovisioning.partners.devices.unclaim"
+ },
+ "findByOwner": {
"flatPath": "v1/partners/{partnersId}/devices:findByOwner",
+ "path": "v1/partners/{+partnerId}/devices:findByOwner",
"id": "androiddeviceprovisioning.partners.devices.findByOwner",
- "path": "v1/partners/{+partnerId}/devices:findByOwner"
+ "description": "Find devices by ownership.",
+ "request": {
+ "$ref": "FindDevicesByOwnerRequest"
+ },
+ "response": {
+ "$ref": "FindDevicesByOwnerResponse"
+ },
+ "parameterOrder": [
+ "partnerId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "partnerId": {
+ "location": "path",
+ "description": "ID of the partner.",
+ "pattern": "^[^/]+$",
+ "format": "int64",
+ "required": true,
+ "type": "string"
+ }
+ }
},
"claim": {
- "request": {
- "$ref": "ClaimDeviceRequest"
- },
- "description": "Claim the device identified by device identifier.",
"response": {
"$ref": "ClaimDeviceResponse"
},
@@ -898,30 +120,145 @@
"description": "ID of the partner.",
"pattern": "^[^/]+$",
"format": "int64",
- "type": "string",
"required": true,
+ "type": "string",
"location": "path"
}
},
"flatPath": "v1/partners/{partnersId}/devices:claim",
"path": "v1/partners/{+partnerId}/devices:claim",
- "id": "androiddeviceprovisioning.partners.devices.claim"
+ "id": "androiddeviceprovisioning.partners.devices.claim",
+ "request": {
+ "$ref": "ClaimDeviceRequest"
+ },
+ "description": "Claim the device identified by device identifier."
+ },
+ "claimAsync": {
+ "path": "v1/partners/{+partnerId}/devices:claimAsync",
+ "id": "androiddeviceprovisioning.partners.devices.claimAsync",
+ "request": {
+ "$ref": "ClaimDevicesRequest"
+ },
+ "description": "Claim devices asynchronously.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "partnerId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "partnerId": {
+ "description": "Partner ID.",
+ "pattern": "^[^/]+$",
+ "format": "int64",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/partners/{partnersId}/devices:claimAsync"
+ },
+ "findByIdentifier": {
+ "request": {
+ "$ref": "FindDevicesByDeviceIdentifierRequest"
+ },
+ "description": "Find devices by device identifier.",
+ "response": {
+ "$ref": "FindDevicesByDeviceIdentifierResponse"
+ },
+ "parameterOrder": [
+ "partnerId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "partnerId": {
+ "pattern": "^[^/]+$",
+ "format": "int64",
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "ID of the partner."
+ }
+ },
+ "flatPath": "v1/partners/{partnersId}/devices:findByIdentifier",
+ "path": "v1/partners/{+partnerId}/devices:findByIdentifier",
+ "id": "androiddeviceprovisioning.partners.devices.findByIdentifier"
+ },
+ "unclaimAsync": {
+ "path": "v1/partners/{+partnerId}/devices:unclaimAsync",
+ "id": "androiddeviceprovisioning.partners.devices.unclaimAsync",
+ "description": "Unclaim devices asynchronously.",
+ "request": {
+ "$ref": "UnclaimDevicesRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "partnerId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "partnerId": {
+ "description": "Partner ID.",
+ "pattern": "^[^/]+$",
+ "format": "int64",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/partners/{partnersId}/devices:unclaimAsync"
+ },
+ "metadata": {
+ "description": "Update the metadata.",
+ "request": {
+ "$ref": "UpdateDeviceMetadataRequest"
+ },
+ "response": {
+ "$ref": "DeviceMetadata"
+ },
+ "parameterOrder": [
+ "metadataOwnerId",
+ "deviceId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "metadataOwnerId": {
+ "location": "path",
+ "description": "The owner of the newly set metadata. Set this to the partner ID.",
+ "pattern": "^[^/]+$",
+ "format": "int64",
+ "required": true,
+ "type": "string"
+ },
+ "deviceId": {
+ "location": "path",
+ "description": "ID of the partner.",
+ "pattern": "^[^/]+$",
+ "format": "int64",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/partners/{partnersId}/devices/{devicesId}/metadata",
+ "path": "v1/partners/{+metadataOwnerId}/devices/{+deviceId}/metadata",
+ "id": "androiddeviceprovisioning.partners.devices.metadata"
}
}
},
"customers": {
"methods": {
"list": {
- "path": "v1/partners/{+partnerId}/customers",
- "id": "androiddeviceprovisioning.partners.customers.list",
"description": "Lists the customers that are enrolled to the reseller identified by the\n`partnerId` argument. This list includes customers that the reseller\ncreated and customers that enrolled themselves using the portal.",
- "response": {
- "$ref": "ListCustomersResponse"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"partnerId"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "ListCustomersResponse"
+ },
"parameters": {
"partnerId": {
"location": "path",
@@ -932,32 +269,34 @@
"type": "string"
}
},
- "flatPath": "v1/partners/{partnersId}/customers"
+ "flatPath": "v1/partners/{partnersId}/customers",
+ "id": "androiddeviceprovisioning.partners.customers.list",
+ "path": "v1/partners/{+partnerId}/customers"
},
"create": {
- "description": "Creates a customer for zero-touch enrollment. After the method returns\nsuccessfully, admin and owner roles can manage devices and EMM configs\nby calling API methods or using their zero-touch enrollment portal. The API\ndoesn't notify the customer that they have access.",
- "request": {
- "$ref": "CreateCustomerRequest"
- },
- "response": {
- "$ref": "Company"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"parent"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "Company"
+ },
"parameters": {
"parent": {
+ "pattern": "^partners/[^/]+$",
"location": "path",
"description": "Required. The parent resource ID in format `partners/[PARTNER_ID]` that\nidentifies the reseller.",
"required": true,
- "type": "string",
- "pattern": "^partners/[^/]+$"
+ "type": "string"
}
},
"flatPath": "v1/partners/{partnersId}/customers",
+ "id": "androiddeviceprovisioning.partners.customers.create",
"path": "v1/{+parent}/customers",
- "id": "androiddeviceprovisioning.partners.customers.create"
+ "request": {
+ "$ref": "CreateCustomerRequest"
+ },
+ "description": "Creates a customer for zero-touch enrollment. After the method returns\nsuccessfully, admin and owner roles can manage devices and EMM configs\nby calling API methods or using their zero-touch enrollment portal. The API\ndoesn't notify the customer that they have access."
}
}
}
@@ -991,47 +330,26 @@
}
},
"parameters": {
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
},
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
"bearer_token": {
"description": "OAuth bearer token.",
"type": "string",
"location": "query"
},
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
"upload_protocol": {
+ "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"prettyPrint": {
+ "location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true",
- "location": "query"
+ "default": "true"
},
"uploadType": {
"location": "query",
@@ -1039,27 +357,27 @@
"type": "string"
},
"fields": {
- "location": "query",
"description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
"type": "string",
"location": "query"
},
"$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
},
"alt": {
"enum": [
@@ -1076,6 +394,688 @@
"location": "query",
"description": "Data format for response.",
"default": "json"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
}
- }
+ },
+ "schemas": {
+ "DevicesLongRunningOperationResponse": {
+ "properties": {
+ "successCount": {
+ "description": "Number of succeesfully processed ones.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "perDeviceStatus": {
+ "description": "Processing status for each device.\nOne `PerDeviceStatus` per device. The order is the same as in your requests.",
+ "type": "array",
+ "items": {
+ "$ref": "OperationPerDevice"
+ }
+ }
+ },
+ "id": "DevicesLongRunningOperationResponse",
+ "description": "Long running operation response.",
+ "type": "object"
+ },
+ "DeviceClaim": {
+ "description": "Information about a device claimed for a partner.",
+ "type": "object",
+ "properties": {
+ "ownerCompanyId": {
+ "description": "Owner ID.",
+ "format": "int64",
+ "type": "string"
+ },
+ "sectionType": {
+ "enumDescriptions": [
+ "Unspecified section type.",
+ "Zero touch section type."
+ ],
+ "enum": [
+ "SECTION_TYPE_UNSPECIFIED",
+ "SECTION_TYPE_ZERO_TOUCH"
+ ],
+ "description": "Section type of the device claim.",
+ "type": "string"
+ }
+ },
+ "id": "DeviceClaim"
+ },
+ "PerDeviceStatusInBatch": {
+ "description": "Stores the processing result for each device.",
+ "type": "object",
+ "properties": {
+ "errorMessage": {
+ "description": "Error message.",
+ "type": "string"
+ },
+ "deviceId": {
+ "description": "Device ID of the device if process succeeds.",
+ "format": "int64",
+ "type": "string"
+ },
+ "status": {
+ "enumDescriptions": [
+ "Invalid code. Shouldn't be used.",
+ "Unknown error.\nWe don't expect this error to occur here.",
+ "Other error.\nWe know/expect this error, but there's no defined error code for the\nerror.",
+ "Success.",
+ "Permission denied.",
+ "Invalid device identifier.",
+ "Invalid section type.",
+ "This section is claimed by another company."
+ ],
+ "enum": [
+ "SINGLE_DEVICE_STATUS_UNSPECIFIED",
+ "SINGLE_DEVICE_STATUS_UNKNOWN_ERROR",
+ "SINGLE_DEVICE_STATUS_OTHER_ERROR",
+ "SINGLE_DEVICE_STATUS_SUCCESS",
+ "SINGLE_DEVICE_STATUS_PERMISSION_DENIED",
+ "SINGLE_DEVICE_STATUS_INVALID_DEVICE_IDENTIFIER",
+ "SINGLE_DEVICE_STATUS_INVALID_SECTION_TYPE",
+ "SINGLE_DEVICE_STATUS_SECTION_NOT_YOURS"
+ ],
+ "description": "Process result.",
+ "type": "string"
+ },
+ "errorIdentifier": {
+ "description": "Error identifier.",
+ "type": "string"
+ }
+ },
+ "id": "PerDeviceStatusInBatch"
+ },
+ "ClaimDevicesRequest": {
+ "description": "Request to claim devices asynchronously in batch.",
+ "type": "object",
+ "properties": {
+ "claims": {
+ "description": "List of claims.",
+ "type": "array",
+ "items": {
+ "$ref": "PartnerClaim"
+ }
+ }
+ },
+ "id": "ClaimDevicesRequest"
+ },
+ "FindDevicesByOwnerRequest": {
+ "description": "Request to find devices by customers.",
+ "type": "object",
+ "properties": {
+ "limit": {
+ "description": "The number of devices to show in the result.",
+ "format": "int64",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Page token.",
+ "type": "string"
+ },
+ "sectionType": {
+ "enumDescriptions": [
+ "Unspecified section type.",
+ "Zero touch section type."
+ ],
+ "enum": [
+ "SECTION_TYPE_UNSPECIFIED",
+ "SECTION_TYPE_ZERO_TOUCH"
+ ],
+ "description": "The section type.",
+ "type": "string"
+ },
+ "customerId": {
+ "description": "List of customer IDs to search for.",
+ "type": "array",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ }
+ }
+ },
+ "id": "FindDevicesByOwnerRequest"
+ },
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object",
+ "properties": {
+ "response": {
+ "description": "This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
+ "type": "string"
+ },
+ "error": {
+ "description": "This field will always be not set if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. In this case, error information for each device is set in `response.perDeviceStatus.result.status`.",
+ "$ref": "Status"
+ },
+ "metadata": {
+ "description": "This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ }
+ },
+ "id": "Operation"
+ },
+ "DeviceIdentifier": {
+ "description": "Identifies a unique device.",
+ "type": "object",
+ "properties": {
+ "imei": {
+ "description": "IMEI number.",
+ "type": "string"
+ },
+ "meid": {
+ "description": "MEID number.",
+ "type": "string"
+ },
+ "manufacturer": {
+ "description": "Manufacturer name to match `android.os.Build.MANUFACTURER` (required).\nAllowed values listed in\n[manufacturer names](/zero-touch/resources/manufacturer-names).",
+ "type": "string"
+ },
+ "serialNumber": {
+ "description": "Serial number (optional).",
+ "type": "string"
+ }
+ },
+ "id": "DeviceIdentifier"
+ },
+ "UnclaimDevicesRequest": {
+ "description": "Request to unclaim devices asynchronously in batch.",
+ "type": "object",
+ "properties": {
+ "unclaims": {
+ "description": "List of devices to unclaim.",
+ "type": "array",
+ "items": {
+ "$ref": "PartnerUnclaim"
+ }
+ }
+ },
+ "id": "UnclaimDevicesRequest"
+ },
+ "Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
+ "properties": {
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "type": "array",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ }
+ }
+ },
+ "id": "Status"
+ },
+ "FindDevicesByDeviceIdentifierRequest": {
+ "properties": {
+ "limit": {
+ "description": "Number of devices to show.",
+ "format": "int64",
+ "type": "string"
+ },
+ "deviceIdentifier": {
+ "$ref": "DeviceIdentifier",
+ "description": "The device identifier to search."
+ },
+ "pageToken": {
+ "description": "Page token.",
+ "type": "string"
+ }
+ },
+ "id": "FindDevicesByDeviceIdentifierRequest",
+ "description": "Request to find devices.",
+ "type": "object"
+ },
+ "OperationPerDevice": {
+ "description": "Operation the server received for every device.",
+ "type": "object",
+ "properties": {
+ "unclaim": {
+ "description": "Request to unclaim a device.",
+ "$ref": "PartnerUnclaim"
+ },
+ "result": {
+ "$ref": "PerDeviceStatusInBatch",
+ "description": "Processing result for every device."
+ },
+ "claim": {
+ "$ref": "PartnerClaim",
+ "description": "Request to claim a device."
+ },
+ "updateMetadata": {
+ "description": "Request to set metadata for a device.",
+ "$ref": "UpdateMetadataArguments"
+ }
+ },
+ "id": "OperationPerDevice"
+ },
+ "FindDevicesByOwnerResponse": {
+ "description": "Response containing found devices.",
+ "type": "object",
+ "properties": {
+ "devices": {
+ "description": "Devices found.",
+ "type": "array",
+ "items": {
+ "$ref": "Device"
+ }
+ },
+ "nextPageToken": {
+ "description": "Page token of the next page.",
+ "type": "string"
+ }
+ },
+ "id": "FindDevicesByOwnerResponse"
+ },
+ "DevicesLongRunningOperationMetadata": {
+ "description": "Long running operation metadata.",
+ "type": "object",
+ "properties": {
+ "progress": {
+ "description": "Processing progress from 0 to 100.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "devicesCount": {
+ "description": "Number of devices parsed in your requests.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "processingStatus": {
+ "enumDescriptions": [
+ "Invalid code. Shouldn't be used.",
+ "Pending.",
+ "In progress.",
+ "Processed.\nThis doesn't mean all items were processed sucessfully, you should\ncheck the `response` field for the result of every item."
+ ],
+ "enum": [
+ "BATCH_PROCESS_STATUS_UNSPECIFIED",
+ "BATCH_PROCESS_PENDING",
+ "BATCH_PROCESS_IN_PROGRESS",
+ "BATCH_PROCESS_PROCESSED"
+ ],
+ "description": "The overall processing status.",
+ "type": "string"
+ }
+ },
+ "id": "DevicesLongRunningOperationMetadata"
+ },
+ "ClaimDeviceRequest": {
+ "properties": {
+ "deviceIdentifier": {
+ "description": "The device identifier of the device to claim.",
+ "$ref": "DeviceIdentifier"
+ },
+ "sectionType": {
+ "enum": [
+ "SECTION_TYPE_UNSPECIFIED",
+ "SECTION_TYPE_ZERO_TOUCH"
+ ],
+ "description": "The section to claim.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified section type.",
+ "Zero touch section type."
+ ]
+ },
+ "customerId": {
+ "description": "The customer to claim for.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "ClaimDeviceRequest",
+ "description": "Request message to claim a device on behalf of a customer.",
+ "type": "object"
+ },
+ "UpdateDeviceMetadataInBatchRequest": {
+ "description": "Request to update device metadata in batch.",
+ "type": "object",
+ "properties": {
+ "updates": {
+ "description": "List of metadata updates.",
+ "type": "array",
+ "items": {
+ "$ref": "UpdateMetadataArguments"
+ }
+ }
+ },
+ "id": "UpdateDeviceMetadataInBatchRequest"
+ },
+ "UpdateMetadataArguments": {
+ "description": "Identifies metdata updates to one device.",
+ "type": "object",
+ "properties": {
+ "deviceIdentifier": {
+ "$ref": "DeviceIdentifier",
+ "description": "Device identifier."
+ },
+ "deviceMetadata": {
+ "description": "The metadata to update.",
+ "$ref": "DeviceMetadata"
+ },
+ "deviceId": {
+ "description": "Device ID of the device.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "UpdateMetadataArguments"
+ },
+ "ClaimDeviceResponse": {
+ "description": "Response message containing device id of the claim.",
+ "type": "object",
+ "properties": {
+ "deviceName": {
+ "description": "The resource name of the device in the format\n`partners/[PARTNER_ID]/devices/[DEVICE_ID]`.",
+ "type": "string"
+ },
+ "deviceId": {
+ "description": "The device ID of the claimed device.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "ClaimDeviceResponse"
+ },
+ "ListCustomersResponse": {
+ "description": "Response message of all customers related to this partner.",
+ "type": "object",
+ "properties": {
+ "customers": {
+ "description": "List of customers related to this partner.",
+ "type": "array",
+ "items": {
+ "$ref": "Company"
+ }
+ }
+ },
+ "id": "ListCustomersResponse"
+ },
+ "Device": {
+ "description": "An Android device.",
+ "type": "object",
+ "properties": {
+ "deviceIdentifier": {
+ "description": "Device identifier.",
+ "$ref": "DeviceIdentifier"
+ },
+ "deviceMetadata": {
+ "$ref": "DeviceMetadata",
+ "description": "Device metadata."
+ },
+ "name": {
+ "description": "Resource name in `partners/[PARTNER_ID]/devices/[DEVICE_ID]`.",
+ "type": "string"
+ },
+ "deviceId": {
+ "description": "Device ID.",
+ "format": "int64",
+ "type": "string"
+ },
+ "configuration": {
+ "description": "The resource name of the configuration.\nOnly set for customers.",
+ "type": "string"
+ },
+ "claims": {
+ "description": "Claims.",
+ "type": "array",
+ "items": {
+ "$ref": "DeviceClaim"
+ }
+ }
+ },
+ "id": "Device"
+ },
+ "CreateCustomerRequest": {
+ "description": "Request message to create a customer.",
+ "type": "object",
+ "properties": {
+ "customer": {
+ "$ref": "Company",
+ "description": "Required. The company data to populate the new customer. Must contain a\nvalue for `companyName` and at least one `owner_email` that's associated\nwith a Google Account. The values for `companyId` and `name` must be empty."
+ }
+ },
+ "id": "CreateCustomerRequest"
+ },
+ "Company": {
+ "properties": {
+ "companyName": {
+ "description": "Required. The name of the company. For example _XYZ Corp_. Characters\nallowed are: Latin letters, numerals, hyphens, and spaces. Displayed to the\ncustomer's employees in the zero-touch enrollment portal.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Output only. The API resource name of the company in the format\n`partners/[PARTNER_ID]/customers/[CUSTOMER_ID]`. Assigned by the server.",
+ "type": "string"
+ },
+ "adminEmails": {
+ "description": "Input only. Optional. Email address of customer's users in the admin role.\nEach email address must be associated with a Google Account.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "ownerEmails": {
+ "description": "Input only. Email address of customer's users in the owner role. At least\none `owner_email` is required. Each email address must be associated with a\nGoogle Account. Owners share the same access as admins but can also add,\ndelete, and edit your organization's portal users.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "companyId": {
+ "description": "Output only. The ID of the company. Assigned by the server.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "Company",
+ "description": "A customer resource in the zero-touch enrollment API.",
+ "type": "object"
+ },
+ "UpdateDeviceMetadataRequest": {
+ "description": "Request to set metadata for a device.",
+ "type": "object",
+ "properties": {
+ "deviceMetadata": {
+ "description": "The metdata to set.",
+ "$ref": "DeviceMetadata"
+ }
+ },
+ "id": "UpdateDeviceMetadataRequest"
+ },
+ "PartnerUnclaim": {
+ "description": "Identifies one unclaim request.",
+ "type": "object",
+ "properties": {
+ "deviceIdentifier": {
+ "$ref": "DeviceIdentifier",
+ "description": "Device identifier of the device."
+ },
+ "sectionType": {
+ "enumDescriptions": [
+ "Unspecified section type.",
+ "Zero touch section type."
+ ],
+ "enum": [
+ "SECTION_TYPE_UNSPECIFIED",
+ "SECTION_TYPE_ZERO_TOUCH"
+ ],
+ "description": "Section type to unclaim.",
+ "type": "string"
+ },
+ "deviceId": {
+ "description": "Device ID of the device.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "PartnerUnclaim"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
+ },
+ "FindDevicesByDeviceIdentifierResponse": {
+ "description": "Response containing found devices.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Page token of the next page.",
+ "type": "string"
+ },
+ "devices": {
+ "description": "Found devices.",
+ "type": "array",
+ "items": {
+ "$ref": "Device"
+ }
+ }
+ },
+ "id": "FindDevicesByDeviceIdentifierResponse"
+ },
+ "PartnerClaim": {
+ "description": "Identifies one claim request.",
+ "type": "object",
+ "properties": {
+ "deviceIdentifier": {
+ "$ref": "DeviceIdentifier",
+ "description": "Device identifier of the device."
+ },
+ "deviceMetadata": {
+ "description": "Metadata to set at claim.",
+ "$ref": "DeviceMetadata"
+ },
+ "sectionType": {
+ "enumDescriptions": [
+ "Unspecified section type.",
+ "Zero touch section type."
+ ],
+ "enum": [
+ "SECTION_TYPE_UNSPECIFIED",
+ "SECTION_TYPE_ZERO_TOUCH"
+ ],
+ "description": "Section type to claim.",
+ "type": "string"
+ },
+ "customerId": {
+ "description": "Customer ID to claim for.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "PartnerClaim"
+ },
+ "UnclaimDeviceRequest": {
+ "description": "Request message to unclaim a device.",
+ "type": "object",
+ "properties": {
+ "deviceId": {
+ "description": "The device ID returned by `ClaimDevice`.",
+ "format": "int64",
+ "type": "string"
+ },
+ "deviceIdentifier": {
+ "$ref": "DeviceIdentifier",
+ "description": "The device identifier you used when you claimed this device."
+ },
+ "sectionType": {
+ "enumDescriptions": [
+ "Unspecified section type.",
+ "Zero touch section type."
+ ],
+ "enum": [
+ "SECTION_TYPE_UNSPECIFIED",
+ "SECTION_TYPE_ZERO_TOUCH"
+ ],
+ "description": "The section type to unclaim for.",
+ "type": "string"
+ }
+ },
+ "id": "UnclaimDeviceRequest"
+ },
+ "DeviceMetadata": {
+ "properties": {
+ "entries": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Metadata entries",
+ "type": "object"
+ }
+ },
+ "id": "DeviceMetadata",
+ "description": "A key-value pair of the device metadata.",
+ "type": "object"
+ }
+ },
+ "protocol": "rest",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "version": "v1",
+ "baseUrl": "https://androiddeviceprovisioning.googleapis.com/",
+ "canonicalName": "Android Provisioning Partner",
+ "servicePath": "",
+ "description": "Automates reseller integration into zero-touch enrollment by assigning devices to customers and creating device reports.",
+ "kind": "discovery#restDescription",
+ "rootUrl": "https://androiddeviceprovisioning.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "androiddeviceprovisioning",
+ "batchPath": "batch",
+ "revision": "20171007",
+ "documentationLink": "https://developers.google.com/zero-touch/",
+ "id": "androiddeviceprovisioning:v1",
+ "title": "Android Device Provisioning Partner API"
}
diff --git a/appengine/v1/appengine-api.json b/appengine/v1/appengine-api.json
index c32fb8e..ad53259 100644
--- a/appengine/v1/appengine-api.json
+++ b/appengine/v1/appengine-api.json
@@ -1,1446 +1,1555 @@
{
- "schemas": {
- "ScriptHandler": {
- "description": "Executes a script to handle the request that matches the URL pattern.",
- "type": "object",
- "properties": {
- "scriptPath": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
- }
- },
- "id": "ScriptHandler"
- },
- "FileInfo": {
- "description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.",
- "type": "object",
- "properties": {
- "sourceUrl": {
- "description": "URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
- "type": "string"
- },
- "sha1Sum": {
- "description": "The SHA1 hash of the file, in hex.",
- "type": "string"
- },
- "mimeType": {
- "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage.",
- "type": "string"
- }
- },
- "id": "FileInfo"
- },
- "OperationMetadataExperimental": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/customDomains/example.com.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.experimental.CustomDomains.CreateCustomDomain.@OutputOnly",
- "type": "string"
- },
- "insertTime": {
- "format": "google-datetime",
- "description": "Time that this operation was created.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "Time that this operation completed.@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadataExperimental"
- },
- "AuthorizedDomain": {
- "properties": {
- "id": {
- "description": "Fully qualified domain name of the domain authorized for use. Example: example.com.",
- "type": "string"
- },
- "name": {
- "description": "Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly",
- "type": "string"
- }
- },
- "id": "AuthorizedDomain",
- "description": "A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central (https://www.google.com/webmasters/verification/home).",
- "type": "object"
- },
- "TrafficSplit": {
- "description": "Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.",
- "type": "object",
- "properties": {
- "allocations": {
- "additionalProperties": {
- "format": "double",
- "type": "number"
- },
- "description": "Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.",
- "type": "object"
- },
- "shardBy": {
- "description": "Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.",
- "type": "string",
- "enumDescriptions": [
- "Diversion method unspecified.",
- "Diversion based on a specially named cookie, \"GOOGAPPUID.\" The cookie must be set by the application itself or no diversion will occur.",
- "Diversion based on applying the modulus operation to a fingerprint of the IP address.",
- "Diversion based on weighted random assignment. An incoming request is randomly routed to a version in the traffic split, with probability proportional to the version's traffic share."
- ],
- "enum": [
- "UNSPECIFIED",
- "COOKIE",
- "IP",
- "RANDOM"
- ]
- }
- },
- "id": "TrafficSplit"
- },
- "OperationMetadataV1Beta": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "endTime": {
- "format": "google-datetime",
- "description": "Time that this operation completed.@OutputOnly",
- "type": "string"
- },
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "insertTime": {
- "format": "google-datetime",
- "description": "Time that this operation was created.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1Beta"
- },
- "ListServicesResponse": {
- "properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
+ "id": "appengine:v1",
+ "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
+ "revision": "20170929",
+ "title": "Google App Engine Admin API",
+ "ownerName": "Google",
+ "discoveryVersion": "v1",
+ "version_module": true,
+ "resources": {
+ "apps": {
+ "resources": {
"services": {
- "description": "The services belonging to the requested application.",
- "items": {
- "$ref": "Service"
+ "resources": {
+ "versions": {
+ "methods": {
+ "delete": {
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "id": "appengine.apps.services.versions.delete",
+ "description": "Deletes an existing Version resource."
+ },
+ "patch": {
+ "id": "appengine.apps.services.versions.patch",
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "request": {
+ "$ref": "Version"
+ },
+ "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "updateMask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Standard field mask for the set of fields to be updated.",
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.",
+ "type": "string",
+ "required": true
+ },
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}"
+ },
+ "get": {
+ "response": {
+ "$ref": "Version"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "view": {
+ "location": "query",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "description": "Controls the set of fields returned in the Get response.",
+ "type": "string"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "id": "appengine.apps.services.versions.get",
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource."
+ },
+ "list": {
+ "response": {
+ "$ref": "ListVersionsResponse"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `parent`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Maximum results to return per page.",
+ "type": "integer"
+ },
+ "view": {
+ "location": "query",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "description": "Controls the set of fields returned in the List response.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions",
+ "id": "appengine.apps.services.versions.list",
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions",
+ "description": "Lists the versions of a service."
+ },
+ "create": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `parent`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions",
+ "id": "appengine.apps.services.versions.create",
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions",
+ "description": "Deploys code and resource files to a new version.",
+ "request": {
+ "$ref": "Version"
+ }
+ }
+ },
+ "resources": {
+ "instances": {
+ "methods": {
+ "debug": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "instancesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "id": "appengine.apps.services.versions.instances.debug",
+ "request": {
+ "$ref": "DebugInstanceRequest"
+ },
+ "description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment."
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "instancesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
+ "type": "string",
+ "required": true
+ },
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "id": "appengine.apps.services.versions.instances.delete",
+ "description": "Stops a running instance."
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Instance"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "parameters": {
+ "instancesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "id": "appengine.apps.services.versions.instances.get",
+ "description": "Gets instance information."
+ },
+ "list": {
+ "id": "appengine.apps.services.versions.instances.list",
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
+ "description": "Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).",
+ "response": {
+ "$ref": "ListInstancesResponse"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `parent`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `parent`. Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1.",
+ "type": "string",
+ "required": true
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Maximum results to return per page.",
+ "type": "integer",
+ "location": "query"
+ },
+ "versionsId": {
+ "description": "Part of `parent`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances"
+ }
+ }
+ }
+ }
+ }
},
- "type": "array"
- }
- },
- "id": "ListServicesResponse",
- "description": "Response message for Services.ListServices.",
- "type": "object"
- },
- "ListIngressRulesResponse": {
- "properties": {
- "ingressRules": {
- "description": "The ingress FirewallRules for this application.",
- "items": {
- "$ref": "FirewallRule"
- },
- "type": "array"
+ "methods": {
+ "delete": {
+ "id": "appengine.apps.services.delete",
+ "path": "v1/apps/{appsId}/services/{servicesId}",
+ "description": "Deletes the specified service and all enclosed versions.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
+ "type": "string",
+ "required": true
+ },
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}"
+ },
+ "patch": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "updateMask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Standard field mask for the set of fields to be updated.",
+ "type": "string"
+ },
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "migrateTraffic": {
+ "location": "query",
+ "description": "Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services#shardby) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).",
+ "type": "boolean"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}",
+ "id": "appengine.apps.services.patch",
+ "path": "v1/apps/{appsId}/services/{servicesId}",
+ "description": "Updates the configuration of the specified service.",
+ "request": {
+ "$ref": "Service"
+ }
+ },
+ "get": {
+ "id": "appengine.apps.services.get",
+ "path": "v1/apps/{appsId}/services/{servicesId}",
+ "description": "Gets the current configuration of the specified service.",
+ "response": {
+ "$ref": "Service"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListServicesResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "type": "string",
+ "required": true
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Maximum results to return per page.",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/apps/{appsId}/services",
+ "path": "v1/apps/{appsId}/services",
+ "id": "appengine.apps.services.list",
+ "description": "Lists all the services in the application."
+ }
+ }
},
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- }
- },
- "id": "ListIngressRulesResponse",
- "description": "Response message for Firewall.ListIngressRules.",
- "type": "object"
- },
- "Resources": {
- "description": "Machine resources for a version.",
- "type": "object",
- "properties": {
- "volumes": {
- "description": "User specified volumes.",
- "items": {
- "$ref": "Volume"
- },
- "type": "array"
+ "authorizedDomains": {
+ "methods": {
+ "list": {
+ "path": "v1/apps/{appsId}/authorizedDomains",
+ "id": "appengine.apps.authorizedDomains.list",
+ "description": "Lists all domains the user is authorized to administer.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListAuthorizedDomainsResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "type": "string",
+ "required": true
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Maximum results to return per page.",
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/apps/{appsId}/authorizedDomains"
+ }
+ }
},
- "diskGb": {
- "format": "double",
- "description": "Disk size (GB) needed.",
- "type": "number"
- },
- "memoryGb": {
- "format": "double",
- "description": "Memory (GB) needed.",
- "type": "number"
- },
- "cpu": {
- "format": "double",
- "description": "Number of CPU cores needed.",
- "type": "number"
- }
- },
- "id": "Resources"
- },
- "Deployment": {
- "description": "Code and application artifacts used to deploy a version to App Engine.",
- "type": "object",
- "properties": {
- "files": {
- "additionalProperties": {
- "$ref": "FileInfo"
- },
- "description": "Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.",
- "type": "object"
- },
- "zip": {
- "$ref": "ZipInfo",
- "description": "The zip file for this deployment, if this is a zip deployment."
- },
- "container": {
- "$ref": "ContainerInfo",
- "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment."
- }
- },
- "id": "Deployment"
- },
- "Volume": {
- "description": "Volumes mounted within the app container. Only applicable for VM runtimes.",
- "type": "object",
- "properties": {
- "volumeType": {
- "description": "Underlying volume type, e.g. 'tmpfs'.",
- "type": "string"
- },
- "sizeGb": {
- "format": "double",
- "description": "Volume size in gigabytes.",
- "type": "number"
- },
- "name": {
- "description": "Unique name for the volume.",
- "type": "string"
- }
- },
- "id": "Volume"
- },
- "BatchUpdateIngressRulesResponse": {
- "description": "Response message for Firewall.UpdateAllIngressRules.",
- "type": "object",
- "properties": {
- "ingressRules": {
- "description": "The full list of ingress FirewallRules for this application.",
- "items": {
- "$ref": "FirewallRule"
- },
- "type": "array"
- }
- },
- "id": "BatchUpdateIngressRulesResponse"
- },
- "ListInstancesResponse": {
- "description": "Response message for Instances.ListInstances.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "instances": {
- "description": "The instances belonging to the requested version.",
- "items": {
- "$ref": "Instance"
- },
- "type": "array"
- }
- },
- "id": "ListInstancesResponse"
- },
- "ListDomainMappingsResponse": {
- "description": "Response message for DomainMappings.ListDomainMappings.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
+ "operations": {
+ "methods": {
+ "get": {
+ "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "operationsId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. The name of the operation resource.",
+ "type": "string",
+ "required": true
+ },
+ "operationsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/apps/{appsId}/operations/{operationsId}",
+ "path": "v1/apps/{appsId}/operations/{operationsId}",
+ "id": "appengine.apps.operations.get"
+ },
+ "list": {
+ "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. The name of the operation's parent resource.",
+ "type": "string",
+ "required": true
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer"
+ }
+ },
+ "flatPath": "v1/apps/{appsId}/operations",
+ "id": "appengine.apps.operations.list",
+ "path": "v1/apps/{appsId}/operations"
+ }
+ }
},
"domainMappings": {
- "description": "The domain mappings for the application.",
- "items": {
- "$ref": "DomainMapping"
- },
- "type": "array"
- }
- },
- "id": "ListDomainMappingsResponse"
- },
- "OperationMetadataV1Alpha": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "Time that this operation completed.@OutputOnly",
- "type": "string"
- },
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "insertTime": {
- "format": "google-datetime",
- "description": "Time that this operation was created.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1Alpha"
- },
- "UrlDispatchRule": {
- "description": "Rules to match an HTTP request and dispatch that request to a service.",
- "type": "object",
- "properties": {
- "service": {
- "description": "Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.",
- "type": "string"
- },
- "domain": {
- "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
- "type": "string"
- },
- "path": {
- "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.",
- "type": "string"
- }
- },
- "id": "UrlDispatchRule"
- },
- "ListVersionsResponse": {
- "properties": {
- "versions": {
- "description": "The versions belonging to the requested service.",
- "items": {
- "$ref": "Version"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- }
- },
- "id": "ListVersionsResponse",
- "description": "Response message for Versions.ListVersions.",
- "type": "object"
- },
- "ListAuthorizedDomainsResponse": {
- "properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "domains": {
- "description": "The authorized domains belonging to the user.",
- "items": {
- "$ref": "AuthorizedDomain"
- },
- "type": "array"
- }
- },
- "id": "ListAuthorizedDomainsResponse",
- "description": "Response message for AuthorizedDomains.ListAuthorizedDomains.",
- "type": "object"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "ApiEndpointHandler": {
- "description": "Uses Google Cloud Endpoints to handle requests.",
- "type": "object",
- "properties": {
- "scriptPath": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
- }
- },
- "id": "ApiEndpointHandler"
- },
- "DomainMapping": {
- "properties": {
- "sslSettings": {
- "$ref": "SslSettings",
- "description": "SSL configuration for this domain. If unconfigured, this domain will not serve with SSL."
- },
- "name": {
- "description": "Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly",
- "type": "string"
- },
- "resourceRecords": {
- "description": "The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly",
- "items": {
- "$ref": "ResourceRecord"
- },
- "type": "array"
- },
- "id": {
- "description": "Relative name of the domain serving the application. Example: example.com.",
- "type": "string"
- }
- },
- "id": "DomainMapping",
- "description": "A domain serving an App Engine application.",
- "type": "object"
- },
- "AutomaticScaling": {
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
- "type": "object",
- "properties": {
- "minTotalInstances": {
- "format": "int32",
- "description": "Minimum number of instances that should be maintained for this version.",
- "type": "integer"
- },
- "networkUtilization": {
- "$ref": "NetworkUtilization",
- "description": "Target scaling by network usage."
- },
- "coolDownPeriod": {
- "format": "google-duration",
- "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.",
- "type": "string"
- },
- "maxConcurrentRequests": {
- "format": "int32",
- "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
- "type": "integer"
- },
- "maxPendingLatency": {
- "format": "google-duration",
- "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.",
- "type": "string"
- },
- "cpuUtilization": {
- "description": "Target scaling by CPU usage.",
- "$ref": "CpuUtilization"
- },
- "diskUtilization": {
- "$ref": "DiskUtilization",
- "description": "Target scaling by disk usage."
- },
- "minPendingLatency": {
- "format": "google-duration",
- "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
- "type": "string"
- },
- "requestUtilization": {
- "$ref": "RequestUtilization",
- "description": "Target scaling by request utilization."
- },
- "maxIdleInstances": {
- "format": "int32",
- "description": "Maximum number of idle instances that should be maintained for this version.",
- "type": "integer"
- },
- "minIdleInstances": {
- "format": "int32",
- "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.",
- "type": "integer"
- },
- "maxTotalInstances": {
- "format": "int32",
- "description": "Maximum number of instances that should be started to handle requests.",
- "type": "integer"
- }
- },
- "id": "AutomaticScaling"
- },
- "ZipInfo": {
- "description": "The zip file information for a zip deployment.",
- "type": "object",
- "properties": {
- "filesCount": {
- "format": "int32",
- "description": "An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.",
- "type": "integer"
- },
- "sourceUrl": {
- "description": "URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
- "type": "string"
- }
- },
- "id": "ZipInfo"
- },
- "AuthorizedCertificate": {
- "properties": {
- "expireTime": {
- "format": "google-datetime",
- "description": "The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly",
- "type": "string"
- },
- "name": {
- "description": "Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly",
- "type": "string"
- },
- "domainMappingsCount": {
- "format": "int32",
- "description": "Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly",
- "type": "integer"
- },
- "domainNames": {
- "description": "Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "id": {
- "description": "Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly",
- "type": "string"
- },
- "displayName": {
- "description": "The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.",
- "type": "string"
- },
- "certificateRawData": {
- "$ref": "CertificateRawData",
- "description": "The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority."
- },
- "visibleDomainMappings": {
- "description": "The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "AuthorizedCertificate",
- "description": "An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.",
- "type": "object"
- },
- "ResourceRecord": {
- "description": "A DNS resource record.",
- "type": "object",
- "properties": {
- "rrdata": {
- "description": "Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).",
- "type": "string"
- },
- "name": {
- "description": "Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.",
- "type": "string"
- },
- "type": {
- "enumDescriptions": [
- "An unknown resource record.",
- "An A resource record. Data is an IPv4 address.",
- "An AAAA resource record. Data is an IPv6 address.",
- "A CNAME resource record. Data is a domain name to be aliased."
- ],
- "enum": [
- "RECORD_TYPE_UNSPECIFIED",
- "A",
- "AAAA",
- "CNAME"
- ],
- "description": "Resource record type. Example: AAAA.",
- "type": "string"
- }
- },
- "id": "ResourceRecord"
- },
- "Library": {
- "description": "Third-party Python runtime library that is required by the application.",
- "type": "object",
- "properties": {
- "version": {
- "description": "Version of the library to select, or \"latest\".",
- "type": "string"
- },
- "name": {
- "description": "Name of the library. Example: \"django\".",
- "type": "string"
- }
- },
- "id": "Library"
- },
- "ListLocationsResponse": {
- "description": "The response message for Locations.ListLocations.",
- "type": "object",
- "properties": {
- "locations": {
- "description": "A list of locations that matches the specified filter in the request.",
- "items": {
- "$ref": "Location"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- }
- },
- "id": "ListLocationsResponse"
- },
- "ContainerInfo": {
- "properties": {
- "image": {
- "description": "URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: \"gcr.io/my-project/image:tag\" or \"gcr.io/my-project/image@digest\"",
- "type": "string"
- }
- },
- "id": "ContainerInfo",
- "description": "Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment.",
- "type": "object"
- },
- "RequestUtilization": {
- "description": "Target scaling by request utilization. Only applicable for VM runtimes.",
- "type": "object",
- "properties": {
- "targetConcurrentRequests": {
- "format": "int32",
- "description": "Target number of concurrent requests.",
- "type": "integer"
- },
- "targetRequestCountPerSecond": {
- "format": "int32",
- "description": "Target requests per second.",
- "type": "integer"
- }
- },
- "id": "RequestUtilization"
- },
- "UrlMap": {
- "description": "URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.",
- "type": "object",
- "properties": {
- "securityLevel": {
- "description": "Security (HTTPS) enforcement for this URL.",
- "type": "string",
- "enumDescriptions": [
- "Not specified.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
- "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
- "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
- ],
- "enum": [
- "SECURE_UNSPECIFIED",
- "SECURE_DEFAULT",
- "SECURE_NEVER",
- "SECURE_OPTIONAL",
- "SECURE_ALWAYS"
- ]
- },
- "authFailAction": {
- "enum": [
- "AUTH_FAIL_ACTION_UNSPECIFIED",
- "AUTH_FAIL_ACTION_REDIRECT",
- "AUTH_FAIL_ACTION_UNAUTHORIZED"
- ],
- "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
- "type": "string",
- "enumDescriptions": [
- "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
- "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
- "Rejects request with a 401 HTTP status code and an error message."
- ]
- },
- "script": {
- "description": "Executes a script to handle the request that matches this URL pattern.",
- "$ref": "ScriptHandler"
- },
- "urlRegex": {
- "description": "URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.",
- "type": "string"
- },
- "login": {
- "enumDescriptions": [
- "Not specified. LOGIN_OPTIONAL is assumed.",
- "Does not require that the user is signed in.",
- "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
- "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
- ],
- "enum": [
- "LOGIN_UNSPECIFIED",
- "LOGIN_OPTIONAL",
- "LOGIN_ADMIN",
- "LOGIN_REQUIRED"
- ],
- "description": "Level of login required to access this resource.",
- "type": "string"
- },
- "apiEndpoint": {
- "$ref": "ApiEndpointHandler",
- "description": "Uses API Endpoints to handle requests."
- },
- "staticFiles": {
- "description": "Returns the contents of a file, such as an image, as the response.",
- "$ref": "StaticFilesHandler"
- },
- "redirectHttpResponseCode": {
- "enumDescriptions": [
- "Not specified. 302 is assumed.",
- "301 Moved Permanently code.",
- "302 Moved Temporarily code.",
- "303 See Other code.",
- "307 Temporary Redirect code."
- ],
- "enum": [
- "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED",
- "REDIRECT_HTTP_RESPONSE_CODE_301",
- "REDIRECT_HTTP_RESPONSE_CODE_302",
- "REDIRECT_HTTP_RESPONSE_CODE_303",
- "REDIRECT_HTTP_RESPONSE_CODE_307"
- ],
- "description": "30x code to use when performing redirects for the secure field. Defaults to 302.",
- "type": "string"
- }
- },
- "id": "UrlMap"
- },
- "EndpointsApiService": {
- "properties": {
- "configId": {
- "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"",
- "type": "string"
- },
- "name": {
- "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"",
- "type": "string"
- }
- },
- "id": "EndpointsApiService",
- "description": "Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and configuration id of a \"service\" resource in the Service Management API (https://cloud.google.com/service-management/overview).",
- "type": "object"
- },
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a network API call.",
- "type": "object",
- "properties": {
- "done": {
- "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
- "type": "boolean"
- },
- "response": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.",
- "type": "object"
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.",
- "type": "string"
- },
- "error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure or cancellation."
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
- "type": "object"
- }
- },
- "id": "Operation"
- },
- "ApiConfigHandler": {
- "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
- "type": "object",
- "properties": {
- "securityLevel": {
- "enum": [
- "SECURE_UNSPECIFIED",
- "SECURE_DEFAULT",
- "SECURE_NEVER",
- "SECURE_OPTIONAL",
- "SECURE_ALWAYS"
- ],
- "description": "Security (HTTPS) enforcement for this URL.",
- "type": "string",
- "enumDescriptions": [
- "Not specified.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
- "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
- "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
- ]
- },
- "authFailAction": {
- "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
- "type": "string",
- "enumDescriptions": [
- "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
- "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
- "Rejects request with a 401 HTTP status code and an error message."
- ],
- "enum": [
- "AUTH_FAIL_ACTION_UNSPECIFIED",
- "AUTH_FAIL_ACTION_REDIRECT",
- "AUTH_FAIL_ACTION_UNAUTHORIZED"
- ]
- },
- "script": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
- },
- "login": {
- "enumDescriptions": [
- "Not specified. LOGIN_OPTIONAL is assumed.",
- "Does not require that the user is signed in.",
- "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
- "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
- ],
- "enum": [
- "LOGIN_UNSPECIFIED",
- "LOGIN_OPTIONAL",
- "LOGIN_ADMIN",
- "LOGIN_REQUIRED"
- ],
- "description": "Level of login required to access this resource. Defaults to optional.",
- "type": "string"
- },
- "url": {
- "description": "URL to serve the endpoint at.",
- "type": "string"
- }
- },
- "id": "ApiConfigHandler"
- },
- "StaticFilesHandler": {
- "description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.",
- "type": "object",
- "properties": {
- "requireMatchingFile": {
- "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
- "type": "boolean"
- },
- "expiration": {
- "format": "google-duration",
- "description": "Time a static file served by this handler should be cached by web proxies and browsers.",
- "type": "string"
- },
- "applicationReadable": {
- "description": "Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.",
- "type": "boolean"
- },
- "httpHeaders": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "HTTP headers to use for all responses from these URLs.",
- "type": "object"
- },
- "uploadPathRegex": {
- "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.",
- "type": "string"
- },
- "path": {
- "description": "Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.",
- "type": "string"
- },
- "mimeType": {
- "description": "MIME type used to serve all files served by this handler.Defaults to file-specific MIME types, which are derived from each file's filename extension.",
- "type": "string"
- }
- },
- "id": "StaticFilesHandler"
- },
- "BasicScaling": {
- "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.",
- "type": "object",
- "properties": {
- "maxInstances": {
- "format": "int32",
- "description": "Maximum number of instances to create for this version.",
- "type": "integer"
- },
- "idleTimeout": {
- "format": "google-duration",
- "description": "Duration of time after the last request that an instance must wait before the instance is shut down.",
- "type": "string"
- }
- },
- "id": "BasicScaling"
- },
- "DiskUtilization": {
- "description": "Target scaling by disk usage. Only applicable for VM runtimes.",
- "type": "object",
- "properties": {
- "targetWriteOpsPerSecond": {
- "format": "int32",
- "description": "Target ops written per second.",
- "type": "integer"
- },
- "targetWriteBytesPerSecond": {
- "format": "int32",
- "description": "Target bytes written per second.",
- "type": "integer"
- },
- "targetReadOpsPerSecond": {
- "format": "int32",
- "description": "Target ops read per seconds.",
- "type": "integer"
- },
- "targetReadBytesPerSecond": {
- "format": "int32",
- "description": "Target bytes read per second.",
- "type": "integer"
- }
- },
- "id": "DiskUtilization"
- },
- "CpuUtilization": {
- "properties": {
- "aggregationWindowLength": {
- "format": "google-duration",
- "description": "Period of time over which CPU utilization is calculated.",
- "type": "string"
- },
- "targetUtilization": {
- "format": "double",
- "description": "Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.",
- "type": "number"
- }
- },
- "id": "CpuUtilization",
- "description": "Target scaling by CPU usage.",
- "type": "object"
- },
- "IdentityAwareProxy": {
- "properties": {
- "oauth2ClientSecret": {
- "description": "OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly",
- "type": "string"
- },
- "oauth2ClientId": {
- "description": "OAuth2 client ID to use for the authentication flow.",
- "type": "string"
- },
- "oauth2ClientSecretSha256": {
- "description": "Hex-encoded SHA-256 hash of the client secret.@OutputOnly",
- "type": "string"
- },
- "enabled": {
- "description": "Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.",
- "type": "boolean"
- }
- },
- "id": "IdentityAwareProxy",
- "description": "Identity-Aware Proxy",
- "type": "object"
- },
- "Status": {
- "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
+ "methods": {
+ "create": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/apps/{appsId}/domainMappings",
+ "id": "appengine.apps.domainMappings.create",
+ "path": "v1/apps/{appsId}/domainMappings",
+ "request": {
+ "$ref": "DomainMapping"
+ },
+ "description": "Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains."
},
- "type": "object"
- },
- "type": "array"
+ "delete": {
+ "path": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "id": "appengine.apps.domainMappings.delete",
+ "description": "Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "appsId",
+ "domainMappingsId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "domainMappingsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/apps/{appsId}/domainMappings/{domainMappingsId}"
+ },
+ "patch": {
+ "request": {
+ "$ref": "DomainMapping"
+ },
+ "description": "Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "domainMappingsId"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "domainMappingsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "updateMask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Standard field mask for the set of fields to be updated.",
+ "type": "string"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "id": "appengine.apps.domainMappings.patch",
+ "path": "v1/apps/{appsId}/domainMappings/{domainMappingsId}"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "appsId",
+ "domainMappingsId"
+ ],
+ "response": {
+ "$ref": "DomainMapping"
+ },
+ "parameters": {
+ "domainMappingsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "path": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "id": "appengine.apps.domainMappings.get",
+ "description": "Gets the specified domain mapping."
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListDomainMappingsResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Maximum results to return per page.",
+ "type": "integer"
+ }
+ },
+ "flatPath": "v1/apps/{appsId}/domainMappings",
+ "path": "v1/apps/{appsId}/domainMappings",
+ "id": "appengine.apps.domainMappings.list",
+ "description": "Lists the domain mappings on an application."
+ }
+ }
},
- "code": {
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer"
+ "firewall": {
+ "resources": {
+ "ingressRules": {
+ "methods": {
+ "delete": {
+ "description": "Deletes the specified firewall rule.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "appsId",
+ "ingressRulesId"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the Firewall resource to delete. Example: apps/myapp/firewall/ingressRules/100.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "ingressRulesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "path": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "id": "appengine.apps.firewall.ingressRules.delete"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListIngressRulesResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `parent`. Name of the Firewall collection to retrieve. Example: apps/myapp/firewall/ingressRules.",
+ "type": "string",
+ "required": true
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Maximum results to return per page.",
+ "type": "integer",
+ "location": "query"
+ },
+ "matchingAddress": {
+ "description": "A valid IP Address. If set, only rules matching this address will be returned. The first returned rule will be the rule that fires on requests from this IP.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/apps/{appsId}/firewall/ingressRules",
+ "path": "v1/apps/{appsId}/firewall/ingressRules",
+ "id": "appengine.apps.firewall.ingressRules.list",
+ "description": "Lists the firewall rules of an application."
+ },
+ "create": {
+ "request": {
+ "$ref": "FirewallRule"
+ },
+ "description": "Creates a firewall rule for the application.",
+ "response": {
+ "$ref": "FirewallRule"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Firewall collection in which to create a new rule. Example: apps/myapp/firewall/ingressRules.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/apps/{appsId}/firewall/ingressRules",
+ "id": "appengine.apps.firewall.ingressRules.create",
+ "path": "v1/apps/{appsId}/firewall/ingressRules"
+ },
+ "get": {
+ "id": "appengine.apps.firewall.ingressRules.get",
+ "path": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "description": "Gets the specified firewall rule.",
+ "response": {
+ "$ref": "FirewallRule"
+ },
+ "parameterOrder": [
+ "appsId",
+ "ingressRulesId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the Firewall resource to retrieve. Example: apps/myapp/firewall/ingressRules/100.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "ingressRulesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}"
+ },
+ "patch": {
+ "request": {
+ "$ref": "FirewallRule"
+ },
+ "description": "Updates the specified firewall rule.",
+ "response": {
+ "$ref": "FirewallRule"
+ },
+ "parameterOrder": [
+ "appsId",
+ "ingressRulesId"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "Standard field mask for the set of fields to be updated.",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the Firewall resource to update. Example: apps/myapp/firewall/ingressRules/100.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "ingressRulesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "id": "appengine.apps.firewall.ingressRules.patch",
+ "path": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}"
+ },
+ "batchUpdate": {
+ "id": "appengine.apps.firewall.ingressRules.batchUpdate",
+ "path": "v1/apps/{appsId}/firewall/ingressRules:batchUpdate",
+ "description": "Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the rules of an existing firewall with the new rules.If the final rule does not match traffic with the '*' wildcard IP range, then an \"allow all\" rule is explicitly added to the end of the list.",
+ "request": {
+ "$ref": "BatchUpdateIngressRulesRequest"
+ },
+ "response": {
+ "$ref": "BatchUpdateIngressRulesResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the Firewall collection to set. Example: apps/myapp/firewall/ingressRules.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/apps/{appsId}/firewall/ingressRules:batchUpdate"
+ }
+ }
+ }
+ }
},
- "message": {
- "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
- "type": "string"
+ "locations": {
+ "methods": {
+ "get": {
+ "description": "Get information about a location.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Location"
+ },
+ "parameterOrder": [
+ "appsId",
+ "locationsId"
+ ],
+ "parameters": {
+ "locationsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "description": "Part of `name`. Resource name for the location.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/apps/{appsId}/locations/{locationsId}",
+ "path": "v1/apps/{appsId}/locations/{locationsId}",
+ "id": "appengine.apps.locations.get"
+ },
+ "list": {
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer"
+ },
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/apps/{appsId}/locations",
+ "id": "appengine.apps.locations.list",
+ "path": "v1/apps/{appsId}/locations",
+ "description": "Lists information about the supported locations for this service."
+ }
+ }
+ },
+ "authorizedCertificates": {
+ "methods": {
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "appsId",
+ "authorizedCertificatesId"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "authorizedCertificatesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "path": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "id": "appengine.apps.authorizedCertificates.delete",
+ "description": "Deletes the specified SSL certificate."
+ },
+ "patch": {
+ "response": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "parameterOrder": [
+ "appsId",
+ "authorizedCertificatesId"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "authorizedCertificatesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "id": "appengine.apps.authorizedCertificates.patch",
+ "path": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "request": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "description": "Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated."
+ },
+ "get": {
+ "response": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "parameterOrder": [
+ "appsId",
+ "authorizedCertificatesId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "authorizedCertificatesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "view": {
+ "enum": [
+ "BASIC_CERTIFICATE",
+ "FULL_CERTIFICATE"
+ ],
+ "description": "Controls the set of fields returned in the GET response.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "id": "appengine.apps.authorizedCertificates.get",
+ "path": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "description": "Gets the specified SSL certificate."
+ },
+ "list": {
+ "response": {
+ "$ref": "ListAuthorizedCertificatesResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "type": "string",
+ "required": true
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Maximum results to return per page.",
+ "type": "integer"
+ },
+ "view": {
+ "enum": [
+ "BASIC_CERTIFICATE",
+ "FULL_CERTIFICATE"
+ ],
+ "description": "Controls the set of fields returned in the LIST response.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/apps/{appsId}/authorizedCertificates",
+ "id": "appengine.apps.authorizedCertificates.list",
+ "path": "v1/apps/{appsId}/authorizedCertificates",
+ "description": "Lists all SSL certificates the user is authorized to administer."
+ },
+ "create": {
+ "id": "appengine.apps.authorizedCertificates.create",
+ "path": "v1/apps/{appsId}/authorizedCertificates",
+ "description": "Uploads the specified SSL certificate.",
+ "request": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "response": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/apps/{appsId}/authorizedCertificates"
+ }
+ }
}
},
- "id": "Status"
- },
- "ManualScaling": {
- "properties": {
- "instances": {
- "format": "int32",
- "description": "Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.",
- "type": "integer"
- }
- },
- "id": "ManualScaling",
- "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
- "type": "object"
- },
- "LocationMetadata": {
- "description": "Metadata for the given google.cloud.location.Location.",
- "type": "object",
- "properties": {
- "standardEnvironmentAvailable": {
- "description": "App Engine Standard Environment is available in the given location.@OutputOnly",
- "type": "boolean"
- },
- "flexibleEnvironmentAvailable": {
- "description": "App Engine Flexible Environment is available in the given location.@OutputOnly",
- "type": "boolean"
- }
- },
- "id": "LocationMetadata"
- },
- "Service": {
- "description": "A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "split": {
- "$ref": "TrafficSplit",
- "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service."
- },
- "id": {
- "description": "Relative name of the service within the application. Example: default.@OutputOnly",
- "type": "string"
- }
- },
- "id": "Service"
- },
- "ListOperationsResponse": {
- "properties": {
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
- "items": {
+ "methods": {
+ "create": {
+ "response": {
"$ref": "Operation"
},
- "type": "array"
- },
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- }
- },
- "id": "ListOperationsResponse",
- "description": "The response message for Operations.ListOperations.",
- "type": "object"
- },
- "OperationMetadata": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "insertTime": {
- "format": "google-datetime",
- "description": "Timestamp that this operation was created.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "Timestamp that this operation completed.@OutputOnly",
- "type": "string"
- },
- "operationType": {
- "description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadata"
- },
- "FirewallRule": {
- "description": "A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.",
- "type": "object",
- "properties": {
- "description": {
- "description": "An optional string description of this rule. This field has a maximum length of 100 characters.",
- "type": "string"
- },
- "sourceRange": {
- "description": "IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character \"*\" to match all IPs equivalent to \"0/0\" and \"::/0\" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334.\u003cp\u003eTruncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.",
- "type": "string"
- },
- "priority": {
- "format": "int32",
- "description": "A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.",
- "type": "integer"
- },
- "action": {
- "enumDescriptions": [
- "",
- "Matching requests are allowed.",
- "Matching requests are denied."
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
],
- "enum": [
- "UNSPECIFIED_ACTION",
- "ALLOW",
- "DENY"
- ],
- "description": "The action to take on matched requests.",
- "type": "string"
- }
- },
- "id": "FirewallRule"
- },
- "ListAuthorizedCertificatesResponse": {
- "properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "certificates": {
- "description": "The SSL certificates the user is authorized to administer.",
- "items": {
- "$ref": "AuthorizedCertificate"
+ "parameters": {},
+ "flatPath": "v1/apps",
+ "id": "appengine.apps.create",
+ "path": "v1/apps",
+ "request": {
+ "$ref": "Application"
},
- "type": "array"
- }
- },
- "id": "ListAuthorizedCertificatesResponse",
- "description": "Response message for AuthorizedCertificates.ListAuthorizedCertificates.",
- "type": "object"
- },
- "FeatureSettings": {
- "description": "The feature specific settings to be used in the application. These define behaviors that are user configurable.",
- "type": "object",
- "properties": {
- "splitHealthChecks": {
- "description": "Boolean value indicating if split health checks should be used instead of the legacy health checks. At an app.yaml level, this means defaulting to 'readiness_check' and 'liveness_check' values instead of 'health_check' ones. Once the legacy 'health_check' behavior is deprecated, and this value is always true, this setting can be removed.",
- "type": "boolean"
- }
- },
- "id": "FeatureSettings"
- },
- "OperationMetadataV1": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
- "type": "string"
+ "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/)."
},
- "endTime": {
- "format": "google-datetime",
- "description": "Time that this operation completed.@OutputOnly",
- "type": "string"
- },
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "items": {
- "type": "string"
+ "repair": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "response": {
+ "$ref": "Operation"
},
- "type": "array"
- },
- "insertTime": {
- "format": "google-datetime",
- "description": "Time that this operation was created.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1"
- },
- "SslSettings": {
- "description": "SSL configuration for a DomainMapping resource.",
- "type": "object",
- "properties": {
- "certificateId": {
- "description": "ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support. Example: 12345.",
- "type": "string"
- }
- },
- "id": "SslSettings"
- },
- "ErrorHandler": {
- "properties": {
- "mimeType": {
- "description": "MIME type of file. Defaults to text/html.",
- "type": "string"
- },
- "errorCode": {
- "description": "Error condition this handler applies to.",
- "type": "string",
- "enumDescriptions": [
- "Not specified. ERROR_CODE_DEFAULT is assumed.",
- "All other error types.",
- "Application has exceeded a resource quota.",
- "Client blocked by the application's Denial of Service protection configuration.",
- "Deadline reached before the application responds."
- ],
- "enum": [
- "ERROR_CODE_UNSPECIFIED",
- "ERROR_CODE_DEFAULT",
- "ERROR_CODE_OVER_QUOTA",
- "ERROR_CODE_DOS_API_DENIAL",
- "ERROR_CODE_TIMEOUT"
- ]
- },
- "staticFile": {
- "description": "Static file content to be served for this error.",
- "type": "string"
- }
- },
- "id": "ErrorHandler",
- "description": "Custom static error page to be served when an error occurs.",
- "type": "object"
- },
- "Network": {
- "description": "Extra network settings. Only applicable for App Engine flexible environment versions",
- "type": "object",
- "properties": {
- "subnetworkName": {
- "description": "Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network.\nIf the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.\nIf the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network.\nIf the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the App Engine flexible environment application.",
- "type": "string"
- },
- "instanceTag": {
- "description": "Tag to apply to the VM instance during creation. Only applicable for for App Engine flexible environment versions.",
- "type": "string"
- },
- "forwardedPorts": {
- "description": "List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable for App Engine flexible environment versions.",
- "items": {
- "type": "string"
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the application to repair. Example: apps/myapp",
+ "type": "string",
+ "required": true
+ }
},
- "type": "array"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/apps/{appsId}:repair",
+ "path": "v1/apps/{appsId}:repair",
+ "id": "appengine.apps.repair",
+ "description": "Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account.",
+ "request": {
+ "$ref": "RepairApplicationRequest"
+ }
},
- "name": {
- "description": "Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.",
- "type": "string"
- }
- },
- "id": "Network"
- },
- "Application": {
- "description": "An Application resource contains the top-level configuration of an App Engine application. Next tag: 20",
- "type": "object",
- "properties": {
- "featureSettings": {
- "description": "The feature specific settings to be used in the application.",
- "$ref": "FeatureSettings"
- },
- "authDomain": {
- "description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.",
- "type": "string"
- },
- "iap": {
- "$ref": "IdentityAwareProxy"
- },
- "codeBucket": {
- "description": "Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly",
- "type": "string"
- },
- "defaultBucket": {
- "description": "Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly",
- "type": "string"
- },
- "dispatchRules": {
- "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.@OutputOnly",
- "items": {
- "$ref": "UrlDispatchRule"
+ "patch": {
+ "request": {
+ "$ref": "Application"
},
- "type": "array"
- },
- "gcrDomain": {
- "description": "The Google Container Registry domain used for storing managed build docker images for this application.",
- "type": "string"
- },
- "name": {
- "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
- "type": "string"
- },
- "id": {
- "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.",
- "type": "string"
- },
- "defaultCookieExpiration": {
- "format": "google-duration",
- "description": "Cookie expiration policy for this application.",
- "type": "string"
- },
- "locationId": {
- "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US",
- "type": "string"
- },
- "servingStatus": {
- "enumDescriptions": [
- "Serving status is unspecified.",
- "Application is serving.",
- "Application has been disabled by the user.",
- "Application has been disabled by the system."
+ "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain - Google authentication domain for controlling user access to the application.\ndefault_cookie_expiration - Cookie expiration policy for the application.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "appsId"
],
- "enum": [
- "UNSPECIFIED",
- "SERVING",
- "USER_DISABLED",
- "SYSTEM_DISABLED"
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
],
- "description": "Serving status of this application.",
- "type": "string"
+ "parameters": {
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "Standard field mask for the set of fields to be updated.",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/apps/{appsId}",
+ "path": "v1/apps/{appsId}",
+ "id": "appengine.apps.patch"
},
- "defaultHostname": {
- "description": "Hostname used to reach this application, as resolved by App Engine.@OutputOnly",
- "type": "string"
+ "get": {
+ "description": "Gets information about an application.",
+ "response": {
+ "$ref": "Application"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the Application resource to get. Example: apps/myapp.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/apps/{appsId}",
+ "id": "appengine.apps.get",
+ "path": "v1/apps/{appsId}"
}
- },
- "id": "Application"
+ }
+ }
+ },
+ "parameters": {
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
},
- "Instance": {
- "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
- "type": "object",
- "properties": {
- "vmDebugEnabled": {
- "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "boolean"
- },
- "requests": {
- "format": "int32",
- "description": "Number of requests since this instance was started.@OutputOnly",
- "type": "integer"
- },
- "appEngineRelease": {
- "description": "App Engine release this instance is running on.@OutputOnly",
- "type": "string"
- },
- "vmName": {
- "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "qps": {
- "format": "float",
- "description": "Average queries per second (QPS) over the last minute.@OutputOnly",
- "type": "number"
- },
- "vmId": {
- "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "vmZoneName": {
- "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "name": {
- "description": "Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly",
- "type": "string"
- },
- "averageLatency": {
- "format": "int32",
- "description": "Average latency (ms) over the last minute.@OutputOnly",
- "type": "integer"
- },
- "id": {
- "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
- "type": "string"
- },
- "memoryUsage": {
- "format": "int64",
- "description": "Total memory in use (bytes).@OutputOnly",
- "type": "string"
- },
- "vmIp": {
- "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "vmStatus": {
- "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "availability": {
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "enum": [
- "UNSPECIFIED",
- "RESIDENT",
- "DYNAMIC"
- ],
- "description": "Availability of the instance.@OutputOnly",
- "type": "string"
- },
- "errors": {
- "format": "int32",
- "description": "Number of errors since this instance was started.@OutputOnly",
- "type": "integer"
- },
- "startTime": {
- "format": "google-datetime",
- "description": "Time that this instance was started.@OutputOnly",
- "type": "string"
- }
- },
- "id": "Instance"
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
},
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ }
+ },
+ "schemas": {
"LivenessCheck": {
"description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.",
"type": "object",
@@ -1450,16 +1559,16 @@
"description": "Interval between health checks.",
"type": "string"
},
- "failureThreshold": {
- "format": "uint32",
- "description": "Number of consecutive failed checks required before considering the VM unhealthy.",
- "type": "integer"
- },
"timeout": {
"format": "google-duration",
"description": "Time before the check is considered failed.",
"type": "string"
},
+ "failureThreshold": {
+ "format": "uint32",
+ "description": "Number of consecutive failed checks required before considering the VM unhealthy.",
+ "type": "integer"
+ },
"initialDelay": {
"format": "google-duration",
"description": "The initial delay before starting to execute the checks.",
@@ -1469,19 +1578,21 @@
"description": "The request path.",
"type": "string"
},
+ "host": {
+ "description": "Host header to send when performing a HTTP Liveness check. Example: \"myapp.appspot.com\"",
+ "type": "string"
+ },
"successThreshold": {
"format": "uint32",
"description": "Number of consecutive successful checks required before considering the VM healthy.",
"type": "integer"
- },
- "host": {
- "description": "Host header to send when performing a HTTP Liveness check. Example: \"myapp.appspot.com\"",
- "type": "string"
}
},
"id": "LivenessCheck"
},
"BatchUpdateIngressRulesRequest": {
+ "description": "Request message for Firewall.BatchUpdateIngressRules.",
+ "type": "object",
"properties": {
"ingressRules": {
"description": "A list of FirewallRules to replace the existing set.",
@@ -1491,21 +1602,39 @@
"type": "array"
}
},
- "id": "BatchUpdateIngressRulesRequest",
- "description": "Request message for Firewall.BatchUpdateIngressRules.",
+ "id": "BatchUpdateIngressRulesRequest"
+ },
+ "NetworkUtilization": {
+ "properties": {
+ "targetSentBytesPerSecond": {
+ "format": "int32",
+ "description": "Target bytes sent per second.",
+ "type": "integer"
+ },
+ "targetReceivedBytesPerSecond": {
+ "format": "int32",
+ "description": "Target bytes received per second.",
+ "type": "integer"
+ },
+ "targetSentPacketsPerSecond": {
+ "format": "int32",
+ "description": "Target packets sent per second.",
+ "type": "integer"
+ },
+ "targetReceivedPacketsPerSecond": {
+ "format": "int32",
+ "description": "Target packets received per second.",
+ "type": "integer"
+ }
+ },
+ "id": "NetworkUtilization",
+ "description": "Target scaling by network usage. Only applicable for VM runtimes.",
"type": "object"
},
"Location": {
"description": "A resource that represents Google Cloud Platform location.",
"type": "object",
"properties": {
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
- "type": "object"
- },
"name": {
"description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
"type": "string"
@@ -1521,38 +1650,20 @@
},
"description": "Service-specific metadata. For example the available capacity at the given location.",
"type": "object"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
+ "type": "object"
}
},
"id": "Location"
},
- "NetworkUtilization": {
- "description": "Target scaling by network usage. Only applicable for VM runtimes.",
- "type": "object",
- "properties": {
- "targetReceivedBytesPerSecond": {
- "format": "int32",
- "description": "Target bytes received per second.",
- "type": "integer"
- },
- "targetSentPacketsPerSecond": {
- "format": "int32",
- "description": "Target packets sent per second.",
- "type": "integer"
- },
- "targetReceivedPacketsPerSecond": {
- "format": "int32",
- "description": "Target packets received per second.",
- "type": "integer"
- },
- "targetSentBytesPerSecond": {
- "format": "int32",
- "description": "Target bytes sent per second.",
- "type": "integer"
- }
- },
- "id": "NetworkUtilization"
- },
"HealthCheck": {
+ "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.",
+ "type": "object",
"properties": {
"disableHealthCheck": {
"description": "Whether to explicitly disable health checks for this instance.",
@@ -1588,29 +1699,10 @@
"type": "integer"
}
},
- "id": "HealthCheck",
- "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.",
- "type": "object"
+ "id": "HealthCheck"
},
"ReadinessCheck": {
- "description": "Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.",
- "type": "object",
"properties": {
- "checkInterval": {
- "format": "google-duration",
- "description": "Interval between health checks.",
- "type": "string"
- },
- "timeout": {
- "format": "google-duration",
- "description": "Time before the check is considered failed.",
- "type": "string"
- },
- "failureThreshold": {
- "format": "uint32",
- "description": "Number of consecutive failed checks required before removing traffic.",
- "type": "integer"
- },
"appStartTimeout": {
"format": "google-duration",
"description": "A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.",
@@ -1628,25 +1720,48 @@
"format": "uint32",
"description": "Number of consecutive successful checks required before receiving traffic.",
"type": "integer"
+ },
+ "checkInterval": {
+ "format": "google-duration",
+ "description": "Interval between health checks.",
+ "type": "string"
+ },
+ "timeout": {
+ "format": "google-duration",
+ "description": "Time before the check is considered failed.",
+ "type": "string"
+ },
+ "failureThreshold": {
+ "format": "uint32",
+ "description": "Number of consecutive failed checks required before removing traffic.",
+ "type": "integer"
}
},
- "id": "ReadinessCheck"
+ "id": "ReadinessCheck",
+ "description": "Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.",
+ "type": "object"
},
"DebugInstanceRequest": {
- "description": "Request message for Instances.DebugInstance.",
- "type": "object",
"properties": {
"sshKey": {
"description": "Public SSH key to add to the instance. Examples:\n[USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME]\n[USERNAME]:ssh-rsa [KEY_VALUE] google-ssh {\"userName\":\"[USERNAME]\",\"expireOn\":\"[EXPIRE_TIME]\"}For more information, see Adding and Removing SSH Keys (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys).",
"type": "string"
}
},
- "id": "DebugInstanceRequest"
+ "id": "DebugInstanceRequest",
+ "description": "Request message for Instances.DebugInstance.",
+ "type": "object"
},
"OperationMetadataV1Beta5": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
"properties": {
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
"method": {
"description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
"type": "string"
@@ -1660,93 +1775,17 @@
"format": "google-datetime",
"description": "Timestamp that this operation completed.@OutputOnly",
"type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
}
},
- "id": "OperationMetadataV1Beta5"
+ "id": "OperationMetadataV1Beta5",
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object"
},
"Version": {
"properties": {
- "basicScaling": {
- "$ref": "BasicScaling",
- "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity."
- },
- "runtime": {
- "description": "Desired runtime. Example: python27.",
- "type": "string"
- },
- "id": {
- "description": "Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: \"default\", \"latest\", and any name with the prefix \"ah-\".",
- "type": "string"
- },
- "createdBy": {
- "description": "Email address of the user who created this version.@OutputOnly",
- "type": "string"
- },
- "envVariables": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Environment variables available to the application.Only returned in GET requests if view=FULL is set.",
- "type": "object"
- },
- "livenessCheck": {
- "$ref": "LivenessCheck",
- "description": "Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set."
- },
- "network": {
- "description": "Extra network settings. Only applicable for App Engine flexible environment versions.",
- "$ref": "Network"
- },
- "betaSettings": {
- "description": "Metadata settings that are supplied to this version to enable beta runtime features.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "env": {
- "description": "App Engine execution environment for this version.Defaults to standard.",
- "type": "string"
- },
- "handlers": {
- "description": "An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.",
- "items": {
- "$ref": "UrlMap"
- },
- "type": "array"
- },
- "automaticScaling": {
- "$ref": "AutomaticScaling",
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics."
- },
- "diskUsageBytes": {
- "format": "int64",
- "description": "Total size in bytes of all the files that are included in this version and curerntly hosted on the App Engine disk.@OutputOnly",
- "type": "string"
- },
- "healthCheck": {
- "description": "Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes.Only returned in GET requests if view=FULL is set.",
- "$ref": "HealthCheck"
- },
- "threadsafe": {
- "description": "Whether multiple requests can be dispatched to this version at once.",
- "type": "boolean"
- },
- "readinessCheck": {
- "$ref": "ReadinessCheck",
- "description": "Configures readiness health checking for VM instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set."
- },
"manualScaling": {
- "$ref": "ManualScaling",
- "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time."
+ "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
+ "$ref": "ManualScaling"
},
"name": {
"description": "Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly",
@@ -1773,18 +1812,18 @@
"type": "string"
},
"servingStatus": {
- "enumDescriptions": [
- "Not specified.",
- "Currently serving. Instances are created according to the scaling settings of the version.",
- "Disabled. No instances will be created and the scaling settings are ignored until the state of the version changes to SERVING."
- ],
"enum": [
"SERVING_STATUS_UNSPECIFIED",
"SERVING",
"STOPPED"
],
"description": "Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified.",
+ "Currently serving. Instances are created according to the scaling settings of the version.",
+ "Disabled. No instances will be created and the scaling settings are ignored until the state of the version changes to SERVING."
+ ]
},
"runtimeApiVersion": {
"description": "The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/\u003clanguage\u003e/config/appref",
@@ -1799,10 +1838,6 @@
"description": "Time that this version was created.@OutputOnly",
"type": "string"
},
- "resources": {
- "$ref": "Resources",
- "description": "Machine resources for this version. Only applicable for VM runtimes."
- },
"inboundServices": {
"description": "Before an application can receive email or XMPP messages, the application must be configured to enable the service.",
"items": {
@@ -1832,6 +1867,10 @@
"Enables warmup requests."
]
},
+ "resources": {
+ "$ref": "Resources",
+ "description": "Machine resources for this version. Only applicable for VM runtimes."
+ },
"errorHandlers": {
"description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.",
"items": {
@@ -1854,6 +1893,76 @@
"nobuildFilesRegex": {
"description": "Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.",
"type": "string"
+ },
+ "basicScaling": {
+ "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.",
+ "$ref": "BasicScaling"
+ },
+ "runtime": {
+ "description": "Desired runtime. Example: python27.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: \"default\", \"latest\", and any name with the prefix \"ah-\".",
+ "type": "string"
+ },
+ "createdBy": {
+ "description": "Email address of the user who created this version.@OutputOnly",
+ "type": "string"
+ },
+ "envVariables": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Environment variables available to the application.Only returned in GET requests if view=FULL is set.",
+ "type": "object"
+ },
+ "livenessCheck": {
+ "description": "Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set.",
+ "$ref": "LivenessCheck"
+ },
+ "network": {
+ "description": "Extra network settings. Only applicable for App Engine flexible environment versions.",
+ "$ref": "Network"
+ },
+ "betaSettings": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Metadata settings that are supplied to this version to enable beta runtime features.",
+ "type": "object"
+ },
+ "env": {
+ "description": "App Engine execution environment for this version.Defaults to standard.",
+ "type": "string"
+ },
+ "handlers": {
+ "description": "An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.",
+ "items": {
+ "$ref": "UrlMap"
+ },
+ "type": "array"
+ },
+ "automaticScaling": {
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
+ "$ref": "AutomaticScaling"
+ },
+ "diskUsageBytes": {
+ "format": "int64",
+ "description": "Total size in bytes of all the files that are included in this version and curerntly hosted on the App Engine disk.@OutputOnly",
+ "type": "string"
+ },
+ "healthCheck": {
+ "description": "Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes.Only returned in GET requests if view=FULL is set.",
+ "$ref": "HealthCheck"
+ },
+ "threadsafe": {
+ "description": "Whether multiple requests can be dispatched to this version at once.",
+ "type": "boolean"
+ },
+ "readinessCheck": {
+ "description": "Configures readiness health checking for VM instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set.",
+ "$ref": "ReadinessCheck"
}
},
"id": "Version",
@@ -1867,8 +1976,6 @@
"id": "RepairApplicationRequest"
},
"CertificateRawData": {
- "description": "An SSL certificate obtained from a certificate authority.",
- "type": "object",
"properties": {
"privateKey": {
"description": "Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: \u003cpre\u003e -----BEGIN RSA PRIVATE KEY----- \u003cunencrypted_key_value\u003e -----END RSA PRIVATE KEY----- \u003c/pre\u003e @InputOnly",
@@ -1879,7 +1986,1450 @@
"type": "string"
}
},
- "id": "CertificateRawData"
+ "id": "CertificateRawData",
+ "description": "An SSL certificate obtained from a certificate authority.",
+ "type": "object"
+ },
+ "FileInfo": {
+ "description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.",
+ "type": "object",
+ "properties": {
+ "sha1Sum": {
+ "description": "The SHA1 hash of the file, in hex.",
+ "type": "string"
+ },
+ "mimeType": {
+ "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage.",
+ "type": "string"
+ },
+ "sourceUrl": {
+ "description": "URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
+ "type": "string"
+ }
+ },
+ "id": "FileInfo"
+ },
+ "ScriptHandler": {
+ "description": "Executes a script to handle the request that matches the URL pattern.",
+ "type": "object",
+ "properties": {
+ "scriptPath": {
+ "description": "Path to the script from the application root directory.",
+ "type": "string"
+ }
+ },
+ "id": "ScriptHandler"
+ },
+ "OperationMetadataExperimental": {
+ "properties": {
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.experimental.CustomDomains.CreateCustomDomain.@OutputOnly",
+ "type": "string"
+ },
+ "insertTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation was created.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation completed.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/customDomains/example.com.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadataExperimental",
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object"
+ },
+ "AuthorizedDomain": {
+ "description": "A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central (https://www.google.com/webmasters/verification/home).",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly",
+ "type": "string"
+ },
+ "id": {
+ "description": "Fully qualified domain name of the domain authorized for use. Example: example.com.",
+ "type": "string"
+ }
+ },
+ "id": "AuthorizedDomain"
+ },
+ "TrafficSplit": {
+ "properties": {
+ "allocations": {
+ "additionalProperties": {
+ "format": "double",
+ "type": "number"
+ },
+ "description": "Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.",
+ "type": "object"
+ },
+ "shardBy": {
+ "enum": [
+ "UNSPECIFIED",
+ "COOKIE",
+ "IP",
+ "RANDOM"
+ ],
+ "description": "Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.",
+ "type": "string",
+ "enumDescriptions": [
+ "Diversion method unspecified.",
+ "Diversion based on a specially named cookie, \"GOOGAPPUID.\" The cookie must be set by the application itself or no diversion will occur.",
+ "Diversion based on applying the modulus operation to a fingerprint of the IP address.",
+ "Diversion based on weighted random assignment. An incoming request is randomly routed to a version in the traffic split, with probability proportional to the version's traffic share."
+ ]
+ }
+ },
+ "id": "TrafficSplit",
+ "description": "Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.",
+ "type": "object"
+ },
+ "OperationMetadataV1Beta": {
+ "properties": {
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation completed.@OutputOnly",
+ "type": "string"
+ },
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "insertTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation was created.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadataV1Beta",
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object"
+ },
+ "ListServicesResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "services": {
+ "description": "The services belonging to the requested application.",
+ "items": {
+ "$ref": "Service"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListServicesResponse",
+ "description": "Response message for Services.ListServices.",
+ "type": "object"
+ },
+ "ListIngressRulesResponse": {
+ "description": "Response message for Firewall.ListIngressRules.",
+ "type": "object",
+ "properties": {
+ "ingressRules": {
+ "description": "The ingress FirewallRules for this application.",
+ "items": {
+ "$ref": "FirewallRule"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListIngressRulesResponse"
+ },
+ "Resources": {
+ "properties": {
+ "volumes": {
+ "description": "User specified volumes.",
+ "items": {
+ "$ref": "Volume"
+ },
+ "type": "array"
+ },
+ "diskGb": {
+ "format": "double",
+ "description": "Disk size (GB) needed.",
+ "type": "number"
+ },
+ "memoryGb": {
+ "format": "double",
+ "description": "Memory (GB) needed.",
+ "type": "number"
+ },
+ "cpu": {
+ "format": "double",
+ "description": "Number of CPU cores needed.",
+ "type": "number"
+ }
+ },
+ "id": "Resources",
+ "description": "Machine resources for a version.",
+ "type": "object"
+ },
+ "Deployment": {
+ "description": "Code and application artifacts used to deploy a version to App Engine.",
+ "type": "object",
+ "properties": {
+ "files": {
+ "additionalProperties": {
+ "$ref": "FileInfo"
+ },
+ "description": "Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.",
+ "type": "object"
+ },
+ "zip": {
+ "$ref": "ZipInfo",
+ "description": "The zip file for this deployment, if this is a zip deployment."
+ },
+ "container": {
+ "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.",
+ "$ref": "ContainerInfo"
+ }
+ },
+ "id": "Deployment"
+ },
+ "Volume": {
+ "description": "Volumes mounted within the app container. Only applicable for VM runtimes.",
+ "type": "object",
+ "properties": {
+ "volumeType": {
+ "description": "Underlying volume type, e.g. 'tmpfs'.",
+ "type": "string"
+ },
+ "sizeGb": {
+ "format": "double",
+ "description": "Volume size in gigabytes.",
+ "type": "number"
+ },
+ "name": {
+ "description": "Unique name for the volume.",
+ "type": "string"
+ }
+ },
+ "id": "Volume"
+ },
+ "BatchUpdateIngressRulesResponse": {
+ "properties": {
+ "ingressRules": {
+ "description": "The full list of ingress FirewallRules for this application.",
+ "items": {
+ "$ref": "FirewallRule"
+ },
+ "type": "array"
+ }
+ },
+ "id": "BatchUpdateIngressRulesResponse",
+ "description": "Response message for Firewall.UpdateAllIngressRules.",
+ "type": "object"
+ },
+ "ListInstancesResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "instances": {
+ "description": "The instances belonging to the requested version.",
+ "items": {
+ "$ref": "Instance"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListInstancesResponse",
+ "description": "Response message for Instances.ListInstances.",
+ "type": "object"
+ },
+ "ListDomainMappingsResponse": {
+ "properties": {
+ "domainMappings": {
+ "description": "The domain mappings for the application.",
+ "items": {
+ "$ref": "DomainMapping"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListDomainMappingsResponse",
+ "description": "Response message for DomainMappings.ListDomainMappings.",
+ "type": "object"
+ },
+ "OperationMetadataV1Alpha": {
+ "properties": {
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "insertTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation was created.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation completed.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadataV1Alpha",
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object"
+ },
+ "UrlDispatchRule": {
+ "properties": {
+ "path": {
+ "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.",
+ "type": "string"
+ },
+ "service": {
+ "description": "Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.",
+ "type": "string"
+ },
+ "domain": {
+ "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
+ "type": "string"
+ }
+ },
+ "id": "UrlDispatchRule",
+ "description": "Rules to match an HTTP request and dispatch that request to a service.",
+ "type": "object"
+ },
+ "ListVersionsResponse": {
+ "description": "Response message for Versions.ListVersions.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "versions": {
+ "description": "The versions belonging to the requested service.",
+ "items": {
+ "$ref": "Version"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListVersionsResponse"
+ },
+ "ListAuthorizedDomainsResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "domains": {
+ "description": "The authorized domains belonging to the user.",
+ "items": {
+ "$ref": "AuthorizedDomain"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListAuthorizedDomainsResponse",
+ "description": "Response message for AuthorizedDomains.ListAuthorizedDomains.",
+ "type": "object"
+ },
+ "DomainMapping": {
+ "description": "A domain serving an App Engine application.",
+ "type": "object",
+ "properties": {
+ "resourceRecords": {
+ "description": "The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly",
+ "items": {
+ "$ref": "ResourceRecord"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "Relative name of the domain serving the application. Example: example.com.",
+ "type": "string"
+ },
+ "sslSettings": {
+ "description": "SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.",
+ "$ref": "SslSettings"
+ },
+ "name": {
+ "description": "Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "DomainMapping"
+ },
+ "ApiEndpointHandler": {
+ "properties": {
+ "scriptPath": {
+ "description": "Path to the script from the application root directory.",
+ "type": "string"
+ }
+ },
+ "id": "ApiEndpointHandler",
+ "description": "Uses Google Cloud Endpoints to handle requests.",
+ "type": "object"
+ },
+ "Empty": {
+ "properties": {},
+ "id": "Empty",
+ "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
+ "type": "object"
+ },
+ "AutomaticScaling": {
+ "properties": {
+ "minTotalInstances": {
+ "format": "int32",
+ "description": "Minimum number of instances that should be maintained for this version.",
+ "type": "integer"
+ },
+ "networkUtilization": {
+ "description": "Target scaling by network usage.",
+ "$ref": "NetworkUtilization"
+ },
+ "coolDownPeriod": {
+ "format": "google-duration",
+ "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.",
+ "type": "string"
+ },
+ "maxConcurrentRequests": {
+ "format": "int32",
+ "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
+ "type": "integer"
+ },
+ "maxPendingLatency": {
+ "format": "google-duration",
+ "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.",
+ "type": "string"
+ },
+ "cpuUtilization": {
+ "$ref": "CpuUtilization",
+ "description": "Target scaling by CPU usage."
+ },
+ "diskUtilization": {
+ "description": "Target scaling by disk usage.",
+ "$ref": "DiskUtilization"
+ },
+ "minPendingLatency": {
+ "format": "google-duration",
+ "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
+ "type": "string"
+ },
+ "requestUtilization": {
+ "$ref": "RequestUtilization",
+ "description": "Target scaling by request utilization."
+ },
+ "maxIdleInstances": {
+ "format": "int32",
+ "description": "Maximum number of idle instances that should be maintained for this version.",
+ "type": "integer"
+ },
+ "minIdleInstances": {
+ "format": "int32",
+ "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.",
+ "type": "integer"
+ },
+ "maxTotalInstances": {
+ "format": "int32",
+ "description": "Maximum number of instances that should be started to handle requests.",
+ "type": "integer"
+ }
+ },
+ "id": "AutomaticScaling",
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
+ "type": "object"
+ },
+ "ZipInfo": {
+ "properties": {
+ "sourceUrl": {
+ "description": "URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
+ "type": "string"
+ },
+ "filesCount": {
+ "format": "int32",
+ "description": "An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.",
+ "type": "integer"
+ }
+ },
+ "id": "ZipInfo",
+ "description": "The zip file information for a zip deployment.",
+ "type": "object"
+ },
+ "AuthorizedCertificate": {
+ "description": "An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.",
+ "type": "object",
+ "properties": {
+ "visibleDomainMappings": {
+ "description": "The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "expireTime": {
+ "format": "google-datetime",
+ "description": "The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly",
+ "type": "string"
+ },
+ "domainMappingsCount": {
+ "format": "int32",
+ "description": "Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly",
+ "type": "integer"
+ },
+ "domainNames": {
+ "description": "Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.",
+ "type": "string"
+ },
+ "certificateRawData": {
+ "description": "The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.",
+ "$ref": "CertificateRawData"
+ }
+ },
+ "id": "AuthorizedCertificate"
+ },
+ "ResourceRecord": {
+ "properties": {
+ "name": {
+ "description": "Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.",
+ "type": "string"
+ },
+ "type": {
+ "enum": [
+ "RECORD_TYPE_UNSPECIFIED",
+ "A",
+ "AAAA",
+ "CNAME"
+ ],
+ "description": "Resource record type. Example: AAAA.",
+ "type": "string",
+ "enumDescriptions": [
+ "An unknown resource record.",
+ "An A resource record. Data is an IPv4 address.",
+ "An AAAA resource record. Data is an IPv6 address.",
+ "A CNAME resource record. Data is a domain name to be aliased."
+ ]
+ },
+ "rrdata": {
+ "description": "Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).",
+ "type": "string"
+ }
+ },
+ "id": "ResourceRecord",
+ "description": "A DNS resource record.",
+ "type": "object"
+ },
+ "Library": {
+ "description": "Third-party Python runtime library that is required by the application.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the library. Example: \"django\".",
+ "type": "string"
+ },
+ "version": {
+ "description": "Version of the library to select, or \"latest\".",
+ "type": "string"
+ }
+ },
+ "id": "Library"
+ },
+ "ListLocationsResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
+ "locations": {
+ "description": "A list of locations that matches the specified filter in the request.",
+ "items": {
+ "$ref": "Location"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListLocationsResponse",
+ "description": "The response message for Locations.ListLocations.",
+ "type": "object"
+ },
+ "ContainerInfo": {
+ "properties": {
+ "image": {
+ "description": "URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: \"gcr.io/my-project/image:tag\" or \"gcr.io/my-project/image@digest\"",
+ "type": "string"
+ }
+ },
+ "id": "ContainerInfo",
+ "description": "Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment.",
+ "type": "object"
+ },
+ "RequestUtilization": {
+ "properties": {
+ "targetRequestCountPerSecond": {
+ "format": "int32",
+ "description": "Target requests per second.",
+ "type": "integer"
+ },
+ "targetConcurrentRequests": {
+ "format": "int32",
+ "description": "Target number of concurrent requests.",
+ "type": "integer"
+ }
+ },
+ "id": "RequestUtilization",
+ "description": "Target scaling by request utilization. Only applicable for VM runtimes.",
+ "type": "object"
+ },
+ "EndpointsApiService": {
+ "description": "Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and configuration id of a \"service\" resource in the Service Management API (https://cloud.google.com/service-management/overview).",
+ "type": "object",
+ "properties": {
+ "configId": {
+ "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"",
+ "type": "string"
+ },
+ "name": {
+ "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"",
+ "type": "string"
+ }
+ },
+ "id": "EndpointsApiService"
+ },
+ "UrlMap": {
+ "description": "URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.",
+ "type": "object",
+ "properties": {
+ "apiEndpoint": {
+ "description": "Uses API Endpoints to handle requests.",
+ "$ref": "ApiEndpointHandler"
+ },
+ "staticFiles": {
+ "$ref": "StaticFilesHandler",
+ "description": "Returns the contents of a file, such as an image, as the response."
+ },
+ "redirectHttpResponseCode": {
+ "enum": [
+ "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED",
+ "REDIRECT_HTTP_RESPONSE_CODE_301",
+ "REDIRECT_HTTP_RESPONSE_CODE_302",
+ "REDIRECT_HTTP_RESPONSE_CODE_303",
+ "REDIRECT_HTTP_RESPONSE_CODE_307"
+ ],
+ "description": "30x code to use when performing redirects for the secure field. Defaults to 302.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified. 302 is assumed.",
+ "301 Moved Permanently code.",
+ "302 Moved Temporarily code.",
+ "303 See Other code.",
+ "307 Temporary Redirect code."
+ ]
+ },
+ "securityLevel": {
+ "enum": [
+ "SECURE_UNSPECIFIED",
+ "SECURE_DEFAULT",
+ "SECURE_NEVER",
+ "SECURE_OPTIONAL",
+ "SECURE_ALWAYS"
+ ],
+ "description": "Security (HTTPS) enforcement for this URL.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
+ "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
+ "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
+ ]
+ },
+ "authFailAction": {
+ "enum": [
+ "AUTH_FAIL_ACTION_UNSPECIFIED",
+ "AUTH_FAIL_ACTION_REDIRECT",
+ "AUTH_FAIL_ACTION_UNAUTHORIZED"
+ ],
+ "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
+ "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
+ "Rejects request with a 401 HTTP status code and an error message."
+ ]
+ },
+ "script": {
+ "$ref": "ScriptHandler",
+ "description": "Executes a script to handle the request that matches this URL pattern."
+ },
+ "urlRegex": {
+ "description": "URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.",
+ "type": "string"
+ },
+ "login": {
+ "enumDescriptions": [
+ "Not specified. LOGIN_OPTIONAL is assumed.",
+ "Does not require that the user is signed in.",
+ "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
+ "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
+ ],
+ "enum": [
+ "LOGIN_UNSPECIFIED",
+ "LOGIN_OPTIONAL",
+ "LOGIN_ADMIN",
+ "LOGIN_REQUIRED"
+ ],
+ "description": "Level of login required to access this resource.",
+ "type": "string"
+ }
+ },
+ "id": "UrlMap"
+ },
+ "ApiConfigHandler": {
+ "properties": {
+ "script": {
+ "description": "Path to the script from the application root directory.",
+ "type": "string"
+ },
+ "login": {
+ "enum": [
+ "LOGIN_UNSPECIFIED",
+ "LOGIN_OPTIONAL",
+ "LOGIN_ADMIN",
+ "LOGIN_REQUIRED"
+ ],
+ "description": "Level of login required to access this resource. Defaults to optional.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified. LOGIN_OPTIONAL is assumed.",
+ "Does not require that the user is signed in.",
+ "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
+ "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
+ ]
+ },
+ "url": {
+ "description": "URL to serve the endpoint at.",
+ "type": "string"
+ },
+ "securityLevel": {
+ "enum": [
+ "SECURE_UNSPECIFIED",
+ "SECURE_DEFAULT",
+ "SECURE_NEVER",
+ "SECURE_OPTIONAL",
+ "SECURE_ALWAYS"
+ ],
+ "description": "Security (HTTPS) enforcement for this URL.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
+ "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
+ "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
+ ]
+ },
+ "authFailAction": {
+ "enum": [
+ "AUTH_FAIL_ACTION_UNSPECIFIED",
+ "AUTH_FAIL_ACTION_REDIRECT",
+ "AUTH_FAIL_ACTION_UNAUTHORIZED"
+ ],
+ "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
+ "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
+ "Rejects request with a 401 HTTP status code and an error message."
+ ]
+ }
+ },
+ "id": "ApiConfigHandler",
+ "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
+ "type": "object"
+ },
+ "Operation": {
+ "properties": {
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.",
+ "type": "string"
+ },
+ "error": {
+ "description": "The error result of the operation in case of failure or cancellation.",
+ "$ref": "Status"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
+ "type": "object"
+ },
+ "done": {
+ "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
+ "type": "boolean"
+ }
+ },
+ "id": "Operation",
+ "description": "This resource represents a long-running operation that is the result of a network API call.",
+ "type": "object"
+ },
+ "StaticFilesHandler": {
+ "description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.",
+ "type": "object",
+ "properties": {
+ "applicationReadable": {
+ "description": "Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.",
+ "type": "boolean"
+ },
+ "httpHeaders": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "HTTP headers to use for all responses from these URLs.",
+ "type": "object"
+ },
+ "uploadPathRegex": {
+ "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.",
+ "type": "string"
+ },
+ "path": {
+ "description": "Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.",
+ "type": "string"
+ },
+ "mimeType": {
+ "description": "MIME type used to serve all files served by this handler.Defaults to file-specific MIME types, which are derived from each file's filename extension.",
+ "type": "string"
+ },
+ "requireMatchingFile": {
+ "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
+ "type": "boolean"
+ },
+ "expiration": {
+ "format": "google-duration",
+ "description": "Time a static file served by this handler should be cached by web proxies and browsers.",
+ "type": "string"
+ }
+ },
+ "id": "StaticFilesHandler"
+ },
+ "DiskUtilization": {
+ "properties": {
+ "targetWriteBytesPerSecond": {
+ "format": "int32",
+ "description": "Target bytes written per second.",
+ "type": "integer"
+ },
+ "targetReadOpsPerSecond": {
+ "format": "int32",
+ "description": "Target ops read per seconds.",
+ "type": "integer"
+ },
+ "targetReadBytesPerSecond": {
+ "format": "int32",
+ "description": "Target bytes read per second.",
+ "type": "integer"
+ },
+ "targetWriteOpsPerSecond": {
+ "format": "int32",
+ "description": "Target ops written per second.",
+ "type": "integer"
+ }
+ },
+ "id": "DiskUtilization",
+ "description": "Target scaling by disk usage. Only applicable for VM runtimes.",
+ "type": "object"
+ },
+ "BasicScaling": {
+ "properties": {
+ "idleTimeout": {
+ "format": "google-duration",
+ "description": "Duration of time after the last request that an instance must wait before the instance is shut down.",
+ "type": "string"
+ },
+ "maxInstances": {
+ "format": "int32",
+ "description": "Maximum number of instances to create for this version.",
+ "type": "integer"
+ }
+ },
+ "id": "BasicScaling",
+ "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.",
+ "type": "object"
+ },
+ "CpuUtilization": {
+ "description": "Target scaling by CPU usage.",
+ "type": "object",
+ "properties": {
+ "aggregationWindowLength": {
+ "format": "google-duration",
+ "description": "Period of time over which CPU utilization is calculated.",
+ "type": "string"
+ },
+ "targetUtilization": {
+ "format": "double",
+ "description": "Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.",
+ "type": "number"
+ }
+ },
+ "id": "CpuUtilization"
+ },
+ "Status": {
+ "properties": {
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "code": {
+ "format": "int32",
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "type": "integer"
+ }
+ },
+ "id": "Status",
+ "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object"
+ },
+ "IdentityAwareProxy": {
+ "properties": {
+ "oauth2ClientSecretSha256": {
+ "description": "Hex-encoded SHA-256 hash of the client secret.@OutputOnly",
+ "type": "string"
+ },
+ "enabled": {
+ "description": "Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.",
+ "type": "boolean"
+ },
+ "oauth2ClientSecret": {
+ "description": "OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly",
+ "type": "string"
+ },
+ "oauth2ClientId": {
+ "description": "OAuth2 client ID to use for the authentication flow.",
+ "type": "string"
+ }
+ },
+ "id": "IdentityAwareProxy",
+ "description": "Identity-Aware Proxy",
+ "type": "object"
+ },
+ "ManualScaling": {
+ "properties": {
+ "instances": {
+ "format": "int32",
+ "description": "Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.",
+ "type": "integer"
+ }
+ },
+ "id": "ManualScaling",
+ "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
+ "type": "object"
+ },
+ "LocationMetadata": {
+ "description": "Metadata for the given google.cloud.location.Location.",
+ "type": "object",
+ "properties": {
+ "standardEnvironmentAvailable": {
+ "description": "App Engine Standard Environment is available in the given location.@OutputOnly",
+ "type": "boolean"
+ },
+ "flexibleEnvironmentAvailable": {
+ "description": "App Engine Flexible Environment is available in the given location.@OutputOnly",
+ "type": "boolean"
+ }
+ },
+ "id": "LocationMetadata"
+ },
+ "Service": {
+ "properties": {
+ "id": {
+ "description": "Relative name of the service within the application. Example: default.@OutputOnly",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "split": {
+ "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service.",
+ "$ref": "TrafficSplit"
+ }
+ },
+ "id": "Service",
+ "description": "A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.",
+ "type": "object"
+ },
+ "ListOperationsResponse": {
+ "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"
+ }
+ },
+ "id": "ListOperationsResponse",
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object"
+ },
+ "FirewallRule": {
+ "properties": {
+ "sourceRange": {
+ "description": "IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character \"*\" to match all IPs equivalent to \"0/0\" and \"::/0\" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334.\u003cp\u003eTruncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.",
+ "type": "string"
+ },
+ "priority": {
+ "format": "int32",
+ "description": "A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.",
+ "type": "integer"
+ },
+ "action": {
+ "enumDescriptions": [
+ "",
+ "Matching requests are allowed.",
+ "Matching requests are denied."
+ ],
+ "enum": [
+ "UNSPECIFIED_ACTION",
+ "ALLOW",
+ "DENY"
+ ],
+ "description": "The action to take on matched requests.",
+ "type": "string"
+ },
+ "description": {
+ "description": "An optional string description of this rule. This field has a maximum length of 100 characters.",
+ "type": "string"
+ }
+ },
+ "id": "FirewallRule",
+ "description": "A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.",
+ "type": "object"
+ },
+ "OperationMetadata": {
+ "properties": {
+ "operationType": {
+ "description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly",
+ "type": "string"
+ },
+ "insertTime": {
+ "format": "google-datetime",
+ "description": "Timestamp that this operation was created.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Timestamp that this operation completed.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadata",
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object"
+ },
+ "ListAuthorizedCertificatesResponse": {
+ "description": "Response message for AuthorizedCertificates.ListAuthorizedCertificates.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "certificates": {
+ "description": "The SSL certificates the user is authorized to administer.",
+ "items": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListAuthorizedCertificatesResponse"
+ },
+ "FeatureSettings": {
+ "properties": {
+ "splitHealthChecks": {
+ "description": "Boolean value indicating if split health checks should be used instead of the legacy health checks. At an app.yaml level, this means defaulting to 'readiness_check' and 'liveness_check' values instead of 'health_check' ones. Once the legacy 'health_check' behavior is deprecated, and this value is always true, this setting can be removed.",
+ "type": "boolean"
+ }
+ },
+ "id": "FeatureSettings",
+ "description": "The feature specific settings to be used in the application. These define behaviors that are user configurable.",
+ "type": "object"
+ },
+ "ErrorHandler": {
+ "properties": {
+ "mimeType": {
+ "description": "MIME type of file. Defaults to text/html.",
+ "type": "string"
+ },
+ "errorCode": {
+ "enumDescriptions": [
+ "Not specified. ERROR_CODE_DEFAULT is assumed.",
+ "All other error types.",
+ "Application has exceeded a resource quota.",
+ "Client blocked by the application's Denial of Service protection configuration.",
+ "Deadline reached before the application responds."
+ ],
+ "enum": [
+ "ERROR_CODE_UNSPECIFIED",
+ "ERROR_CODE_DEFAULT",
+ "ERROR_CODE_OVER_QUOTA",
+ "ERROR_CODE_DOS_API_DENIAL",
+ "ERROR_CODE_TIMEOUT"
+ ],
+ "description": "Error condition this handler applies to.",
+ "type": "string"
+ },
+ "staticFile": {
+ "description": "Static file content to be served for this error.",
+ "type": "string"
+ }
+ },
+ "id": "ErrorHandler",
+ "description": "Custom static error page to be served when an error occurs.",
+ "type": "object"
+ },
+ "SslSettings": {
+ "properties": {
+ "certificateId": {
+ "description": "ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support. Example: 12345.",
+ "type": "string"
+ }
+ },
+ "id": "SslSettings",
+ "description": "SSL configuration for a DomainMapping resource.",
+ "type": "object"
+ },
+ "OperationMetadataV1": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
+ "properties": {
+ "insertTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation was created.@OutputOnly",
+ "type": "string"
+ },
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation completed.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadataV1"
+ },
+ "Application": {
+ "properties": {
+ "iap": {
+ "$ref": "IdentityAwareProxy"
+ },
+ "authDomain": {
+ "description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.",
+ "type": "string"
+ },
+ "codeBucket": {
+ "description": "Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly",
+ "type": "string"
+ },
+ "defaultBucket": {
+ "description": "Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly",
+ "type": "string"
+ },
+ "dispatchRules": {
+ "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.@OutputOnly",
+ "items": {
+ "$ref": "UrlDispatchRule"
+ },
+ "type": "array"
+ },
+ "gcrDomain": {
+ "description": "The Google Container Registry domain used for storing managed build docker images for this application.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
+ "type": "string"
+ },
+ "defaultCookieExpiration": {
+ "format": "google-duration",
+ "description": "Cookie expiration policy for this application.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.",
+ "type": "string"
+ },
+ "locationId": {
+ "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US",
+ "type": "string"
+ },
+ "servingStatus": {
+ "enum": [
+ "UNSPECIFIED",
+ "SERVING",
+ "USER_DISABLED",
+ "SYSTEM_DISABLED"
+ ],
+ "description": "Serving status of this application.",
+ "type": "string",
+ "enumDescriptions": [
+ "Serving status is unspecified.",
+ "Application is serving.",
+ "Application has been disabled by the user.",
+ "Application has been disabled by the system."
+ ]
+ },
+ "defaultHostname": {
+ "description": "Hostname used to reach this application, as resolved by App Engine.@OutputOnly",
+ "type": "string"
+ },
+ "featureSettings": {
+ "description": "The feature specific settings to be used in the application.",
+ "$ref": "FeatureSettings"
+ }
+ },
+ "id": "Application",
+ "description": "An Application resource contains the top-level configuration of an App Engine application. Next tag: 20",
+ "type": "object"
+ },
+ "Network": {
+ "properties": {
+ "subnetworkName": {
+ "description": "Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network.\nIf the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.\nIf the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network.\nIf the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the App Engine flexible environment application.",
+ "type": "string"
+ },
+ "instanceTag": {
+ "description": "Tag to apply to the VM instance during creation. Only applicable for for App Engine flexible environment versions.",
+ "type": "string"
+ },
+ "forwardedPorts": {
+ "description": "List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable for App Engine flexible environment versions.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.",
+ "type": "string"
+ }
+ },
+ "id": "Network",
+ "description": "Extra network settings. Only applicable for App Engine flexible environment versions",
+ "type": "object"
+ },
+ "Instance": {
+ "properties": {
+ "vmName": {
+ "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "qps": {
+ "format": "float",
+ "description": "Average queries per second (QPS) over the last minute.@OutputOnly",
+ "type": "number"
+ },
+ "vmId": {
+ "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly",
+ "type": "string"
+ },
+ "vmZoneName": {
+ "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "averageLatency": {
+ "format": "int32",
+ "description": "Average latency (ms) over the last minute.@OutputOnly",
+ "type": "integer"
+ },
+ "id": {
+ "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
+ "type": "string"
+ },
+ "vmIp": {
+ "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "memoryUsage": {
+ "format": "int64",
+ "description": "Total memory in use (bytes).@OutputOnly",
+ "type": "string"
+ },
+ "vmStatus": {
+ "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "availability": {
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "enum": [
+ "UNSPECIFIED",
+ "RESIDENT",
+ "DYNAMIC"
+ ],
+ "description": "Availability of the instance.@OutputOnly",
+ "type": "string"
+ },
+ "errors": {
+ "format": "int32",
+ "description": "Number of errors since this instance was started.@OutputOnly",
+ "type": "integer"
+ },
+ "startTime": {
+ "format": "google-datetime",
+ "description": "Time that this instance was started.@OutputOnly",
+ "type": "string"
+ },
+ "vmDebugEnabled": {
+ "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "boolean"
+ },
+ "requests": {
+ "format": "int32",
+ "description": "Number of requests since this instance was started.@OutputOnly",
+ "type": "integer"
+ },
+ "appEngineRelease": {
+ "description": "App Engine release this instance is running on.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "Instance",
+ "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
+ "type": "object"
}
},
"icons": {
@@ -1892,1574 +3442,24 @@
"auth": {
"oauth2": {
"scopes": {
+ "https://www.googleapis.com/auth/appengine.admin": {
+ "description": "View and manage your applications deployed on Google App Engine"
+ },
"https://www.googleapis.com/auth/cloud-platform.read-only": {
"description": "View your data across Google Cloud Platform services"
},
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/appengine.admin": {
- "description": "View and manage your applications deployed on Google App Engine"
}
}
}
},
- "servicePath": "",
- "kind": "discovery#restDescription",
"description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.",
+ "kind": "discovery#restDescription",
+ "servicePath": "",
"rootUrl": "https://appengine.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "appengine",
- "batchPath": "batch",
- "revision": "20170929",
- "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
- "id": "appengine:v1",
- "title": "Google App Engine Admin API",
- "discoveryVersion": "v1",
- "ownerName": "Google",
- "version_module": true,
- "resources": {
- "apps": {
- "methods": {
- "patch": {
- "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain - Google authentication domain for controlling user access to the application.\ndefault_cookie_expiration - Cookie expiration policy for the application.",
- "request": {
- "$ref": "Application"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "updateMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "Standard field mask for the set of fields to be updated.",
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/apps/{appsId}",
- "id": "appengine.apps.patch",
- "path": "v1/apps/{appsId}"
- },
- "get": {
- "response": {
- "$ref": "Application"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the Application resource to get. Example: apps/myapp.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/apps/{appsId}",
- "id": "appengine.apps.get",
- "path": "v1/apps/{appsId}",
- "description": "Gets information about an application."
- },
- "create": {
- "id": "appengine.apps.create",
- "path": "v1/apps",
- "request": {
- "$ref": "Application"
- },
- "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v1/apps"
- },
- "repair": {
- "path": "v1/apps/{appsId}:repair",
- "id": "appengine.apps.repair",
- "description": "Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account.",
- "request": {
- "$ref": "RepairApplicationRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the application to repair. Example: apps/myapp",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/apps/{appsId}:repair"
- }
- },
- "resources": {
- "locations": {
- "methods": {
- "get": {
- "description": "Get information about a location.",
- "response": {
- "$ref": "Location"
- },
- "parameterOrder": [
- "appsId",
- "locationsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "locationsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "appsId": {
- "description": "Part of `name`. Resource name for the location.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/apps/{appsId}/locations/{locationsId}",
- "id": "appengine.apps.locations.get",
- "path": "v1/apps/{appsId}/locations/{locationsId}"
- },
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "ListLocationsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "pageSize": {
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "appsId": {
- "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/apps/{appsId}/locations",
- "path": "v1/apps/{appsId}/locations",
- "id": "appengine.apps.locations.list",
- "description": "Lists information about the supported locations for this service."
- }
- }
- },
- "authorizedCertificates": {
- "methods": {
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "appsId",
- "authorizedCertificatesId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "authorizedCertificatesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.delete",
- "path": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "description": "Deletes the specified SSL certificate."
- },
- "patch": {
- "response": {
- "$ref": "AuthorizedCertificate"
- },
- "parameterOrder": [
- "appsId",
- "authorizedCertificatesId"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "updateMask": {
- "format": "google-fieldmask",
- "description": "Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.",
- "type": "string",
- "required": true
- },
- "authorizedCertificatesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.patch",
- "path": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "description": "Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.",
- "request": {
- "$ref": "AuthorizedCertificate"
- }
- },
- "get": {
- "flatPath": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.get",
- "path": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "description": "Gets the specified SSL certificate.",
- "response": {
- "$ref": "AuthorizedCertificate"
- },
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId",
- "authorizedCertificatesId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "authorizedCertificatesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "view": {
- "location": "query",
- "enum": [
- "BASIC_CERTIFICATE",
- "FULL_CERTIFICATE"
- ],
- "description": "Controls the set of fields returned in the GET response.",
- "type": "string"
- }
- }
- },
- "list": {
- "description": "Lists all SSL certificates the user is authorized to administer.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListAuthorizedCertificatesResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Maximum results to return per page.",
- "type": "integer"
- },
- "view": {
- "enum": [
- "BASIC_CERTIFICATE",
- "FULL_CERTIFICATE"
- ],
- "description": "Controls the set of fields returned in the LIST response.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1/apps/{appsId}/authorizedCertificates",
- "path": "v1/apps/{appsId}/authorizedCertificates",
- "id": "appengine.apps.authorizedCertificates.list"
- },
- "create": {
- "id": "appengine.apps.authorizedCertificates.create",
- "path": "v1/apps/{appsId}/authorizedCertificates",
- "request": {
- "$ref": "AuthorizedCertificate"
- },
- "description": "Uploads the specified SSL certificate.",
- "response": {
- "$ref": "AuthorizedCertificate"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "appsId": {
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/apps/{appsId}/authorizedCertificates"
- }
- }
- },
- "services": {
- "methods": {
- "delete": {
- "description": "Deletes the specified service and all enclosed versions.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/apps/{appsId}/services/{servicesId}",
- "id": "appengine.apps.services.delete",
- "path": "v1/apps/{appsId}/services/{servicesId}"
- },
- "patch": {
- "flatPath": "v1/apps/{appsId}/services/{servicesId}",
- "id": "appengine.apps.services.patch",
- "path": "v1/apps/{appsId}/services/{servicesId}",
- "request": {
- "$ref": "Service"
- },
- "description": "Updates the configuration of the specified service.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "updateMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "Standard field mask for the set of fields to be updated.",
- "type": "string"
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "migrateTraffic": {
- "location": "query",
- "description": "Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services#shardby) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).",
- "type": "boolean"
- }
- }
- },
- "get": {
- "response": {
- "$ref": "Service"
- },
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/apps/{appsId}/services/{servicesId}",
- "id": "appengine.apps.services.get",
- "path": "v1/apps/{appsId}/services/{servicesId}",
- "description": "Gets the current configuration of the specified service."
- },
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "ListServicesResponse"
- },
- "parameters": {
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "pageSize": {
- "format": "int32",
- "description": "Maximum results to return per page.",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/apps/{appsId}/services",
- "path": "v1/apps/{appsId}/services",
- "id": "appengine.apps.services.list",
- "description": "Lists all the services in the application."
- }
- },
- "resources": {
- "versions": {
- "methods": {
- "delete": {
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.delete",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "description": "Deletes an existing Version resource.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "patch": {
- "request": {
- "$ref": "Version"
- },
- "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.",
- "httpMethod": "PATCH",
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "updateMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "Standard field mask for the set of fields to be updated.",
- "type": "string"
- },
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.patch"
- },
- "get": {
- "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.",
- "response": {
- "$ref": "Version"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "view": {
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "description": "Controls the set of fields returned in the Get response.",
- "type": "string"
- },
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.get",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}"
- },
- "list": {
- "description": "Lists the versions of a service.",
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "response": {
- "$ref": "ListVersionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "pageSize": {
- "format": "int32",
- "description": "Maximum results to return per page.",
- "type": "integer",
- "location": "query"
- },
- "view": {
- "enum": [
- "BASIC",
- "FULL"
- ],
- "description": "Controls the set of fields returned in the List response.",
- "type": "string",
- "location": "query"
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `parent`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "description": "Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions",
- "id": "appengine.apps.services.versions.list"
- },
- "create": {
- "request": {
- "$ref": "Version"
- },
- "description": "Deploys code and resource files to a new version.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "servicesId": {
- "description": "Part of `parent`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions",
- "id": "appengine.apps.services.versions.create",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions"
- }
- },
- "resources": {
- "instances": {
- "methods": {
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId",
- "instancesId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "instancesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "id": "appengine.apps.services.versions.instances.delete",
- "description": "Stops a running instance."
- },
- "get": {
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId",
- "instancesId"
- ],
- "httpMethod": "GET",
- "response": {
- "$ref": "Instance"
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "instancesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
- "type": "string",
- "required": true
- },
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "id": "appengine.apps.services.versions.instances.get",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "description": "Gets instance information."
- },
- "list": {
- "description": "Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListInstancesResponse"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Maximum results to return per page.",
- "type": "integer"
- },
- "versionsId": {
- "description": "Part of `parent`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "servicesId": {
- "description": "Part of `parent`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
- "id": "appengine.apps.services.versions.instances.list"
- },
- "debug": {
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "id": "appengine.apps.services.versions.instances.debug",
- "request": {
- "$ref": "DebugInstanceRequest"
- },
- "description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.",
- "httpMethod": "POST",
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId",
- "instancesId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "instancesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "authorizedDomains": {
- "methods": {
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "ListAuthorizedDomainsResponse"
- },
- "parameters": {
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "type": "string",
- "required": true
- },
- "pageSize": {
- "format": "int32",
- "description": "Maximum results to return per page.",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/apps/{appsId}/authorizedDomains",
- "path": "v1/apps/{appsId}/authorizedDomains",
- "id": "appengine.apps.authorizedDomains.list",
- "description": "Lists all domains the user is authorized to administer."
- }
- }
- },
- "operations": {
- "methods": {
- "get": {
- "id": "appengine.apps.operations.get",
- "path": "v1/apps/{appsId}/operations/{operationsId}",
- "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "operationsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. The name of the operation resource.",
- "type": "string",
- "required": true
- },
- "operationsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/apps/{appsId}/operations/{operationsId}"
- },
- "list": {
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "description": "Part of `name`. The name of the operation's parent resource.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/apps/{appsId}/operations",
- "id": "appengine.apps.operations.list",
- "path": "v1/apps/{appsId}/operations",
- "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id."
- }
- }
- },
- "domainMappings": {
- "methods": {
- "delete": {
- "description": "Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "domainMappingsId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "domainMappingsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
- "id": "appengine.apps.domainMappings.delete",
- "path": "v1/apps/{appsId}/domainMappings/{domainMappingsId}"
- },
- "patch": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "domainMappingsId"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "updateMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "Standard field mask for the set of fields to be updated.",
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.",
- "type": "string",
- "required": true
- },
- "domainMappingsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
- "id": "appengine.apps.domainMappings.patch",
- "path": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
- "description": "Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.",
- "request": {
- "$ref": "DomainMapping"
- }
- },
- "get": {
- "description": "Gets the specified domain mapping.",
- "response": {
- "$ref": "DomainMapping"
- },
- "parameterOrder": [
- "appsId",
- "domainMappingsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "domainMappingsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
- "id": "appengine.apps.domainMappings.get",
- "path": "v1/apps/{appsId}/domainMappings/{domainMappingsId}"
- },
- "list": {
- "flatPath": "v1/apps/{appsId}/domainMappings",
- "id": "appengine.apps.domainMappings.list",
- "path": "v1/apps/{appsId}/domainMappings",
- "description": "Lists the domain mappings on an application.",
- "response": {
- "$ref": "ListDomainMappingsResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "appsId": {
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Maximum results to return per page.",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- },
- "create": {
- "path": "v1/apps/{appsId}/domainMappings",
- "id": "appengine.apps.domainMappings.create",
- "description": "Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.",
- "request": {
- "$ref": "DomainMapping"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "appsId": {
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/apps/{appsId}/domainMappings"
- }
- }
- },
- "firewall": {
- "resources": {
- "ingressRules": {
- "methods": {
- "get": {
- "description": "Gets the specified firewall rule.",
- "response": {
- "$ref": "FirewallRule"
- },
- "parameterOrder": [
- "appsId",
- "ingressRulesId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "ingressRulesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the Firewall resource to retrieve. Example: apps/myapp/firewall/ingressRules/100.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "id": "appengine.apps.firewall.ingressRules.get",
- "path": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}"
- },
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "appsId",
- "ingressRulesId"
- ],
- "response": {
- "$ref": "FirewallRule"
- },
- "parameters": {
- "updateMask": {
- "format": "google-fieldmask",
- "description": "Standard field mask for the set of fields to be updated.",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "description": "Part of `name`. Name of the Firewall resource to update. Example: apps/myapp/firewall/ingressRules/100.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "ingressRulesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "path": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "id": "appengine.apps.firewall.ingressRules.patch",
- "description": "Updates the specified firewall rule.",
- "request": {
- "$ref": "FirewallRule"
- }
- },
- "batchUpdate": {
- "id": "appengine.apps.firewall.ingressRules.batchUpdate",
- "path": "v1/apps/{appsId}/firewall/ingressRules:batchUpdate",
- "request": {
- "$ref": "BatchUpdateIngressRulesRequest"
- },
- "description": "Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the rules of an existing firewall with the new rules.If the final rule does not match traffic with the '*' wildcard IP range, then an \"allow all\" rule is explicitly added to the end of the list.",
- "response": {
- "$ref": "BatchUpdateIngressRulesResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the Firewall collection to set. Example: apps/myapp/firewall/ingressRules.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/apps/{appsId}/firewall/ingressRules:batchUpdate"
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "appsId",
- "ingressRulesId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the Firewall resource to delete. Example: apps/myapp/firewall/ingressRules/100.",
- "type": "string",
- "required": true
- },
- "ingressRulesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "id": "appengine.apps.firewall.ingressRules.delete",
- "path": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "description": "Deletes the specified firewall rule."
- },
- "list": {
- "description": "Lists the firewall rules of an application.",
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "ListIngressRulesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Maximum results to return per page.",
- "type": "integer"
- },
- "matchingAddress": {
- "location": "query",
- "description": "A valid IP Address. If set, only rules matching this address will be returned. The first returned rule will be the rule that fires on requests from this IP.",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "appsId": {
- "description": "Part of `parent`. Name of the Firewall collection to retrieve. Example: apps/myapp/firewall/ingressRules.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/apps/{appsId}/firewall/ingressRules",
- "path": "v1/apps/{appsId}/firewall/ingressRules",
- "id": "appengine.apps.firewall.ingressRules.list"
- },
- "create": {
- "flatPath": "v1/apps/{appsId}/firewall/ingressRules",
- "id": "appengine.apps.firewall.ingressRules.create",
- "path": "v1/apps/{appsId}/firewall/ingressRules",
- "description": "Creates a firewall rule for the application.",
- "request": {
- "$ref": "FirewallRule"
- },
- "response": {
- "$ref": "FirewallRule"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Firewall collection in which to create a new rule. Example: apps/myapp/firewall/ingressRules.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- }
- }
- }
- }
- }
- }
- },
- "parameters": {
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- },
- "alt": {
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
- },
- "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"
- }
- }
+ "batchPath": "batch"
}
diff --git a/appengine/v1alpha/appengine-api.json b/appengine/v1alpha/appengine-api.json
index 46616cf..f5b1c7f 100644
--- a/appengine/v1alpha/appengine-api.json
+++ b/appengine/v1alpha/appengine-api.json
@@ -1,8 +1,4 @@
{
- "kind": "discovery#restDescription",
- "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.",
- "servicePath": "",
- "rootUrl": "https://appengine.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "appengine",
@@ -16,126 +12,6 @@
"resources": {
"apps": {
"resources": {
- "authorizedDomains": {
- "methods": {
- "list": {
- "path": "v1alpha/apps/{appsId}/authorizedDomains",
- "id": "appengine.apps.authorizedDomains.list",
- "description": "Lists all domains the user is authorized to administer.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListAuthorizedDomainsResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "appsId": {
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "pageSize": {
- "format": "int32",
- "description": "Maximum results to return per page.",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1alpha/apps/{appsId}/authorizedDomains"
- }
- }
- },
- "operations": {
- "methods": {
- "get": {
- "flatPath": "v1alpha/apps/{appsId}/operations/{operationsId}",
- "path": "v1alpha/apps/{appsId}/operations/{operationsId}",
- "id": "appengine.apps.operations.get",
- "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId",
- "operationsId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. The name of the operation resource.",
- "type": "string",
- "required": true
- },
- "operationsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- },
- "list": {
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "pageSize": {
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. The name of the operation's parent resource.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1alpha/apps/{appsId}/operations",
- "id": "appengine.apps.operations.list",
- "path": "v1alpha/apps/{appsId}/operations",
- "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id."
- }
- }
- },
"locations": {
"methods": {
"get": {
@@ -151,59 +27,56 @@
"locationsId"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"parameters": {
- "locationsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
"appsId": {
"description": "Part of `name`. Resource name for the location.",
"type": "string",
"required": true,
"location": "path"
+ },
+ "locationsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
}
- }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
},
"list": {
- "path": "v1alpha/apps/{appsId}/locations",
- "id": "appengine.apps.locations.list",
- "description": "Lists information about the supported locations for this service.",
"httpMethod": "GET",
- "parameterOrder": [
- "appsId"
- ],
"response": {
"$ref": "ListLocationsResponse"
},
+ "parameterOrder": [
+ "appsId"
+ ],
"parameters": {
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
+ },
"pageToken": {
"description": "The standard list page token.",
"type": "string",
"location": "query"
},
"appsId": {
+ "location": "path",
"description": "Part of `name`. The resource that owns the locations collection, if applicable.",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
},
"pageSize": {
+ "location": "query",
"format": "int32",
"description": "The standard list page size.",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
+ "type": "integer"
}
},
"scopes": [
@@ -211,50 +84,23 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
- "flatPath": "v1alpha/apps/{appsId}/locations"
+ "flatPath": "v1alpha/apps/{appsId}/locations",
+ "path": "v1alpha/apps/{appsId}/locations",
+ "id": "appengine.apps.locations.list",
+ "description": "Lists information about the supported locations for this service."
}
}
},
"domainMappings": {
"methods": {
- "delete": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "domainMappingsId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.",
- "type": "string",
- "required": true
- },
- "domainMappingsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
- "id": "appengine.apps.domainMappings.delete",
- "path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
- "description": "Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource."
- },
"patch": {
+ "flatPath": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
"id": "appengine.apps.domainMappings.patch",
"path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
- "description": "Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.",
"request": {
"$ref": "DomainMapping"
},
+ "description": "Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.",
"response": {
"$ref": "Operation"
},
@@ -263,18 +109,21 @@
"domainMappingsId"
],
"httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"appsId": {
+ "location": "path",
"description": "Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
},
"domainMappingsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
"type": "string",
"required": true,
- "location": "path"
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`."
},
"noManagedCertificate": {
"location": "query",
@@ -282,16 +131,12 @@
"type": "boolean"
},
"updateMask": {
- "format": "google-fieldmask",
- "description": "Standard field mask for the set of fields to be updated.",
"type": "string",
- "location": "query"
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Standard field mask for the set of fields to be updated."
}
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}"
+ }
},
"get": {
"description": "Gets the specified domain mapping.",
@@ -303,11 +148,6 @@
"domainMappingsId"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"parameters": {
"appsId": {
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.",
@@ -316,20 +156,22 @@
"location": "path"
},
"domainMappingsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`."
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"flatPath": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
"id": "appengine.apps.domainMappings.get",
"path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}"
},
"list": {
- "id": "appengine.apps.domainMappings.list",
- "path": "v1alpha/apps/{appsId}/domainMappings",
- "description": "Lists the domain mappings on an application.",
"response": {
"$ref": "ListDomainMappingsResponse"
},
@@ -361,9 +203,19 @@
"location": "query"
}
},
- "flatPath": "v1alpha/apps/{appsId}/domainMappings"
+ "flatPath": "v1alpha/apps/{appsId}/domainMappings",
+ "id": "appengine.apps.domainMappings.list",
+ "path": "v1alpha/apps/{appsId}/domainMappings",
+ "description": "Lists the domain mappings on an application."
},
"create": {
+ "flatPath": "v1alpha/apps/{appsId}/domainMappings",
+ "path": "v1alpha/apps/{appsId}/domainMappings",
+ "id": "appengine.apps.domainMappings.create",
+ "description": "Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.",
+ "request": {
+ "$ref": "DomainMapping"
+ },
"httpMethod": "POST",
"parameterOrder": [
"appsId"
@@ -372,54 +224,79 @@
"$ref": "Operation"
},
"parameters": {
+ "noManagedCertificate": {
+ "location": "query",
+ "description": "Whether a managed certificate should be provided by App Engine. If true, a certificate ID must be manaually set in the DomainMapping resource to configure SSL for this domain. If false, a managed certificate will be provisioned and a certificate ID will be automatically populated.",
+ "type": "boolean"
+ },
"appsId": {
+ "location": "path",
"description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
"type": "string",
- "required": true,
- "location": "path"
- },
- "noManagedCertificate": {
- "description": "Whether a managed certificate should be provided by App Engine. If true, a certificate ID must be manaually set in the DomainMapping resource to configure SSL for this domain. If false, a managed certificate will be provisioned and a certificate ID will be automatically populated.",
- "type": "boolean",
- "location": "query"
+ "required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "delete": {
+ "flatPath": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "id": "appengine.apps.domainMappings.delete",
+ "description": "Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "domainMappingsId"
],
- "flatPath": "v1alpha/apps/{appsId}/domainMappings",
- "path": "v1alpha/apps/{appsId}/domainMappings",
- "id": "appengine.apps.domainMappings.create",
- "description": "Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.",
- "request": {
- "$ref": "DomainMapping"
- }
+ "parameters": {
+ "domainMappingsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
}
}
},
"authorizedCertificates": {
"methods": {
"delete": {
+ "description": "Deletes the specified SSL certificate.",
"httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
"parameterOrder": [
"appsId",
"authorizedCertificatesId"
],
+ "response": {
+ "$ref": "Empty"
+ },
"parameters": {
"appsId": {
- "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.",
"type": "string",
"required": true,
- "location": "path"
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345."
},
"authorizedCertificatesId": {
+ "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
}
},
"scopes": [
@@ -427,10 +304,13 @@
],
"flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
"path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.delete",
- "description": "Deletes the specified SSL certificate."
+ "id": "appengine.apps.authorizedCertificates.delete"
},
"patch": {
+ "description": "Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.",
+ "request": {
+ "$ref": "AuthorizedCertificate"
+ },
"response": {
"$ref": "AuthorizedCertificate"
},
@@ -439,15 +319,12 @@
"authorizedCertificatesId"
],
"httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"authorizedCertificatesId": {
- "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
},
"updateMask": {
"format": "google-fieldmask",
@@ -456,19 +333,18 @@
"location": "query"
},
"appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.",
"type": "string",
"required": true,
- "location": "path"
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345."
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
"id": "appengine.apps.authorizedCertificates.patch",
- "path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "request": {
- "$ref": "AuthorizedCertificate"
- },
- "description": "Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated."
+ "path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}"
},
"get": {
"response": {
@@ -479,12 +355,16 @@
"authorizedCertificatesId"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"parameters": {
+ "view": {
+ "location": "query",
+ "enum": [
+ "BASIC_CERTIFICATE",
+ "FULL_CERTIFICATE"
+ ],
+ "description": "Controls the set of fields returned in the GET response.",
+ "type": "string"
+ },
"authorizedCertificatesId": {
"description": "Part of `name`. See documentation of `appsId`.",
"type": "string",
@@ -496,23 +376,22 @@
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.",
"type": "string",
"required": true
- },
- "view": {
- "description": "Controls the set of fields returned in the GET response.",
- "type": "string",
- "location": "query",
- "enum": [
- "BASIC_CERTIFICATE",
- "FULL_CERTIFICATE"
- ]
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
"id": "appengine.apps.authorizedCertificates.get",
"path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
"description": "Gets the specified SSL certificate."
},
"list": {
+ "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates",
+ "id": "appengine.apps.authorizedCertificates.list",
+ "path": "v1alpha/apps/{appsId}/authorizedCertificates",
"description": "Lists all SSL certificates the user is authorized to administer.",
"response": {
"$ref": "ListAuthorizedCertificatesResponse"
@@ -553,37 +432,154 @@
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates",
- "id": "appengine.apps.authorizedCertificates.list",
- "path": "v1alpha/apps/{appsId}/authorizedCertificates"
+ ]
},
"create": {
- "id": "appengine.apps.authorizedCertificates.create",
- "path": "v1alpha/apps/{appsId}/authorizedCertificates",
- "request": {
- "$ref": "AuthorizedCertificate"
- },
- "description": "Uploads the specified SSL certificate.",
- "response": {
- "$ref": "AuthorizedCertificate"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"appsId"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "AuthorizedCertificate"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"appsId": {
+ "type": "string",
+ "required": true,
"location": "path",
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp."
+ }
+ },
+ "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates",
+ "path": "v1alpha/apps/{appsId}/authorizedCertificates",
+ "id": "appengine.apps.authorizedCertificates.create",
+ "request": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "description": "Uploads the specified SSL certificate."
+ }
+ }
+ },
+ "authorizedDomains": {
+ "methods": {
+ "list": {
+ "description": "Lists all domains the user is authorized to administer.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "response": {
+ "$ref": "ListAuthorizedDomainsResponse"
+ },
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "appsId": {
"description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
"type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Maximum results to return per page.",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1alpha/apps/{appsId}/authorizedDomains",
+ "path": "v1alpha/apps/{appsId}/authorizedDomains",
+ "id": "appengine.apps.authorizedDomains.list"
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "get": {
+ "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "operationsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Part of `name`. The name of the operation resource."
+ },
+ "operationsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
"required": true
}
},
- "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates"
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1alpha/apps/{appsId}/operations/{operationsId}",
+ "path": "v1alpha/apps/{appsId}/operations/{operationsId}",
+ "id": "appengine.apps.operations.get"
+ },
+ "list": {
+ "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "appsId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Part of `name`. The name of the operation's parent resource."
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer"
+ },
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "The standard list filter."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1alpha/apps/{appsId}/operations",
+ "path": "v1alpha/apps/{appsId}/operations",
+ "id": "appengine.apps.operations.list"
}
}
}
@@ -591,31 +587,10 @@
}
},
"parameters": {
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
"upload_protocol": {
+ "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"prettyPrint": {
"location": "query",
@@ -634,52 +609,196 @@
"type": "string"
},
"callback": {
+ "location": "query",
"description": "JSONP",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
- "type": "string"
+ "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",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
"location": "query"
},
"key": {
- "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "type": "string",
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
"type": "string"
},
- "access_token": {
+ "bearer_token": {
"location": "query",
- "description": "OAuth access token.",
+ "description": "OAuth bearer token.",
"type": "string"
}
},
"schemas": {
+ "ListDomainMappingsResponse": {
+ "type": "object",
+ "properties": {
+ "domainMappings": {
+ "description": "The domain mappings for the application.",
+ "items": {
+ "$ref": "DomainMapping"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListDomainMappingsResponse",
+ "description": "Response message for DomainMappings.ListDomainMappings."
+ },
+ "OperationMetadataV1Alpha": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
+ "properties": {
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "insertTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation was created.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation completed.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadataV1Alpha"
+ },
+ "OperationMetadataExperimental": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
+ "properties": {
+ "endTime": {
+ "type": "string",
+ "format": "google-datetime",
+ "description": "Time that this operation completed.@OutputOnly"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/customDomains/example.com.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.experimental.CustomDomains.CreateCustomDomain.@OutputOnly",
+ "type": "string"
+ },
+ "insertTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation was created.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadataExperimental"
+ },
+ "AuthorizedDomain": {
+ "description": "A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central (https://www.google.com/webmasters/verification/home).",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Fully qualified domain name of the domain authorized for use. Example: example.com.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "AuthorizedDomain"
+ },
+ "ListAuthorizedDomainsResponse": {
+ "description": "Response message for AuthorizedDomains.ListAuthorizedDomains.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "domains": {
+ "description": "The authorized domains belonging to the user.",
+ "items": {
+ "$ref": "AuthorizedDomain"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListAuthorizedDomainsResponse"
+ },
"Status": {
+ "id": "Status",
+ "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
"properties": {
"message": {
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
@@ -701,62 +820,24 @@
"description": "The status code, which should be an enum value of google.rpc.Code.",
"type": "integer"
}
- },
- "id": "Status",
- "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
- "type": "object"
- },
- "ListAuthorizedDomainsResponse": {
- "description": "Response message for AuthorizedDomains.ListAuthorizedDomains.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "domains": {
- "description": "The authorized domains belonging to the user.",
- "items": {
- "$ref": "AuthorizedDomain"
- },
- "type": "array"
- }
- },
- "id": "ListAuthorizedDomainsResponse"
- },
- "AuthorizedDomain": {
- "properties": {
- "name": {
- "description": "Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly",
- "type": "string"
- },
- "id": {
- "description": "Fully qualified domain name of the domain authorized for use. Example: example.com.",
- "type": "string"
- }
- },
- "id": "AuthorizedDomain",
- "description": "A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central (https://www.google.com/webmasters/verification/home).",
- "type": "object"
+ }
},
"LocationMetadata": {
- "description": "Metadata for the given google.cloud.location.Location.",
- "type": "object",
"properties": {
"flexibleEnvironmentAvailable": {
- "description": "App Engine Flexible Environment is available in the given location.@OutputOnly",
- "type": "boolean"
+ "type": "boolean",
+ "description": "App Engine Flexible Environment is available in the given location.@OutputOnly"
},
"standardEnvironmentAvailable": {
"description": "App Engine Standard Environment is available in the given location.@OutputOnly",
"type": "boolean"
}
},
- "id": "LocationMetadata"
+ "id": "LocationMetadata",
+ "description": "Metadata for the given google.cloud.location.Location.",
+ "type": "object"
},
"DomainMapping": {
- "description": "A domain serving an App Engine application.",
- "type": "object",
"properties": {
"sslSettings": {
"description": "SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.",
@@ -778,39 +859,20 @@
"type": "string"
}
},
- "id": "DomainMapping"
+ "id": "DomainMapping",
+ "description": "A domain serving an App Engine application.",
+ "type": "object"
},
"Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
"type": "object",
"properties": {},
- "id": "Empty"
+ "id": "Empty",
+ "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}."
},
"OperationMetadataV1Beta": {
"description": "Metadata for the given google.longrunning.Operation.",
"type": "object",
"properties": {
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "Time that this operation completed.@OutputOnly",
- "type": "string"
- },
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "insertTime": {
- "format": "google-datetime",
- "description": "Time that this operation was created.@OutputOnly",
- "type": "string"
- },
"user": {
"description": "User who requested this operation.@OutputOnly",
"type": "string"
@@ -822,12 +884,32 @@
"ephemeralMessage": {
"description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
"type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation completed.@OutputOnly",
+ "type": "string"
+ },
+ "insertTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation was created.@OutputOnly",
+ "type": "string"
+ },
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
},
"id": "OperationMetadataV1Beta"
},
"Location": {
- "description": "A resource that represents Google Cloud Platform location.",
"type": "object",
"properties": {
"labels": {
@@ -846,20 +928,25 @@
"type": "string"
},
"metadata": {
+ "description": "Service-specific metadata. For example the available capacity at the given location.",
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- },
- "description": "Service-specific metadata. For example the available capacity at the given location.",
- "type": "object"
+ }
}
},
- "id": "Location"
+ "id": "Location",
+ "description": "A resource that represents Google Cloud Platform location."
},
"AuthorizedCertificate": {
"description": "An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.",
"type": "object",
"properties": {
+ "name": {
+ "description": "Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly",
+ "type": "string"
+ },
"domainMappingsCount": {
"format": "int32",
"description": "Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly",
@@ -880,14 +967,14 @@
"description": "The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.",
"type": "string"
},
- "certificateRawData": {
- "$ref": "CertificateRawData",
- "description": "The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority."
- },
"managedCertificate": {
"$ref": "ManagedCertificate",
"description": "Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly"
},
+ "certificateRawData": {
+ "$ref": "CertificateRawData",
+ "description": "The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority."
+ },
"visibleDomainMappings": {
"description": "The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly",
"items": {
@@ -899,15 +986,12 @@
"format": "google-datetime",
"description": "The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly",
"type": "string"
- },
- "name": {
- "description": "Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly",
- "type": "string"
}
},
"id": "AuthorizedCertificate"
},
"ResourceRecord": {
+ "id": "ResourceRecord",
"description": "A DNS resource record.",
"type": "object",
"properties": {
@@ -916,6 +1000,8 @@
"type": "string"
},
"type": {
+ "description": "Resource record type. Example: AAAA.",
+ "type": "string",
"enumDescriptions": [
"An A resource record. Data is an IPv4 address.",
"An AAAA resource record. Data is an IPv6 address.",
@@ -925,16 +1011,13 @@
"A",
"AAAA",
"CNAME"
- ],
- "description": "Resource record type. Example: AAAA.",
- "type": "string"
+ ]
},
"rrdata": {
"description": "Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).",
"type": "string"
}
- },
- "id": "ResourceRecord"
+ }
},
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
@@ -955,7 +1038,21 @@
"id": "ListOperationsResponse"
},
"OperationMetadata": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
"properties": {
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
"endTime": {
"format": "google-datetime",
"description": "Timestamp that this operation completed.@OutputOnly",
@@ -969,25 +1066,12 @@
"format": "google-datetime",
"description": "Timestamp that this operation was created.@OutputOnly",
"type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
- "type": "string"
}
},
- "id": "OperationMetadata",
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object"
+ "id": "OperationMetadata"
},
"ListAuthorizedCertificatesResponse": {
+ "id": "ListAuthorizedCertificatesResponse",
"description": "Response message for AuthorizedCertificates.ListAuthorizedCertificates.",
"type": "object",
"properties": {
@@ -1002,19 +1086,12 @@
},
"type": "array"
}
- },
- "id": "ListAuthorizedCertificatesResponse"
+ }
},
"OperationMetadataV1Beta5": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
"properties": {
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
"method": {
"description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
"type": "string"
@@ -1028,11 +1105,17 @@
"format": "google-datetime",
"description": "Timestamp that this operation completed.@OutputOnly",
"type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
}
},
- "id": "OperationMetadataV1Beta5",
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object"
+ "id": "OperationMetadataV1Beta5"
},
"ListLocationsResponse": {
"description": "The response message for Locations.ListLocations.",
@@ -1057,9 +1140,9 @@
"type": "object",
"properties": {
"lastRenewalTime": {
+ "type": "string",
"format": "google-datetime",
- "description": "Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly",
- "type": "string"
+ "description": "Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly"
},
"status": {
"enumDescriptions": [
@@ -1085,6 +1168,8 @@
"id": "ManagedCertificate"
},
"CertificateRawData": {
+ "description": "An SSL certificate obtained from a certificate authority.",
+ "type": "object",
"properties": {
"privateKey": {
"description": "Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: \u003cpre\u003e -----BEGIN RSA PRIVATE KEY----- \u003cunencrypted_key_value\u003e -----END RSA PRIVATE KEY----- \u003c/pre\u003e @InputOnly",
@@ -1095,29 +1180,18 @@
"type": "string"
}
},
- "id": "CertificateRawData",
- "description": "An SSL certificate obtained from a certificate authority.",
- "type": "object"
- },
- "SslSettings": {
- "description": "SSL configuration for a DomainMapping resource.",
- "type": "object",
- "properties": {
- "isManagedCertificate": {
- "description": "Whether the mapped certificate is an App Engine managed certificate. Managed certificates are created by default with a domain mapping. To opt out, specify no_managed_certificate on a CREATE or UPDATE request.@OutputOnly",
- "type": "boolean"
- },
- "certificateId": {
- "description": "ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify no_managed_certificate on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.",
- "type": "string"
- }
- },
- "id": "SslSettings"
+ "id": "CertificateRawData"
},
"OperationMetadataV1": {
+ "id": "OperationMetadataV1",
"description": "Metadata for the given google.longrunning.Operation.",
"type": "object",
"properties": {
+ "insertTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation was created.@OutputOnly",
+ "type": "string"
+ },
"warning": {
"description": "Durable messages that persist on every operation poll. @OutputOnly",
"items": {
@@ -1125,19 +1199,14 @@
},
"type": "array"
},
- "insertTime": {
- "format": "google-datetime",
- "description": "Time that this operation was created.@OutputOnly",
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
"type": "string"
},
"user": {
"description": "User who requested this operation.@OutputOnly",
"type": "string"
},
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
"ephemeralMessage": {
"description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
"type": "string"
@@ -1151,33 +1220,27 @@
"description": "Time that this operation completed.@OutputOnly",
"type": "string"
}
- },
- "id": "OperationMetadataV1"
+ }
+ },
+ "SslSettings": {
+ "id": "SslSettings",
+ "description": "SSL configuration for a DomainMapping resource.",
+ "type": "object",
+ "properties": {
+ "isManagedCertificate": {
+ "description": "Whether the mapped certificate is an App Engine managed certificate. Managed certificates are created by default with a domain mapping. To opt out, specify no_managed_certificate on a CREATE or UPDATE request.@OutputOnly",
+ "type": "boolean"
+ },
+ "certificateId": {
+ "description": "ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify no_managed_certificate on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.",
+ "type": "string"
+ }
+ }
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a network API call.",
"type": "object",
"properties": {
- "done": {
- "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
- "type": "boolean"
- },
- "response": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.",
- "type": "object"
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.",
- "type": "string"
- },
- "error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure or cancellation."
- },
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
@@ -1185,101 +1248,34 @@
},
"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
"type": "object"
+ },
+ "done": {
+ "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
+ "type": "boolean"
+ },
+ "response": {
+ "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.",
+ "type": "string"
+ },
+ "error": {
+ "description": "The error result of the operation in case of failure or cancellation.",
+ "$ref": "Status"
}
},
"id": "Operation"
- },
- "ListDomainMappingsResponse": {
- "description": "Response message for DomainMappings.ListDomainMappings.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "domainMappings": {
- "description": "The domain mappings for the application.",
- "items": {
- "$ref": "DomainMapping"
- },
- "type": "array"
- }
- },
- "id": "ListDomainMappingsResponse"
- },
- "OperationMetadataExperimental": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "insertTime": {
- "format": "google-datetime",
- "description": "Time that this operation was created.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "Time that this operation completed.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/customDomains/example.com.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.experimental.CustomDomains.CreateCustomDomain.@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadataExperimental"
- },
- "OperationMetadataV1Alpha": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "Time that this operation completed.@OutputOnly",
- "type": "string"
- },
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "insertTime": {
- "format": "google-datetime",
- "description": "Time that this operation was created.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1Alpha"
}
},
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"protocol": "rest",
"version": "v1alpha",
@@ -1287,16 +1283,20 @@
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/appengine.admin": {
- "description": "View and manage your applications deployed on Google App Engine"
- },
"https://www.googleapis.com/auth/cloud-platform.read-only": {
"description": "View your data across Google Cloud Platform services"
},
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/appengine.admin": {
+ "description": "View and manage your applications deployed on Google App Engine"
}
}
}
- }
+ },
+ "servicePath": "",
+ "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.",
+ "kind": "discovery#restDescription",
+ "rootUrl": "https://appengine.googleapis.com/"
}
diff --git a/appengine/v1beta/appengine-api.json b/appengine/v1beta/appengine-api.json
index c5fca75..4d4a68f 100644
--- a/appengine/v1beta/appengine-api.json
+++ b/appengine/v1beta/appengine-api.json
@@ -1,148 +1,1577 @@
{
- "schemas": {
- "ManagedCertificate": {
- "description": "A certificate managed by App Engine.",
- "type": "object",
- "properties": {
- "status": {
- "enumDescriptions": [
- "",
- "Certificate was successfully obtained and inserted into the serving system.",
- "Certificate is under active attempts to acquire or renew.",
- "Most recent renewal failed due to an invalid DNS setup and will be retried. Renewal attempts will continue to fail until the certificate domain's DNS configuration is fixed. The last successfully provisioned certificate may still be serving.",
- "All renewal attempts have been exhausted, likely due to an invalid DNS setup."
- ],
- "enum": [
- "MANAGEMENT_STATUS_UNSPECIFIED",
- "OK",
- "PENDING",
- "FAILED_RETRYING_NOT_VISIBLE",
- "FAILED_PERMANENT"
- ],
- "description": "Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly",
- "type": "string"
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/appengine.admin": {
+ "description": "View and manage your applications deployed on Google App Engine"
},
- "lastRenewalTime": {
- "format": "google-datetime",
- "description": "Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly",
- "type": "string"
+ "https://www.googleapis.com/auth/cloud-platform.read-only": {
+ "description": "View your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
}
- },
- "id": "ManagedCertificate"
- },
- "ListInstancesResponse": {
- "description": "Response message for Instances.ListInstances.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "instances": {
- "description": "The instances belonging to the requested version.",
- "items": {
- "$ref": "Instance"
+ }
+ }
+ },
+ "kind": "discovery#restDescription",
+ "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.",
+ "servicePath": "",
+ "rootUrl": "https://appengine.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "appengine",
+ "batchPath": "batch",
+ "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
+ "id": "appengine:v1beta",
+ "revision": "20170929",
+ "title": "Google App Engine Admin API",
+ "ownerName": "Google",
+ "discoveryVersion": "v1",
+ "resources": {
+ "apps": {
+ "methods": {
+ "create": {
+ "flatPath": "v1beta/apps",
+ "id": "appengine.apps.create",
+ "path": "v1beta/apps",
+ "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).",
+ "request": {
+ "$ref": "Application"
},
- "type": "array"
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "repair": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the application to repair. Example: apps/myapp",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}:repair",
+ "id": "appengine.apps.repair",
+ "path": "v1beta/apps/{appsId}:repair",
+ "request": {
+ "$ref": "RepairApplicationRequest"
+ },
+ "description": "Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account."
+ },
+ "patch": {
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "Standard field mask for the set of fields to be updated.",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta/apps/{appsId}",
+ "path": "v1beta/apps/{appsId}",
+ "id": "appengine.apps.patch",
+ "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain - Google authentication domain for controlling user access to the application.\ndefault_cookie_expiration - Cookie expiration policy for the application.",
+ "request": {
+ "$ref": "Application"
+ }
+ },
+ "get": {
+ "description": "Gets information about an application.",
+ "response": {
+ "$ref": "Application"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the Application resource to get. Example: apps/myapp.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}",
+ "id": "appengine.apps.get",
+ "path": "v1beta/apps/{appsId}"
}
},
- "id": "ListInstancesResponse"
- },
- "ListDomainMappingsResponse": {
- "description": "Response message for DomainMappings.ListDomainMappings.",
- "type": "object",
- "properties": {
+ "resources": {
"domainMappings": {
- "description": "The domain mappings for the application.",
- "items": {
- "$ref": "DomainMapping"
+ "methods": {
+ "create": {
+ "description": "Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.",
+ "request": {
+ "$ref": "DomainMapping"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/domainMappings",
+ "id": "appengine.apps.domainMappings.create",
+ "path": "v1beta/apps/{appsId}/domainMappings"
+ },
+ "delete": {
+ "description": "Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "domainMappingsId"
+ ],
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.",
+ "type": "string",
+ "required": true
+ },
+ "domainMappingsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "id": "appengine.apps.domainMappings.delete"
+ },
+ "patch": {
+ "flatPath": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "id": "appengine.apps.domainMappings.patch",
+ "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "request": {
+ "$ref": "DomainMapping"
+ },
+ "description": "Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "domainMappingsId"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "domainMappingsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "updateMask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Standard field mask for the set of fields to be updated.",
+ "type": "string"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ }
+ },
+ "get": {
+ "response": {
+ "$ref": "DomainMapping"
+ },
+ "parameterOrder": [
+ "appsId",
+ "domainMappingsId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "domainMappingsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "id": "appengine.apps.domainMappings.get",
+ "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "description": "Gets the specified domain mapping."
+ },
+ "list": {
+ "path": "v1beta/apps/{appsId}/domainMappings",
+ "id": "appengine.apps.domainMappings.list",
+ "description": "Lists the domain mappings on an application.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListDomainMappingsResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "type": "string",
+ "required": true
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Maximum results to return per page.",
+ "type": "integer"
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/domainMappings"
+ }
+ }
+ },
+ "firewall": {
+ "resources": {
+ "ingressRules": {
+ "methods": {
+ "patch": {
+ "request": {
+ "$ref": "FirewallRule"
+ },
+ "description": "Updates the specified firewall rule.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "appsId",
+ "ingressRulesId"
+ ],
+ "response": {
+ "$ref": "FirewallRule"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "Standard field mask for the set of fields to be updated.",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the Firewall resource to update. Example: apps/myapp/firewall/ingressRules/100.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "ingressRulesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "id": "appengine.apps.firewall.ingressRules.patch"
+ },
+ "get": {
+ "response": {
+ "$ref": "FirewallRule"
+ },
+ "parameterOrder": [
+ "appsId",
+ "ingressRulesId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the Firewall resource to retrieve. Example: apps/myapp/firewall/ingressRules/100.",
+ "type": "string",
+ "required": true
+ },
+ "ingressRulesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "id": "appengine.apps.firewall.ingressRules.get",
+ "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "description": "Gets the specified firewall rule."
+ },
+ "batchUpdate": {
+ "response": {
+ "$ref": "BatchUpdateIngressRulesResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the Firewall collection to set. Example: apps/myapp/firewall/ingressRules.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules:batchUpdate",
+ "id": "appengine.apps.firewall.ingressRules.batchUpdate",
+ "path": "v1beta/apps/{appsId}/firewall/ingressRules:batchUpdate",
+ "description": "Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the rules of an existing firewall with the new rules.If the final rule does not match traffic with the '*' wildcard IP range, then an \"allow all\" rule is explicitly added to the end of the list.",
+ "request": {
+ "$ref": "BatchUpdateIngressRulesRequest"
+ }
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "appsId",
+ "ingressRulesId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the Firewall resource to delete. Example: apps/myapp/firewall/ingressRules/100.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "ingressRulesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "id": "appengine.apps.firewall.ingressRules.delete",
+ "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "description": "Deletes the specified firewall rule."
+ },
+ "list": {
+ "path": "v1beta/apps/{appsId}/firewall/ingressRules",
+ "id": "appengine.apps.firewall.ingressRules.list",
+ "description": "Lists the firewall rules of an application.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListIngressRulesResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "pageSize": {
+ "format": "int32",
+ "description": "Maximum results to return per page.",
+ "type": "integer",
+ "location": "query"
+ },
+ "matchingAddress": {
+ "location": "query",
+ "description": "A valid IP Address. If set, only rules matching this address will be returned. The first returned rule will be the rule that fires on requests from this IP.",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "appsId": {
+ "description": "Part of `parent`. Name of the Firewall collection to retrieve. Example: apps/myapp/firewall/ingressRules.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules"
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "response": {
+ "$ref": "FirewallRule"
+ },
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `parent`. Name of the parent Firewall collection in which to create a new rule. Example: apps/myapp/firewall/ingressRules.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules",
+ "path": "v1beta/apps/{appsId}/firewall/ingressRules",
+ "id": "appengine.apps.firewall.ingressRules.create",
+ "description": "Creates a firewall rule for the application.",
+ "request": {
+ "$ref": "FirewallRule"
+ }
+ }
+ }
+ }
+ }
+ },
+ "locations": {
+ "methods": {
+ "get": {
+ "id": "appengine.apps.locations.get",
+ "path": "v1beta/apps/{appsId}/locations/{locationsId}",
+ "description": "Get information about a location.",
+ "response": {
+ "$ref": "Location"
+ },
+ "parameterOrder": [
+ "appsId",
+ "locationsId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "locationsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Resource name for the location.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/locations/{locationsId}"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "parameters": {
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "appsId": {
+ "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/locations",
+ "path": "v1beta/apps/{appsId}/locations",
+ "id": "appengine.apps.locations.list",
+ "description": "Lists information about the supported locations for this service."
+ }
+ }
+ },
+ "authorizedCertificates": {
+ "methods": {
+ "delete": {
+ "description": "Deletes the specified SSL certificate.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "appsId",
+ "authorizedCertificatesId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.",
+ "type": "string",
+ "required": true
+ },
+ "authorizedCertificatesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "id": "appengine.apps.authorizedCertificates.delete",
+ "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}"
+ },
+ "patch": {
+ "flatPath": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "id": "appengine.apps.authorizedCertificates.patch",
+ "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "request": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "description": "Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.",
+ "response": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "parameterOrder": [
+ "appsId",
+ "authorizedCertificatesId"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "authorizedCertificatesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ }
+ }
+ },
+ "get": {
+ "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "id": "appengine.apps.authorizedCertificates.get",
+ "description": "Gets the specified SSL certificate.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "parameterOrder": [
+ "appsId",
+ "authorizedCertificatesId"
+ ],
+ "parameters": {
+ "view": {
+ "location": "query",
+ "enum": [
+ "BASIC_CERTIFICATE",
+ "FULL_CERTIFICATE"
+ ],
+ "description": "Controls the set of fields returned in the GET response.",
+ "type": "string"
+ },
+ "authorizedCertificatesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}"
+ },
+ "list": {
+ "path": "v1beta/apps/{appsId}/authorizedCertificates",
+ "id": "appengine.apps.authorizedCertificates.list",
+ "description": "Lists all SSL certificates the user is authorized to administer.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "response": {
+ "$ref": "ListAuthorizedCertificatesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "type": "string",
+ "required": true
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Maximum results to return per page.",
+ "type": "integer"
+ },
+ "view": {
+ "description": "Controls the set of fields returned in the LIST response.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "BASIC_CERTIFICATE",
+ "FULL_CERTIFICATE"
+ ]
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/authorizedCertificates"
+ },
+ "create": {
+ "flatPath": "v1beta/apps/{appsId}/authorizedCertificates",
+ "path": "v1beta/apps/{appsId}/authorizedCertificates",
+ "id": "appengine.apps.authorizedCertificates.create",
+ "description": "Uploads the specified SSL certificate.",
+ "request": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "response": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ },
+ "services": {
+ "methods": {
+ "delete": {
+ "path": "v1beta/apps/{appsId}/services/{servicesId}",
+ "id": "appengine.apps.services.delete",
+ "description": "Deletes the specified service and all enclosed versions.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}"
+ },
+ "patch": {
+ "description": "Updates the configuration of the specified service.",
+ "request": {
+ "$ref": "Service"
+ },
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "Standard field mask for the set of fields to be updated.",
+ "type": "string",
+ "location": "query"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.",
+ "type": "string",
+ "required": true
+ },
+ "migrateTraffic": {
+ "location": "query",
+ "description": "Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services#shardby) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).",
+ "type": "boolean"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}",
+ "id": "appengine.apps.services.patch"
+ },
+ "get": {
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}",
+ "id": "appengine.apps.services.get",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}",
+ "description": "Gets the current configuration of the specified service.",
+ "response": {
+ "$ref": "Service"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "response": {
+ "$ref": "ListServicesResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Maximum results to return per page.",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/services",
+ "id": "appengine.apps.services.list",
+ "path": "v1beta/apps/{appsId}/services",
+ "description": "Lists all the services in the application."
+ }
},
- "type": "array"
+ "resources": {
+ "versions": {
+ "methods": {
+ "delete": {
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "id": "appengine.apps.services.versions.delete",
+ "description": "Deletes an existing Version resource.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ }
+ },
+ "patch": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "Standard field mask for the set of fields to be updated.",
+ "type": "string",
+ "location": "query"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "id": "appengine.apps.services.versions.patch",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "request": {
+ "$ref": "Version"
+ },
+ "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment."
+ },
+ "get": {
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "id": "appengine.apps.services.versions.get",
+ "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "response": {
+ "$ref": "Version"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "view": {
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "description": "Controls the set of fields returned in the Get response.",
+ "type": "string",
+ "location": "query"
+ },
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ }
+ }
+ },
+ "list": {
+ "description": "Lists the versions of a service.",
+ "response": {
+ "$ref": "ListVersionsResponse"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `parent`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Maximum results to return per page.",
+ "type": "integer",
+ "location": "query"
+ },
+ "view": {
+ "location": "query",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "description": "Controls the set of fields returned in the List response.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions",
+ "id": "appengine.apps.services.versions.list",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions"
+ },
+ "create": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "servicesId": {
+ "description": "Part of `parent`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions",
+ "id": "appengine.apps.services.versions.create",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions",
+ "description": "Deploys code and resource files to a new version.",
+ "request": {
+ "$ref": "Version"
+ }
+ }
+ },
+ "resources": {
+ "instances": {
+ "methods": {
+ "debug": {
+ "description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.",
+ "request": {
+ "$ref": "DebugInstanceRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "instancesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "id": "appengine.apps.services.versions.instances.debug"
+ },
+ "delete": {
+ "description": "Stops a running instance.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "instancesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "id": "appengine.apps.services.versions.instances.delete"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "response": {
+ "$ref": "Instance"
+ },
+ "parameters": {
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "instancesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "id": "appengine.apps.services.versions.instances.get",
+ "description": "Gets instance information."
+ },
+ "list": {
+ "response": {
+ "$ref": "ListInstancesResponse"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `parent`. Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1.",
+ "type": "string",
+ "required": true
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Maximum results to return per page.",
+ "type": "integer",
+ "location": "query"
+ },
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `parent`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "servicesId": {
+ "description": "Part of `parent`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
+ "id": "appengine.apps.services.versions.instances.list",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
+ "description": "Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list)."
+ }
+ }
+ }
+ }
+ }
+ }
},
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
+ "authorizedDomains": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListAuthorizedDomainsResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "type": "string",
+ "required": true
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Maximum results to return per page.",
+ "type": "integer"
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/authorizedDomains",
+ "id": "appengine.apps.authorizedDomains.list",
+ "path": "v1beta/apps/{appsId}/authorizedDomains",
+ "description": "Lists all domains the user is authorized to administer."
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "get": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "operationsId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "operationsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "description": "Part of `name`. The name of the operation resource.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/operations/{operationsId}",
+ "id": "appengine.apps.operations.get",
+ "path": "v1beta/apps/{appsId}/operations/{operationsId}",
+ "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service."
+ },
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. The name of the operation's parent resource.",
+ "type": "string",
+ "required": true
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer"
+ },
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/operations",
+ "path": "v1beta/apps/{appsId}/operations",
+ "id": "appengine.apps.operations.list",
+ "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id."
+ }
+ }
}
- },
- "id": "ListDomainMappingsResponse"
+ }
+ }
+ },
+ "parameters": {
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
},
- "OperationMetadataV1Alpha": {
- "properties": {
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "insertTime": {
- "format": "google-datetime",
- "description": "Time that this operation was created.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "Time that this operation completed.@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1Alpha",
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object"
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
},
- "UrlDispatchRule": {
- "description": "Rules to match an HTTP request and dispatch that request to a service.",
- "type": "object",
- "properties": {
- "service": {
- "description": "Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.",
- "type": "string"
- },
- "domain": {
- "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
- "type": "string"
- },
- "path": {
- "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.",
- "type": "string"
- }
- },
- "id": "UrlDispatchRule"
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
},
- "ListVersionsResponse": {
- "properties": {
- "versions": {
- "description": "The versions belonging to the requested service.",
- "items": {
- "$ref": "Version"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- }
- },
- "id": "ListVersionsResponse",
- "description": "Response message for Versions.ListVersions.",
- "type": "object"
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
},
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "alt": {
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "schemas": {
"ListAuthorizedDomainsResponse": {
"properties": {
"nextPageToken": {
@@ -161,38 +1590,6 @@
"description": "Response message for AuthorizedDomains.ListAuthorizedDomains.",
"type": "object"
},
- "DomainMapping": {
- "description": "A domain serving an App Engine application.",
- "type": "object",
- "properties": {
- "resourceRecords": {
- "description": "The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly",
- "items": {
- "$ref": "ResourceRecord"
- },
- "type": "array"
- },
- "id": {
- "description": "Relative name of the domain serving the application. Example: example.com.",
- "type": "string"
- },
- "sslSettings": {
- "$ref": "SslSettings",
- "description": "SSL configuration for this domain. If unconfigured, this domain will not serve with SSL."
- },
- "name": {
- "description": "Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly",
- "type": "string"
- }
- },
- "id": "DomainMapping"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
"ApiEndpointHandler": {
"description": "Uses Google Cloud Endpoints to handle requests.",
"type": "object",
@@ -204,13 +1601,58 @@
},
"id": "ApiEndpointHandler"
},
- "AutomaticScaling": {
+ "Empty": {
+ "properties": {},
+ "id": "Empty",
+ "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
+ "type": "object"
+ },
+ "DomainMapping": {
+ "description": "A domain serving an App Engine application.",
+ "type": "object",
"properties": {
- "maxTotalInstances": {
+ "sslSettings": {
+ "$ref": "SslSettings",
+ "description": "SSL configuration for this domain. If unconfigured, this domain will not serve with SSL."
+ },
+ "name": {
+ "description": "Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly",
+ "type": "string"
+ },
+ "resourceRecords": {
+ "description": "The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly",
+ "items": {
+ "$ref": "ResourceRecord"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "Relative name of the domain serving the application. Example: example.com.",
+ "type": "string"
+ }
+ },
+ "id": "DomainMapping"
+ },
+ "ZipInfo": {
+ "description": "The zip file information for a zip deployment.",
+ "type": "object",
+ "properties": {
+ "filesCount": {
"format": "int32",
- "description": "Maximum number of instances that should be started to handle requests.",
+ "description": "An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.",
"type": "integer"
},
+ "sourceUrl": {
+ "description": "URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
+ "type": "string"
+ }
+ },
+ "id": "ZipInfo"
+ },
+ "AutomaticScaling": {
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
+ "type": "object",
+ "properties": {
"minTotalInstances": {
"format": "int32",
"description": "Minimum number of instances that should be maintained for this version.",
@@ -248,44 +1690,31 @@
"description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
"type": "string"
},
- "requestUtilization": {
- "description": "Target scaling by request utilization.",
- "$ref": "RequestUtilization"
- },
"maxIdleInstances": {
"format": "int32",
"description": "Maximum number of idle instances that should be maintained for this version.",
"type": "integer"
},
"standardSchedulerSettings": {
- "$ref": "StandardSchedulerSettings",
- "description": "Scheduler settings for standard environment."
+ "description": "Scheduler settings for standard environment.",
+ "$ref": "StandardSchedulerSettings"
+ },
+ "requestUtilization": {
+ "description": "Target scaling by request utilization.",
+ "$ref": "RequestUtilization"
},
"minIdleInstances": {
"format": "int32",
"description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.",
"type": "integer"
- }
- },
- "id": "AutomaticScaling",
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
- "type": "object"
- },
- "ZipInfo": {
- "properties": {
- "sourceUrl": {
- "description": "URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
- "type": "string"
},
- "filesCount": {
+ "maxTotalInstances": {
"format": "int32",
- "description": "An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.",
+ "description": "Maximum number of instances that should be started to handle requests.",
"type": "integer"
}
},
- "id": "ZipInfo",
- "description": "The zip file information for a zip deployment.",
- "type": "object"
+ "id": "AutomaticScaling"
},
"AuthorizedCertificate": {
"description": "An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.",
@@ -327,25 +1756,19 @@
"description": "The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.",
"type": "string"
},
- "managedCertificate": {
- "description": "Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly",
- "$ref": "ManagedCertificate"
- },
"certificateRawData": {
"description": "The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.",
"$ref": "CertificateRawData"
+ },
+ "managedCertificate": {
+ "$ref": "ManagedCertificate",
+ "description": "Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly"
}
},
"id": "AuthorizedCertificate"
},
"ResourceRecord": {
- "description": "A DNS resource record.",
- "type": "object",
"properties": {
- "name": {
- "description": "Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.",
- "type": "string"
- },
"type": {
"enumDescriptions": [
"An A resource record. Data is an IPv4 address.",
@@ -363,11 +1786,19 @@
"rrdata": {
"description": "Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).",
"type": "string"
+ },
+ "name": {
+ "description": "Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.",
+ "type": "string"
}
},
- "id": "ResourceRecord"
+ "id": "ResourceRecord",
+ "description": "A DNS resource record.",
+ "type": "object"
},
"Library": {
+ "description": "Third-party Python runtime library that is required by the application.",
+ "type": "object",
"properties": {
"version": {
"description": "Version of the library to select, or \"latest\".",
@@ -378,11 +1809,11 @@
"type": "string"
}
},
- "id": "Library",
- "description": "Third-party Python runtime library that is required by the application.",
- "type": "object"
+ "id": "Library"
},
"ListLocationsResponse": {
+ "description": "The response message for Locations.ListLocations.",
+ "type": "object",
"properties": {
"locations": {
"description": "A list of locations that matches the specified filter in the request.",
@@ -396,9 +1827,7 @@
"type": "string"
}
},
- "id": "ListLocationsResponse",
- "description": "The response message for Locations.ListLocations.",
- "type": "object"
+ "id": "ListLocationsResponse"
},
"ContainerInfo": {
"description": "Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment.",
@@ -432,6 +1861,10 @@
"description": "URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.",
"type": "object",
"properties": {
+ "staticFiles": {
+ "$ref": "StaticFilesHandler",
+ "description": "Returns the contents of a file, such as an image, as the response."
+ },
"redirectHttpResponseCode": {
"enum": [
"REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED",
@@ -469,8 +1902,6 @@
]
},
"authFailAction": {
- "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
- "type": "string",
"enumDescriptions": [
"Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
"Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
@@ -480,11 +1911,13 @@
"AUTH_FAIL_ACTION_UNSPECIFIED",
"AUTH_FAIL_ACTION_REDIRECT",
"AUTH_FAIL_ACTION_UNAUTHORIZED"
- ]
+ ],
+ "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
+ "type": "string"
},
"script": {
- "description": "Executes a script to handle the request that matches this URL pattern.",
- "$ref": "ScriptHandler"
+ "$ref": "ScriptHandler",
+ "description": "Executes a script to handle the request that matches this URL pattern."
},
"urlRegex": {
"description": "URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.",
@@ -507,12 +1940,8 @@
"type": "string"
},
"apiEndpoint": {
- "description": "Uses API Endpoints to handle requests.",
- "$ref": "ApiEndpointHandler"
- },
- "staticFiles": {
- "$ref": "StaticFilesHandler",
- "description": "Returns the contents of a file, such as an image, as the response."
+ "$ref": "ApiEndpointHandler",
+ "description": "Uses API Endpoints to handle requests."
}
},
"id": "UrlMap"
@@ -536,10 +1965,6 @@
"description": "This resource represents a long-running operation that is the result of a network API call.",
"type": "object",
"properties": {
- "done": {
- "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
- "type": "boolean"
- },
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
@@ -553,32 +1978,27 @@
"type": "string"
},
"error": {
- "description": "The error result of the operation in case of failure or cancellation.",
- "$ref": "Status"
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
+ "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- },
- "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
- "type": "object"
+ }
+ },
+ "done": {
+ "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
+ "type": "boolean"
}
},
"id": "Operation"
},
"ApiConfigHandler": {
- "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
- "type": "object",
"properties": {
"securityLevel": {
- "enumDescriptions": [
- "Not specified.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
- "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
- "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
- ],
"enum": [
"SECURE_UNSPECIFIED",
"SECURE_DEFAULT",
@@ -587,9 +2007,18 @@
"SECURE_ALWAYS"
],
"description": "Security (HTTPS) enforcement for this URL.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
+ "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
+ "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
+ ]
},
"authFailAction": {
+ "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
+ "type": "string",
"enumDescriptions": [
"Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
"Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
@@ -599,21 +2028,13 @@
"AUTH_FAIL_ACTION_UNSPECIFIED",
"AUTH_FAIL_ACTION_REDIRECT",
"AUTH_FAIL_ACTION_UNAUTHORIZED"
- ],
- "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
- "type": "string"
+ ]
},
"script": {
"description": "Path to the script from the application root directory.",
"type": "string"
},
"login": {
- "enumDescriptions": [
- "Not specified. LOGIN_OPTIONAL is assumed.",
- "Does not require that the user is signed in.",
- "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
- "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
- ],
"enum": [
"LOGIN_UNSPECIFIED",
"LOGIN_OPTIONAL",
@@ -621,19 +2042,43 @@
"LOGIN_REQUIRED"
],
"description": "Level of login required to access this resource. Defaults to optional.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified. LOGIN_OPTIONAL is assumed.",
+ "Does not require that the user is signed in.",
+ "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
+ "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
+ ]
},
"url": {
"description": "URL to serve the endpoint at.",
"type": "string"
}
},
- "id": "ApiConfigHandler"
+ "id": "ApiConfigHandler",
+ "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
+ "type": "object"
},
"StaticFilesHandler": {
"description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.",
"type": "object",
"properties": {
+ "expiration": {
+ "format": "google-duration",
+ "description": "Time a static file served by this handler should be cached by web proxies and browsers.",
+ "type": "string"
+ },
+ "applicationReadable": {
+ "description": "Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.",
+ "type": "boolean"
+ },
+ "httpHeaders": {
+ "description": "HTTP headers to use for all responses from these URLs.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
"uploadPathRegex": {
"description": "Regular expression that matches the file paths for all files that should be referenced by this handler.",
"type": "string"
@@ -649,22 +2094,6 @@
"requireMatchingFile": {
"description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
"type": "boolean"
- },
- "expiration": {
- "format": "google-duration",
- "description": "Time a static file served by this handler should be cached by web proxies and browsers.",
- "type": "string"
- },
- "applicationReadable": {
- "description": "Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.",
- "type": "boolean"
- },
- "httpHeaders": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "HTTP headers to use for all responses from these URLs.",
- "type": "object"
}
},
"id": "StaticFilesHandler"
@@ -690,6 +2119,11 @@
"description": "Target scaling by disk usage. Only applicable for VM runtimes.",
"type": "object",
"properties": {
+ "targetWriteBytesPerSecond": {
+ "format": "int32",
+ "description": "Target bytes written per second.",
+ "type": "integer"
+ },
"targetReadOpsPerSecond": {
"format": "int32",
"description": "Target ops read per seconds.",
@@ -704,11 +2138,6 @@
"format": "int32",
"description": "Target ops written per second.",
"type": "integer"
- },
- "targetWriteBytesPerSecond": {
- "format": "int32",
- "description": "Target bytes written per second.",
- "type": "integer"
}
},
"id": "DiskUtilization"
@@ -730,33 +2159,6 @@
},
"id": "CpuUtilization"
},
- "Status": {
- "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "code": {
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- },
- "type": "array"
- }
- },
- "id": "Status"
- },
"IdentityAwareProxy": {
"description": "Identity-Aware Proxy",
"type": "object",
@@ -780,6 +2182,33 @@
},
"id": "IdentityAwareProxy"
},
+ "Status": {
+ "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
+ "properties": {
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "code": {
+ "format": "int32",
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "type": "integer"
+ }
+ },
+ "id": "Status"
+ },
"ManualScaling": {
"description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
"type": "object",
@@ -793,8 +2222,6 @@
"id": "ManualScaling"
},
"LocationMetadata": {
- "description": "Metadata for the given google.cloud.location.Location.",
- "type": "object",
"properties": {
"flexibleEnvironmentAvailable": {
"description": "App Engine Flexible Environment is available in the given location.@OutputOnly",
@@ -805,23 +2232,25 @@
"type": "boolean"
}
},
- "id": "LocationMetadata"
+ "id": "LocationMetadata",
+ "description": "Metadata for the given google.cloud.location.Location.",
+ "type": "object"
},
"Service": {
"description": "A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.",
"type": "object",
"properties": {
- "name": {
- "description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
"split": {
- "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service.",
- "$ref": "TrafficSplit"
+ "$ref": "TrafficSplit",
+ "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service."
},
"id": {
"description": "Relative name of the service within the application. Example: default.@OutputOnly",
"type": "string"
+ },
+ "name": {
+ "description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
}
},
"id": "Service"
@@ -844,6 +2273,40 @@
},
"id": "ListOperationsResponse"
},
+ "FirewallRule": {
+ "description": "A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.",
+ "type": "object",
+ "properties": {
+ "sourceRange": {
+ "description": "IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character \"*\" to match all IPs equivalent to \"0/0\" and \"::/0\" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334.\u003cp\u003eTruncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.",
+ "type": "string"
+ },
+ "priority": {
+ "format": "int32",
+ "description": "A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.",
+ "type": "integer"
+ },
+ "action": {
+ "enum": [
+ "UNSPECIFIED_ACTION",
+ "ALLOW",
+ "DENY"
+ ],
+ "description": "The action to take on matched requests.",
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "Matching requests are allowed.",
+ "Matching requests are denied."
+ ]
+ },
+ "description": {
+ "description": "An optional string description of this rule. This field has a maximum length of 100 characters.",
+ "type": "string"
+ }
+ },
+ "id": "FirewallRule"
+ },
"OperationMetadata": {
"description": "Metadata for the given google.longrunning.Operation.",
"type": "object",
@@ -877,84 +2340,39 @@
},
"id": "OperationMetadata"
},
- "FirewallRule": {
- "description": "A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.",
- "type": "object",
- "properties": {
- "sourceRange": {
- "description": "IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character \"*\" to match all IPs equivalent to \"0/0\" and \"::/0\" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334.\u003cp\u003eTruncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.",
- "type": "string"
- },
- "priority": {
- "format": "int32",
- "description": "A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.",
- "type": "integer"
- },
- "action": {
- "enumDescriptions": [
- "",
- "Matching requests are allowed.",
- "Matching requests are denied."
- ],
- "enum": [
- "UNSPECIFIED_ACTION",
- "ALLOW",
- "DENY"
- ],
- "description": "The action to take on matched requests.",
- "type": "string"
- },
- "description": {
- "description": "An optional string description of this rule. This field has a maximum length of 100 characters.",
- "type": "string"
- }
- },
- "id": "FirewallRule"
- },
"ListAuthorizedCertificatesResponse": {
"description": "Response message for AuthorizedCertificates.ListAuthorizedCertificates.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
"certificates": {
"description": "The SSL certificates the user is authorized to administer.",
"items": {
"$ref": "AuthorizedCertificate"
},
"type": "array"
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
}
},
"id": "ListAuthorizedCertificatesResponse"
},
"FeatureSettings": {
- "description": "The feature specific settings to be used in the application. These define behaviors that are user configurable.",
- "type": "object",
"properties": {
"splitHealthChecks": {
"description": "Boolean value indicating if split health checks should be used instead of the legacy health checks. At an app.yaml level, this means defaulting to 'readiness_check' and 'liveness_check' values instead of 'health_check' ones. Once the legacy 'health_check' behavior is deprecated, and this value is always true, this setting can be removed.",
"type": "boolean"
}
},
- "id": "FeatureSettings"
+ "id": "FeatureSettings",
+ "description": "The feature specific settings to be used in the application. These define behaviors that are user configurable.",
+ "type": "object"
},
"OperationMetadataV1": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
"properties": {
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "Time that this operation completed.@OutputOnly",
- "type": "string"
- },
"warning": {
"description": "Durable messages that persist on every operation poll. @OutputOnly",
"items": {
@@ -974,35 +2392,46 @@
"user": {
"description": "User who requested this operation.@OutputOnly",
"type": "string"
+ },
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation completed.@OutputOnly",
+ "type": "string"
}
},
- "id": "OperationMetadataV1",
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object"
+ "id": "OperationMetadataV1"
},
"SslSettings": {
"description": "SSL configuration for a DomainMapping resource.",
"type": "object",
"properties": {
- "pendingManagedCertificateId": {
- "description": "ID of the managed AuthorizedCertificate resource currently being provisioned, if applicable. Until the new managed certificate has been successfully provisioned, the previous SSL state will be preserved. Once the provisioning process completes, the certificate_id field will reflect the new managed certificate and this field will be left empty. To remove SSL support while there is still a pending managed certificate, clear the certificate_id field with an UpdateDomainMappingRequest.@OutputOnly",
- "type": "string"
- },
"sslManagementType": {
- "enumDescriptions": [
- "SSL support for this domain is configured automatically. The mapped SSL certificate will be automatically renewed.",
- "SSL support for this domain is configured manually by the user. Either the domain has no SSL support or a user-obtained SSL certificate has been explictly mapped to this domain."
- ],
"enum": [
"AUTOMATIC",
"MANUAL"
],
"description": "SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificate_id must be manually specified in order to configure SSL for this domain.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "SSL support for this domain is configured automatically. The mapped SSL certificate will be automatically renewed.",
+ "SSL support for this domain is configured manually by the user. Either the domain has no SSL support or a user-obtained SSL certificate has been explictly mapped to this domain."
+ ]
},
"certificateId": {
"description": "ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify SslManagementType.MANUAL on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.",
"type": "string"
+ },
+ "pendingManagedCertificateId": {
+ "description": "ID of the managed AuthorizedCertificate resource currently being provisioned, if applicable. Until the new managed certificate has been successfully provisioned, the previous SSL state will be preserved. Once the provisioning process completes, the certificate_id field will reflect the new managed certificate and this field will be left empty. To remove SSL support while there is still a pending managed certificate, clear the certificate_id field with an UpdateDomainMappingRequest.@OutputOnly",
+ "type": "string"
}
},
"id": "SslSettings"
@@ -1016,8 +2445,6 @@
"type": "string"
},
"errorCode": {
- "description": "Error condition this handler applies to.",
- "type": "string",
"enumDescriptions": [
"Not specified. ERROR_CODE_DEFAULT is assumed.",
"All other error types.",
@@ -1031,7 +2458,9 @@
"ERROR_CODE_OVER_QUOTA",
"ERROR_CODE_DOS_API_DENIAL",
"ERROR_CODE_TIMEOUT"
- ]
+ ],
+ "description": "Error condition this handler applies to.",
+ "type": "string"
},
"staticFile": {
"description": "Static file content to be served for this error.",
@@ -1070,6 +2499,15 @@
"description": "An Application resource contains the top-level configuration of an App Engine application. Next tag: 20",
"type": "object",
"properties": {
+ "id": {
+ "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.",
+ "type": "string"
+ },
+ "defaultCookieExpiration": {
+ "format": "google-duration",
+ "description": "Cookie expiration policy for this application.",
+ "type": "string"
+ },
"locationId": {
"description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US",
"type": "string"
@@ -1127,15 +2565,6 @@
"name": {
"description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
"type": "string"
- },
- "defaultCookieExpiration": {
- "format": "google-duration",
- "description": "Cookie expiration policy for this application.",
- "type": "string"
- },
- "id": {
- "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.",
- "type": "string"
}
},
"id": "Application"
@@ -1144,51 +2573,13 @@
"description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
"type": "object",
"properties": {
- "vmName": {
- "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "vmStatus": {
+ "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
"type": "string"
},
- "qps": {
- "format": "float",
- "description": "Average queries per second (QPS) over the last minute.@OutputOnly",
- "type": "number"
- },
- "vmId": {
- "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "vmZoneName": {
- "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "name": {
- "description": "Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly",
- "type": "string"
- },
- "averageLatency": {
- "format": "int32",
- "description": "Average latency (ms) over the last minute.@OutputOnly",
- "type": "integer"
- },
- "vmIp": {
- "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "id": {
- "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
- "type": "string"
- },
- "memoryUsage": {
- "format": "int64",
- "description": "Total memory in use (bytes).@OutputOnly",
- "type": "string"
- },
- "errors": {
- "format": "int32",
- "description": "Number of errors since this instance was started.@OutputOnly",
- "type": "integer"
- },
"availability": {
+ "description": "Availability of the instance.@OutputOnly",
+ "type": "string",
"enumDescriptions": [
"",
"",
@@ -1198,13 +2589,12 @@
"UNSPECIFIED",
"RESIDENT",
"DYNAMIC"
- ],
- "description": "Availability of the instance.@OutputOnly",
- "type": "string"
+ ]
},
- "vmStatus": {
- "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
+ "errors": {
+ "format": "int32",
+ "description": "Number of errors since this instance was started.@OutputOnly",
+ "type": "integer"
},
"startTime": {
"format": "google-datetime",
@@ -1223,6 +2613,45 @@
"appEngineRelease": {
"description": "App Engine release this instance is running on.@OutputOnly",
"type": "string"
+ },
+ "vmName": {
+ "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "vmId": {
+ "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "qps": {
+ "format": "float",
+ "description": "Average queries per second (QPS) over the last minute.@OutputOnly",
+ "type": "number"
+ },
+ "name": {
+ "description": "Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly",
+ "type": "string"
+ },
+ "vmZoneName": {
+ "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "averageLatency": {
+ "format": "int32",
+ "description": "Average latency (ms) over the last minute.@OutputOnly",
+ "type": "integer"
+ },
+ "memoryUsage": {
+ "format": "int64",
+ "description": "Total memory in use (bytes).@OutputOnly",
+ "type": "string"
+ },
+ "id": {
+ "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
+ "type": "string"
+ },
+ "vmIp": {
+ "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
}
},
"id": "Instance"
@@ -1231,43 +2660,45 @@
"description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.",
"type": "object",
"properties": {
- "checkInterval": {
- "format": "google-duration",
- "description": "Interval between health checks.",
- "type": "string"
- },
- "failureThreshold": {
- "format": "uint32",
- "description": "Number of consecutive failed checks required before considering the VM unhealthy.",
- "type": "integer"
- },
- "timeout": {
- "format": "google-duration",
- "description": "Time before the check is considered failed.",
- "type": "string"
- },
- "initialDelay": {
- "format": "google-duration",
- "description": "The initial delay before starting to execute the checks.",
- "type": "string"
- },
"path": {
"description": "The request path.",
"type": "string"
},
+ "host": {
+ "description": "Host header to send when performing a HTTP Liveness check. Example: \"myapp.appspot.com\"",
+ "type": "string"
+ },
"successThreshold": {
"format": "uint32",
"description": "Number of consecutive successful checks required before considering the VM healthy.",
"type": "integer"
},
- "host": {
- "description": "Host header to send when performing a HTTP Liveness check. Example: \"myapp.appspot.com\"",
+ "checkInterval": {
+ "format": "google-duration",
+ "description": "Interval between health checks.",
+ "type": "string"
+ },
+ "timeout": {
+ "format": "google-duration",
+ "description": "Time before the check is considered failed.",
+ "type": "string"
+ },
+ "failureThreshold": {
+ "format": "uint32",
+ "description": "Number of consecutive failed checks required before considering the VM unhealthy.",
+ "type": "integer"
+ },
+ "initialDelay": {
+ "format": "google-duration",
+ "description": "The initial delay before starting to execute the checks.",
"type": "string"
}
},
"id": "LivenessCheck"
},
"BatchUpdateIngressRulesRequest": {
+ "description": "Request message for Firewall.BatchUpdateIngressRules.",
+ "type": "object",
"properties": {
"ingressRules": {
"description": "A list of FirewallRules to replace the existing set.",
@@ -1277,11 +2708,11 @@
"type": "array"
}
},
- "id": "BatchUpdateIngressRulesRequest",
- "description": "Request message for Firewall.BatchUpdateIngressRules.",
- "type": "object"
+ "id": "BatchUpdateIngressRulesRequest"
},
"Location": {
+ "description": "A resource that represents Google Cloud Platform location.",
+ "type": "object",
"properties": {
"labels": {
"additionalProperties": {
@@ -1299,27 +2730,20 @@
"type": "string"
},
"metadata": {
+ "description": "Service-specific metadata. For example the available capacity at the given location.",
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- },
- "description": "Service-specific metadata. For example the available capacity at the given location.",
- "type": "object"
+ }
}
},
- "id": "Location",
- "description": "A resource that represents Google Cloud Platform location.",
- "type": "object"
+ "id": "Location"
},
"NetworkUtilization": {
"description": "Target scaling by network usage. Only applicable for VM runtimes.",
"type": "object",
"properties": {
- "targetSentBytesPerSecond": {
- "format": "int32",
- "description": "Target bytes sent per second.",
- "type": "integer"
- },
"targetReceivedBytesPerSecond": {
"format": "int32",
"description": "Target bytes received per second.",
@@ -1334,22 +2758,19 @@
"format": "int32",
"description": "Target packets received per second.",
"type": "integer"
+ },
+ "targetSentBytesPerSecond": {
+ "format": "int32",
+ "description": "Target bytes sent per second.",
+ "type": "integer"
}
},
"id": "NetworkUtilization"
},
"HealthCheck": {
+ "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.",
+ "type": "object",
"properties": {
- "timeout": {
- "format": "google-duration",
- "description": "Time before the health check is considered failed.",
- "type": "string"
- },
- "unhealthyThreshold": {
- "format": "uint32",
- "description": "Number of consecutive failed health checks required before removing traffic.",
- "type": "integer"
- },
"disableHealthCheck": {
"description": "Whether to explicitly disable health checks for this instance.",
"type": "boolean"
@@ -1372,14 +2793,29 @@
"format": "google-duration",
"description": "Interval between health checks.",
"type": "string"
+ },
+ "timeout": {
+ "format": "google-duration",
+ "description": "Time before the health check is considered failed.",
+ "type": "string"
+ },
+ "unhealthyThreshold": {
+ "format": "uint32",
+ "description": "Number of consecutive failed health checks required before removing traffic.",
+ "type": "integer"
}
},
- "id": "HealthCheck",
- "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.",
- "type": "object"
+ "id": "HealthCheck"
},
"ReadinessCheck": {
+ "description": "Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.",
+ "type": "object",
"properties": {
+ "appStartTimeout": {
+ "format": "google-duration",
+ "description": "A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.",
+ "type": "string"
+ },
"path": {
"description": "The request path.",
"type": "string"
@@ -1407,16 +2843,9 @@
"format": "uint32",
"description": "Number of consecutive failed checks required before removing traffic.",
"type": "integer"
- },
- "appStartTimeout": {
- "format": "google-duration",
- "description": "A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.",
- "type": "string"
}
},
- "id": "ReadinessCheck",
- "description": "Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.",
- "type": "object"
+ "id": "ReadinessCheck"
},
"StandardSchedulerSettings": {
"properties": {
@@ -1446,28 +2875,20 @@
"type": "object"
},
"DebugInstanceRequest": {
+ "description": "Request message for Instances.DebugInstance.",
+ "type": "object",
"properties": {
"sshKey": {
"description": "Public SSH key to add to the instance. Examples:\n[USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME]\n[USERNAME]:ssh-rsa [KEY_VALUE] google-ssh {\"userName\":\"[USERNAME]\",\"expireOn\":\"[EXPIRE_TIME]\"}For more information, see Adding and Removing SSH Keys (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys).",
"type": "string"
}
},
- "id": "DebugInstanceRequest",
- "description": "Request message for Instances.DebugInstance.",
- "type": "object"
+ "id": "DebugInstanceRequest"
},
"OperationMetadataV1Beta5": {
"description": "Metadata for the given google.longrunning.Operation.",
"type": "object",
"properties": {
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
"method": {
"description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
"type": "string"
@@ -1481,108 +2902,20 @@
"format": "google-datetime",
"description": "Timestamp that this operation completed.@OutputOnly",
"type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
}
},
"id": "OperationMetadataV1Beta5"
},
"Version": {
- "description": "A Version resource is a specific set of source code and configuration files that are deployed into a service.",
- "type": "object",
"properties": {
- "betaSettings": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Metadata settings that are supplied to this version to enable beta runtime features.",
- "type": "object"
- },
- "env": {
- "description": "App Engine execution environment for this version.Defaults to standard.",
- "type": "string"
- },
- "handlers": {
- "description": "An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.",
- "items": {
- "$ref": "UrlMap"
- },
- "type": "array"
- },
- "automaticScaling": {
- "$ref": "AutomaticScaling",
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics."
- },
- "diskUsageBytes": {
- "format": "int64",
- "description": "Total size in bytes of all the files that are included in this version and curerntly hosted on the App Engine disk.@OutputOnly",
- "type": "string"
- },
- "healthCheck": {
- "description": "Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes.Only returned in GET requests if view=FULL is set.",
- "$ref": "HealthCheck"
- },
- "threadsafe": {
- "description": "Whether multiple requests can be dispatched to this version at once.",
- "type": "boolean"
- },
- "readinessCheck": {
- "description": "Configures readiness health checking for VM instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set.",
- "$ref": "ReadinessCheck"
- },
- "manualScaling": {
- "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
- "$ref": "ManualScaling"
- },
- "name": {
- "description": "Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly",
- "type": "string"
- },
- "apiConfig": {
- "description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set.",
- "$ref": "ApiConfigHandler"
- },
- "endpointsApiService": {
- "$ref": "EndpointsApiService",
- "description": "Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app."
- },
- "versionUrl": {
- "description": "Serving URL for this version. Example: \"https://myversion-dot-myservice-dot-myapp.appspot.com\"@OutputOnly",
- "type": "string"
- },
- "vm": {
- "description": "Whether to deploy this version in a container on a virtual machine.",
- "type": "boolean"
- },
- "instanceClass": {
- "description": "Instance class that is used to run this version. Valid values are:\nAutomaticScaling: F1, F2, F4, F4_1G\nManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.",
- "type": "string"
- },
- "servingStatus": {
- "description": "Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.",
- "type": "string",
- "enumDescriptions": [
- "Not specified.",
- "Currently serving. Instances are created according to the scaling settings of the version.",
- "Disabled. No instances will be created and the scaling settings are ignored until the state of the version changes to SERVING."
- ],
- "enum": [
- "SERVING_STATUS_UNSPECIFIED",
- "SERVING",
- "STOPPED"
- ]
- },
- "runtimeApiVersion": {
- "description": "The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/\u003clanguage\u003e/config/appref",
- "type": "string"
- },
- "deployment": {
- "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.",
- "$ref": "Deployment"
- },
- "createTime": {
- "format": "google-datetime",
- "description": "Time that this version was created.@OutputOnly",
- "type": "string"
- },
"inboundServices": {
"description": "Before an application can receive email or XMPP messages, the application must be configured to enable the service.",
"items": {
@@ -1613,8 +2946,8 @@
]
},
"resources": {
- "$ref": "Resources",
- "description": "Machine resources for this version. Only applicable for VM runtimes."
+ "description": "Machine resources for this version. Only applicable for VM runtimes.",
+ "$ref": "Resources"
},
"errorHandlers": {
"description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.",
@@ -1640,8 +2973,8 @@
"type": "string"
},
"basicScaling": {
- "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.",
- "$ref": "BasicScaling"
+ "$ref": "BasicScaling",
+ "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity."
},
"runtime": {
"description": "Desired runtime. Example: python27.",
@@ -1656,22 +2989,118 @@
"type": "string"
},
"envVariables": {
- "description": "Environment variables available to the application.Only returned in GET requests if view=FULL is set.",
- "type": "object",
"additionalProperties": {
"type": "string"
- }
+ },
+ "description": "Environment variables available to the application.Only returned in GET requests if view=FULL is set.",
+ "type": "object"
},
"livenessCheck": {
- "description": "Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set.",
- "$ref": "LivenessCheck"
+ "$ref": "LivenessCheck",
+ "description": "Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set."
},
"network": {
"$ref": "Network",
"description": "Extra network settings. Only applicable for App Engine flexible environment versions."
+ },
+ "betaSettings": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Metadata settings that are supplied to this version to enable beta runtime features.",
+ "type": "object"
+ },
+ "env": {
+ "description": "App Engine execution environment for this version.Defaults to standard.",
+ "type": "string"
+ },
+ "handlers": {
+ "description": "An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.",
+ "items": {
+ "$ref": "UrlMap"
+ },
+ "type": "array"
+ },
+ "automaticScaling": {
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
+ "$ref": "AutomaticScaling"
+ },
+ "diskUsageBytes": {
+ "format": "int64",
+ "description": "Total size in bytes of all the files that are included in this version and curerntly hosted on the App Engine disk.@OutputOnly",
+ "type": "string"
+ },
+ "healthCheck": {
+ "$ref": "HealthCheck",
+ "description": "Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes.Only returned in GET requests if view=FULL is set."
+ },
+ "threadsafe": {
+ "description": "Whether multiple requests can be dispatched to this version at once.",
+ "type": "boolean"
+ },
+ "readinessCheck": {
+ "$ref": "ReadinessCheck",
+ "description": "Configures readiness health checking for VM instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set."
+ },
+ "manualScaling": {
+ "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
+ "$ref": "ManualScaling"
+ },
+ "name": {
+ "description": "Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly",
+ "type": "string"
+ },
+ "apiConfig": {
+ "description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set.",
+ "$ref": "ApiConfigHandler"
+ },
+ "endpointsApiService": {
+ "description": "Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app.",
+ "$ref": "EndpointsApiService"
+ },
+ "vm": {
+ "description": "Whether to deploy this version in a container on a virtual machine.",
+ "type": "boolean"
+ },
+ "versionUrl": {
+ "description": "Serving URL for this version. Example: \"https://myversion-dot-myservice-dot-myapp.appspot.com\"@OutputOnly",
+ "type": "string"
+ },
+ "instanceClass": {
+ "description": "Instance class that is used to run this version. Valid values are:\nAutomaticScaling: F1, F2, F4, F4_1G\nManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.",
+ "type": "string"
+ },
+ "servingStatus": {
+ "description": "Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified.",
+ "Currently serving. Instances are created according to the scaling settings of the version.",
+ "Disabled. No instances will be created and the scaling settings are ignored until the state of the version changes to SERVING."
+ ],
+ "enum": [
+ "SERVING_STATUS_UNSPECIFIED",
+ "SERVING",
+ "STOPPED"
+ ]
+ },
+ "deployment": {
+ "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.",
+ "$ref": "Deployment"
+ },
+ "runtimeApiVersion": {
+ "description": "The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/\u003clanguage\u003e/config/appref",
+ "type": "string"
+ },
+ "createTime": {
+ "format": "google-datetime",
+ "description": "Time that this version was created.@OutputOnly",
+ "type": "string"
}
},
- "id": "Version"
+ "id": "Version",
+ "description": "A Version resource is a specific set of source code and configuration files that are deployed into a service.",
+ "type": "object"
},
"RepairApplicationRequest": {
"description": "Request message for 'Applications.RepairApplication'.",
@@ -1679,21 +3108,6 @@
"properties": {},
"id": "RepairApplicationRequest"
},
- "CertificateRawData": {
- "properties": {
- "privateKey": {
- "description": "Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: \u003cpre\u003e -----BEGIN RSA PRIVATE KEY----- \u003cunencrypted_key_value\u003e -----END RSA PRIVATE KEY----- \u003c/pre\u003e @InputOnly",
- "type": "string"
- },
- "publicCertificate": {
- "description": "PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: \u003cpre\u003e -----BEGIN CERTIFICATE----- \u003ccertificate_value\u003e -----END CERTIFICATE----- \u003c/pre\u003e",
- "type": "string"
- }
- },
- "id": "CertificateRawData",
- "description": "An SSL certificate obtained from a certificate authority.",
- "type": "object"
- },
"BuildInfo": {
"description": "Google Cloud Container Builder build information.",
"type": "object",
@@ -1705,16 +3119,20 @@
},
"id": "BuildInfo"
},
- "ScriptHandler": {
- "description": "Executes a script to handle the request that matches the URL pattern.",
+ "CertificateRawData": {
+ "description": "An SSL certificate obtained from a certificate authority.",
"type": "object",
"properties": {
- "scriptPath": {
- "description": "Path to the script from the application root directory.",
+ "privateKey": {
+ "description": "Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: \u003cpre\u003e -----BEGIN RSA PRIVATE KEY----- \u003cunencrypted_key_value\u003e -----END RSA PRIVATE KEY----- \u003c/pre\u003e @InputOnly",
+ "type": "string"
+ },
+ "publicCertificate": {
+ "description": "PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: \u003cpre\u003e -----BEGIN CERTIFICATE----- \u003ccertificate_value\u003e -----END CERTIFICATE----- \u003c/pre\u003e",
"type": "string"
}
},
- "id": "ScriptHandler"
+ "id": "CertificateRawData"
},
"FileInfo": {
"description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.",
@@ -1735,12 +3153,21 @@
},
"id": "FileInfo"
},
- "OperationMetadataExperimental": {
+ "ScriptHandler": {
+ "description": "Executes a script to handle the request that matches the URL pattern.",
+ "type": "object",
"properties": {
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.experimental.CustomDomains.CreateCustomDomain.@OutputOnly",
+ "scriptPath": {
+ "description": "Path to the script from the application root directory.",
"type": "string"
- },
+ }
+ },
+ "id": "ScriptHandler"
+ },
+ "OperationMetadataExperimental": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
+ "properties": {
"insertTime": {
"format": "google-datetime",
"description": "Time that this operation was created.@OutputOnly",
@@ -1758,42 +3185,42 @@
"user": {
"description": "User who requested this operation.@OutputOnly",
"type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.experimental.CustomDomains.CreateCustomDomain.@OutputOnly",
+ "type": "string"
}
},
- "id": "OperationMetadataExperimental",
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object"
+ "id": "OperationMetadataExperimental"
},
"AuthorizedDomain": {
- "description": "A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central (https://www.google.com/webmasters/verification/home).",
- "type": "object",
"properties": {
- "name": {
- "description": "Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly",
- "type": "string"
- },
"id": {
"description": "Fully qualified domain name of the domain authorized for use. Example: example.com.",
"type": "string"
+ },
+ "name": {
+ "description": "Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly",
+ "type": "string"
}
},
- "id": "AuthorizedDomain"
+ "id": "AuthorizedDomain",
+ "description": "A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central (https://www.google.com/webmasters/verification/home).",
+ "type": "object"
},
"TrafficSplit": {
"description": "Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.",
"type": "object",
"properties": {
"allocations": {
- "description": "Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.",
- "type": "object",
"additionalProperties": {
"format": "double",
"type": "number"
- }
+ },
+ "description": "Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.",
+ "type": "object"
},
"shardBy": {
- "description": "Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.",
- "type": "string",
"enumDescriptions": [
"Diversion method unspecified.",
"Diversion based on a specially named cookie, \"GOOGAPPUID.\" The cookie must be set by the application itself or no diversion will occur.",
@@ -1805,13 +3232,21 @@
"COOKIE",
"IP",
"RANDOM"
- ]
+ ],
+ "description": "Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.",
+ "type": "string"
}
},
"id": "TrafficSplit"
},
"OperationMetadataV1Beta": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
"properties": {
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
"method": {
"description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
"type": "string"
@@ -1833,22 +3268,34 @@
"description": "Time that this operation was created.@OutputOnly",
"type": "string"
},
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
"user": {
"description": "User who requested this operation.@OutputOnly",
"type": "string"
},
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
"type": "string"
}
},
- "id": "OperationMetadataV1Beta",
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object"
+ "id": "OperationMetadataV1Beta"
+ },
+ "ListIngressRulesResponse": {
+ "description": "Response message for Firewall.ListIngressRules.",
+ "type": "object",
+ "properties": {
+ "ingressRules": {
+ "description": "The ingress FirewallRules for this application.",
+ "items": {
+ "$ref": "FirewallRule"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListIngressRulesResponse"
},
"ListServicesResponse": {
"description": "Response message for Services.ListServices.",
@@ -1868,60 +3315,13 @@
},
"id": "ListServicesResponse"
},
- "ListIngressRulesResponse": {
- "properties": {
- "ingressRules": {
- "description": "The ingress FirewallRules for this application.",
- "items": {
- "$ref": "FirewallRule"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- }
- },
- "id": "ListIngressRulesResponse",
- "description": "Response message for Firewall.ListIngressRules.",
- "type": "object"
- },
- "Resources": {
- "description": "Machine resources for a version.",
- "type": "object",
- "properties": {
- "volumes": {
- "description": "User specified volumes.",
- "items": {
- "$ref": "Volume"
- },
- "type": "array"
- },
- "diskGb": {
- "format": "double",
- "description": "Disk size (GB) needed.",
- "type": "number"
- },
- "memoryGb": {
- "format": "double",
- "description": "Memory (GB) needed.",
- "type": "number"
- },
- "cpu": {
- "format": "double",
- "description": "Number of CPU cores needed.",
- "type": "number"
- }
- },
- "id": "Resources"
- },
"Deployment": {
"description": "Code and application artifacts used to deploy a version to App Engine.",
"type": "object",
"properties": {
"build": {
- "$ref": "BuildInfo",
- "description": "Google Cloud Container Builder build information."
+ "description": "Google Cloud Container Builder build information.",
+ "$ref": "BuildInfo"
},
"files": {
"additionalProperties": {
@@ -1941,27 +3341,38 @@
},
"id": "Deployment"
},
- "Volume": {
- "description": "Volumes mounted within the app container. Only applicable for VM runtimes.",
+ "Resources": {
+ "description": "Machine resources for a version.",
"type": "object",
"properties": {
- "sizeGb": {
+ "memoryGb": {
"format": "double",
- "description": "Volume size in gigabytes.",
+ "description": "Memory (GB) needed.",
"type": "number"
},
- "name": {
- "description": "Unique name for the volume.",
- "type": "string"
+ "cpu": {
+ "format": "double",
+ "description": "Number of CPU cores needed.",
+ "type": "number"
},
- "volumeType": {
- "description": "Underlying volume type, e.g. 'tmpfs'.",
- "type": "string"
+ "volumes": {
+ "description": "User specified volumes.",
+ "items": {
+ "$ref": "Volume"
+ },
+ "type": "array"
+ },
+ "diskGb": {
+ "format": "double",
+ "description": "Disk size (GB) needed.",
+ "type": "number"
}
},
- "id": "Volume"
+ "id": "Resources"
},
"BatchUpdateIngressRulesResponse": {
+ "description": "Response message for Firewall.UpdateAllIngressRules.",
+ "type": "object",
"properties": {
"ingressRules": {
"description": "The full list of ingress FirewallRules for this application.",
@@ -1971,1588 +3382,177 @@
"type": "array"
}
},
- "id": "BatchUpdateIngressRulesResponse",
- "description": "Response message for Firewall.UpdateAllIngressRules.",
- "type": "object"
+ "id": "BatchUpdateIngressRulesResponse"
+ },
+ "Volume": {
+ "description": "Volumes mounted within the app container. Only applicable for VM runtimes.",
+ "type": "object",
+ "properties": {
+ "volumeType": {
+ "description": "Underlying volume type, e.g. 'tmpfs'.",
+ "type": "string"
+ },
+ "sizeGb": {
+ "format": "double",
+ "description": "Volume size in gigabytes.",
+ "type": "number"
+ },
+ "name": {
+ "description": "Unique name for the volume.",
+ "type": "string"
+ }
+ },
+ "id": "Volume"
+ },
+ "ManagedCertificate": {
+ "description": "A certificate managed by App Engine.",
+ "type": "object",
+ "properties": {
+ "lastRenewalTime": {
+ "format": "google-datetime",
+ "description": "Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly",
+ "type": "string"
+ },
+ "status": {
+ "description": "Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly",
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "Certificate was successfully obtained and inserted into the serving system.",
+ "Certificate is under active attempts to acquire or renew.",
+ "Most recent renewal failed due to an invalid DNS setup and will be retried. Renewal attempts will continue to fail until the certificate domain's DNS configuration is fixed. The last successfully provisioned certificate may still be serving.",
+ "All renewal attempts have been exhausted, likely due to an invalid DNS setup."
+ ],
+ "enum": [
+ "MANAGEMENT_STATUS_UNSPECIFIED",
+ "OK",
+ "PENDING",
+ "FAILED_RETRYING_NOT_VISIBLE",
+ "FAILED_PERMANENT"
+ ]
+ }
+ },
+ "id": "ManagedCertificate"
+ },
+ "ListInstancesResponse": {
+ "description": "Response message for Instances.ListInstances.",
+ "type": "object",
+ "properties": {
+ "instances": {
+ "description": "The instances belonging to the requested version.",
+ "items": {
+ "$ref": "Instance"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListInstancesResponse"
+ },
+ "ListDomainMappingsResponse": {
+ "description": "Response message for DomainMappings.ListDomainMappings.",
+ "type": "object",
+ "properties": {
+ "domainMappings": {
+ "description": "The domain mappings for the application.",
+ "items": {
+ "$ref": "DomainMapping"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListDomainMappingsResponse"
+ },
+ "OperationMetadataV1Alpha": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
+ "properties": {
+ "insertTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation was created.@OutputOnly",
+ "type": "string"
+ },
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation completed.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadataV1Alpha"
+ },
+ "UrlDispatchRule": {
+ "description": "Rules to match an HTTP request and dispatch that request to a service.",
+ "type": "object",
+ "properties": {
+ "path": {
+ "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.",
+ "type": "string"
+ },
+ "service": {
+ "description": "Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.",
+ "type": "string"
+ },
+ "domain": {
+ "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
+ "type": "string"
+ }
+ },
+ "id": "UrlDispatchRule"
+ },
+ "ListVersionsResponse": {
+ "description": "Response message for Versions.ListVersions.",
+ "type": "object",
+ "properties": {
+ "versions": {
+ "description": "The versions belonging to the requested service.",
+ "items": {
+ "$ref": "Version"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListVersionsResponse"
}
},
+ "protocol": "rest",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
- "protocol": "rest",
"version": "v1beta",
- "baseUrl": "https://appengine.googleapis.com/",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/appengine.admin": {
- "description": "View and manage your applications deployed on Google App Engine"
- },
- "https://www.googleapis.com/auth/cloud-platform.read-only": {
- "description": "View your data across Google Cloud Platform services"
- }
- }
- }
- },
- "kind": "discovery#restDescription",
- "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.",
- "servicePath": "",
- "rootUrl": "https://appengine.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "appengine",
- "batchPath": "batch",
- "id": "appengine:v1beta",
- "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
- "revision": "20170929",
- "title": "Google App Engine Admin API",
- "ownerName": "Google",
- "discoveryVersion": "v1",
- "resources": {
- "apps": {
- "resources": {
- "authorizedCertificates": {
- "methods": {
- "delete": {
- "description": "Deletes the specified SSL certificate.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "appsId",
- "authorizedCertificatesId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "authorizedCertificatesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.delete",
- "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}"
- },
- "patch": {
- "response": {
- "$ref": "AuthorizedCertificate"
- },
- "parameterOrder": [
- "appsId",
- "authorizedCertificatesId"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "updateMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.",
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.",
- "type": "string",
- "required": true
- },
- "authorizedCertificatesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.patch",
- "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "request": {
- "$ref": "AuthorizedCertificate"
- },
- "description": "Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated."
- },
- "get": {
- "description": "Gets the specified SSL certificate.",
- "httpMethod": "GET",
- "response": {
- "$ref": "AuthorizedCertificate"
- },
- "parameterOrder": [
- "appsId",
- "authorizedCertificatesId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "view": {
- "enum": [
- "BASIC_CERTIFICATE",
- "FULL_CERTIFICATE"
- ],
- "description": "Controls the set of fields returned in the GET response.",
- "type": "string",
- "location": "query"
- },
- "authorizedCertificatesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.get"
- },
- "list": {
- "path": "v1beta/apps/{appsId}/authorizedCertificates",
- "id": "appengine.apps.authorizedCertificates.list",
- "description": "Lists all SSL certificates the user is authorized to administer.",
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "ListAuthorizedCertificatesResponse"
- },
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "type": "string",
- "required": true
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Maximum results to return per page.",
- "type": "integer"
- },
- "view": {
- "location": "query",
- "enum": [
- "BASIC_CERTIFICATE",
- "FULL_CERTIFICATE"
- ],
- "description": "Controls the set of fields returned in the LIST response.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta/apps/{appsId}/authorizedCertificates"
- },
- "create": {
- "description": "Uploads the specified SSL certificate.",
- "request": {
- "$ref": "AuthorizedCertificate"
- },
- "response": {
- "$ref": "AuthorizedCertificate"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta/apps/{appsId}/authorizedCertificates",
- "id": "appengine.apps.authorizedCertificates.create",
- "path": "v1beta/apps/{appsId}/authorizedCertificates"
- }
- }
- },
- "services": {
- "methods": {
- "patch": {
- "request": {
- "$ref": "Service"
- },
- "description": "Updates the configuration of the specified service.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "migrateTraffic": {
- "description": "Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services#shardby) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).",
- "type": "boolean",
- "location": "query"
- },
- "updateMask": {
- "format": "google-fieldmask",
- "description": "Standard field mask for the set of fields to be updated.",
- "type": "string",
- "location": "query"
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}",
- "id": "appengine.apps.services.patch",
- "path": "v1beta/apps/{appsId}/services/{servicesId}"
- },
- "get": {
- "id": "appengine.apps.services.get",
- "path": "v1beta/apps/{appsId}/services/{servicesId}",
- "description": "Gets the current configuration of the specified service.",
- "response": {
- "$ref": "Service"
- },
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}"
- },
- "list": {
- "id": "appengine.apps.services.list",
- "path": "v1beta/apps/{appsId}/services",
- "description": "Lists all the services in the application.",
- "response": {
- "$ref": "ListServicesResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "type": "string",
- "required": true
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Maximum results to return per page.",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta/apps/{appsId}/services"
- },
- "delete": {
- "id": "appengine.apps.services.delete",
- "path": "v1beta/apps/{appsId}/services/{servicesId}",
- "description": "Deletes the specified service and all enclosed versions.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}"
- }
- },
- "resources": {
- "versions": {
- "methods": {
- "create": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "servicesId": {
- "location": "path",
- "description": "Part of `parent`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions",
- "id": "appengine.apps.services.versions.create",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions",
- "request": {
- "$ref": "Version"
- },
- "description": "Deploys code and resource files to a new version."
- },
- "delete": {
- "description": "Deletes an existing Version resource.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
- "type": "string",
- "required": true
- },
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.delete",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}"
- },
- "patch": {
- "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.",
- "request": {
- "$ref": "Version"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "updateMask": {
- "format": "google-fieldmask",
- "description": "Standard field mask for the set of fields to be updated.",
- "type": "string",
- "location": "query"
- },
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.patch",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}"
- },
- "get": {
- "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.",
- "response": {
- "$ref": "Version"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "view": {
- "enum": [
- "BASIC",
- "FULL"
- ],
- "description": "Controls the set of fields returned in the Get response.",
- "type": "string",
- "location": "query"
- },
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.get",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}"
- },
- "list": {
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions",
- "id": "appengine.apps.services.versions.list",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions",
- "description": "Lists the versions of a service.",
- "response": {
- "$ref": "ListVersionsResponse"
- },
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "servicesId": {
- "description": "Part of `parent`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default.",
- "type": "string",
- "required": true
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Maximum results to return per page.",
- "type": "integer"
- },
- "view": {
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "description": "Controls the set of fields returned in the List response.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- }
- },
- "resources": {
- "instances": {
- "methods": {
- "debug": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId",
- "instancesId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "instancesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "id": "appengine.apps.services.versions.instances.debug",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "request": {
- "$ref": "DebugInstanceRequest"
- },
- "description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment."
- },
- "delete": {
- "description": "Stops a running instance.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId",
- "instancesId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "instancesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "id": "appengine.apps.services.versions.instances.delete",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}"
- },
- "get": {
- "response": {
- "$ref": "Instance"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId",
- "instancesId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "instancesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "id": "appengine.apps.services.versions.instances.get",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "description": "Gets instance information."
- },
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "response": {
- "$ref": "ListInstancesResponse"
- },
- "parameters": {
- "servicesId": {
- "location": "path",
- "description": "Part of `parent`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "pageToken": {
- "location": "query",
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1.",
- "type": "string",
- "required": true
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Maximum results to return per page.",
- "type": "integer"
- },
- "versionsId": {
- "location": "path",
- "description": "Part of `parent`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
- "id": "appengine.apps.services.versions.instances.list",
- "description": "Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list)."
- }
- }
- }
- }
- }
- }
- },
- "authorizedDomains": {
- "methods": {
- "list": {
- "description": "Lists all domains the user is authorized to administer.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListAuthorizedDomainsResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "appsId": {
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "pageSize": {
- "format": "int32",
- "description": "Maximum results to return per page.",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta/apps/{appsId}/authorizedDomains",
- "path": "v1beta/apps/{appsId}/authorizedDomains",
- "id": "appengine.apps.authorizedDomains.list"
- }
- }
- },
- "operations": {
- "methods": {
- "get": {
- "flatPath": "v1beta/apps/{appsId}/operations/{operationsId}",
- "path": "v1beta/apps/{appsId}/operations/{operationsId}",
- "id": "appengine.apps.operations.get",
- "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId",
- "operationsId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "operationsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "appsId": {
- "description": "Part of `name`. The name of the operation resource.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- },
- "list": {
- "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "appsId": {
- "description": "Part of `name`. The name of the operation's parent resource.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "pageSize": {
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer",
- "location": "query"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/operations",
- "id": "appengine.apps.operations.list",
- "path": "v1beta/apps/{appsId}/operations"
- }
- }
- },
- "domainMappings": {
- "methods": {
- "delete": {
- "description": "Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "domainMappingsId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "domainMappingsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
- "id": "appengine.apps.domainMappings.delete",
- "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}"
- },
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "appsId",
- "domainMappingsId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "updateMask": {
- "format": "google-fieldmask",
- "description": "Standard field mask for the set of fields to be updated.",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "domainMappingsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
- "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
- "id": "appengine.apps.domainMappings.patch",
- "request": {
- "$ref": "DomainMapping"
- },
- "description": "Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource."
- },
- "get": {
- "flatPath": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
- "id": "appengine.apps.domainMappings.get",
- "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
- "description": "Gets the specified domain mapping.",
- "response": {
- "$ref": "DomainMapping"
- },
- "parameterOrder": [
- "appsId",
- "domainMappingsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "domainMappingsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- }
- },
- "list": {
- "response": {
- "$ref": "ListDomainMappingsResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "appsId": {
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Maximum results to return per page.",
- "type": "integer"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/domainMappings",
- "id": "appengine.apps.domainMappings.list",
- "path": "v1beta/apps/{appsId}/domainMappings",
- "description": "Lists the domain mappings on an application."
- },
- "create": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta/apps/{appsId}/domainMappings",
- "id": "appengine.apps.domainMappings.create",
- "path": "v1beta/apps/{appsId}/domainMappings",
- "request": {
- "$ref": "DomainMapping"
- },
- "description": "Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains."
- }
- }
- },
- "firewall": {
- "resources": {
- "ingressRules": {
- "methods": {
- "batchUpdate": {
- "response": {
- "$ref": "BatchUpdateIngressRulesResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the Firewall collection to set. Example: apps/myapp/firewall/ingressRules.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules:batchUpdate",
- "id": "appengine.apps.firewall.ingressRules.batchUpdate",
- "path": "v1beta/apps/{appsId}/firewall/ingressRules:batchUpdate",
- "request": {
- "$ref": "BatchUpdateIngressRulesRequest"
- },
- "description": "Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the rules of an existing firewall with the new rules.If the final rule does not match traffic with the '*' wildcard IP range, then an \"allow all\" rule is explicitly added to the end of the list."
- },
- "delete": {
- "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "id": "appengine.apps.firewall.ingressRules.delete",
- "description": "Deletes the specified firewall rule.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "appsId",
- "ingressRulesId"
- ],
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the Firewall resource to delete. Example: apps/myapp/firewall/ingressRules/100.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "ingressRulesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "list": {
- "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules",
- "id": "appengine.apps.firewall.ingressRules.list",
- "path": "v1beta/apps/{appsId}/firewall/ingressRules",
- "description": "Lists the firewall rules of an application.",
- "response": {
- "$ref": "ListIngressRulesResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the Firewall collection to retrieve. Example: apps/myapp/firewall/ingressRules.",
- "type": "string",
- "required": true
- },
- "pageSize": {
- "format": "int32",
- "description": "Maximum results to return per page.",
- "type": "integer",
- "location": "query"
- },
- "matchingAddress": {
- "location": "query",
- "description": "A valid IP Address. If set, only rules matching this address will be returned. The first returned rule will be the rule that fires on requests from this IP.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- },
- "create": {
- "description": "Creates a firewall rule for the application.",
- "request": {
- "$ref": "FirewallRule"
- },
- "response": {
- "$ref": "FirewallRule"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Firewall collection in which to create a new rule. Example: apps/myapp/firewall/ingressRules.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules",
- "id": "appengine.apps.firewall.ingressRules.create",
- "path": "v1beta/apps/{appsId}/firewall/ingressRules"
- },
- "get": {
- "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "id": "appengine.apps.firewall.ingressRules.get",
- "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "description": "Gets the specified firewall rule.",
- "response": {
- "$ref": "FirewallRule"
- },
- "parameterOrder": [
- "appsId",
- "ingressRulesId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the Firewall resource to retrieve. Example: apps/myapp/firewall/ingressRules/100.",
- "type": "string",
- "required": true
- },
- "ingressRulesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- }
- },
- "patch": {
- "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "id": "appengine.apps.firewall.ingressRules.patch",
- "description": "Updates the specified firewall rule.",
- "request": {
- "$ref": "FirewallRule"
- },
- "httpMethod": "PATCH",
- "parameterOrder": [
- "appsId",
- "ingressRulesId"
- ],
- "response": {
- "$ref": "FirewallRule"
- },
- "parameters": {
- "ingressRulesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "updateMask": {
- "format": "google-fieldmask",
- "description": "Standard field mask for the set of fields to be updated.",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "description": "Part of `name`. Name of the Firewall resource to update. Example: apps/myapp/firewall/ingressRules/100.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- }
- }
- }
- },
- "locations": {
- "methods": {
- "get": {
- "id": "appengine.apps.locations.get",
- "path": "v1beta/apps/{appsId}/locations/{locationsId}",
- "description": "Get information about a location.",
- "response": {
- "$ref": "Location"
- },
- "parameterOrder": [
- "appsId",
- "locationsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Resource name for the location.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "locationsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta/apps/{appsId}/locations/{locationsId}"
- },
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "ListLocationsResponse"
- },
- "parameters": {
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "appsId": {
- "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta/apps/{appsId}/locations",
- "path": "v1beta/apps/{appsId}/locations",
- "id": "appengine.apps.locations.list",
- "description": "Lists information about the supported locations for this service."
- }
- }
- }
- },
- "methods": {
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "updateMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "Standard field mask for the set of fields to be updated.",
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta/apps/{appsId}",
- "path": "v1beta/apps/{appsId}",
- "id": "appengine.apps.patch",
- "request": {
- "$ref": "Application"
- },
- "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain - Google authentication domain for controlling user access to the application.\ndefault_cookie_expiration - Cookie expiration policy for the application."
- },
- "get": {
- "description": "Gets information about an application.",
- "response": {
- "$ref": "Application"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the Application resource to get. Example: apps/myapp.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1beta/apps/{appsId}",
- "id": "appengine.apps.get",
- "path": "v1beta/apps/{appsId}"
- },
- "create": {
- "flatPath": "v1beta/apps",
- "path": "v1beta/apps",
- "id": "appengine.apps.create",
- "request": {
- "$ref": "Application"
- },
- "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {}
- },
- "repair": {
- "flatPath": "v1beta/apps/{appsId}:repair",
- "id": "appengine.apps.repair",
- "path": "v1beta/apps/{appsId}:repair",
- "request": {
- "$ref": "RepairApplicationRequest"
- },
- "description": "Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the application to repair. Example: apps/myapp",
- "type": "string",
- "required": true
- }
- }
- }
- }
- }
- },
- "parameters": {
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "alt": {
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- }
- }
+ "baseUrl": "https://appengine.googleapis.com/"
}
diff --git a/appengine/v1beta4/appengine-api.json b/appengine/v1beta4/appengine-api.json
index 908913f..734b488 100644
--- a/appengine/v1beta4/appengine-api.json
+++ b/appengine/v1beta4/appengine-api.json
@@ -1,744 +1,917 @@
{
- "schemas": {
- "UrlMap": {
- "description": "URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the version, such as images, CSS, or JavaScript.",
- "type": "object",
- "properties": {
- "login": {
- "enumDescriptions": [
- "Not specified. LOGIN_OPTIONAL is assumed.",
- "Does not require that the user is signed in.",
- "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
- "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
- ],
- "enum": [
- "LOGIN_UNSPECIFIED",
- "LOGIN_OPTIONAL",
- "LOGIN_ADMIN",
- "LOGIN_REQUIRED"
- ],
- "description": "Level of login required to access this resource.",
- "type": "string"
- },
- "apiEndpoint": {
- "$ref": "ApiEndpointHandler",
- "description": "Uses API Endpoints to handle requests."
- },
- "staticDirectory": {
- "$ref": "StaticDirectoryHandler",
- "description": "Serves the entire contents of a directory as static files.This attribute is deprecated. You can mimic the behavior of static directories using static files."
- },
- "staticFiles": {
- "description": "Returns the contents of a file, such as an image, as the response.",
- "$ref": "StaticFilesHandler"
- },
- "redirectHttpResponseCode": {
- "enumDescriptions": [
- "Not specified. 302 is assumed.",
- "301 Moved Permanently code.",
- "302 Moved Temporarily code.",
- "303 See Other code.",
- "307 Temporary Redirect code."
- ],
- "enum": [
- "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED",
- "REDIRECT_HTTP_RESPONSE_CODE_301",
- "REDIRECT_HTTP_RESPONSE_CODE_302",
- "REDIRECT_HTTP_RESPONSE_CODE_303",
- "REDIRECT_HTTP_RESPONSE_CODE_307"
- ],
- "description": "30x code to use when performing redirects for the secure field. Defaults to 302.",
- "type": "string"
- },
- "securityLevel": {
- "enum": [
- "SECURE_UNSPECIFIED",
- "SECURE_DEFAULT",
- "SECURE_NEVER",
- "SECURE_OPTIONAL",
- "SECURE_ALWAYS"
- ],
- "description": "Security (HTTPS) enforcement for this URL.",
- "type": "string",
- "enumDescriptions": [
- "Not specified.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
- "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
- "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
- ]
- },
- "authFailAction": {
- "enumDescriptions": [
- "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
- "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
- "Rejects request with a 401 HTTP status code and an error message."
- ],
- "enum": [
- "AUTH_FAIL_ACTION_UNSPECIFIED",
- "AUTH_FAIL_ACTION_REDIRECT",
- "AUTH_FAIL_ACTION_UNAUTHORIZED"
- ],
- "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
- "type": "string"
- },
- "script": {
- "$ref": "ScriptHandler",
- "description": "Executes a script to handle the request that matches this URL pattern."
- },
- "urlRegex": {
- "description": "A URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.",
- "type": "string"
- }
- },
- "id": "UrlMap"
- },
- "ApiConfigHandler": {
- "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
- "type": "object",
- "properties": {
- "url": {
- "description": "URL to serve the endpoint at.",
- "type": "string"
- },
- "securityLevel": {
- "enumDescriptions": [
- "Not specified.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
- "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
- "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
- ],
- "enum": [
- "SECURE_UNSPECIFIED",
- "SECURE_DEFAULT",
- "SECURE_NEVER",
- "SECURE_OPTIONAL",
- "SECURE_ALWAYS"
- ],
- "description": "Security (HTTPS) enforcement for this URL.",
- "type": "string"
- },
- "authFailAction": {
- "enum": [
- "AUTH_FAIL_ACTION_UNSPECIFIED",
- "AUTH_FAIL_ACTION_REDIRECT",
- "AUTH_FAIL_ACTION_UNAUTHORIZED"
- ],
- "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
- "type": "string",
- "enumDescriptions": [
- "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
- "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
- "Rejects request with a 401 HTTP status code and an error message."
- ]
- },
- "script": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
- },
- "login": {
- "description": "Level of login required to access this resource. Defaults to optional.",
- "type": "string",
- "enumDescriptions": [
- "Not specified. LOGIN_OPTIONAL is assumed.",
- "Does not require that the user is signed in.",
- "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
- "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
- ],
- "enum": [
- "LOGIN_UNSPECIFIED",
- "LOGIN_OPTIONAL",
- "LOGIN_ADMIN",
- "LOGIN_REQUIRED"
- ]
- }
- },
- "id": "ApiConfigHandler"
- },
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a network API call.",
- "type": "object",
- "properties": {
- "error": {
- "description": "The error result of the operation in case of failure or cancellation.",
- "$ref": "Status"
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
+ "resources": {
+ "apps": {
+ "methods": {
+ "patch": {
+ "request": {
+ "$ref": "Application"
},
- "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
- "type": "object"
- },
- "done": {
- "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
- "type": "boolean"
- },
- "response": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.",
- "type": "object"
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.",
- "type": "string"
- }
- },
- "id": "Operation"
- },
- "FileInfo": {
- "description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.",
- "type": "object",
- "properties": {
- "sha1Sum": {
- "description": "The SHA1 hash of the file, in hex.",
- "type": "string"
- },
- "mimeType": {
- "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage.",
- "type": "string"
- },
- "sourceUrl": {
- "description": "URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
- "type": "string"
- }
- },
- "id": "FileInfo"
- },
- "StaticFilesHandler": {
- "description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.",
- "type": "object",
- "properties": {
- "requireMatchingFile": {
- "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
- "type": "boolean"
- },
- "expiration": {
- "format": "google-duration",
- "description": "Time a static file served by this handler should be cached.",
- "type": "string"
- },
- "httpHeaders": {
- "description": "HTTP headers to use for all responses from these URLs.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "applicationReadable": {
- "description": "Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.",
- "type": "boolean"
- },
- "uploadPathRegex": {
- "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.",
- "type": "string"
- },
- "path": {
- "description": "Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.",
- "type": "string"
- },
- "mimeType": {
- "description": "MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are derived from each file's filename extension.",
- "type": "string"
- }
- },
- "id": "StaticFilesHandler"
- },
- "ScriptHandler": {
- "description": "Executes a script to handle the request that matches the URL pattern.",
- "type": "object",
- "properties": {
- "scriptPath": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
- }
- },
- "id": "ScriptHandler"
- },
- "DiskUtilization": {
- "description": "Target scaling by disk usage. Only applicable for VM runtimes.",
- "type": "object",
- "properties": {
- "targetReadOpsPerSec": {
- "format": "int32",
- "description": "Target ops read per second.",
- "type": "integer"
- },
- "targetReadBytesPerSec": {
- "format": "int32",
- "description": "Target bytes read per second.",
- "type": "integer"
- },
- "targetWriteOpsPerSec": {
- "format": "int32",
- "description": "Target ops written per second.",
- "type": "integer"
- },
- "targetWriteBytesPerSec": {
- "format": "int32",
- "description": "Target bytes written per second.",
- "type": "integer"
- }
- },
- "id": "DiskUtilization"
- },
- "BasicScaling": {
- "description": "A module with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.",
- "type": "object",
- "properties": {
- "idleTimeout": {
- "format": "google-duration",
- "description": "Duration of time after the last request that an instance must wait before the instance is shut down.",
- "type": "string"
- },
- "maxInstances": {
- "format": "int32",
- "description": "Maximum number of instances to create for this version.",
- "type": "integer"
- }
- },
- "id": "BasicScaling"
- },
- "OperationMetadataExperimental": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "insertTime": {
- "format": "google-datetime",
- "description": "Time that this operation was created.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "Time that this operation completed.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/customDomains/example.com.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.experimental.CustomDomains.CreateCustomDomain.@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadataExperimental"
- },
- "CpuUtilization": {
- "description": "Target scaling by CPU usage.",
- "type": "object",
- "properties": {
- "aggregationWindowLength": {
- "format": "google-duration",
- "description": "Period of time over which CPU utilization is calculated.",
- "type": "string"
- },
- "targetUtilization": {
- "format": "double",
- "description": "Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.",
- "type": "number"
- }
- },
- "id": "CpuUtilization"
- },
- "IdentityAwareProxy": {
- "description": "Identity-Aware Proxy",
- "type": "object",
- "properties": {
- "oauth2ClientSecret": {
- "description": "For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly",
- "type": "string"
- },
- "oauth2ClientId": {
- "description": "OAuth2 client ID to use for the authentication flow.",
- "type": "string"
- },
- "oauth2ClientSecretSha256": {
- "description": "Hex-encoded SHA-256 hash of the client secret.@OutputOnly",
- "type": "string"
- },
- "enabled": {
- "description": "Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.",
- "type": "boolean"
- }
- },
- "id": "IdentityAwareProxy"
- },
- "Status": {
- "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- },
- "type": "array"
- },
- "code": {
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
- "type": "string"
- }
- },
- "id": "Status"
- },
- "TrafficSplit": {
- "description": "Traffic routing configuration for versions within a single module. Traffic splits define how traffic directed to the module is assigned to versions.",
- "type": "object",
- "properties": {
- "allocations": {
- "description": "Mapping from version IDs within the module to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the module may not have any traffic allocation. Modules that have traffic allocated cannot be deleted until either the module is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.",
- "type": "object",
- "additionalProperties": {
- "format": "double",
- "type": "number"
- }
- },
- "shardBy": {
- "enum": [
- "UNSPECIFIED",
- "COOKIE",
- "IP"
- ],
- "description": "Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.",
- "type": "string",
- "enumDescriptions": [
- "Diversion method unspecified.",
- "Diversion based on a specially named cookie, \"GOOGAPPUID.\" The cookie must be set by the application itself or else no diversion will occur.",
- "Diversion based on applying the modulus operation to a fingerprint of the IP address."
- ]
- }
- },
- "id": "TrafficSplit"
- },
- "ManualScaling": {
- "description": "A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
- "type": "object",
- "properties": {
- "instances": {
- "format": "int32",
- "description": "Number of instances to assign to the module at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.",
- "type": "integer"
- }
- },
- "id": "ManualScaling"
- },
- "LocationMetadata": {
- "description": "Metadata for the given google.cloud.location.Location.",
- "type": "object",
- "properties": {
- "flexibleEnvironmentAvailable": {
- "description": "App Engine Flexible Environment is available in the given location.@OutputOnly",
- "type": "boolean"
- },
- "standardEnvironmentAvailable": {
- "description": "App Engine Standard Environment is available in the given location.@OutputOnly",
- "type": "boolean"
- }
- },
- "id": "LocationMetadata"
- },
- "OperationMetadataV1Beta": {
- "properties": {
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "insertTime": {
- "format": "google-datetime",
- "description": "Time that this operation was created.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "Time that this operation completed.@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1Beta",
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object"
- },
- "ListModulesResponse": {
- "description": "Response message for Modules.ListModules.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "modules": {
- "description": "The modules belonging to the requested application.",
- "items": {
- "$ref": "Module"
- },
- "type": "array"
- }
- },
- "id": "ListModulesResponse"
- },
- "Deployment": {
- "properties": {
- "sourceReferences": {
- "description": "Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.",
- "items": {
- "$ref": "SourceReference"
- },
- "type": "array"
- },
- "container": {
- "$ref": "ContainerInfo",
- "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment."
- },
- "files": {
- "additionalProperties": {
- "$ref": "FileInfo"
- },
- "description": "Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.",
- "type": "object"
- }
- },
- "id": "Deployment",
- "description": "Code and application artifacts used to deploy a version to App Engine.",
- "type": "object"
- },
- "Resources": {
- "description": "Machine resources for a version.",
- "type": "object",
- "properties": {
- "memoryGb": {
- "format": "double",
- "description": "Memory (GB) needed.",
- "type": "number"
- },
- "cpu": {
- "format": "double",
- "description": "Number of CPU cores needed.",
- "type": "number"
- },
- "volumes": {
- "description": "User specified volumes.",
- "items": {
- "$ref": "Volume"
- },
- "type": "array"
- },
- "diskGb": {
- "format": "double",
- "description": "Disk size (GB) needed.",
- "type": "number"
- }
- },
- "id": "Resources"
- },
- "Volume": {
- "description": "Volumes mounted within the app container. Only applicable for VM runtimes.",
- "type": "object",
- "properties": {
- "volumeType": {
- "description": "Underlying volume type, e.g. 'tmpfs'.",
- "type": "string"
- },
- "sizeGb": {
- "format": "double",
- "description": "Volume size in gigabytes.",
- "type": "number"
- },
- "name": {
- "description": "Unique name for the volume.",
- "type": "string"
- }
- },
- "id": "Volume"
- },
- "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": {
+ "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps#Application.FIELDS.auth_domain)\ndefault_cookie_expiration (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps#Application.FIELDS.default_cookie_expiration)",
+ "response": {
"$ref": "Operation"
},
- "type": "array"
- }
- },
- "id": "ListOperationsResponse",
- "description": "The response message for Operations.ListOperations.",
- "type": "object"
- },
- "OperationMetadata": {
- "properties": {
- "insertTime": {
- "format": "google-datetime",
- "description": "Timestamp that this operation was created.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "Timestamp that this operation completed.@OutputOnly",
- "type": "string"
- },
- "operationType": {
- "description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadata",
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object"
- },
- "ListInstancesResponse": {
- "description": "Response message for Instances.ListInstances.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "instances": {
- "description": "The instances belonging to the requested version.",
- "items": {
- "$ref": "Instance"
- },
- "type": "array"
- }
- },
- "id": "ListInstancesResponse"
- },
- "OperationMetadataV1": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "insertTime": {
- "format": "google-datetime",
- "description": "Time that this operation was created.@OutputOnly",
- "type": "string"
- },
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "Time that this operation completed.@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1"
- },
- "ErrorHandler": {
- "description": "Custom static error page to be served when an error occurs.",
- "type": "object",
- "properties": {
- "mimeType": {
- "description": "MIME type of file. Defaults to text/html.",
- "type": "string"
- },
- "errorCode": {
- "enumDescriptions": [
- "Not specified. ERROR_CODE_DEFAULT is assumed.",
- "All other error types.",
- "Application has exceeded a resource quota.",
- "Client blocked by the application's Denial of Service protection configuration.",
- "Deadline reached before the application responds."
+ "parameterOrder": [
+ "appsId"
],
- "enum": [
- "ERROR_CODE_UNSPECIFIED",
- "ERROR_CODE_DEFAULT",
- "ERROR_CODE_OVER_QUOTA",
- "ERROR_CODE_DOS_API_DENIAL",
- "ERROR_CODE_TIMEOUT"
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
],
- "description": "Error condition this handler applies to.",
- "type": "string"
+ "parameters": {
+ "mask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Standard field mask for the set of fields to be updated.",
+ "type": "string"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta4/apps/{appsId}",
+ "id": "appengine.apps.patch",
+ "path": "v1beta4/apps/{appsId}"
},
- "staticFile": {
- "description": "Static file content to be served for this error.",
- "type": "string"
+ "get": {
+ "response": {
+ "$ref": "Application"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "ensureResourcesExist": {
+ "location": "query",
+ "description": "Certain resources associated with an application are created on-demand. Controls whether these resources should be created when performing the GET operation. If specified and any resources could not be created, the request will fail with an error code. Additionally, this parameter can cause the request to take longer to complete.",
+ "type": "boolean"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the application to get. Example: apps/myapp.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta4/apps/{appsId}",
+ "id": "appengine.apps.get",
+ "path": "v1beta4/apps/{appsId}",
+ "description": "Gets information about an application."
+ },
+ "create": {
+ "request": {
+ "$ref": "Application"
+ },
+ "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1beta4/apps",
+ "path": "v1beta4/apps",
+ "id": "appengine.apps.create"
}
},
- "id": "ErrorHandler"
+ "resources": {
+ "modules": {
+ "methods": {
+ "patch": {
+ "description": "Updates the configuration of the specified module.",
+ "request": {
+ "$ref": "Module"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "modulesId"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/modules/default.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "migrateTraffic": {
+ "location": "query",
+ "description": "Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules#shardby) field in the Module resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).",
+ "type": "boolean"
+ },
+ "mask": {
+ "format": "google-fieldmask",
+ "description": "Standard field mask for the set of fields to be updated.",
+ "type": "string",
+ "location": "query"
+ },
+ "modulesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}",
+ "id": "appengine.apps.modules.patch",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}"
+ },
+ "list": {
+ "description": "Lists all the modules in the application.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListModulesResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Maximum results to return per page.",
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta4/apps/{appsId}/modules",
+ "path": "v1beta4/apps/{appsId}/modules",
+ "id": "appengine.apps.modules.list"
+ },
+ "get": {
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}",
+ "id": "appengine.apps.modules.get",
+ "description": "Gets the current configuration of the specified module.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Module"
+ },
+ "parameterOrder": [
+ "appsId",
+ "modulesId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default.",
+ "type": "string",
+ "required": true
+ },
+ "modulesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}"
+ },
+ "delete": {
+ "description": "Deletes the specified module and all enclosed versions.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "modulesId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "modulesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}",
+ "id": "appengine.apps.modules.delete",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}"
+ }
+ },
+ "resources": {
+ "versions": {
+ "methods": {
+ "delete": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "appsId",
+ "modulesId",
+ "versionsId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1.",
+ "type": "string",
+ "required": true
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "modulesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
+ "id": "appengine.apps.modules.versions.delete",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
+ "description": "Deletes an existing version."
+ },
+ "patch": {
+ "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.",
+ "request": {
+ "$ref": "Version"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "modulesId",
+ "versionsId"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/modules/default/versions/1.",
+ "type": "string",
+ "required": true
+ },
+ "mask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Standard field mask for the set of fields to be updated.",
+ "type": "string"
+ },
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "modulesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
+ "id": "appengine.apps.modules.versions.patch",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}"
+ },
+ "list": {
+ "response": {
+ "$ref": "ListVersionsResponse"
+ },
+ "parameterOrder": [
+ "appsId",
+ "modulesId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default.",
+ "type": "string",
+ "required": true
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Maximum results to return per page.",
+ "type": "integer",
+ "location": "query"
+ },
+ "view": {
+ "description": "Controls the set of fields returned in the List response.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ]
+ },
+ "modulesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
+ "id": "appengine.apps.modules.versions.list",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
+ "description": "Lists the versions of a module."
+ },
+ "get": {
+ "response": {
+ "$ref": "Version"
+ },
+ "parameterOrder": [
+ "appsId",
+ "modulesId",
+ "versionsId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1.",
+ "type": "string",
+ "required": true
+ },
+ "view": {
+ "description": "Controls the set of fields returned in the Get response.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ]
+ },
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "modulesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
+ "id": "appengine.apps.modules.versions.get",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
+ "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource."
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "appsId",
+ "modulesId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "modulesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/modules/default.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
+ "id": "appengine.apps.modules.versions.create",
+ "description": "Deploys code and resource files to a new version.",
+ "request": {
+ "$ref": "Version"
+ }
+ }
+ },
+ "resources": {
+ "instances": {
+ "methods": {
+ "delete": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "modulesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "instancesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1/instances/instance-1.",
+ "type": "string",
+ "required": true
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "modulesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}",
+ "id": "appengine.apps.modules.versions.instances.delete",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}",
+ "description": "Stops a running instance."
+ },
+ "list": {
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances",
+ "id": "appengine.apps.modules.versions.instances.list",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances",
+ "description": "Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).",
+ "response": {
+ "$ref": "ListInstancesResponse"
+ },
+ "parameterOrder": [
+ "appsId",
+ "modulesId",
+ "versionsId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Maximum results to return per page.",
+ "type": "integer"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "modulesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "get": {
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}",
+ "id": "appengine.apps.modules.versions.instances.get",
+ "description": "Gets instance information.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "appsId",
+ "modulesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "response": {
+ "$ref": "Instance"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "instancesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1/instances/instance-1.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "modulesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}"
+ },
+ "debug": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "modulesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "modulesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "instancesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1/instances/instance-1.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "id": "appengine.apps.modules.versions.instances.debug",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "request": {
+ "$ref": "DebugInstanceRequest"
+ },
+ "description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment."
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "get": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "operationsId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. The name of the operation resource.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "operationsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta4/apps/{appsId}/operations/{operationsId}",
+ "id": "appengine.apps.operations.get",
+ "path": "v1beta4/apps/{appsId}/operations/{operationsId}",
+ "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service."
+ },
+ "list": {
+ "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. The name of the operation's parent resource.",
+ "type": "string",
+ "required": true
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer"
+ },
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta4/apps/{appsId}/operations",
+ "id": "appengine.apps.operations.list",
+ "path": "v1beta4/apps/{appsId}/operations"
+ }
+ }
+ },
+ "locations": {
+ "methods": {
+ "get": {
+ "description": "Get information about a location.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "appsId",
+ "locationsId"
+ ],
+ "response": {
+ "$ref": "Location"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "locationsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "description": "Part of `name`. Resource name for the location.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta4/apps/{appsId}/locations/{locationsId}",
+ "path": "v1beta4/apps/{appsId}/locations/{locationsId}",
+ "id": "appengine.apps.locations.get"
+ },
+ "list": {
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
+ "type": "string",
+ "required": true
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer"
+ },
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta4/apps/{appsId}/locations",
+ "id": "appengine.apps.locations.list",
+ "path": "v1beta4/apps/{appsId}/locations",
+ "description": "Lists information about the supported locations for this service."
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
},
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ }
+ },
+ "schemas": {
"OperationMetadataV1Alpha": {
"description": "Metadata for the given google.longrunning.Operation.",
"type": "object",
"properties": {
- "insertTime": {
- "format": "google-datetime",
- "description": "Time that this operation was created.@OutputOnly",
- "type": "string"
- },
"warning": {
"description": "Durable messages that persist on every operation poll. @OutputOnly",
"items": {
@@ -746,14 +919,19 @@
},
"type": "array"
},
- "user": {
- "description": "User who requested this operation.@OutputOnly",
+ "insertTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation was created.@OutputOnly",
"type": "string"
},
"target": {
"description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
"type": "string"
},
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
"ephemeralMessage": {
"description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
"type": "string"
@@ -772,34 +950,6 @@
},
"Application": {
"properties": {
- "iap": {
- "$ref": "IdentityAwareProxy"
- },
- "authDomain": {
- "description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.",
- "type": "string"
- },
- "defaultCookieExpiration": {
- "format": "google-duration",
- "description": "Cookie expiration policy for this application.",
- "type": "string"
- },
- "id": {
- "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.",
- "type": "string"
- },
- "codeBucket": {
- "description": "Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly",
- "type": "string"
- },
- "location": {
- "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US",
- "type": "string"
- },
- "defaultBucket": {
- "description": "Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly",
- "type": "string"
- },
"dispatchRules": {
"description": "HTTP path dispatch rules for requests to the application that do not explicitly target a module or version. Rules are order-dependent.@OutputOnly",
"items": {
@@ -814,6 +964,34 @@
"name": {
"description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
"type": "string"
+ },
+ "authDomain": {
+ "description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.",
+ "type": "string"
+ },
+ "iap": {
+ "$ref": "IdentityAwareProxy"
+ },
+ "id": {
+ "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.",
+ "type": "string"
+ },
+ "defaultCookieExpiration": {
+ "format": "google-duration",
+ "description": "Cookie expiration policy for this application.",
+ "type": "string"
+ },
+ "codeBucket": {
+ "description": "Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly",
+ "type": "string"
+ },
+ "location": {
+ "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US",
+ "type": "string"
+ },
+ "defaultBucket": {
+ "description": "Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly",
+ "type": "string"
}
},
"id": "Application",
@@ -844,6 +1022,10 @@
},
"Instance": {
"properties": {
+ "vmName": {
+ "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
"qps": {
"format": "float",
"description": "Average queries per second (QPS) over the last minute.@OutputOnly",
@@ -870,8 +1052,8 @@
"description": "Average latency (ms) over the last minute.@OutputOnly",
"type": "integer"
},
- "vmIp": {
- "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "id": {
+ "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
"type": "string"
},
"memoryUsage": {
@@ -879,33 +1061,33 @@
"description": "Total memory in use (bytes).@OutputOnly",
"type": "string"
},
- "id": {
- "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
+ "vmIp": {
+ "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
"type": "string"
},
- "errors": {
- "format": "uint32",
- "description": "Number of errors since this instance was started.@OutputOnly",
- "type": "integer"
- },
"availability": {
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
"enum": [
"UNSPECIFIED",
"RESIDENT",
"DYNAMIC"
],
"description": "Availability of the instance.@OutputOnly",
- "type": "string",
- "enumDescriptions": [
- "",
- "",
- ""
- ]
+ "type": "string"
},
"vmStatus": {
"description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
"type": "string"
},
+ "errors": {
+ "format": "uint32",
+ "description": "Number of errors since this instance was started.@OutputOnly",
+ "type": "integer"
+ },
"requests": {
"format": "int32",
"description": "Number of requests since this instance was started.@OutputOnly",
@@ -919,10 +1101,6 @@
"format": "google-datetime",
"description": "Time that this instance was started.@OutputOnly",
"type": "string"
- },
- "vmName": {
- "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
}
},
"id": "Instance",
@@ -933,10 +1111,6 @@
"description": "Rules to match an HTTP request and dispatch that request to a module.",
"type": "object",
"properties": {
- "path": {
- "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.",
- "type": "string"
- },
"module": {
"description": "Resource ID of a module in this application that should serve the matched request. The module must already exist. Example: default.",
"type": "string"
@@ -944,6 +1118,10 @@
"domain": {
"description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
"type": "string"
+ },
+ "path": {
+ "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.",
+ "type": "string"
}
},
"id": "UrlDispatchRule"
@@ -997,38 +1175,12 @@
"id": "ApiEndpointHandler"
},
"AutomaticScaling": {
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
+ "type": "object",
"properties": {
- "minTotalInstances": {
- "format": "int32",
- "description": "Minimum number of instances that should be maintained for this version.",
- "type": "integer"
- },
- "networkUtilization": {
- "description": "Target scaling by network usage.",
- "$ref": "NetworkUtilization"
- },
- "coolDownPeriod": {
- "format": "google-duration",
- "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.",
- "type": "string"
- },
- "maxConcurrentRequests": {
- "format": "int32",
- "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
- "type": "integer"
- },
- "maxPendingLatency": {
- "format": "google-duration",
- "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.",
- "type": "string"
- },
- "cpuUtilization": {
- "$ref": "CpuUtilization",
- "description": "Target scaling by CPU usage."
- },
"diskUtilization": {
- "description": "Target scaling by disk usage.",
- "$ref": "DiskUtilization"
+ "$ref": "DiskUtilization",
+ "description": "Target scaling by disk usage."
},
"minPendingLatency": {
"format": "google-duration",
@@ -1053,16 +1205,50 @@
"format": "int32",
"description": "Maximum number of instances that should be started to handle requests.",
"type": "integer"
+ },
+ "minTotalInstances": {
+ "format": "int32",
+ "description": "Minimum number of instances that should be maintained for this version.",
+ "type": "integer"
+ },
+ "networkUtilization": {
+ "$ref": "NetworkUtilization",
+ "description": "Target scaling by network usage."
+ },
+ "coolDownPeriod": {
+ "format": "google-duration",
+ "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.",
+ "type": "string"
+ },
+ "maxConcurrentRequests": {
+ "format": "int32",
+ "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
+ "type": "integer"
+ },
+ "maxPendingLatency": {
+ "format": "google-duration",
+ "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.",
+ "type": "string"
+ },
+ "cpuUtilization": {
+ "description": "Target scaling by CPU usage.",
+ "$ref": "CpuUtilization"
}
},
- "id": "AutomaticScaling",
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
- "type": "object"
+ "id": "AutomaticScaling"
},
"StaticDirectoryHandler": {
"description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static directory handlers make it easy to serve the entire contents of a directory as static files.",
"type": "object",
"properties": {
+ "mimeType": {
+ "description": "MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are direved from each file's filename extension.",
+ "type": "string"
+ },
+ "requireMatchingFile": {
+ "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
+ "type": "boolean"
+ },
"expiration": {
"format": "google-duration",
"description": "Time a static file served by this handler should be cached.",
@@ -1073,56 +1259,18 @@
"type": "boolean"
},
"httpHeaders": {
- "additionalProperties": {
- "type": "string"
- },
"description": "HTTP headers to use for all responses from these URLs.",
- "type": "object"
- },
- "directory": {
- "description": "Path to the directory containing the static files from the application root directory. Everything after the end of the matched URL pattern is appended to static_dir to form the full path to the requested file.",
- "type": "string"
- },
- "mimeType": {
- "description": "MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are direved from each file's filename extension.",
- "type": "string"
- },
- "requireMatchingFile": {
- "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
- "type": "boolean"
- }
- },
- "id": "StaticDirectoryHandler"
- },
- "Location": {
- "description": "A resource that represents Google Cloud Platform location.",
- "type": "object",
- "properties": {
- "labels": {
- "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
- "name": {
- "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
+ "directory": {
+ "description": "Path to the directory containing the static files from the application root directory. Everything after the end of the matched URL pattern is appended to static_dir to form the full path to the requested file.",
"type": "string"
- },
- "locationId": {
- "description": "The canonical id for this location. For example: \"us-east1\".",
- "type": "string"
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata. For example the available capacity at the given location.",
- "type": "object"
}
},
- "id": "Location"
+ "id": "StaticDirectoryHandler"
},
"NetworkUtilization": {
"properties": {
@@ -1151,8 +1299,53 @@
"description": "Target scaling by network usage. Only applicable for VM runtimes.",
"type": "object"
},
+ "Location": {
+ "description": "A resource that represents Google Cloud Platform location.",
+ "type": "object",
+ "properties": {
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
+ "type": "object"
+ },
+ "name": {
+ "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
+ "type": "string"
+ },
+ "locationId": {
+ "description": "The canonical id for this location. For example: \"us-east1\".",
+ "type": "string"
+ },
+ "metadata": {
+ "description": "Service-specific metadata. For example the available capacity at the given location.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ }
+ },
+ "id": "Location"
+ },
"HealthCheck": {
"properties": {
+ "restartThreshold": {
+ "format": "uint32",
+ "description": "Number of consecutive failed health checks required before an instance is restarted.",
+ "type": "integer"
+ },
+ "healthyThreshold": {
+ "format": "uint32",
+ "description": "Number of consecutive successful health checks required before receiving traffic.",
+ "type": "integer"
+ },
+ "checkInterval": {
+ "format": "google-duration",
+ "description": "Interval between health checks.",
+ "type": "string"
+ },
"timeout": {
"format": "google-duration",
"description": "Time before the health check is considered failed.",
@@ -1170,27 +1363,27 @@
"host": {
"description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"",
"type": "string"
- },
- "healthyThreshold": {
- "format": "uint32",
- "description": "Number of consecutive successful health checks required before receiving traffic.",
- "type": "integer"
- },
- "restartThreshold": {
- "format": "uint32",
- "description": "Number of consecutive failed health checks required before an instance is restarted.",
- "type": "integer"
- },
- "checkInterval": {
- "format": "google-duration",
- "description": "Interval between health checks.",
- "type": "string"
}
},
"id": "HealthCheck",
"description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.",
"type": "object"
},
+ "SourceReference": {
+ "properties": {
+ "repository": {
+ "description": "URI string identifying the repository. Example: \"https://source.developers.google.com/p/app-123/r/default\"",
+ "type": "string"
+ },
+ "revisionId": {
+ "description": "The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): \"2198322f89e0bb2e25021667c2ed489d1fd34e6b\"",
+ "type": "string"
+ }
+ },
+ "id": "SourceReference",
+ "description": "Reference to a particular snapshot of the source tree used to build and deploy the application.",
+ "type": "object"
+ },
"DebugInstanceRequest": {
"description": "Request message for Instances.DebugInstance.",
"type": "object",
@@ -1202,22 +1395,24 @@
},
"id": "DebugInstanceRequest"
},
- "SourceReference": {
+ "Library": {
+ "description": "Third-party Python runtime library that is required by the application.",
+ "type": "object",
"properties": {
- "revisionId": {
- "description": "The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): \"2198322f89e0bb2e25021667c2ed489d1fd34e6b\"",
+ "version": {
+ "description": "Version of the library to select, or \"latest\".",
"type": "string"
},
- "repository": {
- "description": "URI string identifying the repository. Example: \"https://source.developers.google.com/p/app-123/r/default\"",
+ "name": {
+ "description": "Name of the library. Example: \"django\".",
"type": "string"
}
},
- "id": "SourceReference",
- "description": "Reference to a particular snapshot of the source tree used to build and deploy the application.",
- "type": "object"
+ "id": "Library"
},
"OperationMetadataV1Beta5": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
"properties": {
"method": {
"description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
@@ -1242,24 +1437,7 @@
"type": "string"
}
},
- "id": "OperationMetadataV1Beta5",
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object"
- },
- "Library": {
- "description": "Third-party Python runtime library that is required by the application.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the library. Example: \"django\".",
- "type": "string"
- },
- "version": {
- "description": "Version of the library to select, or \"latest\".",
- "type": "string"
- }
- },
- "id": "Library"
+ "id": "OperationMetadataV1Beta5"
},
"ListLocationsResponse": {
"properties": {
@@ -1279,21 +1457,55 @@
"description": "The response message for Locations.ListLocations.",
"type": "object"
},
- "ContainerInfo": {
- "description": "Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment.",
- "type": "object",
- "properties": {
- "image": {
- "description": "URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: \"gcr.io/my-project/image:tag\" or \"gcr.io/my-project/image@digest\"",
- "type": "string"
- }
- },
- "id": "ContainerInfo"
- },
"Version": {
"description": "A Version resource is a specific set of source code and configuration files that are deployed into a module.",
"type": "object",
"properties": {
+ "envVariables": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Environment variables made available to the application.Only returned in GET requests if view=FULL is set.",
+ "type": "object"
+ },
+ "network": {
+ "$ref": "Network",
+ "description": "Extra network settings. Only applicable for VM runtimes."
+ },
+ "betaSettings": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Metadata settings that are supplied to this version to enable beta runtime features.",
+ "type": "object"
+ },
+ "env": {
+ "description": "App Engine execution environment to use for this version.Defaults to 1.",
+ "type": "string"
+ },
+ "handlers": {
+ "description": "An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.",
+ "items": {
+ "$ref": "UrlMap"
+ },
+ "type": "array"
+ },
+ "deployer": {
+ "description": "Email address of the user who created this version.@OutputOnly",
+ "type": "string"
+ },
+ "automaticScaling": {
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
+ "$ref": "AutomaticScaling"
+ },
+ "healthCheck": {
+ "$ref": "HealthCheck",
+ "description": "Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes.Only returned in GET requests if view=FULL is set."
+ },
+ "threadsafe": {
+ "description": "Whether multiple requests can be dispatched to this version at once.",
+ "type": "boolean"
+ },
"manualScaling": {
"$ref": "ManualScaling",
"description": "A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time."
@@ -1336,24 +1548,10 @@
"description": "The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/\u003clanguage\u003e/config/appref",
"type": "string"
},
- "resources": {
- "description": "Machine resources for this version. Only applicable for VM runtimes.",
- "$ref": "Resources"
- },
"inboundServices": {
- "enumDescriptions": [
- "Not specified.",
- "Allows an application to receive mail.",
- "Allows an application to receive email-bound notifications.",
- "Allows an application to receive error stanzas.",
- "Allows an application to receive instant messages.",
- "Allows an application to receive user subscription POSTs.",
- "Allows an application to receive a user's chat presence.",
- "Registers an application for notifications when a client connects or disconnects from a channel.",
- "Enables warmup requests."
- ],
"description": "Before an application can receive email or XMPP messages, the application must be configured to enable the service.",
"items": {
+ "type": "string",
"enum": [
"INBOUND_SERVICE_UNSPECIFIED",
"INBOUND_SERVICE_MAIL",
@@ -1364,10 +1562,24 @@
"INBOUND_SERVICE_XMPP_PRESENCE",
"INBOUND_SERVICE_CHANNEL_PRESENCE",
"INBOUND_SERVICE_WARMUP"
- ],
- "type": "string"
+ ]
},
- "type": "array"
+ "type": "array",
+ "enumDescriptions": [
+ "Not specified.",
+ "Allows an application to receive mail.",
+ "Allows an application to receive email-bound notifications.",
+ "Allows an application to receive error stanzas.",
+ "Allows an application to receive instant messages.",
+ "Allows an application to receive user subscription POSTs.",
+ "Allows an application to receive a user's chat presence.",
+ "Registers an application for notifications when a client connects or disconnects from a channel.",
+ "Enables warmup requests."
+ ]
+ },
+ "resources": {
+ "$ref": "Resources",
+ "description": "Machine resources for this version. Only applicable for VM runtimes."
},
"errorHandlers": {
"description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.",
@@ -1408,59 +1620,23 @@
"id": {
"description": "Relative name of the version within the module. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: \"default\", \"latest\", and any name with the prefix \"ah-\".",
"type": "string"
- },
- "envVariables": {
- "description": "Environment variables made available to the application.Only returned in GET requests if view=FULL is set.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "network": {
- "description": "Extra network settings. Only applicable for VM runtimes.",
- "$ref": "Network"
- },
- "betaSettings": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Metadata settings that are supplied to this version to enable beta runtime features.",
- "type": "object"
- },
- "env": {
- "description": "App Engine execution environment to use for this version.Defaults to 1.",
- "type": "string"
- },
- "handlers": {
- "description": "An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.",
- "items": {
- "$ref": "UrlMap"
- },
- "type": "array"
- },
- "deployer": {
- "description": "Email address of the user who created this version.@OutputOnly",
- "type": "string"
- },
- "automaticScaling": {
- "$ref": "AutomaticScaling",
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics."
- },
- "healthCheck": {
- "description": "Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes.Only returned in GET requests if view=FULL is set.",
- "$ref": "HealthCheck"
- },
- "threadsafe": {
- "description": "Whether multiple requests can be dispatched to this version at once.",
- "type": "boolean"
}
},
"id": "Version"
},
- "RequestUtilization": {
- "description": "Target scaling by request utilization. Only applicable for VM runtimes.",
+ "ContainerInfo": {
+ "description": "Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment.",
"type": "object",
"properties": {
+ "image": {
+ "description": "URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: \"gcr.io/my-project/image:tag\" or \"gcr.io/my-project/image@digest\"",
+ "type": "string"
+ }
+ },
+ "id": "ContainerInfo"
+ },
+ "RequestUtilization": {
+ "properties": {
"targetConcurrentRequests": {
"format": "int32",
"description": "Target number of concurrent requests.",
@@ -1472,27 +1648,759 @@
"type": "integer"
}
},
- "id": "RequestUtilization"
+ "id": "RequestUtilization",
+ "description": "Target scaling by request utilization. Only applicable for VM runtimes.",
+ "type": "object"
+ },
+ "UrlMap": {
+ "description": "URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the version, such as images, CSS, or JavaScript.",
+ "type": "object",
+ "properties": {
+ "securityLevel": {
+ "enumDescriptions": [
+ "Not specified.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
+ "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
+ "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
+ ],
+ "enum": [
+ "SECURE_UNSPECIFIED",
+ "SECURE_DEFAULT",
+ "SECURE_NEVER",
+ "SECURE_OPTIONAL",
+ "SECURE_ALWAYS"
+ ],
+ "description": "Security (HTTPS) enforcement for this URL.",
+ "type": "string"
+ },
+ "authFailAction": {
+ "enumDescriptions": [
+ "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
+ "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
+ "Rejects request with a 401 HTTP status code and an error message."
+ ],
+ "enum": [
+ "AUTH_FAIL_ACTION_UNSPECIFIED",
+ "AUTH_FAIL_ACTION_REDIRECT",
+ "AUTH_FAIL_ACTION_UNAUTHORIZED"
+ ],
+ "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
+ "type": "string"
+ },
+ "script": {
+ "description": "Executes a script to handle the request that matches this URL pattern.",
+ "$ref": "ScriptHandler"
+ },
+ "urlRegex": {
+ "description": "A URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.",
+ "type": "string"
+ },
+ "login": {
+ "enumDescriptions": [
+ "Not specified. LOGIN_OPTIONAL is assumed.",
+ "Does not require that the user is signed in.",
+ "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
+ "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
+ ],
+ "enum": [
+ "LOGIN_UNSPECIFIED",
+ "LOGIN_OPTIONAL",
+ "LOGIN_ADMIN",
+ "LOGIN_REQUIRED"
+ ],
+ "description": "Level of login required to access this resource.",
+ "type": "string"
+ },
+ "apiEndpoint": {
+ "description": "Uses API Endpoints to handle requests.",
+ "$ref": "ApiEndpointHandler"
+ },
+ "staticDirectory": {
+ "$ref": "StaticDirectoryHandler",
+ "description": "Serves the entire contents of a directory as static files.This attribute is deprecated. You can mimic the behavior of static directories using static files."
+ },
+ "staticFiles": {
+ "$ref": "StaticFilesHandler",
+ "description": "Returns the contents of a file, such as an image, as the response."
+ },
+ "redirectHttpResponseCode": {
+ "enum": [
+ "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED",
+ "REDIRECT_HTTP_RESPONSE_CODE_301",
+ "REDIRECT_HTTP_RESPONSE_CODE_302",
+ "REDIRECT_HTTP_RESPONSE_CODE_303",
+ "REDIRECT_HTTP_RESPONSE_CODE_307"
+ ],
+ "description": "30x code to use when performing redirects for the secure field. Defaults to 302.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified. 302 is assumed.",
+ "301 Moved Permanently code.",
+ "302 Moved Temporarily code.",
+ "303 See Other code.",
+ "307 Temporary Redirect code."
+ ]
+ }
+ },
+ "id": "UrlMap"
+ },
+ "ApiConfigHandler": {
+ "properties": {
+ "url": {
+ "description": "URL to serve the endpoint at.",
+ "type": "string"
+ },
+ "securityLevel": {
+ "enum": [
+ "SECURE_UNSPECIFIED",
+ "SECURE_DEFAULT",
+ "SECURE_NEVER",
+ "SECURE_OPTIONAL",
+ "SECURE_ALWAYS"
+ ],
+ "description": "Security (HTTPS) enforcement for this URL.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
+ "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
+ "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
+ ]
+ },
+ "authFailAction": {
+ "enumDescriptions": [
+ "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
+ "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
+ "Rejects request with a 401 HTTP status code and an error message."
+ ],
+ "enum": [
+ "AUTH_FAIL_ACTION_UNSPECIFIED",
+ "AUTH_FAIL_ACTION_REDIRECT",
+ "AUTH_FAIL_ACTION_UNAUTHORIZED"
+ ],
+ "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
+ "type": "string"
+ },
+ "script": {
+ "description": "Path to the script from the application root directory.",
+ "type": "string"
+ },
+ "login": {
+ "enumDescriptions": [
+ "Not specified. LOGIN_OPTIONAL is assumed.",
+ "Does not require that the user is signed in.",
+ "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
+ "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
+ ],
+ "enum": [
+ "LOGIN_UNSPECIFIED",
+ "LOGIN_OPTIONAL",
+ "LOGIN_ADMIN",
+ "LOGIN_REQUIRED"
+ ],
+ "description": "Level of login required to access this resource. Defaults to optional.",
+ "type": "string"
+ }
+ },
+ "id": "ApiConfigHandler",
+ "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
+ "type": "object"
+ },
+ "Operation": {
+ "properties": {
+ "error": {
+ "description": "The error result of the operation in case of failure or cancellation.",
+ "$ref": "Status"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
+ "type": "object"
+ },
+ "done": {
+ "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
+ "type": "boolean"
+ },
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.",
+ "type": "string"
+ }
+ },
+ "id": "Operation",
+ "description": "This resource represents a long-running operation that is the result of a network API call.",
+ "type": "object"
+ },
+ "FileInfo": {
+ "description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.",
+ "type": "object",
+ "properties": {
+ "mimeType": {
+ "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage.",
+ "type": "string"
+ },
+ "sourceUrl": {
+ "description": "URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
+ "type": "string"
+ },
+ "sha1Sum": {
+ "description": "The SHA1 hash of the file, in hex.",
+ "type": "string"
+ }
+ },
+ "id": "FileInfo"
+ },
+ "StaticFilesHandler": {
+ "description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.",
+ "type": "object",
+ "properties": {
+ "expiration": {
+ "format": "google-duration",
+ "description": "Time a static file served by this handler should be cached.",
+ "type": "string"
+ },
+ "applicationReadable": {
+ "description": "Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.",
+ "type": "boolean"
+ },
+ "httpHeaders": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "HTTP headers to use for all responses from these URLs.",
+ "type": "object"
+ },
+ "uploadPathRegex": {
+ "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.",
+ "type": "string"
+ },
+ "path": {
+ "description": "Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.",
+ "type": "string"
+ },
+ "mimeType": {
+ "description": "MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are derived from each file's filename extension.",
+ "type": "string"
+ },
+ "requireMatchingFile": {
+ "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
+ "type": "boolean"
+ }
+ },
+ "id": "StaticFilesHandler"
+ },
+ "ScriptHandler": {
+ "description": "Executes a script to handle the request that matches the URL pattern.",
+ "type": "object",
+ "properties": {
+ "scriptPath": {
+ "description": "Path to the script from the application root directory.",
+ "type": "string"
+ }
+ },
+ "id": "ScriptHandler"
+ },
+ "DiskUtilization": {
+ "description": "Target scaling by disk usage. Only applicable for VM runtimes.",
+ "type": "object",
+ "properties": {
+ "targetReadOpsPerSec": {
+ "format": "int32",
+ "description": "Target ops read per second.",
+ "type": "integer"
+ },
+ "targetReadBytesPerSec": {
+ "format": "int32",
+ "description": "Target bytes read per second.",
+ "type": "integer"
+ },
+ "targetWriteOpsPerSec": {
+ "format": "int32",
+ "description": "Target ops written per second.",
+ "type": "integer"
+ },
+ "targetWriteBytesPerSec": {
+ "format": "int32",
+ "description": "Target bytes written per second.",
+ "type": "integer"
+ }
+ },
+ "id": "DiskUtilization"
+ },
+ "BasicScaling": {
+ "description": "A module with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.",
+ "type": "object",
+ "properties": {
+ "maxInstances": {
+ "format": "int32",
+ "description": "Maximum number of instances to create for this version.",
+ "type": "integer"
+ },
+ "idleTimeout": {
+ "format": "google-duration",
+ "description": "Duration of time after the last request that an instance must wait before the instance is shut down.",
+ "type": "string"
+ }
+ },
+ "id": "BasicScaling"
+ },
+ "OperationMetadataExperimental": {
+ "properties": {
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.experimental.CustomDomains.CreateCustomDomain.@OutputOnly",
+ "type": "string"
+ },
+ "insertTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation was created.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation completed.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/customDomains/example.com.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadataExperimental",
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object"
+ },
+ "CpuUtilization": {
+ "description": "Target scaling by CPU usage.",
+ "type": "object",
+ "properties": {
+ "aggregationWindowLength": {
+ "format": "google-duration",
+ "description": "Period of time over which CPU utilization is calculated.",
+ "type": "string"
+ },
+ "targetUtilization": {
+ "format": "double",
+ "description": "Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.",
+ "type": "number"
+ }
+ },
+ "id": "CpuUtilization"
+ },
+ "Status": {
+ "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
+ "properties": {
+ "code": {
+ "format": "int32",
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "id": "Status"
+ },
+ "IdentityAwareProxy": {
+ "description": "Identity-Aware Proxy",
+ "type": "object",
+ "properties": {
+ "oauth2ClientSecretSha256": {
+ "description": "Hex-encoded SHA-256 hash of the client secret.@OutputOnly",
+ "type": "string"
+ },
+ "enabled": {
+ "description": "Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.",
+ "type": "boolean"
+ },
+ "oauth2ClientSecret": {
+ "description": "For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly",
+ "type": "string"
+ },
+ "oauth2ClientId": {
+ "description": "OAuth2 client ID to use for the authentication flow.",
+ "type": "string"
+ }
+ },
+ "id": "IdentityAwareProxy"
+ },
+ "TrafficSplit": {
+ "description": "Traffic routing configuration for versions within a single module. Traffic splits define how traffic directed to the module is assigned to versions.",
+ "type": "object",
+ "properties": {
+ "allocations": {
+ "additionalProperties": {
+ "format": "double",
+ "type": "number"
+ },
+ "description": "Mapping from version IDs within the module to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the module may not have any traffic allocation. Modules that have traffic allocated cannot be deleted until either the module is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.",
+ "type": "object"
+ },
+ "shardBy": {
+ "enum": [
+ "UNSPECIFIED",
+ "COOKIE",
+ "IP"
+ ],
+ "description": "Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.",
+ "type": "string",
+ "enumDescriptions": [
+ "Diversion method unspecified.",
+ "Diversion based on a specially named cookie, \"GOOGAPPUID.\" The cookie must be set by the application itself or else no diversion will occur.",
+ "Diversion based on applying the modulus operation to a fingerprint of the IP address."
+ ]
+ }
+ },
+ "id": "TrafficSplit"
+ },
+ "ManualScaling": {
+ "description": "A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
+ "type": "object",
+ "properties": {
+ "instances": {
+ "format": "int32",
+ "description": "Number of instances to assign to the module at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.",
+ "type": "integer"
+ }
+ },
+ "id": "ManualScaling"
+ },
+ "LocationMetadata": {
+ "description": "Metadata for the given google.cloud.location.Location.",
+ "type": "object",
+ "properties": {
+ "flexibleEnvironmentAvailable": {
+ "description": "App Engine Flexible Environment is available in the given location.@OutputOnly",
+ "type": "boolean"
+ },
+ "standardEnvironmentAvailable": {
+ "description": "App Engine Standard Environment is available in the given location.@OutputOnly",
+ "type": "boolean"
+ }
+ },
+ "id": "LocationMetadata"
+ },
+ "OperationMetadataV1Beta": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
+ "properties": {
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation completed.@OutputOnly",
+ "type": "string"
+ },
+ "insertTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation was created.@OutputOnly",
+ "type": "string"
+ },
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "OperationMetadataV1Beta"
+ },
+ "ListModulesResponse": {
+ "description": "Response message for Modules.ListModules.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "modules": {
+ "description": "The modules belonging to the requested application.",
+ "items": {
+ "$ref": "Module"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListModulesResponse"
+ },
+ "Deployment": {
+ "properties": {
+ "sourceReferences": {
+ "description": "Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.",
+ "items": {
+ "$ref": "SourceReference"
+ },
+ "type": "array"
+ },
+ "container": {
+ "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.",
+ "$ref": "ContainerInfo"
+ },
+ "files": {
+ "additionalProperties": {
+ "$ref": "FileInfo"
+ },
+ "description": "Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.",
+ "type": "object"
+ }
+ },
+ "id": "Deployment",
+ "description": "Code and application artifacts used to deploy a version to App Engine.",
+ "type": "object"
+ },
+ "Resources": {
+ "description": "Machine resources for a version.",
+ "type": "object",
+ "properties": {
+ "volumes": {
+ "description": "User specified volumes.",
+ "items": {
+ "$ref": "Volume"
+ },
+ "type": "array"
+ },
+ "diskGb": {
+ "format": "double",
+ "description": "Disk size (GB) needed.",
+ "type": "number"
+ },
+ "memoryGb": {
+ "format": "double",
+ "description": "Memory (GB) needed.",
+ "type": "number"
+ },
+ "cpu": {
+ "format": "double",
+ "description": "Number of CPU cores needed.",
+ "type": "number"
+ }
+ },
+ "id": "Resources"
+ },
+ "Volume": {
+ "description": "Volumes mounted within the app container. Only applicable for VM runtimes.",
+ "type": "object",
+ "properties": {
+ "volumeType": {
+ "description": "Underlying volume type, e.g. 'tmpfs'.",
+ "type": "string"
+ },
+ "sizeGb": {
+ "format": "double",
+ "description": "Volume size in gigabytes.",
+ "type": "number"
+ },
+ "name": {
+ "description": "Unique name for the volume.",
+ "type": "string"
+ }
+ },
+ "id": "Volume"
+ },
+ "ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
+ "items": {
+ "$ref": "Operation"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListOperationsResponse"
+ },
+ "OperationMetadata": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
+ "properties": {
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Timestamp that this operation completed.@OutputOnly",
+ "type": "string"
+ },
+ "operationType": {
+ "description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly",
+ "type": "string"
+ },
+ "insertTime": {
+ "format": "google-datetime",
+ "description": "Timestamp that this operation was created.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadata"
+ },
+ "ListInstancesResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "instances": {
+ "description": "The instances belonging to the requested version.",
+ "items": {
+ "$ref": "Instance"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListInstancesResponse",
+ "description": "Response message for Instances.ListInstances.",
+ "type": "object"
+ },
+ "ErrorHandler": {
+ "description": "Custom static error page to be served when an error occurs.",
+ "type": "object",
+ "properties": {
+ "mimeType": {
+ "description": "MIME type of file. Defaults to text/html.",
+ "type": "string"
+ },
+ "errorCode": {
+ "enumDescriptions": [
+ "Not specified. ERROR_CODE_DEFAULT is assumed.",
+ "All other error types.",
+ "Application has exceeded a resource quota.",
+ "Client blocked by the application's Denial of Service protection configuration.",
+ "Deadline reached before the application responds."
+ ],
+ "enum": [
+ "ERROR_CODE_UNSPECIFIED",
+ "ERROR_CODE_DEFAULT",
+ "ERROR_CODE_OVER_QUOTA",
+ "ERROR_CODE_DOS_API_DENIAL",
+ "ERROR_CODE_TIMEOUT"
+ ],
+ "description": "Error condition this handler applies to.",
+ "type": "string"
+ },
+ "staticFile": {
+ "description": "Static file content to be served for this error.",
+ "type": "string"
+ }
+ },
+ "id": "ErrorHandler"
+ },
+ "OperationMetadataV1": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
+ "properties": {
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "insertTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation was created.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation completed.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadataV1"
}
},
"protocol": "rest",
"icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"version": "v1beta4",
"baseUrl": "https://appengine.googleapis.com/",
"auth": {
"oauth2": {
"scopes": {
+ "https://www.googleapis.com/auth/cloud-platform.read-only": {
+ "description": "View your data across Google Cloud Platform services"
+ },
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
},
"https://www.googleapis.com/auth/appengine.admin": {
"description": "View and manage your applications deployed on Google App Engine"
- },
- "https://www.googleapis.com/auth/cloud-platform.read-only": {
- "description": "View your data across Google Cloud Platform services"
}
}
}
@@ -1505,918 +2413,10 @@
"ownerDomain": "google.com",
"name": "appengine",
"batchPath": "batch",
- "id": "appengine:v1beta4",
"documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
+ "id": "appengine:v1beta4",
"revision": "20170929",
"title": "Google App Engine Admin API",
- "ownerName": "Google",
"discoveryVersion": "v1",
- "resources": {
- "apps": {
- "methods": {
- "create": {
- "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).",
- "request": {
- "$ref": "Application"
- },
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta4/apps",
- "path": "v1beta4/apps",
- "id": "appengine.apps.create"
- },
- "patch": {
- "request": {
- "$ref": "Application"
- },
- "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps#Application.FIELDS.auth_domain)\ndefault_cookie_expiration (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps#Application.FIELDS.default_cookie_expiration)",
- "httpMethod": "PATCH",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "mask": {
- "format": "google-fieldmask",
- "description": "Standard field mask for the set of fields to be updated.",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1beta4/apps/{appsId}",
- "path": "v1beta4/apps/{appsId}",
- "id": "appengine.apps.patch"
- },
- "get": {
- "response": {
- "$ref": "Application"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "ensureResourcesExist": {
- "location": "query",
- "description": "Certain resources associated with an application are created on-demand. Controls whether these resources should be created when performing the GET operation. If specified and any resources could not be created, the request will fail with an error code. Additionally, this parameter can cause the request to take longer to complete.",
- "type": "boolean"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the application to get. Example: apps/myapp.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta4/apps/{appsId}",
- "id": "appengine.apps.get",
- "path": "v1beta4/apps/{appsId}",
- "description": "Gets information about an application."
- }
- },
- "resources": {
- "modules": {
- "methods": {
- "delete": {
- "description": "Deletes the specified module and all enclosed versions.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "modulesId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "modulesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}",
- "id": "appengine.apps.modules.delete"
- },
- "patch": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "modulesId"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/modules/default.",
- "type": "string",
- "required": true
- },
- "migrateTraffic": {
- "location": "query",
- "description": "Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules#shardby) field in the Module resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).",
- "type": "boolean"
- },
- "mask": {
- "format": "google-fieldmask",
- "description": "Standard field mask for the set of fields to be updated.",
- "type": "string",
- "location": "query"
- },
- "modulesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}",
- "id": "appengine.apps.modules.patch",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}",
- "request": {
- "$ref": "Module"
- },
- "description": "Updates the configuration of the specified module."
- },
- "list": {
- "path": "v1beta4/apps/{appsId}/modules",
- "id": "appengine.apps.modules.list",
- "description": "Lists all the modules in the application.",
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "ListModulesResponse"
- },
- "parameters": {
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "pageSize": {
- "format": "int32",
- "description": "Maximum results to return per page.",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta4/apps/{appsId}/modules"
- },
- "get": {
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}",
- "id": "appengine.apps.modules.get",
- "description": "Gets the current configuration of the specified module.",
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId",
- "modulesId"
- ],
- "response": {
- "$ref": "Module"
- },
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "modulesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}"
- }
- },
- "resources": {
- "versions": {
- "methods": {
- "patch": {
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
- "id": "appengine.apps.modules.versions.patch",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
- "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.",
- "request": {
- "$ref": "Version"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "modulesId",
- "versionsId"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "mask": {
- "format": "google-fieldmask",
- "description": "Standard field mask for the set of fields to be updated.",
- "type": "string",
- "location": "query"
- },
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "modulesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/modules/default/versions/1.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId",
- "modulesId"
- ],
- "response": {
- "$ref": "ListVersionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "pageSize": {
- "format": "int32",
- "description": "Maximum results to return per page.",
- "type": "integer",
- "location": "query"
- },
- "view": {
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "description": "Controls the set of fields returned in the List response.",
- "type": "string"
- },
- "modulesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
- "id": "appengine.apps.modules.versions.list",
- "description": "Lists the versions of a module."
- },
- "get": {
- "response": {
- "$ref": "Version"
- },
- "parameterOrder": [
- "appsId",
- "modulesId",
- "versionsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "view": {
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "description": "Controls the set of fields returned in the Get response.",
- "type": "string"
- },
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "modulesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
- "id": "appengine.apps.modules.versions.get",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
- "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource."
- },
- "create": {
- "id": "appengine.apps.modules.versions.create",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
- "request": {
- "$ref": "Version"
- },
- "description": "Deploys code and resource files to a new version.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "modulesId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/modules/default.",
- "type": "string",
- "required": true
- },
- "modulesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions"
- },
- "delete": {
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
- "id": "appengine.apps.modules.versions.delete",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
- "description": "Deletes an existing version.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "modulesId",
- "versionsId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "modulesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- },
- "resources": {
- "instances": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListInstancesResponse"
- },
- "parameterOrder": [
- "appsId",
- "modulesId",
- "versionsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1.",
- "type": "string",
- "required": true
- },
- "pageSize": {
- "format": "int32",
- "description": "Maximum results to return per page.",
- "type": "integer",
- "location": "query"
- },
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "modulesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances",
- "id": "appengine.apps.modules.versions.instances.list",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances",
- "description": "Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list)."
- },
- "get": {
- "response": {
- "$ref": "Instance"
- },
- "parameterOrder": [
- "appsId",
- "modulesId",
- "versionsId",
- "instancesId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "modulesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "instancesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1/instances/instance-1.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}",
- "id": "appengine.apps.modules.versions.instances.get",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}",
- "description": "Gets instance information."
- },
- "debug": {
- "request": {
- "$ref": "DebugInstanceRequest"
- },
- "description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.",
- "httpMethod": "POST",
- "parameterOrder": [
- "appsId",
- "modulesId",
- "versionsId",
- "instancesId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "instancesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1/instances/instance-1.",
- "type": "string",
- "required": true
- },
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "modulesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "id": "appengine.apps.modules.versions.instances.debug"
- },
- "delete": {
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}",
- "id": "appengine.apps.modules.versions.instances.delete",
- "description": "Stops a running instance.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "appsId",
- "modulesId",
- "versionsId",
- "instancesId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "modulesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "instancesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1/instances/instance-1.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}"
- }
- }
- }
- }
- }
- }
- },
- "operations": {
- "methods": {
- "get": {
- "flatPath": "v1beta4/apps/{appsId}/operations/{operationsId}",
- "id": "appengine.apps.operations.get",
- "path": "v1beta4/apps/{appsId}/operations/{operationsId}",
- "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "operationsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "appsId": {
- "description": "Part of `name`. The name of the operation resource.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "operationsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- }
- },
- "list": {
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "pageSize": {
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "appsId": {
- "description": "Part of `name`. The name of the operation's parent resource.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1beta4/apps/{appsId}/operations",
- "id": "appengine.apps.operations.list",
- "path": "v1beta4/apps/{appsId}/operations",
- "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id."
- }
- }
- },
- "locations": {
- "methods": {
- "get": {
- "response": {
- "$ref": "Location"
- },
- "parameterOrder": [
- "appsId",
- "locationsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Resource name for the location.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "locationsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1beta4/apps/{appsId}/locations/{locationsId}",
- "id": "appengine.apps.locations.get",
- "path": "v1beta4/apps/{appsId}/locations/{locationsId}",
- "description": "Get information about a location."
- },
- "list": {
- "response": {
- "$ref": "ListLocationsResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
- "type": "string",
- "required": true
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta4/apps/{appsId}/locations",
- "id": "appengine.apps.locations.list",
- "path": "v1beta4/apps/{appsId}/locations",
- "description": "Lists information about the supported locations for this service."
- }
- }
- }
- }
- }
- },
- "parameters": {
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- },
- "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"
- }
- }
+ "ownerName": "Google"
}
diff --git a/appengine/v1beta5/appengine-api.json b/appengine/v1beta5/appengine-api.json
index c53876f..b68b711 100644
--- a/appengine/v1beta5/appengine-api.json
+++ b/appengine/v1beta5/appengine-api.json
@@ -1,10 +1,71 @@
{
- "title": "Google App Engine Admin API",
- "ownerName": "Google",
"discoveryVersion": "v1",
+ "ownerName": "Google",
"resources": {
"apps": {
"methods": {
+ "patch": {
+ "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps#Application.FIELDS.auth_domain)\ndefault_cookie_expiration (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps#Application.FIELDS.default_cookie_expiration)",
+ "request": {
+ "$ref": "Application"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "mask": {
+ "format": "google-fieldmask",
+ "description": "Standard field mask for the set of fields to be updated.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta5/apps/{appsId}",
+ "id": "appengine.apps.patch",
+ "path": "v1beta5/apps/{appsId}"
+ },
+ "get": {
+ "description": "Gets information about an application.",
+ "response": {
+ "$ref": "Application"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "ensureResourcesExist": {
+ "location": "query",
+ "description": "Certain resources associated with an application are created on-demand. Controls whether these resources should be created when performing the GET operation. If specified and any resources could not be created, the request will fail with an error code. Additionally, this parameter can cause the request to take longer to complete. Note: This parameter will be deprecated in a future version of the API.",
+ "type": "boolean"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the application to get. Example: apps/myapp.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta5/apps/{appsId}",
+ "id": "appengine.apps.get",
+ "path": "v1beta5/apps/{appsId}"
+ },
"create": {
"request": {
"$ref": "Application"
@@ -22,419 +83,210 @@
"flatPath": "v1beta5/apps",
"id": "appengine.apps.create",
"path": "v1beta5/apps"
- },
- "patch": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.",
- "type": "string",
- "required": true
- },
- "mask": {
- "format": "google-fieldmask",
- "description": "Standard field mask for the set of fields to be updated.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1beta5/apps/{appsId}",
- "id": "appengine.apps.patch",
- "path": "v1beta5/apps/{appsId}",
- "request": {
- "$ref": "Application"
- },
- "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps#Application.FIELDS.auth_domain)\ndefault_cookie_expiration (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps#Application.FIELDS.default_cookie_expiration)"
- },
- "get": {
- "description": "Gets information about an application.",
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "Application"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "ensureResourcesExist": {
- "location": "query",
- "description": "Certain resources associated with an application are created on-demand. Controls whether these resources should be created when performing the GET operation. If specified and any resources could not be created, the request will fail with an error code. Additionally, this parameter can cause the request to take longer to complete. Note: This parameter will be deprecated in a future version of the API.",
- "type": "boolean"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the application to get. Example: apps/myapp.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta5/apps/{appsId}",
- "path": "v1beta5/apps/{appsId}",
- "id": "appengine.apps.get"
}
},
"resources": {
- "operations": {
- "methods": {
- "get": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "operationsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "operationsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. The name of the operation resource.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta5/apps/{appsId}/operations/{operationsId}",
- "id": "appengine.apps.operations.get",
- "path": "v1beta5/apps/{appsId}/operations/{operationsId}",
- "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service."
- },
- "list": {
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "description": "Part of `name`. The name of the operation's parent resource.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer"
- },
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1beta5/apps/{appsId}/operations",
- "id": "appengine.apps.operations.list",
- "path": "v1beta5/apps/{appsId}/operations",
- "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id."
- }
- }
- },
- "locations": {
- "methods": {
- "get": {
- "response": {
- "$ref": "Location"
- },
- "parameterOrder": [
- "appsId",
- "locationsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "locationsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "appsId": {
- "description": "Part of `name`. Resource name for the location.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1beta5/apps/{appsId}/locations/{locationsId}",
- "id": "appengine.apps.locations.get",
- "path": "v1beta5/apps/{appsId}/locations/{locationsId}",
- "description": "Get information about a location."
- },
- "list": {
- "flatPath": "v1beta5/apps/{appsId}/locations",
- "id": "appengine.apps.locations.list",
- "path": "v1beta5/apps/{appsId}/locations",
- "description": "Lists information about the supported locations for this service.",
- "response": {
- "$ref": "ListLocationsResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer"
- },
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- }
- }
- }
- }
- },
"services": {
- "methods": {
- "delete": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}",
- "id": "appengine.apps.services.delete",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}",
- "description": "Deletes the specified service and all enclosed versions."
- },
- "patch": {
- "id": "appengine.apps.services.patch",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}",
- "request": {
- "$ref": "Service"
- },
- "description": "Updates the configuration of the specified service.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.",
- "type": "string",
- "required": true
- },
- "migrateTraffic": {
- "description": "Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services#shardby) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).",
- "type": "boolean",
- "location": "query"
- },
- "mask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "Standard field mask for the set of fields to be updated.",
- "type": "string"
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}"
- },
- "list": {
- "flatPath": "v1beta5/apps/{appsId}/services",
- "path": "v1beta5/apps/{appsId}/services",
- "id": "appengine.apps.services.list",
- "description": "Lists all the services in the application.",
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "ListServicesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Maximum results to return per page.",
- "type": "integer"
- }
- }
- },
- "get": {
- "id": "appengine.apps.services.get",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}",
- "description": "Gets the current configuration of the specified service.",
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "response": {
- "$ref": "Service"
- },
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}"
- }
- },
"resources": {
"versions": {
- "methods": {
- "delete": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
- "type": "string",
- "required": true,
- "location": "path"
+ "resources": {
+ "instances": {
+ "methods": {
+ "debug": {
+ "request": {
+ "$ref": "DebugInstanceRequest"
+ },
+ "description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "instancesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "id": "appengine.apps.services.versions.instances.debug"
},
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
+ "delete": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "instancesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. For example: \"apps/myapp/services/default/versions/v1/instances/instance-1\".",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "id": "appengine.apps.services.versions.instances.delete",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "description": "Stops a running instance."
},
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListInstancesResponse"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Maximum results to return per page.",
+ "type": "integer"
+ },
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
+ "id": "appengine.apps.services.versions.instances.list",
+ "description": "Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list)."
+ },
+ "get": {
+ "id": "appengine.apps.services.versions.instances.get",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "description": "Gets instance information.",
+ "response": {
+ "$ref": "Instance"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "instancesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}"
}
- },
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.delete",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "description": "Deletes an existing version."
- },
+ }
+ }
+ },
+ "methods": {
"patch": {
"response": {
"$ref": "Operation"
@@ -456,22 +308,22 @@
"location": "query"
},
"versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "servicesId": {
"location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"type": "string",
"required": true
},
- "appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.",
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
"type": "string",
"required": true,
"location": "path"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.",
+ "type": "string",
+ "required": true
}
},
"flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
@@ -483,30 +335,37 @@
"description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment."
},
"list": {
- "httpMethod": "GET",
+ "description": "Lists the versions of a service.",
+ "response": {
+ "$ref": "ListVersionsResponse"
+ },
"parameterOrder": [
"appsId",
"servicesId"
],
- "response": {
- "$ref": "ListVersionsResponse"
- },
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"parameters": {
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
"pageToken": {
- "location": "query",
"description": "Continuation token for fetching the next page of results.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"appsId": {
+ "location": "path",
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
},
"pageSize": {
"location": "query",
@@ -522,20 +381,17 @@
"BASIC",
"FULL"
]
- },
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
}
},
"flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions",
"id": "appengine.apps.services.versions.list",
- "description": "Lists the versions of a service."
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions"
},
"get": {
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "id": "appengine.apps.services.versions.get",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.",
"response": {
"$ref": "Version"
},
@@ -545,6 +401,11 @@
"versionsId"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"parameters": {
"servicesId": {
"description": "Part of `name`. See documentation of `appsId`.",
@@ -559,39 +420,27 @@
"location": "path"
},
"view": {
- "location": "query",
"enum": [
"BASIC",
"FULL"
],
"description": "Controls the set of fields returned in the Get response.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"versionsId": {
- "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
}
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.get",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource."
+ }
},
"create": {
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions",
- "id": "appengine.apps.services.versions.create",
+ "description": "Deploys new code and resource files to a new version.",
"request": {
"$ref": "Version"
},
- "description": "Deploys new code and resource files to a new version.",
"httpMethod": "POST",
"parameterOrder": [
"appsId",
@@ -600,9 +449,6 @@
"response": {
"$ref": "Operation"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"servicesId": {
"description": "Part of `name`. See documentation of `appsId`.",
@@ -611,231 +457,433 @@
"location": "path"
},
"appsId": {
- "location": "path",
"description": "Part of `name`. Name of the resource to update. For example: \"apps/myapp/services/default\".",
"type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions",
+ "id": "appengine.apps.services.versions.create"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
+ "type": "string",
"required": true
}
- }
- }
- },
- "resources": {
- "instances": {
- "methods": {
- "debug": {
- "description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.",
- "request": {
- "$ref": "DebugInstanceRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId",
- "instancesId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "instancesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
- "type": "string",
- "required": true
- },
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "id": "appengine.apps.services.versions.instances.debug"
- },
- "delete": {
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "id": "appengine.apps.services.versions.instances.delete",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "description": "Stops a running instance.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId",
- "instancesId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "instancesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. For example: \"apps/myapp/services/default/versions/v1/instances/instance-1\".",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "list": {
- "response": {
- "$ref": "ListInstancesResponse"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "pageSize": {
- "format": "int32",
- "description": "Maximum results to return per page.",
- "type": "integer",
- "location": "query"
- },
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
- "id": "appengine.apps.services.versions.instances.list",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
- "description": "Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list)."
- },
- "get": {
- "response": {
- "$ref": "Instance"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId",
- "instancesId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "instancesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
- "type": "string",
- "required": true
- },
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "id": "appengine.apps.services.versions.instances.get",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "description": "Gets instance information."
- }
- }
+ },
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "id": "appengine.apps.services.versions.delete",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "description": "Deletes an existing version."
}
}
}
+ },
+ "methods": {
+ "delete": {
+ "description": "Deletes the specified service and all enclosed versions.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}",
+ "id": "appengine.apps.services.delete"
+ },
+ "patch": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "migrateTraffic": {
+ "location": "query",
+ "description": "Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services#shardby) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).",
+ "type": "boolean"
+ },
+ "mask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Standard field mask for the set of fields to be updated.",
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}",
+ "id": "appengine.apps.services.patch",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}",
+ "description": "Updates the configuration of the specified service.",
+ "request": {
+ "$ref": "Service"
+ }
+ },
+ "list": {
+ "description": "Lists all the services in the application.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListServicesResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Maximum results to return per page.",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta5/apps/{appsId}/services",
+ "path": "v1beta5/apps/{appsId}/services",
+ "id": "appengine.apps.services.list"
+ },
+ "get": {
+ "response": {
+ "$ref": "Service"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}",
+ "id": "appengine.apps.services.get",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}",
+ "description": "Gets the current configuration of the specified service."
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "get": {
+ "flatPath": "v1beta5/apps/{appsId}/operations/{operationsId}",
+ "id": "appengine.apps.operations.get",
+ "path": "v1beta5/apps/{appsId}/operations/{operationsId}",
+ "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "operationsId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. The name of the operation resource.",
+ "type": "string",
+ "required": true
+ },
+ "operationsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. The name of the operation's parent resource.",
+ "type": "string",
+ "required": true
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer",
+ "location": "query"
+ },
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta5/apps/{appsId}/operations",
+ "path": "v1beta5/apps/{appsId}/operations",
+ "id": "appengine.apps.operations.list",
+ "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id."
+ }
+ }
+ },
+ "locations": {
+ "methods": {
+ "get": {
+ "description": "Get information about a location.",
+ "response": {
+ "$ref": "Location"
+ },
+ "parameterOrder": [
+ "appsId",
+ "locationsId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Resource name for the location.",
+ "type": "string",
+ "required": true
+ },
+ "locationsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta5/apps/{appsId}/locations/{locationsId}",
+ "id": "appengine.apps.locations.get",
+ "path": "v1beta5/apps/{appsId}/locations/{locationsId}"
+ },
+ "list": {
+ "description": "Lists information about the supported locations for this service.",
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
+ "type": "string",
+ "required": true
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer",
+ "location": "query"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta5/apps/{appsId}/locations",
+ "id": "appengine.apps.locations.list",
+ "path": "v1beta5/apps/{appsId}/locations"
+ }
}
}
}
}
},
"parameters": {
- "pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
"location": "query"
},
- "bearer_token": {
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
"location": "query",
- "description": "OAuth bearer token.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
"type": "string"
},
+ "alt": {
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
+ },
"oauth_token": {
+ "location": "query",
"description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
"type": "string",
"location": "query"
},
@@ -851,639 +899,20 @@
"location": "query"
},
"uploadType": {
- "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"fields": {
"location": "query",
"description": "Selector specifying which fields to include in a partial response.",
"type": "string"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
}
},
"schemas": {
- "ListInstancesResponse": {
- "description": "Response message for Instances.ListInstances.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "instances": {
- "description": "The instances belonging to the requested version.",
- "items": {
- "$ref": "Instance"
- },
- "type": "array"
- }
- },
- "id": "ListInstancesResponse"
- },
- "ErrorHandler": {
- "description": "Custom static error page to be served when an error occurs.",
- "type": "object",
- "properties": {
- "mimeType": {
- "description": "MIME type of file. Defaults to text/html.",
- "type": "string"
- },
- "errorCode": {
- "enumDescriptions": [
- "Not specified. ERROR_CODE_DEFAULT is assumed.",
- "All other error types.",
- "Application has exceeded a resource quota.",
- "Client blocked by the application's Denial of Service protection configuration.",
- "Deadline reached before the application responds."
- ],
- "enum": [
- "ERROR_CODE_UNSPECIFIED",
- "ERROR_CODE_DEFAULT",
- "ERROR_CODE_OVER_QUOTA",
- "ERROR_CODE_DOS_API_DENIAL",
- "ERROR_CODE_TIMEOUT"
- ],
- "description": "Error condition this handler applies to.",
- "type": "string"
- },
- "staticFile": {
- "description": "Static file content to be served for this error.",
- "type": "string"
- }
- },
- "id": "ErrorHandler"
- },
- "OperationMetadataV1": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "insertTime": {
- "format": "google-datetime",
- "description": "Time that this operation was created.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "Time that this operation completed.@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1"
- },
- "OperationMetadataV1Alpha": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "Time that this operation completed.@OutputOnly",
- "type": "string"
- },
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "insertTime": {
- "format": "google-datetime",
- "description": "Time that this operation was created.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1Alpha"
- },
- "Network": {
- "properties": {
- "subnetworkName": {
- "description": "Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network.\nIf the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.\nIf the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network.\nIf the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app.",
- "type": "string"
- },
- "instanceTag": {
- "description": "Tag to apply to the VM instance during creation.",
- "type": "string"
- },
- "forwardedPorts": {
- "description": "List of ports, or port pairs, to forward from the virtual machine to the application container.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "name": {
- "description": "Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.",
- "type": "string"
- }
- },
- "id": "Network",
- "description": "Extra network settings. Only applicable for VM runtimes.",
- "type": "object"
- },
- "Application": {
- "properties": {
- "name": {
- "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
- "type": "string"
- },
- "iap": {
- "$ref": "IdentityAwareProxy"
- },
- "authDomain": {
- "description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.",
- "type": "string"
- },
- "defaultCookieExpiration": {
- "format": "google-duration",
- "description": "Cookie expiration policy for this application.",
- "type": "string"
- },
- "id": {
- "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.",
- "type": "string"
- },
- "codeBucket": {
- "description": "A Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly",
- "type": "string"
- },
- "location": {
- "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US",
- "type": "string"
- },
- "defaultBucket": {
- "description": "A Google Cloud Storage bucket that can be used by the application to store content.@OutputOnly",
- "type": "string"
- },
- "dispatchRules": {
- "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent.@OutputOnly",
- "items": {
- "$ref": "UrlDispatchRule"
- },
- "type": "array"
- },
- "defaultHostname": {
- "description": "Hostname used to reach the application, as resolved by App Engine.@OutputOnly",
- "type": "string"
- }
- },
- "id": "Application",
- "description": "An Application resource contains the top-level configuration of an App Engine application.",
- "type": "object"
- },
- "Instance": {
- "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
- "type": "object",
- "properties": {
- "vmName": {
- "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "qps": {
- "format": "float",
- "description": "Average queries per second (QPS) over the last minute.@OutputOnly",
- "type": "number"
- },
- "vmId": {
- "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "vmUnlocked": {
- "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "boolean"
- },
- "name": {
- "description": "Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly",
- "type": "string"
- },
- "vmZoneName": {
- "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "averageLatency": {
- "format": "int32",
- "description": "Average latency (ms) over the last minute.@OutputOnly",
- "type": "integer"
- },
- "vmIp": {
- "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "id": {
- "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
- "type": "string"
- },
- "memoryUsage": {
- "format": "int64",
- "description": "Total memory in use (bytes).@OutputOnly",
- "type": "string"
- },
- "vmStatus": {
- "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "availability": {
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "enum": [
- "UNSPECIFIED",
- "RESIDENT",
- "DYNAMIC"
- ],
- "description": "Availability of the instance.@OutputOnly",
- "type": "string"
- },
- "errors": {
- "format": "uint32",
- "description": "Number of errors since this instance was started.@OutputOnly",
- "type": "integer"
- },
- "requests": {
- "format": "int32",
- "description": "Number of requests since this instance was started.@OutputOnly",
- "type": "integer"
- },
- "appEngineRelease": {
- "description": "App Engine release this instance is running on.@OutputOnly",
- "type": "string"
- },
- "startTimestamp": {
- "format": "google-datetime",
- "description": "Time that this instance was started.@OutputOnly",
- "type": "string"
- }
- },
- "id": "Instance"
- },
- "UrlDispatchRule": {
- "description": "Rules to match an HTTP request and dispatch that request to a service.",
- "type": "object",
- "properties": {
- "service": {
- "description": "Resource id of a service in this application that should serve the matched request. The service must already exist. Example: default.",
- "type": "string"
- },
- "domain": {
- "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
- "type": "string"
- },
- "path": {
- "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.",
- "type": "string"
- }
- },
- "id": "UrlDispatchRule"
- },
- "ListVersionsResponse": {
- "description": "Response message for Versions.ListVersions.",
- "type": "object",
- "properties": {
- "versions": {
- "description": "The versions belonging to the requested service.",
- "items": {
- "$ref": "Version"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- }
- },
- "id": "ListVersionsResponse"
- },
- "ApiEndpointHandler": {
- "description": "Uses Google Cloud Endpoints to handle requests.",
- "type": "object",
- "properties": {
- "scriptPath": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
- }
- },
- "id": "ApiEndpointHandler"
- },
- "AutomaticScaling": {
- "properties": {
- "diskUtilization": {
- "description": "Target scaling by disk usage.",
- "$ref": "DiskUtilization"
- },
- "minPendingLatency": {
- "format": "google-duration",
- "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
- "type": "string"
- },
- "maxIdleInstances": {
- "format": "int32",
- "description": "Maximum number of idle instances that should be maintained for this version.",
- "type": "integer"
- },
- "requestUtilization": {
- "description": "Target scaling by request utilization.",
- "$ref": "RequestUtilization"
- },
- "minIdleInstances": {
- "format": "int32",
- "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.",
- "type": "integer"
- },
- "maxTotalInstances": {
- "format": "int32",
- "description": "Maximum number of instances that should be started to handle requests.",
- "type": "integer"
- },
- "minTotalInstances": {
- "format": "int32",
- "description": "Minimum number of instances that should be maintained for this version.",
- "type": "integer"
- },
- "networkUtilization": {
- "$ref": "NetworkUtilization",
- "description": "Target scaling by network usage."
- },
- "maxConcurrentRequests": {
- "format": "int32",
- "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
- "type": "integer"
- },
- "coolDownPeriod": {
- "format": "google-duration",
- "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.",
- "type": "string"
- },
- "maxPendingLatency": {
- "format": "google-duration",
- "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.",
- "type": "string"
- },
- "cpuUtilization": {
- "$ref": "CpuUtilization",
- "description": "Target scaling by CPU usage."
- }
- },
- "id": "AutomaticScaling",
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
- "type": "object"
- },
- "NetworkUtilization": {
- "description": "Target scaling by network usage. Only applicable for VM runtimes.",
- "type": "object",
- "properties": {
- "targetReceivedBytesPerSec": {
- "format": "int32",
- "description": "Target bytes received per second.",
- "type": "integer"
- },
- "targetSentPacketsPerSec": {
- "format": "int32",
- "description": "Target packets sent per second.",
- "type": "integer"
- },
- "targetReceivedPacketsPerSec": {
- "format": "int32",
- "description": "Target packets received per second.",
- "type": "integer"
- },
- "targetSentBytesPerSec": {
- "format": "int32",
- "description": "Target bytes sent per second.",
- "type": "integer"
- }
- },
- "id": "NetworkUtilization"
- },
- "Location": {
- "description": "A resource that represents Google Cloud Platform location.",
- "type": "object",
- "properties": {
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
- "type": "object"
- },
- "name": {
- "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
- "type": "string"
- },
- "locationId": {
- "description": "The canonical id for this location. For example: \"us-east1\".",
- "type": "string"
- },
- "metadata": {
- "description": "Service-specific metadata. For example the available capacity at the given location.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- }
- },
- "id": "Location"
- },
- "HealthCheck": {
- "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.",
- "type": "object",
- "properties": {
- "unhealthyThreshold": {
- "format": "uint32",
- "description": "Number of consecutive failed health checks required before removing traffic.",
- "type": "integer"
- },
- "disableHealthCheck": {
- "description": "Whether to explicitly disable health checks for this instance.",
- "type": "boolean"
- },
- "host": {
- "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"",
- "type": "string"
- },
- "healthyThreshold": {
- "format": "uint32",
- "description": "Number of consecutive successful health checks required before receiving traffic.",
- "type": "integer"
- },
- "restartThreshold": {
- "format": "uint32",
- "description": "Number of consecutive failed health checks required before an instance is restarted.",
- "type": "integer"
- },
- "checkInterval": {
- "format": "google-duration",
- "description": "Interval between health checks.",
- "type": "string"
- },
- "timeout": {
- "format": "google-duration",
- "description": "Time before the health check is considered failed.",
- "type": "string"
- }
- },
- "id": "HealthCheck"
- },
- "SourceReference": {
- "description": "Reference to a particular snapshot of the source tree used to build and deploy the application.",
- "type": "object",
- "properties": {
- "revisionId": {
- "description": "The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): \"2198322f89e0bb2e25021667c2ed489d1fd34e6b\"",
- "type": "string"
- },
- "repository": {
- "description": "URI string identifying the repository. Example: \"https://source.developers.google.com/p/app-123/r/default\"",
- "type": "string"
- }
- },
- "id": "SourceReference"
- },
- "DebugInstanceRequest": {
- "properties": {
- "sshKey": {
- "description": "Public SSH key to add to the instance. Examples:\n[USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME]\n[USERNAME]:ssh-rsa [KEY_VALUE] google-ssh {\"userName\":\"[USERNAME]\",\"expireOn\":\"[EXPIRE_TIME]\"}For more information, see Adding and Removing SSH Keys (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys).",
- "type": "string"
- }
- },
- "id": "DebugInstanceRequest",
- "description": "Request message for Instances.DebugInstance.",
- "type": "object"
- },
- "Library": {
- "description": "Third-party Python runtime library that is required by the application.",
- "type": "object",
- "properties": {
- "version": {
- "description": "Version of the library to select, or \"latest\".",
- "type": "string"
- },
- "name": {
- "description": "Name of the library. Example: \"django\".",
- "type": "string"
- }
- },
- "id": "Library"
- },
- "OperationMetadataV1Beta5": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "insertTime": {
- "format": "google-datetime",
- "description": "Timestamp that this operation was created.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "Timestamp that this operation completed.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1Beta5"
- },
"ListLocationsResponse": {
+ "description": "The response message for Locations.ListLocations.",
+ "type": "object",
"properties": {
"locations": {
"description": "A list of locations that matches the specified filter in the request.",
@@ -1497,14 +926,43 @@
"type": "string"
}
},
- "id": "ListLocationsResponse",
- "description": "The response message for Locations.ListLocations.",
- "type": "object"
+ "id": "ListLocationsResponse"
+ },
+ "ContainerInfo": {
+ "description": "Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment.",
+ "type": "object",
+ "properties": {
+ "image": {
+ "description": "URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: \"gcr.io/my-project/image:tag\" or \"gcr.io/my-project/image@digest\"",
+ "type": "string"
+ }
+ },
+ "id": "ContainerInfo"
},
"Version": {
"description": "A Version resource is a specific set of source code and configuration files that are deployed into a service.",
"type": "object",
"properties": {
+ "libraries": {
+ "description": "Configuration for third-party Python runtime libraries required by the application.Only returned in GET requests if view=FULL is set.",
+ "items": {
+ "$ref": "Library"
+ },
+ "type": "array"
+ },
+ "creationTime": {
+ "format": "google-datetime",
+ "description": "Time that this version was created.@OutputOnly",
+ "type": "string"
+ },
+ "nobuildFilesRegex": {
+ "description": "Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.",
+ "type": "string"
+ },
+ "basicScaling": {
+ "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.",
+ "$ref": "BasicScaling"
+ },
"runtime": {
"description": "Desired runtime. Example: python27.",
"type": "string"
@@ -1514,11 +972,11 @@
"type": "string"
},
"envVariables": {
- "description": "Environment variables made available to the application.Only returned in GET requests if view=FULL is set.",
- "type": "object",
"additionalProperties": {
"type": "string"
- }
+ },
+ "description": "Environment variables made available to the application.Only returned in GET requests if view=FULL is set.",
+ "type": "object"
},
"network": {
"$ref": "Network",
@@ -1556,16 +1014,16 @@
"type": "string"
},
"healthCheck": {
- "description": "Configures health checking for VM instances. Unhealthy instances are be stopped and replaced with new instances. Only applicable for VM runtimes.Only returned in GET requests if view=FULL is set.",
- "$ref": "HealthCheck"
+ "$ref": "HealthCheck",
+ "description": "Configures health checking for VM instances. Unhealthy instances are be stopped and replaced with new instances. Only applicable for VM runtimes.Only returned in GET requests if view=FULL is set."
},
"threadsafe": {
"description": "Whether multiple requests can be dispatched to this version at once.",
"type": "boolean"
},
"manualScaling": {
- "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
- "$ref": "ManualScaling"
+ "$ref": "ManualScaling",
+ "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time."
},
"name": {
"description": "Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly",
@@ -1576,8 +1034,8 @@
"$ref": "ApiConfigHandler"
},
"endpointsApiService": {
- "description": "Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app.",
- "$ref": "EndpointsApiService"
+ "$ref": "EndpointsApiService",
+ "description": "Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app."
},
"vm": {
"description": "Whether to deploy this version in a container on a virtual machine.",
@@ -1606,21 +1064,10 @@
"type": "string"
},
"deployment": {
- "$ref": "Deployment",
- "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set."
+ "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.",
+ "$ref": "Deployment"
},
"inboundServices": {
- "enumDescriptions": [
- "Not specified.",
- "Allows an application to receive mail.",
- "Allows an application to receive email-bound notifications.",
- "Allows an application to receive error stanzas.",
- "Allows an application to receive instant messages.",
- "Allows an application to receive user subscription POSTs.",
- "Allows an application to receive a user's chat presence.",
- "Registers an application for notifications when a client connects or disconnects from a channel.",
- "Enables warmup requests."
- ],
"description": "Before an application can receive email or XMPP messages, the application must be configured to enable the service.",
"items": {
"enum": [
@@ -1636,11 +1083,22 @@
],
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "enumDescriptions": [
+ "Not specified.",
+ "Allows an application to receive mail.",
+ "Allows an application to receive email-bound notifications.",
+ "Allows an application to receive error stanzas.",
+ "Allows an application to receive instant messages.",
+ "Allows an application to receive user subscription POSTs.",
+ "Allows an application to receive a user's chat presence.",
+ "Registers an application for notifications when a client connects or disconnects from a channel.",
+ "Enables warmup requests."
+ ]
},
"resources": {
- "description": "Machine resources for this version. Only applicable for VM runtimes.",
- "$ref": "Resources"
+ "$ref": "Resources",
+ "description": "Machine resources for this version. Only applicable for VM runtimes."
},
"errorHandlers": {
"description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.",
@@ -1653,41 +1111,10 @@
"format": "google-duration",
"description": "Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.",
"type": "string"
- },
- "libraries": {
- "description": "Configuration for third-party Python runtime libraries required by the application.Only returned in GET requests if view=FULL is set.",
- "items": {
- "$ref": "Library"
- },
- "type": "array"
- },
- "nobuildFilesRegex": {
- "description": "Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.",
- "type": "string"
- },
- "creationTime": {
- "format": "google-datetime",
- "description": "Time that this version was created.@OutputOnly",
- "type": "string"
- },
- "basicScaling": {
- "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.",
- "$ref": "BasicScaling"
}
},
"id": "Version"
},
- "ContainerInfo": {
- "description": "Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment.",
- "type": "object",
- "properties": {
- "image": {
- "description": "URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: \"gcr.io/my-project/image:tag\" or \"gcr.io/my-project/image@digest\"",
- "type": "string"
- }
- },
- "id": "ContainerInfo"
- },
"RequestUtilization": {
"description": "Target scaling by request utilization. Only applicable for VM runtimes.",
"type": "object",
@@ -1705,6 +1132,95 @@
},
"id": "RequestUtilization"
},
+ "UrlMap": {
+ "description": "URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the version, such as images, CSS, or JavaScript.",
+ "type": "object",
+ "properties": {
+ "redirectHttpResponseCode": {
+ "enum": [
+ "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED",
+ "REDIRECT_HTTP_RESPONSE_CODE_301",
+ "REDIRECT_HTTP_RESPONSE_CODE_302",
+ "REDIRECT_HTTP_RESPONSE_CODE_303",
+ "REDIRECT_HTTP_RESPONSE_CODE_307"
+ ],
+ "description": "30x code to use when performing redirects for the secure field. Defaults to 302.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified. 302 is assumed.",
+ "301 Moved Permanently code.",
+ "302 Moved Temporarily code.",
+ "303 See Other code.",
+ "307 Temporary Redirect code."
+ ]
+ },
+ "securityLevel": {
+ "description": "Security (HTTPS) enforcement for this URL.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
+ "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
+ "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
+ ],
+ "enum": [
+ "SECURE_UNSPECIFIED",
+ "SECURE_DEFAULT",
+ "SECURE_NEVER",
+ "SECURE_OPTIONAL",
+ "SECURE_ALWAYS"
+ ]
+ },
+ "authFailAction": {
+ "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
+ "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
+ "Rejects request with an401 HTTP status code and an error message."
+ ],
+ "enum": [
+ "AUTH_FAIL_ACTION_UNSPECIFIED",
+ "AUTH_FAIL_ACTION_REDIRECT",
+ "AUTH_FAIL_ACTION_UNAUTHORIZED"
+ ]
+ },
+ "script": {
+ "$ref": "ScriptHandler",
+ "description": "Executes a script to handle the request that matches this URL pattern."
+ },
+ "urlRegex": {
+ "description": "A URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.",
+ "type": "string"
+ },
+ "login": {
+ "enum": [
+ "LOGIN_UNSPECIFIED",
+ "LOGIN_OPTIONAL",
+ "LOGIN_ADMIN",
+ "LOGIN_REQUIRED"
+ ],
+ "description": "Level of login required to access this resource.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified. LOGIN_OPTIONAL is assumed.",
+ "Does not require that the user is signed in.",
+ "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
+ "If the user has signed in, the handler proceeds normally. Otherwise, the action given in auth_fail_action is taken."
+ ]
+ },
+ "apiEndpoint": {
+ "description": "Uses API Endpoints to handle requests.",
+ "$ref": "ApiEndpointHandler"
+ },
+ "staticFiles": {
+ "$ref": "StaticFilesHandler",
+ "description": "Returns the contents of a file, such as an image, as the response."
+ }
+ },
+ "id": "UrlMap"
+ },
"EndpointsApiService": {
"description": "Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and configuration id of a \"service\" resource in the Service Management API (https://cloud.google.com/service-management/overview).",
"type": "object",
@@ -1720,99 +1236,12 @@
},
"id": "EndpointsApiService"
},
- "UrlMap": {
- "description": "URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the version, such as images, CSS, or JavaScript.",
- "type": "object",
- "properties": {
- "securityLevel": {
- "enumDescriptions": [
- "Not specified.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
- "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
- "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
- ],
- "enum": [
- "SECURE_UNSPECIFIED",
- "SECURE_DEFAULT",
- "SECURE_NEVER",
- "SECURE_OPTIONAL",
- "SECURE_ALWAYS"
- ],
- "description": "Security (HTTPS) enforcement for this URL.",
- "type": "string"
- },
- "authFailAction": {
- "enumDescriptions": [
- "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
- "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
- "Rejects request with an401 HTTP status code and an error message."
- ],
- "enum": [
- "AUTH_FAIL_ACTION_UNSPECIFIED",
- "AUTH_FAIL_ACTION_REDIRECT",
- "AUTH_FAIL_ACTION_UNAUTHORIZED"
- ],
- "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
- "type": "string"
- },
- "script": {
- "$ref": "ScriptHandler",
- "description": "Executes a script to handle the request that matches this URL pattern."
- },
- "urlRegex": {
- "description": "A URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.",
- "type": "string"
- },
- "login": {
- "description": "Level of login required to access this resource.",
- "type": "string",
- "enumDescriptions": [
- "Not specified. LOGIN_OPTIONAL is assumed.",
- "Does not require that the user is signed in.",
- "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
- "If the user has signed in, the handler proceeds normally. Otherwise, the action given in auth_fail_action is taken."
- ],
- "enum": [
- "LOGIN_UNSPECIFIED",
- "LOGIN_OPTIONAL",
- "LOGIN_ADMIN",
- "LOGIN_REQUIRED"
- ]
- },
- "apiEndpoint": {
- "description": "Uses API Endpoints to handle requests.",
- "$ref": "ApiEndpointHandler"
- },
- "staticFiles": {
- "$ref": "StaticFilesHandler",
- "description": "Returns the contents of a file, such as an image, as the response."
- },
- "redirectHttpResponseCode": {
- "description": "30x code to use when performing redirects for the secure field. Defaults to 302.",
- "type": "string",
- "enumDescriptions": [
- "Not specified. 302 is assumed.",
- "301 Moved Permanently code.",
- "302 Moved Temporarily code.",
- "303 See Other code.",
- "307 Temporary Redirect code."
- ],
- "enum": [
- "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED",
- "REDIRECT_HTTP_RESPONSE_CODE_301",
- "REDIRECT_HTTP_RESPONSE_CODE_302",
- "REDIRECT_HTTP_RESPONSE_CODE_303",
- "REDIRECT_HTTP_RESPONSE_CODE_307"
- ]
- }
- },
- "id": "UrlMap"
- },
"Operation": {
- "description": "This resource represents a long-running operation that is the result of a network API call.",
- "type": "object",
"properties": {
+ "done": {
+ "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
+ "type": "boolean"
+ },
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
@@ -1836,26 +1265,17 @@
},
"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
"type": "object"
- },
- "done": {
- "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
- "type": "boolean"
}
},
- "id": "Operation"
+ "id": "Operation",
+ "description": "This resource represents a long-running operation that is the result of a network API call.",
+ "type": "object"
},
"ApiConfigHandler": {
"description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
"type": "object",
"properties": {
"securityLevel": {
- "enumDescriptions": [
- "Not specified.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
- "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
- "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
- ],
"enum": [
"SECURE_UNSPECIFIED",
"SECURE_DEFAULT",
@@ -1864,7 +1284,14 @@
"SECURE_ALWAYS"
],
"description": "Security (HTTPS) enforcement for this URL.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
+ "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
+ "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
+ ]
},
"authFailAction": {
"enumDescriptions": [
@@ -1908,9 +1335,11 @@
"id": "ApiConfigHandler"
},
"FileInfo": {
- "description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.",
- "type": "object",
"properties": {
+ "sourceUrl": {
+ "description": "URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
+ "type": "string"
+ },
"sha1Sum": {
"description": "The SHA1 hash of the file, in hex.",
"type": "string"
@@ -1918,34 +1347,16 @@
"mimeType": {
"description": "The MIME type of the file.Defaults to the value from Google Cloud Storage.",
"type": "string"
- },
- "sourceUrl": {
- "description": "URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
- "type": "string"
}
},
- "id": "FileInfo"
+ "id": "FileInfo",
+ "description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.",
+ "type": "object"
},
"StaticFilesHandler": {
"description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.",
"type": "object",
"properties": {
- "expiration": {
- "format": "google-duration",
- "description": "Time a static file served by this handler should be cached.",
- "type": "string"
- },
- "applicationReadable": {
- "description": "Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.",
- "type": "boolean"
- },
- "httpHeaders": {
- "description": "HTTP headers to use for all responses from these URLs.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
"uploadPathRegex": {
"description": "Regular expression that matches the file paths for all files that should be referenced by this handler.",
"type": "string"
@@ -1961,28 +1372,39 @@
"requireMatchingFile": {
"description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
"type": "boolean"
+ },
+ "expiration": {
+ "format": "google-duration",
+ "description": "Time a static file served by this handler should be cached.",
+ "type": "string"
+ },
+ "applicationReadable": {
+ "description": "Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.",
+ "type": "boolean"
+ },
+ "httpHeaders": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "HTTP headers to use for all responses from these URLs.",
+ "type": "object"
}
},
"id": "StaticFilesHandler"
},
"ScriptHandler": {
- "description": "Executes a script to handle the request that matches the URL pattern.",
- "type": "object",
"properties": {
"scriptPath": {
"description": "Path to the script from the application root directory.",
"type": "string"
}
},
- "id": "ScriptHandler"
+ "id": "ScriptHandler",
+ "description": "Executes a script to handle the request that matches the URL pattern.",
+ "type": "object"
},
"DiskUtilization": {
"properties": {
- "targetReadOpsPerSec": {
- "format": "int32",
- "description": "Target ops read per second.",
- "type": "integer"
- },
"targetReadBytesPerSec": {
"format": "int32",
"description": "Target bytes read per second.",
@@ -1997,6 +1419,11 @@
"format": "int32",
"description": "Target bytes written per second.",
"type": "integer"
+ },
+ "targetReadOpsPerSec": {
+ "format": "int32",
+ "description": "Target ops read per second.",
+ "type": "integer"
}
},
"id": "DiskUtilization",
@@ -2007,15 +1434,15 @@
"description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.",
"type": "object",
"properties": {
- "maxInstances": {
- "format": "int32",
- "description": "Maximum number of instances to create for this version.",
- "type": "integer"
- },
"idleTimeout": {
"format": "google-duration",
"description": "Duration of time after the last request that an instance must wait before the instance is shut down.",
"type": "string"
+ },
+ "maxInstances": {
+ "format": "int32",
+ "description": "Maximum number of instances to create for this version.",
+ "type": "integer"
}
},
"id": "BasicScaling"
@@ -2066,33 +1493,6 @@
"description": "Target scaling by CPU usage.",
"type": "object"
},
- "Status": {
- "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "message": {
- "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- },
- "type": "array"
- },
- "code": {
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer"
- }
- },
- "id": "Status"
- },
"IdentityAwareProxy": {
"description": "Identity-Aware Proxy",
"type": "object",
@@ -2116,29 +1516,42 @@
},
"id": "IdentityAwareProxy"
},
- "ManualScaling": {
- "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
+ "Status": {
+ "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
- "instances": {
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "type": "array"
+ },
+ "code": {
"format": "int32",
- "description": "Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.",
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
"type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
+ "type": "string"
}
},
- "id": "ManualScaling"
+ "id": "Status"
},
"TrafficSplit": {
- "description": "Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.",
- "type": "object",
"properties": {
"allocations": {
- "description": "Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.",
- "type": "object",
"additionalProperties": {
"format": "double",
"type": "number"
- }
+ },
+ "description": "Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.",
+ "type": "object"
},
"shardBy": {
"enumDescriptions": [
@@ -2155,7 +1568,21 @@
"type": "string"
}
},
- "id": "TrafficSplit"
+ "id": "TrafficSplit",
+ "description": "Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.",
+ "type": "object"
+ },
+ "ManualScaling": {
+ "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
+ "type": "object",
+ "properties": {
+ "instances": {
+ "format": "int32",
+ "description": "Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.",
+ "type": "integer"
+ }
+ },
+ "id": "ManualScaling"
},
"LocationMetadata": {
"description": "Metadata for the given google.cloud.location.Location.",
@@ -2176,15 +1603,6 @@
"description": "Metadata for the given google.longrunning.Operation.",
"type": "object",
"properties": {
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "Time that this operation completed.@OutputOnly",
- "type": "string"
- },
"warning": {
"description": "Durable messages that persist on every operation poll. @OutputOnly",
"items": {
@@ -2208,6 +1626,15 @@
"ephemeralMessage": {
"description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
"type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation completed.@OutputOnly",
+ "type": "string"
}
},
"id": "OperationMetadataV1Beta"
@@ -2230,7 +1657,34 @@
},
"id": "ListServicesResponse"
},
+ "Deployment": {
+ "description": "Code and application artifacts used to deploy a version to App Engine.",
+ "type": "object",
+ "properties": {
+ "sourceReferences": {
+ "description": "Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.",
+ "items": {
+ "$ref": "SourceReference"
+ },
+ "type": "array"
+ },
+ "container": {
+ "$ref": "ContainerInfo",
+ "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment."
+ },
+ "files": {
+ "additionalProperties": {
+ "$ref": "FileInfo"
+ },
+ "description": "Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.",
+ "type": "object"
+ }
+ },
+ "id": "Deployment"
+ },
"Resources": {
+ "description": "Machine resources for a version.",
+ "type": "object",
"properties": {
"volumes": {
"description": "Volumes mounted within the app container.",
@@ -2255,43 +1709,31 @@
"type": "number"
}
},
- "id": "Resources",
- "description": "Machine resources for a version.",
- "type": "object"
+ "id": "Resources"
},
- "Deployment": {
- "description": "Code and application artifacts used to deploy a version to App Engine.",
+ "Service": {
+ "description": "A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle other tasks such as API requests from mobile devices or backend data analysis. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.",
"type": "object",
"properties": {
- "sourceReferences": {
- "description": "Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.",
- "items": {
- "$ref": "SourceReference"
- },
- "type": "array"
+ "id": {
+ "description": "Relative name of the service within the application. Example: default.@OutputOnly",
+ "type": "string"
},
- "container": {
- "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.",
- "$ref": "ContainerInfo"
+ "name": {
+ "description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
},
- "files": {
- "additionalProperties": {
- "$ref": "FileInfo"
- },
- "description": "Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.",
- "type": "object"
+ "split": {
+ "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service.",
+ "$ref": "TrafficSplit"
}
},
- "id": "Deployment"
+ "id": "Service"
},
"Volume": {
"description": "Volumes mounted within the app container. Only applicable for VM runtimes.",
"type": "object",
"properties": {
- "volumeType": {
- "description": "Underlying volume type, e.g. 'tmpfs'.",
- "type": "string"
- },
"sizeGb": {
"format": "double",
"description": "Volume size in gigabytes.",
@@ -2300,62 +1742,36 @@
"name": {
"description": "Unique name for the volume.",
"type": "string"
+ },
+ "volumeType": {
+ "description": "Underlying volume type, e.g. 'tmpfs'.",
+ "type": "string"
}
},
"id": "Volume"
},
- "Service": {
- "description": "A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle other tasks such as API requests from mobile devices or backend data analysis. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.",
- "type": "object",
- "properties": {
- "split": {
- "$ref": "TrafficSplit",
- "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service."
- },
- "id": {
- "description": "Relative name of the service within the application. Example: default.@OutputOnly",
- "type": "string"
- },
- "name": {
- "description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- }
- },
- "id": "Service"
- },
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "Operation"
},
"type": "array"
- },
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
}
},
"id": "ListOperationsResponse"
},
"OperationMetadata": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
"properties": {
- "insertTime": {
- "format": "google-datetime",
- "description": "Timestamp that this operation was created.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
"method": {
"description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
"type": "string"
@@ -2368,17 +1784,600 @@
"operationType": {
"description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly",
"type": "string"
+ },
+ "insertTime": {
+ "format": "google-datetime",
+ "description": "Timestamp that this operation was created.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
}
},
- "id": "OperationMetadata",
- "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadata"
+ },
+ "ListInstancesResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "instances": {
+ "description": "The instances belonging to the requested version.",
+ "items": {
+ "$ref": "Instance"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListInstancesResponse",
+ "description": "Response message for Instances.ListInstances.",
"type": "object"
+ },
+ "ErrorHandler": {
+ "description": "Custom static error page to be served when an error occurs.",
+ "type": "object",
+ "properties": {
+ "mimeType": {
+ "description": "MIME type of file. Defaults to text/html.",
+ "type": "string"
+ },
+ "errorCode": {
+ "description": "Error condition this handler applies to.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified. ERROR_CODE_DEFAULT is assumed.",
+ "All other error types.",
+ "Application has exceeded a resource quota.",
+ "Client blocked by the application's Denial of Service protection configuration.",
+ "Deadline reached before the application responds."
+ ],
+ "enum": [
+ "ERROR_CODE_UNSPECIFIED",
+ "ERROR_CODE_DEFAULT",
+ "ERROR_CODE_OVER_QUOTA",
+ "ERROR_CODE_DOS_API_DENIAL",
+ "ERROR_CODE_TIMEOUT"
+ ]
+ },
+ "staticFile": {
+ "description": "Static file content to be served for this error.",
+ "type": "string"
+ }
+ },
+ "id": "ErrorHandler"
+ },
+ "OperationMetadataV1": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
+ "properties": {
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation completed.@OutputOnly",
+ "type": "string"
+ },
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "insertTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation was created.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadataV1"
+ },
+ "OperationMetadataV1Alpha": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
+ "properties": {
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "insertTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation was created.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Time that this operation completed.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadataV1Alpha"
+ },
+ "Network": {
+ "description": "Extra network settings. Only applicable for VM runtimes.",
+ "type": "object",
+ "properties": {
+ "subnetworkName": {
+ "description": "Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network.\nIf the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.\nIf the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network.\nIf the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app.",
+ "type": "string"
+ },
+ "instanceTag": {
+ "description": "Tag to apply to the VM instance during creation.",
+ "type": "string"
+ },
+ "forwardedPorts": {
+ "description": "List of ports, or port pairs, to forward from the virtual machine to the application container.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.",
+ "type": "string"
+ }
+ },
+ "id": "Network"
+ },
+ "Application": {
+ "description": "An Application resource contains the top-level configuration of an App Engine application.",
+ "type": "object",
+ "properties": {
+ "dispatchRules": {
+ "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent.@OutputOnly",
+ "items": {
+ "$ref": "UrlDispatchRule"
+ },
+ "type": "array"
+ },
+ "defaultHostname": {
+ "description": "Hostname used to reach the application, as resolved by App Engine.@OutputOnly",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
+ "type": "string"
+ },
+ "authDomain": {
+ "description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.",
+ "type": "string"
+ },
+ "iap": {
+ "$ref": "IdentityAwareProxy"
+ },
+ "id": {
+ "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.",
+ "type": "string"
+ },
+ "defaultCookieExpiration": {
+ "format": "google-duration",
+ "description": "Cookie expiration policy for this application.",
+ "type": "string"
+ },
+ "codeBucket": {
+ "description": "A Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly",
+ "type": "string"
+ },
+ "location": {
+ "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US",
+ "type": "string"
+ },
+ "defaultBucket": {
+ "description": "A Google Cloud Storage bucket that can be used by the application to store content.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "Application"
+ },
+ "UrlDispatchRule": {
+ "description": "Rules to match an HTTP request and dispatch that request to a service.",
+ "type": "object",
+ "properties": {
+ "service": {
+ "description": "Resource id of a service in this application that should serve the matched request. The service must already exist. Example: default.",
+ "type": "string"
+ },
+ "domain": {
+ "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
+ "type": "string"
+ },
+ "path": {
+ "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.",
+ "type": "string"
+ }
+ },
+ "id": "UrlDispatchRule"
+ },
+ "Instance": {
+ "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
+ "type": "object",
+ "properties": {
+ "requests": {
+ "format": "int32",
+ "description": "Number of requests since this instance was started.@OutputOnly",
+ "type": "integer"
+ },
+ "appEngineRelease": {
+ "description": "App Engine release this instance is running on.@OutputOnly",
+ "type": "string"
+ },
+ "startTimestamp": {
+ "format": "google-datetime",
+ "description": "Time that this instance was started.@OutputOnly",
+ "type": "string"
+ },
+ "vmName": {
+ "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "qps": {
+ "format": "float",
+ "description": "Average queries per second (QPS) over the last minute.@OutputOnly",
+ "type": "number"
+ },
+ "vmId": {
+ "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "vmZoneName": {
+ "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly",
+ "type": "string"
+ },
+ "vmUnlocked": {
+ "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "boolean"
+ },
+ "averageLatency": {
+ "format": "int32",
+ "description": "Average latency (ms) over the last minute.@OutputOnly",
+ "type": "integer"
+ },
+ "id": {
+ "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
+ "type": "string"
+ },
+ "memoryUsage": {
+ "format": "int64",
+ "description": "Total memory in use (bytes).@OutputOnly",
+ "type": "string"
+ },
+ "vmIp": {
+ "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "errors": {
+ "format": "uint32",
+ "description": "Number of errors since this instance was started.@OutputOnly",
+ "type": "integer"
+ },
+ "availability": {
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "enum": [
+ "UNSPECIFIED",
+ "RESIDENT",
+ "DYNAMIC"
+ ],
+ "description": "Availability of the instance.@OutputOnly",
+ "type": "string"
+ },
+ "vmStatus": {
+ "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "Instance"
+ },
+ "ListVersionsResponse": {
+ "description": "Response message for Versions.ListVersions.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "versions": {
+ "description": "The versions belonging to the requested service.",
+ "items": {
+ "$ref": "Version"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListVersionsResponse"
+ },
+ "ApiEndpointHandler": {
+ "description": "Uses Google Cloud Endpoints to handle requests.",
+ "type": "object",
+ "properties": {
+ "scriptPath": {
+ "description": "Path to the script from the application root directory.",
+ "type": "string"
+ }
+ },
+ "id": "ApiEndpointHandler"
+ },
+ "AutomaticScaling": {
+ "properties": {
+ "maxTotalInstances": {
+ "format": "int32",
+ "description": "Maximum number of instances that should be started to handle requests.",
+ "type": "integer"
+ },
+ "minTotalInstances": {
+ "format": "int32",
+ "description": "Minimum number of instances that should be maintained for this version.",
+ "type": "integer"
+ },
+ "networkUtilization": {
+ "$ref": "NetworkUtilization",
+ "description": "Target scaling by network usage."
+ },
+ "coolDownPeriod": {
+ "format": "google-duration",
+ "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.",
+ "type": "string"
+ },
+ "maxConcurrentRequests": {
+ "format": "int32",
+ "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
+ "type": "integer"
+ },
+ "maxPendingLatency": {
+ "format": "google-duration",
+ "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.",
+ "type": "string"
+ },
+ "cpuUtilization": {
+ "description": "Target scaling by CPU usage.",
+ "$ref": "CpuUtilization"
+ },
+ "diskUtilization": {
+ "$ref": "DiskUtilization",
+ "description": "Target scaling by disk usage."
+ },
+ "minPendingLatency": {
+ "format": "google-duration",
+ "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
+ "type": "string"
+ },
+ "requestUtilization": {
+ "$ref": "RequestUtilization",
+ "description": "Target scaling by request utilization."
+ },
+ "maxIdleInstances": {
+ "format": "int32",
+ "description": "Maximum number of idle instances that should be maintained for this version.",
+ "type": "integer"
+ },
+ "minIdleInstances": {
+ "format": "int32",
+ "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.",
+ "type": "integer"
+ }
+ },
+ "id": "AutomaticScaling",
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
+ "type": "object"
+ },
+ "NetworkUtilization": {
+ "description": "Target scaling by network usage. Only applicable for VM runtimes.",
+ "type": "object",
+ "properties": {
+ "targetReceivedBytesPerSec": {
+ "format": "int32",
+ "description": "Target bytes received per second.",
+ "type": "integer"
+ },
+ "targetSentPacketsPerSec": {
+ "format": "int32",
+ "description": "Target packets sent per second.",
+ "type": "integer"
+ },
+ "targetReceivedPacketsPerSec": {
+ "format": "int32",
+ "description": "Target packets received per second.",
+ "type": "integer"
+ },
+ "targetSentBytesPerSec": {
+ "format": "int32",
+ "description": "Target bytes sent per second.",
+ "type": "integer"
+ }
+ },
+ "id": "NetworkUtilization"
+ },
+ "Location": {
+ "description": "A resource that represents Google Cloud Platform location.",
+ "type": "object",
+ "properties": {
+ "labels": {
+ "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
+ "type": "string"
+ },
+ "locationId": {
+ "description": "The canonical id for this location. For example: \"us-east1\".",
+ "type": "string"
+ },
+ "metadata": {
+ "description": "Service-specific metadata. For example the available capacity at the given location.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ }
+ },
+ "id": "Location"
+ },
+ "HealthCheck": {
+ "properties": {
+ "disableHealthCheck": {
+ "description": "Whether to explicitly disable health checks for this instance.",
+ "type": "boolean"
+ },
+ "host": {
+ "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"",
+ "type": "string"
+ },
+ "healthyThreshold": {
+ "format": "uint32",
+ "description": "Number of consecutive successful health checks required before receiving traffic.",
+ "type": "integer"
+ },
+ "restartThreshold": {
+ "format": "uint32",
+ "description": "Number of consecutive failed health checks required before an instance is restarted.",
+ "type": "integer"
+ },
+ "checkInterval": {
+ "format": "google-duration",
+ "description": "Interval between health checks.",
+ "type": "string"
+ },
+ "timeout": {
+ "format": "google-duration",
+ "description": "Time before the health check is considered failed.",
+ "type": "string"
+ },
+ "unhealthyThreshold": {
+ "format": "uint32",
+ "description": "Number of consecutive failed health checks required before removing traffic.",
+ "type": "integer"
+ }
+ },
+ "id": "HealthCheck",
+ "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.",
+ "type": "object"
+ },
+ "DebugInstanceRequest": {
+ "description": "Request message for Instances.DebugInstance.",
+ "type": "object",
+ "properties": {
+ "sshKey": {
+ "description": "Public SSH key to add to the instance. Examples:\n[USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME]\n[USERNAME]:ssh-rsa [KEY_VALUE] google-ssh {\"userName\":\"[USERNAME]\",\"expireOn\":\"[EXPIRE_TIME]\"}For more information, see Adding and Removing SSH Keys (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys).",
+ "type": "string"
+ }
+ },
+ "id": "DebugInstanceRequest"
+ },
+ "SourceReference": {
+ "properties": {
+ "repository": {
+ "description": "URI string identifying the repository. Example: \"https://source.developers.google.com/p/app-123/r/default\"",
+ "type": "string"
+ },
+ "revisionId": {
+ "description": "The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): \"2198322f89e0bb2e25021667c2ed489d1fd34e6b\"",
+ "type": "string"
+ }
+ },
+ "id": "SourceReference",
+ "description": "Reference to a particular snapshot of the source tree used to build and deploy the application.",
+ "type": "object"
+ },
+ "OperationMetadataV1Beta5": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
+ "properties": {
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "insertTime": {
+ "format": "google-datetime",
+ "description": "Timestamp that this operation was created.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Timestamp that this operation completed.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadataV1Beta5"
+ },
+ "Library": {
+ "description": "Third-party Python runtime library that is required by the application.",
+ "type": "object",
+ "properties": {
+ "version": {
+ "description": "Version of the library to select, or \"latest\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the library. Example: \"django\".",
+ "type": "string"
+ }
+ },
+ "id": "Library"
}
},
"protocol": "rest",
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"version": "v1beta5",
"baseUrl": "https://appengine.googleapis.com/",
@@ -2397,15 +2396,16 @@
}
}
},
- "servicePath": "",
- "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.",
"kind": "discovery#restDescription",
+ "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.",
+ "servicePath": "",
"rootUrl": "https://appengine.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "appengine",
"batchPath": "batch",
- "id": "appengine:v1beta5",
+ "revision": "20170929",
"documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
- "revision": "20170929"
+ "id": "appengine:v1beta5",
+ "title": "Google App Engine Admin API"
}
diff --git a/bigquerydatatransfer/v1/bigquerydatatransfer-api.json b/bigquerydatatransfer/v1/bigquerydatatransfer-api.json
index 4bb691c..86a1930 100644
--- a/bigquerydatatransfer/v1/bigquerydatatransfer-api.json
+++ b/bigquerydatatransfer/v1/bigquerydatatransfer-api.json
@@ -1,10 +1,431 @@
{
- "documentationLink": "https://cloud.google.com/bigquery/",
- "id": "bigquerydatatransfer:v1",
- "revision": "20171010",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "DataSource": {
+ "description": "Represents data source metadata. Metadata is sufficient to\nrender UI and request proper OAuth tokens.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Data source resource name.",
+ "type": "string"
+ },
+ "scopes": {
+ "description": "Api auth scopes for which refresh token needs to be obtained. Only valid\nwhen `client_id` is specified. Ignored otherwise. These are scopes needed\nby a data source to prepare data and ingest them into BigQuery,\ne.g., https://www.googleapis.com/auth/bigquery",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "minimumScheduleInterval": {
+ "type": "string",
+ "format": "google-duration",
+ "description": "The minimum interval between two consecutive scheduled runs."
+ },
+ "clientId": {
+ "description": "Data source client id which should be used to receive refresh token.\nWhen not supplied, no offline credentials are populated for data transfer.",
+ "type": "string"
+ },
+ "authorizationType": {
+ "type": "string",
+ "enumDescriptions": [
+ "Type unspecified.",
+ "Use OAuth 2 authorization codes that can be exchanged\nfor a refresh token on the backend.",
+ "Return an authorization code for a given Google+ page that can then be\nexchanged for a refresh token on the backend."
+ ],
+ "enum": [
+ "AUTHORIZATION_TYPE_UNSPECIFIED",
+ "AUTHORIZATION_CODE",
+ "GOOGLE_PLUS_AUTHORIZATION_CODE"
+ ],
+ "description": "Indicates the type of authorization."
+ },
+ "supportsCustomSchedule": {
+ "type": "boolean",
+ "description": "Specifies whether the data source supports a user defined schedule, or\noperates on the default schedule.\nWhen set to `true`, user can override default schedule."
+ },
+ "displayName": {
+ "description": "User friendly data source name.",
+ "type": "string"
+ },
+ "updateDeadlineSeconds": {
+ "format": "int32",
+ "description": "The number of seconds to wait for an update from the data source\nbefore BigQuery marks the transfer as failed.",
+ "type": "integer"
+ },
+ "dataRefreshType": {
+ "enum": [
+ "DATA_REFRESH_TYPE_UNSPECIFIED",
+ "SLIDING_WINDOW",
+ "CUSTOM_SLIDING_WINDOW"
+ ],
+ "description": "Specifies whether the data source supports automatic data refresh for the\npast few days, and how it's supported.\nFor some data sources, data might not be complete until a few days later,\nso it's useful to refresh data automatically.",
+ "type": "string",
+ "enumDescriptions": [
+ "The data source won't support data auto refresh, which is default value.",
+ "The data source supports data auto refresh, and runs will be scheduled\nfor the past few days. Does not allow custom values to be set for each\ntransfer config.",
+ "The data source supports data auto refresh, and runs will be scheduled\nfor the past few days. Allows custom values to be set for each transfer\nconfig."
+ ]
+ },
+ "parameters": {
+ "description": "Data source parameters.",
+ "items": {
+ "$ref": "DataSourceParameter"
+ },
+ "type": "array"
+ },
+ "helpUrl": {
+ "description": "Url for the help document for this data source.",
+ "type": "string"
+ },
+ "defaultSchedule": {
+ "description": "Default data transfer schedule.\nExamples of valid schedules include:\n`1st,3rd monday of month 15:30`,\n`every wed,fri of jan,jun 13:15`, and\n`first sunday of quarter 00:00`.",
+ "type": "string"
+ },
+ "supportsMultipleTransfers": {
+ "description": "Indicates whether the data source supports multiple transfers\nto different BigQuery targets.",
+ "type": "boolean"
+ },
+ "defaultDataRefreshWindowDays": {
+ "format": "int32",
+ "description": "Default data refresh window on days.\nOnly meaningful when `data_refresh_type` = `SLIDING_WINDOW`.",
+ "type": "integer"
+ },
+ "manualRunsDisabled": {
+ "description": "Disables backfilling and manual run scheduling\nfor the data source.",
+ "type": "boolean"
+ },
+ "transferType": {
+ "description": "Transfer type. Currently supports only batch transfers,\nwhich are transfers that use the BigQuery batch APIs (load or\nquery) to ingest the data.",
+ "type": "string",
+ "enumDescriptions": [
+ "Invalid or Unknown transfer type placeholder.",
+ "Batch data transfer.",
+ "Streaming data transfer. Streaming data source currently doesn't\nsupport multiple transfer configs per project."
+ ],
+ "enum": [
+ "TRANSFER_TYPE_UNSPECIFIED",
+ "BATCH",
+ "STREAMING"
+ ]
+ },
+ "description": {
+ "description": "User friendly data source description string.",
+ "type": "string"
+ },
+ "dataSourceId": {
+ "description": "Data source id.",
+ "type": "string"
+ }
+ },
+ "id": "DataSource"
+ },
+ "ScheduleTransferRunsRequest": {
+ "id": "ScheduleTransferRunsRequest",
+ "description": "A request to schedule transfer runs for a time range.",
+ "type": "object",
+ "properties": {
+ "endTime": {
+ "format": "google-datetime",
+ "description": "End time of the range of transfer runs. For example,\n`\"2017-05-30T00:00:00+00:00\"`.",
+ "type": "string"
+ },
+ "startTime": {
+ "type": "string",
+ "format": "google-datetime",
+ "description": "Start time of the range of transfer runs. For example,\n`\"2017-05-25T00:00:00+00:00\"`."
+ }
+ }
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
+ },
+ "Location": {
+ "type": "object",
+ "properties": {
+ "labels": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}"
+ },
+ "name": {
+ "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
+ "type": "string"
+ },
+ "locationId": {
+ "description": "The canonical id for this location. For example: `\"us-east1\"`.",
+ "type": "string"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
+ "type": "object"
+ }
+ },
+ "id": "Location",
+ "description": "A resource that represents Google Cloud Platform location."
+ },
+ "TransferConfig": {
+ "type": "object",
+ "properties": {
+ "disabled": {
+ "description": "Is this config disabled. When set to true, no runs are scheduled\nfor a given transfer.",
+ "type": "boolean"
+ },
+ "nextRunTime": {
+ "format": "google-datetime",
+ "description": "Output only. Next time when data transfer will run.",
+ "type": "string"
+ },
+ "schedule": {
+ "description": "Data transfer schedule.\nIf the data source does not support a custom schedule, this should be\nempty. If it is empty, the default value for the data source will be\nused.\nThe specified times are in UTC.\nExamples of valid format:\n`1st,3rd monday of month 15:30`,\n`every wed,fri of jan,jun 13:15`, and\n`first sunday of quarter 00:00`.\nSee more explanation about the format here:\nhttps://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format\nNOTE: the granularity should be at least 8 hours, or less frequent.",
+ "type": "string"
+ },
+ "updateTime": {
+ "format": "google-datetime",
+ "description": "Output only. Data transfer modification time. Ignored by server on input.",
+ "type": "string"
+ },
+ "dataRefreshWindowDays": {
+ "format": "int32",
+ "description": "The number of days to look back to automatically refresh the data.\nFor example, if `data_refresh_window_days = 10`, then every day\nBigQuery reingests data for [today-10, today-1], rather than ingesting data\nfor just [today-1].\nOnly valid if the data source supports the feature. Set the value to 0\nto use the default value.",
+ "type": "integer"
+ },
+ "dataSourceId": {
+ "description": "Data source id. Cannot be changed once data transfer is created.",
+ "type": "string"
+ },
+ "state": {
+ "enum": [
+ "TRANSFER_STATE_UNSPECIFIED",
+ "INACTIVE",
+ "PENDING",
+ "RUNNING",
+ "SUCCEEDED",
+ "FAILED",
+ "CANCELLED"
+ ],
+ "description": "Output only. State of the most recently updated transfer run.",
+ "type": "string",
+ "enumDescriptions": [
+ "State placeholder.",
+ "Data transfer is inactive.",
+ "Data transfer is scheduled and is waiting to be picked up by\ndata transfer backend.",
+ "Data transfer is in progress.",
+ "Data transfer completed successsfully.",
+ "Data transfer failed.",
+ "Data transfer is cancelled."
+ ]
+ },
+ "destinationDatasetId": {
+ "description": "The BigQuery target dataset id.",
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "description": "The resource name of the transfer config.\nTransfer config names have the form\n`projects/{project_id}/transferConfigs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or required. The name is ignored when creating a transfer\nconfig."
+ },
+ "userId": {
+ "format": "int64",
+ "description": "Output only. Unique ID of the user on whose behalf transfer is done.\nApplicable only to data sources that do not support service accounts.\nWhen set to 0, the data source service account credentials are used.",
+ "type": "string"
+ },
+ "params": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "Data transfer specific parameters.",
+ "type": "object"
+ },
+ "datasetRegion": {
+ "description": "Output only. Region in which BigQuery dataset is located.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "User specified display name for the data transfer.",
+ "type": "string"
+ }
+ },
+ "id": "TransferConfig",
+ "description": "Represents a data transfer configuration. A transfer configuration\ncontains all metadata needed to perform a data transfer. For example,\n`destination_dataset_id` specifies where data should be stored.\nWhen a new transfer configuration is created, the specified\n`destination_dataset_id` is created when needed and shared with the\nappropriate data source service account."
+ },
+ "TransferRun": {
+ "properties": {
+ "dataSourceId": {
+ "description": "Output only. Data source id.",
+ "type": "string"
+ },
+ "state": {
+ "enumDescriptions": [
+ "State placeholder.",
+ "Data transfer is inactive.",
+ "Data transfer is scheduled and is waiting to be picked up by\ndata transfer backend.",
+ "Data transfer is in progress.",
+ "Data transfer completed successsfully.",
+ "Data transfer failed.",
+ "Data transfer is cancelled."
+ ],
+ "enum": [
+ "TRANSFER_STATE_UNSPECIFIED",
+ "INACTIVE",
+ "PENDING",
+ "RUNNING",
+ "SUCCEEDED",
+ "FAILED",
+ "CANCELLED"
+ ],
+ "description": "Output only. Data transfer run state. Ignored for input requests.",
+ "type": "string"
+ },
+ "destinationDatasetId": {
+ "description": "The BigQuery target dataset id.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The resource name of the transfer run.\nTransfer run names have the form\n`projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`.\nThe name is ignored when creating a transfer run.",
+ "type": "string"
+ },
+ "userId": {
+ "type": "string",
+ "format": "int64",
+ "description": "Output only. Unique ID of the user on whose behalf transfer is done.\nApplicable only to data sources that do not support service accounts.\nWhen set to 0, the data source service account credentials are used."
+ },
+ "params": {
+ "description": "Data transfer specific parameters.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ }
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Output only. Time when transfer run ended.\nParameter ignored by server for input requests.",
+ "type": "string"
+ },
+ "datasetRegion": {
+ "description": "Output only. Region in which BigQuery dataset is located.",
+ "type": "string"
+ },
+ "startTime": {
+ "format": "google-datetime",
+ "description": "Output only. Time when transfer run was started.\nParameter ignored by server for input requests.",
+ "type": "string"
+ },
+ "scheduleTime": {
+ "format": "google-datetime",
+ "description": "Minimum time after which a transfer run can be started.",
+ "type": "string"
+ },
+ "schedule": {
+ "description": "Output only. Describes the schedule of this transfer run if it was\ncreated as part of a regular schedule. For batch transfer runs that are\nscheduled manually, this is empty.\nNOTE: the system might choose to delay the schedule depending on the\ncurrent load, so `schedule_time` doesn't always matches this.",
+ "type": "string"
+ },
+ "updateTime": {
+ "format": "google-datetime",
+ "description": "Output only. Last time the data transfer run state was updated.",
+ "type": "string"
+ },
+ "runTime": {
+ "type": "string",
+ "format": "google-datetime",
+ "description": "For batch transfer runs, specifies the date and time that\ndata should be ingested."
+ }
+ },
+ "id": "TransferRun",
+ "description": "Represents a data transfer run.",
+ "type": "object"
+ },
+ "CheckValidCredsRequest": {
+ "description": "A request to determine whether the user has valid credentials. This method\nis used to limit the number of OAuth popups in the user interface. The\nuser id is inferred from the API call context.\nIf the data source has the Google+ authorization type, this method\nreturns false, as it cannot be determined whether the credentials are\nalready valid merely based on the user id.",
+ "type": "object",
+ "properties": {},
+ "id": "CheckValidCredsRequest"
+ },
+ "CheckValidCredsResponse": {
+ "description": "A response indicating whether the credentials exist and are valid.",
+ "type": "object",
+ "properties": {
+ "hasValidCreds": {
+ "description": "If set to `true`, the credentials exist and are valid.",
+ "type": "boolean"
+ }
+ },
+ "id": "CheckValidCredsResponse"
+ },
+ "ScheduleTransferRunsResponse": {
+ "type": "object",
+ "properties": {
+ "runs": {
+ "description": "The transfer runs that were scheduled.",
+ "items": {
+ "$ref": "TransferRun"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ScheduleTransferRunsResponse",
+ "description": "A response to schedule transfer runs for a time range."
+ },
+ "ListTransferLogsResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "Output only. The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`GetTransferRunLogRequest.page_token`\nto request the next page of list results.",
+ "type": "string"
+ },
+ "transferMessages": {
+ "description": "Output only. The stored pipeline transfer messages.",
+ "items": {
+ "$ref": "TransferMessage"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListTransferLogsResponse",
+ "description": "The returned list transfer run messages.",
+ "type": "object"
+ },
+ "TransferMessage": {
+ "properties": {
+ "messageText": {
+ "description": "Message text.",
+ "type": "string"
+ },
+ "severity": {
+ "enumDescriptions": [
+ "No severity specified.",
+ "Informational message.",
+ "Warning message.",
+ "Error message."
+ ],
+ "enum": [
+ "MESSAGE_SEVERITY_UNSPECIFIED",
+ "INFO",
+ "WARNING",
+ "ERROR"
+ ],
+ "description": "Message severity.",
+ "type": "string"
+ },
+ "messageTime": {
+ "format": "google-datetime",
+ "description": "Time when message was logged.",
+ "type": "string"
+ }
+ },
+ "id": "TransferMessage",
+ "description": "Represents a user facing message for a particular data transfer run.",
+ "type": "object"
+ },
"ListDataSourcesResponse": {
"description": "Returns list of supported data sources and their metadata.",
"type": "object",
@@ -24,60 +445,21 @@
"id": "ListDataSourcesResponse"
},
"DataSourceParameter": {
+ "description": "Represents a data source parameter with validation rules, so that\nparameters can be rendered in the UI. These parameters are given to us by\nsupported data sources, and include all needed information for rendering\nand validation.\nThus, whoever uses this api can decide to generate either generic ui,\nor custom data source specific forms.",
"type": "object",
"properties": {
- "recurse": {
- "description": "If set to true, schema should be taken from the parent with the same\nparameter_id. Only applicable when parameter type is RECORD.",
- "type": "boolean"
- },
- "description": {
- "description": "Parameter description.",
- "type": "string"
- },
- "allowedValues": {
- "description": "All possible values for the parameter.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "minValue": {
- "type": "number",
- "format": "double",
- "description": "For integer and double values specifies minimum allowed value."
- },
- "validationHelpUrl": {
- "description": "URL to a help document to further explain the naming requirements.",
- "type": "string"
- },
- "validationRegex": {
- "type": "string",
- "description": "Regular expression which can be used for parameter validation."
- },
- "paramId": {
- "description": "Parameter identifier.",
- "type": "string"
- },
- "required": {
- "description": "Is parameter required.",
- "type": "boolean"
- },
- "repeated": {
- "description": "Can parameter have multiple values.",
- "type": "boolean"
- },
"displayName": {
"description": "Parameter display name in the user interface.",
"type": "string"
},
- "validationDescription": {
- "type": "string",
- "description": "Description of the requirements for this field, in case the user input does\nnot fulfill the regex pattern or min/max values."
- },
"immutable": {
"description": "Cannot be changed after initial creation.",
"type": "boolean"
},
+ "validationDescription": {
+ "description": "Description of the requirements for this field, in case the user input does\nnot fulfill the regex pattern or min/max values.",
+ "type": "string"
+ },
"fields": {
"description": "When parameter is a record, describes child fields.",
"items": {
@@ -111,30 +493,52 @@
"RECORD",
"PLUS_PAGE"
]
- }
- },
- "id": "DataSourceParameter",
- "description": "Represents a data source parameter with validation rules, so that\nparameters can be rendered in the UI. These parameters are given to us by\nsupported data sources, and include all needed information for rendering\nand validation.\nThus, whoever uses this api can decide to generate either generic ui,\nor custom data source specific forms."
- },
- "ListTransferRunsResponse": {
- "id": "ListTransferRunsResponse",
- "description": "The returned list of pipelines in the project.",
- "type": "object",
- "properties": {
- "transferRuns": {
- "description": "Output only. The stored pipeline transfer runs.",
+ },
+ "recurse": {
+ "description": "If set to true, schema should be taken from the parent with the same\nparameter_id. Only applicable when parameter type is RECORD.",
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Parameter description.",
+ "type": "string"
+ },
+ "allowedValues": {
+ "description": "All possible values for the parameter.",
"items": {
- "$ref": "TransferRun"
+ "type": "string"
},
"type": "array"
},
- "nextPageToken": {
- "description": "Output only. The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListTransferRunsRequest.page_token`\nto request the next page of list results.",
+ "minValue": {
+ "type": "number",
+ "format": "double",
+ "description": "For integer and double values specifies minimum allowed value."
+ },
+ "validationHelpUrl": {
+ "description": "URL to a help document to further explain the naming requirements.",
"type": "string"
+ },
+ "validationRegex": {
+ "description": "Regular expression which can be used for parameter validation.",
+ "type": "string"
+ },
+ "paramId": {
+ "description": "Parameter identifier.",
+ "type": "string"
+ },
+ "required": {
+ "description": "Is parameter required.",
+ "type": "boolean"
+ },
+ "repeated": {
+ "description": "Can parameter have multiple values.",
+ "type": "boolean"
}
- }
+ },
+ "id": "DataSourceParameter"
},
"ListLocationsResponse": {
+ "id": "ListLocationsResponse",
"description": "The response message for Locations.ListLocations.",
"type": "object",
"properties": {
@@ -149,19 +553,36 @@
},
"type": "array"
}
+ }
+ },
+ "ListTransferRunsResponse": {
+ "description": "The returned list of pipelines in the project.",
+ "type": "object",
+ "properties": {
+ "transferRuns": {
+ "items": {
+ "$ref": "TransferRun"
+ },
+ "type": "array",
+ "description": "Output only. The stored pipeline transfer runs."
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "Output only. The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListTransferRunsRequest.page_token`\nto request the next page of list results."
+ }
},
- "id": "ListLocationsResponse"
+ "id": "ListTransferRunsResponse"
},
"ListTransferConfigsResponse": {
"description": "The returned list of pipelines in the project.",
"type": "object",
"properties": {
"transferConfigs": {
- "description": "Output only. The stored pipeline transfer configurations.",
"items": {
"$ref": "TransferConfig"
},
- "type": "array"
+ "type": "array",
+ "description": "Output only. The stored pipeline transfer configurations."
},
"nextPageToken": {
"description": "Output only. The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListTransferConfigsRequest.page_token`\nto request the next page of list results.",
@@ -169,436 +590,12 @@
}
},
"id": "ListTransferConfigsResponse"
- },
- "DataSource": {
- "description": "Represents data source metadata. Metadata is sufficient to\nrender UI and request proper OAuth tokens.",
- "type": "object",
- "properties": {
- "minimumScheduleInterval": {
- "format": "google-duration",
- "description": "The minimum interval between two consecutive scheduled runs.",
- "type": "string"
- },
- "clientId": {
- "description": "Data source client id which should be used to receive refresh token.\nWhen not supplied, no offline credentials are populated for data transfer.",
- "type": "string"
- },
- "authorizationType": {
- "description": "Indicates the type of authorization.",
- "type": "string",
- "enumDescriptions": [
- "Type unspecified.",
- "Use OAuth 2 authorization codes that can be exchanged\nfor a refresh token on the backend.",
- "Return an authorization code for a given Google+ page that can then be\nexchanged for a refresh token on the backend."
- ],
- "enum": [
- "AUTHORIZATION_TYPE_UNSPECIFIED",
- "AUTHORIZATION_CODE",
- "GOOGLE_PLUS_AUTHORIZATION_CODE"
- ]
- },
- "supportsCustomSchedule": {
- "description": "Specifies whether the data source supports a user defined schedule, or\noperates on the default schedule.\nWhen set to `true`, user can override default schedule.",
- "type": "boolean"
- },
- "displayName": {
- "description": "User friendly data source name.",
- "type": "string"
- },
- "updateDeadlineSeconds": {
- "type": "integer",
- "format": "int32",
- "description": "The number of seconds to wait for an update from the data source\nbefore BigQuery marks the transfer as failed."
- },
- "dataRefreshType": {
- "description": "Specifies whether the data source supports automatic data refresh for the\npast few days, and how it's supported.\nFor some data sources, data might not be complete until a few days later,\nso it's useful to refresh data automatically.",
- "type": "string",
- "enumDescriptions": [
- "The data source won't support data auto refresh, which is default value.",
- "The data source supports data auto refresh, and runs will be scheduled\nfor the past few days. Does not allow custom values to be set for each\ntransfer config.",
- "The data source supports data auto refresh, and runs will be scheduled\nfor the past few days. Allows custom values to be set for each transfer\nconfig."
- ],
- "enum": [
- "DATA_REFRESH_TYPE_UNSPECIFIED",
- "SLIDING_WINDOW",
- "CUSTOM_SLIDING_WINDOW"
- ]
- },
- "parameters": {
- "description": "Data source parameters.",
- "items": {
- "$ref": "DataSourceParameter"
- },
- "type": "array"
- },
- "helpUrl": {
- "description": "Url for the help document for this data source.",
- "type": "string"
- },
- "defaultSchedule": {
- "description": "Default data transfer schedule.\nExamples of valid schedules include:\n`1st,3rd monday of month 15:30`,\n`every wed,fri of jan,jun 13:15`, and\n`first sunday of quarter 00:00`.",
- "type": "string"
- },
- "supportsMultipleTransfers": {
- "type": "boolean",
- "description": "Indicates whether the data source supports multiple transfers\nto different BigQuery targets."
- },
- "manualRunsDisabled": {
- "description": "Disables backfilling and manual run scheduling\nfor the data source.",
- "type": "boolean"
- },
- "defaultDataRefreshWindowDays": {
- "type": "integer",
- "format": "int32",
- "description": "Default data refresh window on days.\nOnly meaningful when `data_refresh_type` = `SLIDING_WINDOW`."
- },
- "transferType": {
- "enumDescriptions": [
- "Invalid or Unknown transfer type placeholder.",
- "Batch data transfer.",
- "Streaming data transfer. Streaming data source currently doesn't\nsupport multiple transfer configs per project."
- ],
- "enum": [
- "TRANSFER_TYPE_UNSPECIFIED",
- "BATCH",
- "STREAMING"
- ],
- "description": "Transfer type. Currently supports only batch transfers,\nwhich are transfers that use the BigQuery batch APIs (load or\nquery) to ingest the data.",
- "type": "string"
- },
- "description": {
- "description": "User friendly data source description string.",
- "type": "string"
- },
- "dataSourceId": {
- "description": "Data source id.",
- "type": "string"
- },
- "scopes": {
- "description": "Api auth scopes for which refresh token needs to be obtained. Only valid\nwhen `client_id` is specified. Ignored otherwise. These are scopes needed\nby a data source to prepare data and ingest them into BigQuery,\ne.g., https://www.googleapis.com/auth/bigquery",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "name": {
- "description": "Data source resource name.",
- "type": "string"
- }
- },
- "id": "DataSource"
- },
- "ScheduleTransferRunsRequest": {
- "description": "A request to schedule transfer runs for a time range.",
- "type": "object",
- "properties": {
- "endTime": {
- "format": "google-datetime",
- "description": "End time of the range of transfer runs. For example,\n`\"2017-05-30T00:00:00+00:00\"`.",
- "type": "string"
- },
- "startTime": {
- "format": "google-datetime",
- "description": "Start time of the range of transfer runs. For example,\n`\"2017-05-25T00:00:00+00:00\"`.",
- "type": "string"
- }
- },
- "id": "ScheduleTransferRunsRequest"
- },
- "Empty": {
- "id": "Empty",
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {}
- },
- "Location": {
- "type": "object",
- "properties": {
- "name": {
- "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
- "type": "string"
- },
- "locationId": {
- "description": "The canonical id for this location. For example: `\"us-east1\"`.",
- "type": "string"
- },
- "metadata": {
- "description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
- "type": "object",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
- }
- },
- "labels": {
- "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- }
- },
- "id": "Location",
- "description": "A resource that represents Google Cloud Platform location."
- },
- "TransferConfig": {
- "description": "Represents a data transfer configuration. A transfer configuration\ncontains all metadata needed to perform a data transfer. For example,\n`destination_dataset_id` specifies where data should be stored.\nWhen a new transfer configuration is created, the specified\n`destination_dataset_id` is created when needed and shared with the\nappropriate data source service account.",
- "type": "object",
- "properties": {
- "dataRefreshWindowDays": {
- "type": "integer",
- "format": "int32",
- "description": "The number of days to look back to automatically refresh the data.\nFor example, if `data_refresh_window_days = 10`, then every day\nBigQuery reingests data for [today-10, today-1], rather than ingesting data\nfor just [today-1].\nOnly valid if the data source supports the feature. Set the value to 0\nto use the default value."
- },
- "dataSourceId": {
- "description": "Data source id. Cannot be changed once data transfer is created.",
- "type": "string"
- },
- "state": {
- "enumDescriptions": [
- "State placeholder.",
- "Data transfer is inactive.",
- "Data transfer is scheduled and is waiting to be picked up by\ndata transfer backend.",
- "Data transfer is in progress.",
- "Data transfer completed successsfully.",
- "Data transfer failed.",
- "Data transfer is cancelled."
- ],
- "enum": [
- "TRANSFER_STATE_UNSPECIFIED",
- "INACTIVE",
- "PENDING",
- "RUNNING",
- "SUCCEEDED",
- "FAILED",
- "CANCELLED"
- ],
- "description": "Output only. State of the most recently updated transfer run.",
- "type": "string"
- },
- "name": {
- "description": "The resource name of the transfer config.\nTransfer config names have the form\n`projects/{project_id}/transferConfigs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or required. The name is ignored when creating a transfer\nconfig.",
- "type": "string"
- },
- "destinationDatasetId": {
- "description": "The BigQuery target dataset id.",
- "type": "string"
- },
- "userId": {
- "format": "int64",
- "description": "Output only. Unique ID of the user on whose behalf transfer is done.\nApplicable only to data sources that do not support service accounts.\nWhen set to 0, the data source service account credentials are used.",
- "type": "string"
- },
- "params": {
- "description": "Data transfer specific parameters.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- }
- },
- "datasetRegion": {
- "description": "Output only. Region in which BigQuery dataset is located.",
- "type": "string"
- },
- "displayName": {
- "description": "User specified display name for the data transfer.",
- "type": "string"
- },
- "nextRunTime": {
- "format": "google-datetime",
- "description": "Output only. Next time when data transfer will run.",
- "type": "string"
- },
- "disabled": {
- "type": "boolean",
- "description": "Is this config disabled. When set to true, no runs are scheduled\nfor a given transfer."
- },
- "schedule": {
- "description": "Data transfer schedule.\nIf the data source does not support a custom schedule, this should be\nempty. If it is empty, the default value for the data source will be\nused.\nThe specified times are in UTC.\nExamples of valid format:\n`1st,3rd monday of month 15:30`,\n`every wed,fri of jan,jun 13:15`, and\n`first sunday of quarter 00:00`.\nSee more explanation about the format here:\nhttps://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format\nNOTE: the granularity should be at least 8 hours, or less frequent.",
- "type": "string"
- },
- "updateTime": {
- "format": "google-datetime",
- "description": "Output only. Data transfer modification time. Ignored by server on input.",
- "type": "string"
- }
- },
- "id": "TransferConfig"
- },
- "TransferRun": {
- "id": "TransferRun",
- "description": "Represents a data transfer run.",
- "type": "object",
- "properties": {
- "scheduleTime": {
- "format": "google-datetime",
- "description": "Minimum time after which a transfer run can be started.",
- "type": "string"
- },
- "updateTime": {
- "format": "google-datetime",
- "description": "Output only. Last time the data transfer run state was updated.",
- "type": "string"
- },
- "schedule": {
- "description": "Output only. Describes the schedule of this transfer run if it was\ncreated as part of a regular schedule. For batch transfer runs that are\nscheduled manually, this is empty.\nNOTE: the system might choose to delay the schedule depending on the\ncurrent load, so `schedule_time` doesn't always matches this.",
- "type": "string"
- },
- "runTime": {
- "format": "google-datetime",
- "description": "For batch transfer runs, specifies the date and time that\ndata should be ingested.",
- "type": "string"
- },
- "dataSourceId": {
- "description": "Output only. Data source id.",
- "type": "string"
- },
- "state": {
- "description": "Output only. Data transfer run state. Ignored for input requests.",
- "type": "string",
- "enumDescriptions": [
- "State placeholder.",
- "Data transfer is inactive.",
- "Data transfer is scheduled and is waiting to be picked up by\ndata transfer backend.",
- "Data transfer is in progress.",
- "Data transfer completed successsfully.",
- "Data transfer failed.",
- "Data transfer is cancelled."
- ],
- "enum": [
- "TRANSFER_STATE_UNSPECIFIED",
- "INACTIVE",
- "PENDING",
- "RUNNING",
- "SUCCEEDED",
- "FAILED",
- "CANCELLED"
- ]
- },
- "destinationDatasetId": {
- "description": "The BigQuery target dataset id.",
- "type": "string"
- },
- "name": {
- "description": "The resource name of the transfer run.\nTransfer run names have the form\n`projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`.\nThe name is ignored when creating a transfer run.",
- "type": "string"
- },
- "userId": {
- "format": "int64",
- "description": "Output only. Unique ID of the user on whose behalf transfer is done.\nApplicable only to data sources that do not support service accounts.\nWhen set to 0, the data source service account credentials are used.",
- "type": "string"
- },
- "params": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "Data transfer specific parameters."
- },
- "endTime": {
- "format": "google-datetime",
- "description": "Output only. Time when transfer run ended.\nParameter ignored by server for input requests.",
- "type": "string"
- },
- "startTime": {
- "format": "google-datetime",
- "description": "Output only. Time when transfer run was started.\nParameter ignored by server for input requests.",
- "type": "string"
- },
- "datasetRegion": {
- "description": "Output only. Region in which BigQuery dataset is located.",
- "type": "string"
- }
- }
- },
- "CheckValidCredsRequest": {
- "id": "CheckValidCredsRequest",
- "description": "A request to determine whether the user has valid credentials. This method\nis used to limit the number of OAuth popups in the user interface. The\nuser id is inferred from the API call context.\nIf the data source has the Google+ authorization type, this method\nreturns false, as it cannot be determined whether the credentials are\nalready valid merely based on the user id.",
- "type": "object",
- "properties": {}
- },
- "CheckValidCredsResponse": {
- "description": "A response indicating whether the credentials exist and are valid.",
- "type": "object",
- "properties": {
- "hasValidCreds": {
- "description": "If set to `true`, the credentials exist and are valid.",
- "type": "boolean"
- }
- },
- "id": "CheckValidCredsResponse"
- },
- "ScheduleTransferRunsResponse": {
- "properties": {
- "runs": {
- "description": "The transfer runs that were scheduled.",
- "items": {
- "$ref": "TransferRun"
- },
- "type": "array"
- }
- },
- "id": "ScheduleTransferRunsResponse",
- "description": "A response to schedule transfer runs for a time range.",
- "type": "object"
- },
- "TransferMessage": {
- "description": "Represents a user facing message for a particular data transfer run.",
- "type": "object",
- "properties": {
- "messageText": {
- "description": "Message text.",
- "type": "string"
- },
- "severity": {
- "enum": [
- "MESSAGE_SEVERITY_UNSPECIFIED",
- "INFO",
- "WARNING",
- "ERROR"
- ],
- "description": "Message severity.",
- "type": "string",
- "enumDescriptions": [
- "No severity specified.",
- "Informational message.",
- "Warning message.",
- "Error message."
- ]
- },
- "messageTime": {
- "format": "google-datetime",
- "description": "Time when message was logged.",
- "type": "string"
- }
- },
- "id": "TransferMessage"
- },
- "ListTransferLogsResponse": {
- "id": "ListTransferLogsResponse",
- "description": "The returned list transfer run messages.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Output only. The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`GetTransferRunLogRequest.page_token`\nto request the next page of list results.",
- "type": "string"
- },
- "transferMessages": {
- "description": "Output only. The stored pipeline transfer messages.",
- "items": {
- "$ref": "TransferMessage"
- },
- "type": "array"
- }
- }
}
},
"protocol": "rest",
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"canonicalName": "BigQuery Data Transfer",
"auth": {
@@ -628,15 +625,54 @@
"resources": {
"transferConfigs": {
"methods": {
- "get": {
- "description": "Returns information about a data transfer config.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
+ "patch": {
+ "description": "Updates a data transfer configuration.\nAll fields must be set, even if they are not updated.",
+ "request": {
+ "$ref": "TransferConfig"
+ },
"response": {
"$ref": "TransferConfig"
},
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "name": {
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the transfer config.\nTransfer config names have the form\n`projects/{project_id}/transferConfigs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or required. The name is ignored when creating a transfer\nconfig."
+ },
+ "authorizationCode": {
+ "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nIf it is provided, the transfer configuration will be associated with the\ngaia id of the authorizing user.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=\u003cdatatransferapiclientid\u003e&scope=\u003cdata_source_scopes\u003e&redirect_uri=\u003credirect_uri\u003e\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.",
+ "type": "string",
+ "location": "query"
+ },
+ "updateMask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Required list of fields to be updated in this request.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}",
+ "id": "bigquerydatatransfer.projects.transferConfigs.patch",
+ "path": "v1/{+name}"
+ },
+ "get": {
+ "response": {
+ "$ref": "TransferConfig"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform",
@@ -652,171 +688,25 @@
}
},
"flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}",
+ "id": "bigquerydatatransfer.projects.transferConfigs.get",
"path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.transferConfigs.get"
- },
- "patch": {
- "request": {
- "$ref": "TransferConfig"
- },
- "description": "Updates a data transfer configuration.\nAll fields must be set, even if they are not updated.",
- "httpMethod": "PATCH",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "TransferConfig"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The resource name of the transfer config.\nTransfer config names have the form\n`projects/{project_id}/transferConfigs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or required. The name is ignored when creating a transfer\nconfig.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
- "location": "path"
- },
- "authorizationCode": {
- "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nIf it is provided, the transfer configuration will be associated with the\ngaia id of the authorizing user.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=\u003cdatatransferapiclientid\u003e&scope=\u003cdata_source_scopes\u003e&redirect_uri=\u003credirect_uri\u003e\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.",
- "type": "string",
- "location": "query"
- },
- "updateMask": {
- "type": "string",
- "location": "query",
- "format": "google-fieldmask",
- "description": "Required list of fields to be updated in this request."
- }
- },
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}",
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.transferConfigs.patch"
+ "description": "Returns information about a data transfer config."
},
"delete": {
+ "path": "v1/{+name}",
+ "id": "bigquerydatatransfer.projects.transferConfigs.delete",
"description": "Deletes a data transfer configuration,\nincluding any associated transfer runs and logs.",
+ "httpMethod": "DELETE",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"name"
],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"name": {
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
"location": "path",
- "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`"
- }
- },
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}",
- "id": "bigquerydatatransfer.projects.transferConfigs.delete",
- "path": "v1/{+name}"
- },
- "list": {
- "description": "Returns information about all data transfers in the project.",
- "response": {
- "$ref": "ListTransferConfigsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "pageToken": {
- "description": "Pagination token, which can be used to request a specific page\nof `ListTransfersRequest` list results. For multiple-page\nresults, `ListTransfersResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "format": "int32",
- "description": "Page size. The default page size is the maximum value of 1000 results."
- },
- "dataSourceIds": {
- "repeated": true,
- "location": "query",
- "description": "When specified, only configurations of requested data sources are returned.",
- "type": "string"
- },
- "parent": {
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`."
- }
- },
- "flatPath": "v1/projects/{projectsId}/transferConfigs",
- "id": "bigquerydatatransfer.projects.transferConfigs.list",
- "path": "v1/{+parent}/transferConfigs"
- },
- "create": {
- "request": {
- "$ref": "TransferConfig"
- },
- "description": "Creates a new data transfer configuration.",
- "response": {
- "$ref": "TransferConfig"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "authorizationCode": {
- "location": "query",
- "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nThis is required if new credentials are needed, as indicated by\n`CheckValidCreds`.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=\u003cdatatransferapiclientid\u003e&scope=\u003cdata_source_scopes\u003e&redirect_uri=\u003credirect_uri\u003e\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.",
- "type": "string"
- },
- "parent": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The BigQuery project id where the transfer configuration should be created.\nMust be in the format /projects/{project_id}/locations/{location_id}\nor\n/projects/{project_id}/locations/-\nIn case when '-' is specified as location_id, location is infered from\nthe destination dataset region.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/projects/{projectsId}/transferConfigs",
- "id": "bigquerydatatransfer.projects.transferConfigs.create",
- "path": "v1/{+parent}/transferConfigs"
- },
- "scheduleRuns": {
- "id": "bigquerydatatransfer.projects.transferConfigs.scheduleRuns",
- "path": "v1/{+parent}:scheduleRuns",
- "description": "Creates transfer runs for a time range [range_start_time, range_end_time].\nFor each date - or whatever granularity the data source supports - in the\nrange, one transfer run is created.\nNote that runs are created per UTC time in the time range.",
- "request": {
- "$ref": "ScheduleTransferRunsRequest"
- },
- "response": {
- "$ref": "ScheduleTransferRunsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "location": "path",
- "description": "Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}`.",
+ "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/transferConfigs/[^/]+$"
@@ -826,29 +716,153 @@
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}:scheduleRuns"
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListTransferConfigsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Pagination token, which can be used to request a specific page\nof `ListTransfersRequest` list results. For multiple-page\nresults, `ListTransfersResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Page size. The default page size is the maximum value of 1000 results.",
+ "type": "integer",
+ "location": "query"
+ },
+ "dataSourceIds": {
+ "description": "When specified, only configurations of requested data sources are returned.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
+ "parent": {
+ "description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/transferConfigs",
+ "path": "v1/{+parent}/transferConfigs",
+ "id": "bigquerydatatransfer.projects.transferConfigs.list",
+ "description": "Returns information about all data transfers in the project."
+ },
+ "create": {
+ "flatPath": "v1/projects/{projectsId}/transferConfigs",
+ "id": "bigquerydatatransfer.projects.transferConfigs.create",
+ "path": "v1/{+parent}/transferConfigs",
+ "description": "Creates a new data transfer configuration.",
+ "request": {
+ "$ref": "TransferConfig"
+ },
+ "response": {
+ "$ref": "TransferConfig"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "authorizationCode": {
+ "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nThis is required if new credentials are needed, as indicated by\n`CheckValidCreds`.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=\u003cdatatransferapiclientid\u003e&scope=\u003cdata_source_scopes\u003e&redirect_uri=\u003credirect_uri\u003e\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.",
+ "type": "string",
+ "location": "query"
+ },
+ "parent": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The BigQuery project id where the transfer configuration should be created.\nMust be in the format /projects/{project_id}/locations/{location_id}\nor\n/projects/{project_id}/locations/-\nIn case when '-' is specified as location_id, location is infered from\nthe destination dataset region.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "scheduleRuns": {
+ "request": {
+ "$ref": "ScheduleTransferRunsRequest"
+ },
+ "description": "Creates transfer runs for a time range [range_start_time, range_end_time].\nFor each date - or whatever granularity the data source supports - in the\nrange, one transfer run is created.\nNote that runs are created per UTC time in the time range.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ScheduleTransferRunsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}:scheduleRuns",
+ "path": "v1/{+parent}:scheduleRuns",
+ "id": "bigquerydatatransfer.projects.transferConfigs.scheduleRuns"
}
},
"resources": {
"runs": {
"methods": {
- "list": {
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs",
- "path": "v1/{+parent}/runs",
- "id": "bigquerydatatransfer.projects.transferConfigs.runs.list",
- "description": "Returns information about running and completed jobs.",
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
+ "delete": {
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}",
+ "id": "bigquerydatatransfer.projects.transferConfigs.runs.delete",
+ "path": "v1/{+name}",
+ "description": "Deletes the specified transfer run.",
"response": {
- "$ref": "ListTransferRunsResponse"
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
+ "location": "path"
+ }
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "response": {
+ "$ref": "ListTransferRunsResponse"
+ },
+ "parameterOrder": [
+ "parent"
],
+ "httpMethod": "GET",
"parameters": {
"pageToken": {
"location": "query",
@@ -886,32 +900,11 @@
]
},
"parent": {
- "pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
- "location": "path",
"description": "Name of transfer configuration for which transfer runs should be retrieved.\nFormat of transfer configuration resource name is:\n`projects/{project_id}/transferConfigs/{config_id}`.",
"type": "string",
- "required": true
- }
- }
- },
- "get": {
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.transferConfigs.runs.get",
- "description": "Returns information about the particular transfer run.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "TransferRun"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
- "type": "string",
"required": true,
- "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$"
+ "pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
+ "location": "path"
}
},
"scopes": [
@@ -919,32 +912,36 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}"
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs",
+ "id": "bigquerydatatransfer.projects.transferConfigs.runs.list",
+ "path": "v1/{+parent}/runs",
+ "description": "Returns information about running and completed jobs."
},
- "delete": {
- "description": "Deletes the specified transfer run.",
+ "get": {
+ "description": "Returns information about the particular transfer run.",
"response": {
- "$ref": "Empty"
+ "$ref": "TransferRun"
},
- "httpMethod": "DELETE",
"parameterOrder": [
"name"
],
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
+ "httpMethod": "GET",
"parameters": {
"name": {
- "location": "path",
- "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$"
+ "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
+ "location": "path",
+ "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}",
- "id": "bigquerydatatransfer.projects.transferConfigs.runs.delete",
+ "id": "bigquerydatatransfer.projects.transferConfigs.runs.get",
"path": "v1/{+name}"
}
},
@@ -952,26 +949,27 @@
"transferLogs": {
"methods": {
"list": {
- "response": {
- "$ref": "ListTransferLogsResponse"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"parent"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "ListTransferLogsResponse"
+ },
"parameters": {
"pageToken": {
+ "type": "string",
"location": "query",
- "description": "Pagination token, which can be used to request a specific page\nof `ListTransferLogsRequest` list results. For multiple-page\nresults, `ListTransferLogsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
- "type": "string"
+ "description": "Pagination token, which can be used to request a specific page\nof `ListTransferLogsRequest` list results. For multiple-page\nresults, `ListTransferLogsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results."
},
"pageSize": {
- "location": "query",
"format": "int32",
"description": "Page size. The default page size is the maximum value of 1000 results.",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
},
"messageTypes": {
+ "location": "query",
"enum": [
"MESSAGE_SEVERITY_UNSPECIFIED",
"INFO",
@@ -980,8 +978,7 @@
],
"description": "Message types to return. If not populated - INFO, WARNING and ERROR\nmessages are returned.",
"type": "string",
- "repeated": true,
- "location": "query"
+ "repeated": true
},
"parent": {
"pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
@@ -997,8 +994,8 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs",
- "id": "bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list",
"path": "v1/{+parent}/transferLogs",
+ "id": "bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list",
"description": "Returns user facing log messages for the data transfer run."
}
}
@@ -1009,40 +1006,7 @@
},
"dataSources": {
"methods": {
- "checkValidCreds": {
- "response": {
- "$ref": "CheckValidCredsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "name": {
- "description": "The data source in the form:\n`projects/{project_id}/dataSources/{data_source_id}`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/dataSources/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/dataSources/{dataSourcesId}:checkValidCreds",
- "id": "bigquerydatatransfer.projects.dataSources.checkValidCreds",
- "path": "v1/{+name}:checkValidCreds",
- "request": {
- "$ref": "CheckValidCredsRequest"
- },
- "description": "Returns true if valid credentials exist for the given data source and\nrequesting user.\nSome data sources doesn't support service account, so we need to talk to\nthem on behalf of the end user. This API just checks whether we have OAuth\ntoken for the particular user, which is a pre-requisite before user can\ncreate a transfer config."
- },
"list": {
- "flatPath": "v1/projects/{projectsId}/dataSources",
- "id": "bigquerydatatransfer.projects.dataSources.list",
- "path": "v1/{+parent}/dataSources",
"description": "Lists supported data sources and returns their settings,\nwhich can be used for UI rendering.",
"response": {
"$ref": "ListDataSourcesResponse"
@@ -1064,99 +1028,9 @@
"type": "integer"
},
"parent": {
- "location": "path",
"description": "The BigQuery project id for which data sources should be returned.\nMust be in the form: `projects/{project_id}`",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- },
- "get": {
- "description": "Retrieves a supported data source and returns its settings,\nwhich can be used for UI rendering.",
- "httpMethod": "GET",
- "response": {
- "$ref": "DataSource"
- },
- "parameterOrder": [
- "name"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "name": {
- "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/dataSources/{data_source_id}`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/dataSources/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/dataSources/{dataSourcesId}",
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.dataSources.get"
- }
- }
- },
- "locations": {
- "methods": {
- "get": {
- "description": "Get information about a location.",
- "response": {
- "$ref": "Location"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path",
- "description": "Resource name for the location.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
- "id": "bigquerydatatransfer.projects.locations.get",
- "path": "v1/{+name}"
- },
- "list": {
- "parameters": {
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer"
- },
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "name": {
- "description": "The resource that owns the locations collection, if applicable.",
- "type": "string",
- "required": true,
"pattern": "^projects/[^/]+$",
"location": "path"
}
@@ -1166,104 +1040,81 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
- "flatPath": "v1/projects/{projectsId}/locations",
- "path": "v1/{+name}/locations",
- "id": "bigquerydatatransfer.projects.locations.list",
- "description": "Lists information about the supported locations for this service.",
- "httpMethod": "GET",
+ "flatPath": "v1/projects/{projectsId}/dataSources",
+ "id": "bigquerydatatransfer.projects.dataSources.list",
+ "path": "v1/{+parent}/dataSources"
+ },
+ "get": {
+ "response": {
+ "$ref": "DataSource"
+ },
"parameterOrder": [
"name"
],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/dataSources/{data_source_id}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/dataSources/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/projects/{projectsId}/dataSources/{dataSourcesId}",
+ "id": "bigquerydatatransfer.projects.dataSources.get",
+ "path": "v1/{+name}",
+ "description": "Retrieves a supported data source and returns its settings,\nwhich can be used for UI rendering."
+ },
+ "checkValidCreds": {
"response": {
- "$ref": "ListLocationsResponse"
+ "$ref": "CheckValidCredsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "description": "The data source in the form:\n`projects/{project_id}/dataSources/{data_source_id}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/dataSources/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/projects/{projectsId}/dataSources/{dataSourcesId}:checkValidCreds",
+ "id": "bigquerydatatransfer.projects.dataSources.checkValidCreds",
+ "path": "v1/{+name}:checkValidCreds",
+ "description": "Returns true if valid credentials exist for the given data source and\nrequesting user.\nSome data sources doesn't support service account, so we need to talk to\nthem on behalf of the end user. This API just checks whether we have OAuth\ntoken for the particular user, which is a pre-requisite before user can\ncreate a transfer config.",
+ "request": {
+ "$ref": "CheckValidCredsRequest"
}
}
- },
+ }
+ },
+ "locations": {
"resources": {
"transferConfigs": {
"methods": {
- "delete": {
- "description": "Deletes a data transfer configuration,\nincluding any associated transfer runs and logs.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.delete",
- "path": "v1/{+name}"
- },
- "list": {
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.list",
- "path": "v1/{+parent}/transferConfigs",
- "description": "Returns information about all data transfers in the project.",
- "response": {
- "$ref": "ListTransferConfigsResponse"
- },
+ "create": {
+ "httpMethod": "POST",
"parameterOrder": [
"parent"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Pagination token, which can be used to request a specific page\nof `ListTransfersRequest` list results. For multiple-page\nresults, `ListTransfersResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
- "type": "string"
- },
- "pageSize": {
- "format": "int32",
- "description": "Page size. The default page size is the maximum value of 1000 results.",
- "type": "integer",
- "location": "query"
- },
- "dataSourceIds": {
- "location": "query",
- "description": "When specified, only configurations of requested data sources are returned.",
- "type": "string",
- "repeated": true
- },
- "parent": {
- "location": "path",
- "description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+$"
- }
- }
- },
- "create": {
"response": {
"$ref": "TransferConfig"
},
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"parent": {
"description": "The BigQuery project id where the transfer configuration should be created.\nMust be in the format /projects/{project_id}/locations/{location_id}\nor\n/projects/{project_id}/locations/-\nIn case when '-' is specified as location_id, location is infered from\nthe destination dataset region.",
@@ -1278,51 +1129,64 @@
"location": "query"
}
},
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.create",
- "path": "v1/{+parent}/transferConfigs",
- "request": {
- "$ref": "TransferConfig"
- },
- "description": "Creates a new data transfer configuration."
- },
- "scheduleRuns": {
- "parameters": {
- "parent": {
- "description": "Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
- "location": "path"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform"
],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs",
+ "path": "v1/{+parent}/transferConfigs",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.create",
+ "description": "Creates a new data transfer configuration.",
+ "request": {
+ "$ref": "TransferConfig"
+ }
+ },
+ "scheduleRuns": {
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}:scheduleRuns",
"path": "v1/{+parent}:scheduleRuns",
"id": "bigquerydatatransfer.projects.locations.transferConfigs.scheduleRuns",
- "description": "Creates transfer runs for a time range [range_start_time, range_end_time].\nFor each date - or whatever granularity the data source supports - in the\nrange, one transfer run is created.\nNote that runs are created per UTC time in the time range.",
"request": {
"$ref": "ScheduleTransferRunsRequest"
},
+ "description": "Creates transfer runs for a time range [range_start_time, range_end_time].\nFor each date - or whatever granularity the data source supports - in the\nrange, one transfer run is created.\nNote that runs are created per UTC time in the time range.",
"httpMethod": "POST",
"parameterOrder": [
"parent"
],
"response": {
"$ref": "ScheduleTransferRunsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
+ "location": "path",
+ "description": "Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}`."
+ }
}
},
"get": {
- "response": {
- "$ref": "TransferConfig"
- },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.get",
+ "path": "v1/{+name}",
+ "description": "Returns information about a data transfer config.",
"parameterOrder": [
"name"
],
"httpMethod": "GET",
+ "response": {
+ "$ref": "TransferConfig"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"parameters": {
"name": {
"description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
@@ -1331,97 +1195,146 @@
"pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
"location": "path"
}
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.get",
- "path": "v1/{+name}",
- "description": "Returns information about a data transfer config."
+ }
},
"patch": {
- "request": {
- "$ref": "TransferConfig"
- },
- "description": "Updates a data transfer configuration.\nAll fields must be set, even if they are not updated.",
- "response": {
- "$ref": "TransferConfig"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
"location": "path",
"description": "The resource name of the transfer config.\nTransfer config names have the form\n`projects/{project_id}/transferConfigs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or required. The name is ignored when creating a transfer\nconfig.",
"type": "string",
- "required": true
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$"
},
"authorizationCode": {
+ "location": "query",
"description": "Optional OAuth2 authorization code to use with this transfer configuration.\nIf it is provided, the transfer configuration will be associated with the\ngaia id of the authorizing user.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=\u003cdatatransferapiclientid\u003e&scope=\u003cdata_source_scopes\u003e&redirect_uri=\u003credirect_uri\u003e\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"updateMask": {
- "type": "string",
"location": "query",
"format": "google-fieldmask",
- "description": "Required list of fields to be updated in this request."
+ "description": "Required list of fields to be updated in this request.",
+ "type": "string"
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}",
+ "path": "v1/{+name}",
"id": "bigquerydatatransfer.projects.locations.transferConfigs.patch",
+ "request": {
+ "$ref": "TransferConfig"
+ },
+ "description": "Updates a data transfer configuration.\nAll fields must be set, even if they are not updated.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "TransferConfig"
+ }
+ },
+ "delete": {
+ "description": "Deletes a data transfer configuration,\nincluding any associated transfer runs and logs.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
+ "location": "path",
+ "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.delete",
"path": "v1/{+name}"
+ },
+ "list": {
+ "response": {
+ "$ref": "ListTransferConfigsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "dataSourceIds": {
+ "location": "query",
+ "description": "When specified, only configurations of requested data sources are returned.",
+ "type": "string",
+ "repeated": true
+ },
+ "parent": {
+ "location": "path",
+ "description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+$"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Pagination token, which can be used to request a specific page\nof `ListTransfersRequest` list results. For multiple-page\nresults, `ListTransfersResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Page size. The default page size is the maximum value of 1000 results.",
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.list",
+ "path": "v1/{+parent}/transferConfigs",
+ "description": "Returns information about all data transfers in the project."
}
},
"resources": {
"runs": {
"methods": {
"list": {
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.list",
- "path": "v1/{+parent}/runs",
- "description": "Returns information about running and completed jobs.",
+ "httpMethod": "GET",
"response": {
"$ref": "ListTransferRunsResponse"
},
"parameterOrder": [
"parent"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"parameters": {
- "parent": {
- "location": "path",
- "description": "Name of transfer configuration for which transfer runs should be retrieved.\nFormat of transfer configuration resource name is:\n`projects/{project_id}/transferConfigs/{config_id}`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$"
- },
"pageToken": {
- "type": "string",
"location": "query",
- "description": "Pagination token, which can be used to request a specific page\nof `ListTransferRunsRequest` list results. For multiple-page\nresults, `ListTransferRunsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results."
+ "description": "Pagination token, which can be used to request a specific page\nof `ListTransferRunsRequest` list results. For multiple-page\nresults, `ListTransferRunsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
+ "type": "string"
},
"pageSize": {
+ "location": "query",
"format": "int32",
"description": "Page size. The default page size is the maximum value of 1000 results.",
- "type": "integer",
- "location": "query"
+ "type": "integer"
},
"states": {
+ "description": "When specified, only transfer runs with requested states are returned.",
+ "type": "string",
+ "repeated": true,
"location": "query",
"enum": [
"TRANSFER_STATE_UNSPECIFIED",
@@ -1431,10 +1344,7 @@
"SUCCEEDED",
"FAILED",
"CANCELLED"
- ],
- "description": "When specified, only transfer runs with requested states are returned.",
- "type": "string",
- "repeated": true
+ ]
},
"runAttempt": {
"location": "query",
@@ -1444,26 +1354,40 @@
],
"description": "Indicates how run attempts are to be pulled.",
"type": "string"
+ },
+ "parent": {
+ "location": "path",
+ "description": "Name of transfer configuration for which transfer runs should be retrieved.\nFormat of transfer configuration resource name is:\n`projects/{project_id}/transferConfigs/{config_id}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$"
}
},
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs"
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs",
+ "path": "v1/{+parent}/runs",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.list",
+ "description": "Returns information about running and completed jobs."
},
"get": {
- "description": "Returns information about the particular transfer run.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "TransferRun"
},
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
"parameters": {
"name": {
+ "type": "string",
+ "required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
"location": "path",
- "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
- "type": "string",
- "required": true
+ "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`"
}
},
"scopes": [
@@ -1472,17 +1396,25 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.get",
"path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.get"
+ "description": "Returns information about the particular transfer run."
},
"delete": {
- "response": {
- "$ref": "Empty"
- },
+ "path": "v1/{+name}",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.delete",
+ "description": "Deletes the specified transfer run.",
+ "httpMethod": "DELETE",
"parameterOrder": [
"name"
],
- "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"name": {
"description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
@@ -1492,20 +1424,14 @@
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.delete",
- "path": "v1/{+name}",
- "description": "Deletes the specified transfer run."
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}"
}
},
"resources": {
"transferLogs": {
"methods": {
"list": {
+ "description": "Returns user facing log messages for the data transfer run.",
"response": {
"$ref": "ListTransferLogsResponse"
},
@@ -1513,11 +1439,16 @@
"parent"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"parameters": {
"pageToken": {
- "location": "query",
"description": "Pagination token, which can be used to request a specific page\nof `ListTransferLogsRequest` list results. For multiple-page\nresults, `ListTransferLogsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageSize": {
"format": "int32",
@@ -1526,6 +1457,8 @@
"location": "query"
},
"messageTypes": {
+ "repeated": true,
+ "location": "query",
"enum": [
"MESSAGE_SEVERITY_UNSPECIFIED",
"INFO",
@@ -1533,27 +1466,19 @@
"ERROR"
],
"description": "Message types to return. If not populated - INFO, WARNING and ERROR\nmessages are returned.",
- "type": "string",
- "repeated": true,
- "location": "query"
+ "type": "string"
},
"parent": {
+ "location": "path",
+ "description": "Transfer run name in the form:\n`projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`.",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
- "location": "path",
- "description": "Transfer run name in the form:\n`projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`."
+ "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs",
"id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.transferLogs.list",
- "path": "v1/{+parent}/transferLogs",
- "description": "Returns user facing log messages for the data transfer run."
+ "path": "v1/{+parent}/transferLogs"
}
}
}
@@ -1564,29 +1489,12 @@
"dataSources": {
"methods": {
"list": {
- "id": "bigquerydatatransfer.projects.locations.dataSources.list",
- "path": "v1/{+parent}/dataSources",
- "description": "Lists supported data sources and returns their settings,\nwhich can be used for UI rendering.",
- "response": {
- "$ref": "ListDataSourcesResponse"
- },
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"parameters": {
- "parent": {
- "description": "The BigQuery project id for which data sources should be returned.\nMust be in the form: `projects/{project_id}`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- },
"pageToken": {
"description": "Pagination token, which can be used to request a specific page\nof `ListDataSourcesRequest` list results. For multiple-page\nresults, `ListDataSourcesResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
"type": "string",
@@ -1597,19 +1505,35 @@
"format": "int32",
"description": "Page size. The default page size is the maximum value of 1000 results.",
"type": "integer"
+ },
+ "parent": {
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path",
+ "description": "The BigQuery project id for which data sources should be returned.\nMust be in the form: `projects/{project_id}`",
+ "type": "string",
+ "required": true
}
},
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources"
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources",
+ "id": "bigquerydatatransfer.projects.locations.dataSources.list",
+ "path": "v1/{+parent}/dataSources",
+ "description": "Lists supported data sources and returns their settings,\nwhich can be used for UI rendering.",
+ "response": {
+ "$ref": "ListDataSourcesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET"
},
"get": {
- "description": "Retrieves a supported data source and returns its settings,\nwhich can be used for UI rendering.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "DataSource"
},
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform",
@@ -1625,41 +1549,114 @@
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}",
+ "id": "bigquerydatatransfer.projects.locations.dataSources.get",
"path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.locations.dataSources.get"
+ "description": "Retrieves a supported data source and returns its settings,\nwhich can be used for UI rendering."
},
"checkValidCreds": {
- "description": "Returns true if valid credentials exist for the given data source and\nrequesting user.\nSome data sources doesn't support service account, so we need to talk to\nthem on behalf of the end user. This API just checks whether we have OAuth\ntoken for the particular user, which is a pre-requisite before user can\ncreate a transfer config.",
+ "path": "v1/{+name}:checkValidCreds",
+ "id": "bigquerydatatransfer.projects.locations.dataSources.checkValidCreds",
"request": {
"$ref": "CheckValidCredsRequest"
},
- "response": {
- "$ref": "CheckValidCredsResponse"
- },
+ "description": "Returns true if valid credentials exist for the given data source and\nrequesting user.\nSome data sources doesn't support service account, so we need to talk to\nthem on behalf of the end user. This API just checks whether we have OAuth\ntoken for the particular user, which is a pre-requisite before user can\ncreate a transfer config.",
+ "httpMethod": "POST",
"parameterOrder": [
"name"
],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "description": "The data source in the form:\n`projects/{project_id}/dataSources/{data_source_id}`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$",
- "location": "path"
- }
+ "response": {
+ "$ref": "CheckValidCredsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}:checkValidCreds",
- "id": "bigquerydatatransfer.projects.locations.dataSources.checkValidCreds",
- "path": "v1/{+name}:checkValidCreds"
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$",
+ "location": "path",
+ "description": "The data source in the form:\n`projects/{project_id}/dataSources/{data_source_id}`",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}:checkValidCreds"
}
}
}
+ },
+ "methods": {
+ "get": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
+ "path": "v1/{+name}",
+ "id": "bigquerydatatransfer.projects.locations.get",
+ "description": "Get information about a location.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Location"
+ },
+ "parameters": {
+ "name": {
+ "description": "Resource name for the location.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "list": {
+ "flatPath": "v1/projects/{projectsId}/locations",
+ "path": "v1/{+name}/locations",
+ "id": "bigquerydatatransfer.projects.locations.list",
+ "description": "Lists information about the supported locations for this service.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "name": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The resource that owns the locations collection, if applicable.",
+ "type": "string",
+ "required": true
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer",
+ "location": "query"
+ },
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "The standard list filter."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ }
}
}
}
@@ -1672,9 +1669,9 @@
"location": "query"
},
"key": {
+ "type": "string",
"location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
},
"quotaUser": {
"location": "query",
@@ -1688,19 +1685,19 @@
"location": "query"
},
"oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
"type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
+ "location": "query"
},
"bearer_token": {
- "location": "query",
"description": "OAuth bearer token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"upload_protocol": {
+ "type": "string",
"location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
},
"prettyPrint": {
"description": "Returns response with indentations and line breaks.",
@@ -1708,22 +1705,23 @@
"type": "boolean",
"location": "query"
},
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
},
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
"callback": {
"location": "query",
"description": "JSONP",
"type": "string"
},
"$.xgafv": {
+ "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -1733,8 +1731,7 @@
"1",
"2"
],
- "description": "V1 error format.",
- "type": "string"
+ "description": "V1 error format."
},
"alt": {
"description": "Data format for response.",
@@ -1755,8 +1752,11 @@
},
"version": "v1",
"baseUrl": "https://bigquerydatatransfer.googleapis.com/",
- "servicePath": "",
- "description": "Transfers data from partner SaaS applications to Google BigQuery on a scheduled, managed basis.",
"kind": "discovery#restDescription",
- "basePath": ""
+ "description": "Transfers data from partner SaaS applications to Google BigQuery on a scheduled, managed basis.",
+ "servicePath": "",
+ "basePath": "",
+ "documentationLink": "https://cloud.google.com/bigquery/",
+ "id": "bigquerydatatransfer:v1",
+ "revision": "20171010"
}
diff --git a/classroom/v1/classroom-api.json b/classroom/v1/classroom-api.json
index 37d3239..c872e87 100644
--- a/classroom/v1/classroom-api.json
+++ b/classroom/v1/classroom-api.json
@@ -1,187 +1,40 @@
{
- "kind": "discovery#restDescription",
- "servicePath": "",
- "description": "Manages classes, rosters, and invitations in Google Classroom.",
- "rootUrl": "https://classroom.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "classroom",
- "batchPath": "batch",
- "revision": "20171009",
- "documentationLink": "https://developers.google.com/classroom/",
- "id": "classroom:v1",
- "title": "Google Classroom API",
- "discoveryVersion": "v1",
- "ownerName": "Google",
"resources": {
- "invitations": {
- "methods": {
- "create": {
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters"
- ],
- "parameters": {},
- "flatPath": "v1/invitations",
- "path": "v1/invitations",
- "id": "classroom.invitations.create",
- "request": {
- "$ref": "Invitation"
- },
- "description": "Creates an invitation. Only one invitation for a user and course may exist\nat a time. Delete and re-create an invitation to make changes.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\ninvitations for this course or for access errors.\n* `NOT_FOUND` if the course or the user does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled or if\nthe user already has this role or a role with greater permissions.\n* `ALREADY_EXISTS` if an invitation for the specified user and course\nalready exists.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Invitation"
- }
- },
- "accept": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "id"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters"
- ],
- "parameters": {
- "id": {
- "description": "Identifier of the invitation to accept.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/invitations/{id}:accept",
- "id": "classroom.invitations.accept",
- "path": "v1/invitations/{id}:accept",
- "description": "Accepts an invitation, removing it and adding the invited user to the\nteachers or students (as appropriate) of the specified course. Only the\ninvited user may accept an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to accept the\nrequested invitation or for access errors.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * CourseTeacherLimitReached\n * UserGroupsMembershipLimitReached\n* `NOT_FOUND` if no invitation exists with the requested ID."
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "id"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "id": {
- "location": "path",
- "description": "Identifier of the invitation to delete.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters"
- ],
- "flatPath": "v1/invitations/{id}",
- "id": "classroom.invitations.delete",
- "path": "v1/invitations/{id}",
- "description": "Deletes an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete the\nrequested invitation or for access errors.\n* `NOT_FOUND` if no invitation exists with the requested ID."
- },
- "list": {
- "description": "Returns a list of invitations that the requesting user is permitted to\nview, restricted to those that match the list request.\n\n*Note:* At least one of `user_id` or `course_id` must be supplied. Both\nfields can be supplied.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` for access errors.",
- "response": {
- "$ref": "ListInvitationsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating\nthat the subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
- "type": "string"
- },
- "userId": {
- "type": "string",
- "location": "query",
- "description": "Restricts returned invitations to those for a specific user. The identifier\ncan be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.",
- "type": "integer"
- },
- "courseId": {
- "location": "query",
- "description": "Restricts returned invitations to those for a course with the specified\nidentifier.",
- "type": "string"
- }
- },
- "flatPath": "v1/invitations",
- "id": "classroom.invitations.list",
- "path": "v1/invitations"
- },
- "get": {
- "description": "Returns an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view the\nrequested invitation or for access errors.\n* `NOT_FOUND` if no invitation exists with the requested ID.",
- "response": {
- "$ref": "Invitation"
- },
- "parameterOrder": [
- "id"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ],
- "parameters": {
- "id": {
- "description": "Identifier of the invitation to return.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/invitations/{id}",
- "id": "classroom.invitations.get",
- "path": "v1/invitations/{id}"
- }
- }
- },
"registrations": {
"methods": {
"create": {
- "httpMethod": "POST",
- "parameterOrder": [],
"response": {
"$ref": "Registration"
},
- "parameters": {},
+ "parameterOrder": [],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/classroom.rosters",
"https://www.googleapis.com/auth/classroom.rosters.readonly"
],
+ "parameters": {},
"flatPath": "v1/registrations",
- "path": "v1/registrations",
"id": "classroom.registrations.create",
- "description": "Creates a `Registration`, causing Classroom to start sending notifications\nfrom the provided `feed` to the provided `destination`.\n\nReturns the created `Registration`. Currently, this will be the same as\nthe argument, but with server-assigned fields such as `expiry_time` and\n`id` filled in.\n\nNote that any value specified for the `expiry_time` or `id` fields will be\nignored.\n\nWhile Classroom may validate the `destination` and return errors on a best\neffort basis, it is the caller's responsibility to ensure that it exists\nand that Classroom has permission to publish to it.\n\nThis method may return the following error codes:\n\n* `PERMISSION_DENIED` if:\n * the authenticated user does not have permission to receive\n notifications from the requested field; or\n * the credential provided does not include the appropriate scope for the\n requested feed.\n * another access error is encountered.\n* `INVALID_ARGUMENT` if:\n * no `destination` is specified, or the specified `destination` is not\n valid; or\n * no `feed` is specified, or the specified `feed` is not valid.\n* `NOT_FOUND` if:\n * the specified `feed` cannot be located, or the requesting user does not\n have permission to determine whether or not it exists; or\n * the specified `destination` cannot be located, or Classroom has not\n been granted permission to publish to it.",
+ "path": "v1/registrations",
"request": {
"$ref": "Registration"
- }
+ },
+ "description": "Creates a `Registration`, causing Classroom to start sending notifications\nfrom the provided `feed` to the provided `destination`.\n\nReturns the created `Registration`. Currently, this will be the same as\nthe argument, but with server-assigned fields such as `expiry_time` and\n`id` filled in.\n\nNote that any value specified for the `expiry_time` or `id` fields will be\nignored.\n\nWhile Classroom may validate the `destination` and return errors on a best\neffort basis, it is the caller's responsibility to ensure that it exists\nand that Classroom has permission to publish to it.\n\nThis method may return the following error codes:\n\n* `PERMISSION_DENIED` if:\n * the authenticated user does not have permission to receive\n notifications from the requested field; or\n * the credential provided does not include the appropriate scope for the\n requested feed.\n * another access error is encountered.\n* `INVALID_ARGUMENT` if:\n * no `destination` is specified, or the specified `destination` is not\n valid; or\n * no `feed` is specified, or the specified `feed` is not valid.\n* `NOT_FOUND` if:\n * the specified `feed` cannot be located, or the requesting user does not\n have permission to determine whether or not it exists; or\n * the specified `destination` cannot be located, or Classroom has not\n been granted permission to publish to it."
},
"delete": {
- "response": {
- "$ref": "Empty"
- },
+ "httpMethod": "DELETE",
"parameterOrder": [
"registrationId"
],
- "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
"parameters": {
"registrationId": {
- "location": "path",
"description": "The `registration_id` of the `Registration` to be deleted.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
}
},
"scopes": [
@@ -189,8 +42,8 @@
"https://www.googleapis.com/auth/classroom.rosters.readonly"
],
"flatPath": "v1/registrations/{registrationId}",
- "id": "classroom.registrations.delete",
"path": "v1/registrations/{registrationId}",
+ "id": "classroom.registrations.delete",
"description": "Deletes a `Registration`, causing Classroom to stop sending notifications\nfor that `Registration`."
}
}
@@ -198,14 +51,19 @@
"userProfiles": {
"methods": {
"get": {
- "description": "Returns a user profile.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthis user profile, if no profile exists with the requested ID, or for\naccess errors.",
"httpMethod": "GET",
- "parameterOrder": [
- "userId"
- ],
"response": {
"$ref": "UserProfile"
},
+ "parameterOrder": [
+ "userId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.profile.emails",
+ "https://www.googleapis.com/auth/classroom.profile.photos",
+ "https://www.googleapis.com/auth/classroom.rosters",
+ "https://www.googleapis.com/auth/classroom.rosters.readonly"
+ ],
"parameters": {
"userId": {
"description": "Identifier of the profile to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
@@ -214,47 +72,15 @@
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/classroom.profile.emails",
- "https://www.googleapis.com/auth/classroom.profile.photos",
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ],
"flatPath": "v1/userProfiles/{userId}",
"path": "v1/userProfiles/{userId}",
- "id": "classroom.userProfiles.get"
+ "id": "classroom.userProfiles.get",
+ "description": "Returns a user profile.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthis user profile, if no profile exists with the requested ID, or for\naccess errors."
}
},
"resources": {
"guardianInvitations": {
"methods": {
- "create": {
- "flatPath": "v1/userProfiles/{studentId}/guardianInvitations",
- "id": "classroom.userProfiles.guardianInvitations.create",
- "path": "v1/userProfiles/{studentId}/guardianInvitations",
- "request": {
- "$ref": "GuardianInvitation"
- },
- "description": "Creates a guardian invitation, and sends an email to the guardian asking\nthem to confirm that they are the student's guardian.\n\nOnce the guardian accepts the invitation, their `state` will change to\n`COMPLETED` and they will start receiving guardian notifications. A\n`Guardian` resource will also be created to represent the active guardian.\n\nThe request object must have the `student_id` and\n`invited_email_address` fields set. Failing to set these fields, or\nsetting any other fields in the request, will result in an error.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the current user does not have permission to\n manage guardians, if the guardian in question has already rejected\n too many requests for that student, if guardians are not enabled for the\n domain in question, or for other access errors.\n* `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian\n link limit.\n* `INVALID_ARGUMENT` if the guardian email address is not valid (for\n example, if it is too long), or if the format of the student ID provided\n cannot be recognized (it is not an email address, nor a `user_id` from\n this API). This error will also be returned if read-only fields are set,\n or if the `state` field is set to to a value other than `PENDING`.\n* `NOT_FOUND` if the student ID provided is a valid student ID, but\n Classroom has no record of that student.\n* `ALREADY_EXISTS` if there is already a pending guardian invitation for\n the student and `invited_email_address` provided, or if the provided\n `invited_email_address` matches the Google account of an existing\n `Guardian` for this user.",
- "response": {
- "$ref": "GuardianInvitation"
- },
- "parameterOrder": [
- "studentId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.guardianlinks.students"
- ],
- "parameters": {
- "studentId": {
- "description": "ID of the student (in standard format)",
- "type": "string",
- "required": true,
- "location": "path"
- }
- }
- },
"patch": {
"response": {
"$ref": "GuardianInvitation"
@@ -264,6 +90,9 @@
"invitationId"
],
"httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students"
+ ],
"parameters": {
"updateMask": {
"format": "google-fieldmask",
@@ -284,73 +113,73 @@
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/classroom.guardianlinks.students"
- ],
"flatPath": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
"id": "classroom.userProfiles.guardianInvitations.patch",
"path": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
- "description": "Modifies a guardian invitation.\n\nCurrently, the only valid modification is to change the `state` from\n`PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the current user does not have permission to\n manage guardians, if guardians are not enabled for the domain in question\n or for other access errors.\n* `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state.\n* `INVALID_ARGUMENT` if the format of the student ID provided\n cannot be recognized (it is not an email address, nor a `user_id` from\n this API), or if the passed `GuardianInvitation` has a `state` other than\n `COMPLETE`, or if it modifies fields other than `state`.\n* `NOT_FOUND` if the student ID provided is a valid student ID, but\n Classroom has no record of that student, or if the `id` field does not\n refer to a guardian invitation known to Classroom.",
"request": {
"$ref": "GuardianInvitation"
- }
+ },
+ "description": "Modifies a guardian invitation.\n\nCurrently, the only valid modification is to change the `state` from\n`PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the current user does not have permission to\n manage guardians, if guardians are not enabled for the domain in question\n or for other access errors.\n* `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state.\n* `INVALID_ARGUMENT` if the format of the student ID provided\n cannot be recognized (it is not an email address, nor a `user_id` from\n this API), or if the passed `GuardianInvitation` has a `state` other than\n `COMPLETE`, or if it modifies fields other than `state`.\n* `NOT_FOUND` if the student ID provided is a valid student ID, but\n Classroom has no record of that student, or if the `id` field does not\n refer to a guardian invitation known to Classroom."
},
"get": {
- "httpMethod": "GET",
+ "response": {
+ "$ref": "GuardianInvitation"
+ },
"parameterOrder": [
"studentId",
"invitationId"
],
- "response": {
- "$ref": "GuardianInvitation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.guardianlinks.students",
- "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
- ],
+ "httpMethod": "GET",
"parameters": {
- "studentId": {
- "location": "path",
- "description": "The ID of the student whose guardian invitation is being requested.",
- "type": "string",
- "required": true
- },
"invitationId": {
"description": "The `id` field of the `GuardianInvitation` being requested.",
"type": "string",
"required": true,
"location": "path"
+ },
+ "studentId": {
+ "description": "The ID of the student whose guardian invitation is being requested.",
+ "type": "string",
+ "required": true,
+ "location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students",
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
+ ],
"flatPath": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
- "path": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
"id": "classroom.userProfiles.guardianInvitations.get",
+ "path": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
"description": "Returns a specific guardian invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\n guardian invitations for the student identified by the `student_id`, if\n guardians are not enabled for the domain in question, or for other\n access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`).\n* `NOT_FOUND` if Classroom cannot find any record of the given student or\n `invitation_id`. May also be returned if the student exists, but the\n requesting user does not have access to see that student."
},
"list": {
+ "flatPath": "v1/userProfiles/{studentId}/guardianInvitations",
+ "path": "v1/userProfiles/{studentId}/guardianInvitations",
+ "id": "classroom.userProfiles.guardianInvitations.list",
"description": "Returns a list of guardian invitations that the requesting user is\npermitted to view, filtered by the parameters provided.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if a `student_id` is specified, and the requesting\n user is not permitted to view guardian invitations for that student, if\n `\"-\"` is specified as the `student_id` and the user is not a domain\n administrator, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`). May also be returned if an invalid\n `page_token` or `state` is provided.\n* `NOT_FOUND` if a `student_id` is specified, and its format can be\n recognized, but Classroom has no record of that student.",
- "response": {
- "$ref": "ListGuardianInvitationsResponse"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"studentId"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "ListGuardianInvitationsResponse"
+ },
"scopes": [
"https://www.googleapis.com/auth/classroom.guardianlinks.students",
"https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
],
"parameters": {
"studentId": {
- "type": "string",
- "required": true,
"location": "path",
- "description": "The ID of the student whose guardian invitations are to be returned.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n* the string literal `\"-\"`, indicating that results should be returned for\n all students that the requesting user is permitted to view guardian\n invitations."
+ "description": "The ID of the student whose guardian invitations are to be returned.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n* the string literal `\"-\"`, indicating that results should be returned for\n all students that the requesting user is permitted to view guardian\n invitations.",
+ "type": "string",
+ "required": true
},
"pageToken": {
- "type": "string",
"location": "query",
- "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token."
+ "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
+ "type": "string"
},
"pageSize": {
"format": "int32",
@@ -370,72 +199,64 @@
]
},
"invitedEmailAddress": {
- "location": "query",
"description": "If specified, only results with the specified `invited_email_address`\nwill be returned.",
- "type": "string"
+ "type": "string",
+ "location": "query"
}
- },
+ }
+ },
+ "create": {
"flatPath": "v1/userProfiles/{studentId}/guardianInvitations",
- "id": "classroom.userProfiles.guardianInvitations.list",
- "path": "v1/userProfiles/{studentId}/guardianInvitations"
+ "path": "v1/userProfiles/{studentId}/guardianInvitations",
+ "id": "classroom.userProfiles.guardianInvitations.create",
+ "request": {
+ "$ref": "GuardianInvitation"
+ },
+ "description": "Creates a guardian invitation, and sends an email to the guardian asking\nthem to confirm that they are the student's guardian.\n\nOnce the guardian accepts the invitation, their `state` will change to\n`COMPLETED` and they will start receiving guardian notifications. A\n`Guardian` resource will also be created to represent the active guardian.\n\nThe request object must have the `student_id` and\n`invited_email_address` fields set. Failing to set these fields, or\nsetting any other fields in the request, will result in an error.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the current user does not have permission to\n manage guardians, if the guardian in question has already rejected\n too many requests for that student, if guardians are not enabled for the\n domain in question, or for other access errors.\n* `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian\n link limit.\n* `INVALID_ARGUMENT` if the guardian email address is not valid (for\n example, if it is too long), or if the format of the student ID provided\n cannot be recognized (it is not an email address, nor a `user_id` from\n this API). This error will also be returned if read-only fields are set,\n or if the `state` field is set to to a value other than `PENDING`.\n* `NOT_FOUND` if the student ID provided is a valid student ID, but\n Classroom has no record of that student.\n* `ALREADY_EXISTS` if there is already a pending guardian invitation for\n the student and `invited_email_address` provided, or if the provided\n `invited_email_address` matches the Google account of an existing\n `Guardian` for this user.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "studentId"
+ ],
+ "response": {
+ "$ref": "GuardianInvitation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students"
+ ],
+ "parameters": {
+ "studentId": {
+ "location": "path",
+ "description": "ID of the student (in standard format)",
+ "type": "string",
+ "required": true
+ }
+ }
}
}
},
"guardians": {
"methods": {
- "delete": {
- "description": "Deletes a guardian.\n\nThe guardian will no longer receive guardian notifications and the guardian\nwill no longer be accessible via the API.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if no user that matches the provided `student_id`\n is visible to the requesting user, if the requesting user is not\n permitted to manage guardians for the student identified by the\n `student_id`, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API).\n* `NOT_FOUND` if the requesting user is permitted to modify guardians for\n the requested `student_id`, but no `Guardian` record exists for that\n student with the provided `guardian_id`.",
+ "get": {
+ "httpMethod": "GET",
"parameterOrder": [
"studentId",
"guardianId"
],
"response": {
- "$ref": "Empty"
- },
- "httpMethod": "DELETE",
- "parameters": {
- "studentId": {
- "description": "The student whose guardian is to be deleted. One of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "guardianId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The `id` field from a `Guardian`."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.guardianlinks.students"
- ],
- "flatPath": "v1/userProfiles/{studentId}/guardians/{guardianId}",
- "id": "classroom.userProfiles.guardians.delete",
- "path": "v1/userProfiles/{studentId}/guardians/{guardianId}"
- },
- "get": {
- "description": "Returns a specific guardian.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if no user that matches the provided `student_id`\n is visible to the requesting user, if the requesting user is not\n permitted to view guardian information for the student identified by the\n `student_id`, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`).\n* `NOT_FOUND` if the requesting user is permitted to view guardians for\n the requested `student_id`, but no `Guardian` record exists for that\n student that matches the provided `guardian_id`.",
- "response": {
"$ref": "Guardian"
},
- "parameterOrder": [
- "studentId",
- "guardianId"
- ],
- "httpMethod": "GET",
"parameters": {
+ "studentId": {
+ "location": "path",
+ "description": "The student whose guardian is being requested. One of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "type": "string",
+ "required": true
+ },
"guardianId": {
"location": "path",
"description": "The `id` field from a `Guardian`.",
"type": "string",
"required": true
- },
- "studentId": {
- "description": "The student whose guardian is being requested. One of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "type": "string",
- "required": true,
- "location": "path"
}
},
"scopes": [
@@ -444,23 +265,19 @@
"https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
],
"flatPath": "v1/userProfiles/{studentId}/guardians/{guardianId}",
+ "path": "v1/userProfiles/{studentId}/guardians/{guardianId}",
"id": "classroom.userProfiles.guardians.get",
- "path": "v1/userProfiles/{studentId}/guardians/{guardianId}"
+ "description": "Returns a specific guardian.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if no user that matches the provided `student_id`\n is visible to the requesting user, if the requesting user is not\n permitted to view guardian information for the student identified by the\n `student_id`, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`).\n* `NOT_FOUND` if the requesting user is permitted to view guardians for\n the requested `student_id`, but no `Guardian` record exists for that\n student that matches the provided `guardian_id`."
},
"list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "studentId"
- ],
"response": {
"$ref": "ListGuardiansResponse"
},
+ "parameterOrder": [
+ "studentId"
+ ],
+ "httpMethod": "GET",
"parameters": {
- "pageToken": {
- "location": "query",
- "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
- "type": "string"
- },
"pageSize": {
"location": "query",
"format": "int32",
@@ -468,15 +285,20 @@
"type": "integer"
},
"invitedEmailAddress": {
- "location": "query",
"description": "Filter results by the email address that the original invitation was sent\nto, resulting in this guardian link.\nThis filter can only be used by domain administrators.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"studentId": {
+ "location": "path",
"description": "Filter results by the student who the guardian is linked to.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n* the string literal `\"-\"`, indicating that results should be returned for\n all students that the requesting user has access to view.",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
+ },
+ "pageToken": {
+ "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
+ "type": "string",
+ "location": "query"
}
},
"scopes": [
@@ -485,9 +307,40 @@
"https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
],
"flatPath": "v1/userProfiles/{studentId}/guardians",
- "path": "v1/userProfiles/{studentId}/guardians",
"id": "classroom.userProfiles.guardians.list",
+ "path": "v1/userProfiles/{studentId}/guardians",
"description": "Returns a list of guardians that the requesting user is permitted to\nview, restricted to those that match the request.\n\nTo list guardians for any student that the requesting user may view\nguardians for, use the literal character `-` for the student ID.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if a `student_id` is specified, and the requesting\n user is not permitted to view guardian information for that student, if\n `\"-\"` is specified as the `student_id` and the user is not a domain\n administrator, if guardians are not enabled for the domain in question,\n if the `invited_email_address` filter is set by a user who is not a\n domain administrator, or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`). May also be returned if an invalid\n `page_token` is provided.\n* `NOT_FOUND` if a `student_id` is specified, and its format can be\n recognized, but Classroom has no record of that student."
+ },
+ "delete": {
+ "description": "Deletes a guardian.\n\nThe guardian will no longer receive guardian notifications and the guardian\nwill no longer be accessible via the API.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if no user that matches the provided `student_id`\n is visible to the requesting user, if the requesting user is not\n permitted to manage guardians for the student identified by the\n `student_id`, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API).\n* `NOT_FOUND` if the requesting user is permitted to modify guardians for\n the requested `student_id`, but no `Guardian` record exists for that\n student with the provided `guardian_id`.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "studentId",
+ "guardianId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students"
+ ],
+ "parameters": {
+ "guardianId": {
+ "location": "path",
+ "description": "The `id` field from a `Guardian`.",
+ "type": "string",
+ "required": true
+ },
+ "studentId": {
+ "location": "path",
+ "description": "The student whose guardian is to be deleted. One of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/userProfiles/{studentId}/guardians/{guardianId}",
+ "path": "v1/userProfiles/{studentId}/guardians/{guardianId}",
+ "id": "classroom.userProfiles.guardians.delete"
}
}
}
@@ -495,83 +348,18 @@
},
"courses": {
"methods": {
- "create": {
- "response": {
- "$ref": "Course"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses"
- ],
- "parameters": {},
- "flatPath": "v1/courses",
- "id": "classroom.courses.create",
- "path": "v1/courses",
- "request": {
- "$ref": "Course"
- },
- "description": "Creates a course.\n\nThe user specified in `ownerId` is the owner of the created course\nand added as a teacher.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\ncourses or for access errors.\n* `NOT_FOUND` if the primary teacher is not a valid user.\n* `FAILED_PRECONDITION` if the course owner's account is disabled or for\nthe following request errors:\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if an alias was specified in the `id` and\nalready exists."
- },
- "get": {
- "response": {
- "$ref": "Course"
- },
- "parameterOrder": [
- "id"
- ],
- "httpMethod": "GET",
- "parameters": {
- "id": {
- "location": "path",
- "description": "Identifier of the course to return.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses",
- "https://www.googleapis.com/auth/classroom.courses.readonly"
- ],
- "flatPath": "v1/courses/{id}",
- "id": "classroom.courses.get",
- "path": "v1/courses/{id}",
- "description": "Returns a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID."
- },
"patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "id"
- ],
- "response": {
- "$ref": "Course"
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses"
- ],
- "parameters": {
- "id": {
- "location": "path",
- "description": "Identifier of the course to update.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true
- },
- "updateMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "Mask that identifies which fields on the course to update.\nThis field is required to do an update. The update will fail if invalid\nfields are specified. The following fields are valid:\n\n* `name`\n* `section`\n* `descriptionHeading`\n* `description`\n* `room`\n* `courseState`\n* `ownerId`\n\nNote: patches to ownerId are treated as being effective immediately, but in\npractice it may take some time for the ownership transfer of all affected\nresources to complete.\n\nWhen set in a query parameter, this field should be specified as\n\n`updateMask=\u003cfield1\u003e,\u003cfield2\u003e,...`",
- "type": "string"
- }
- },
- "flatPath": "v1/courses/{id}",
- "path": "v1/courses/{id}",
- "id": "classroom.courses.patch",
"request": {
"$ref": "Course"
},
- "description": "Updates one or more fields in a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `INVALID_ARGUMENT` if invalid fields are specified in the update mask or\nif no update mask is supplied.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseNotModifiable"
- },
- "update": {
+ "description": "Updates one or more fields in a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `INVALID_ARGUMENT` if invalid fields are specified in the update mask or\nif no update mask is supplied.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseNotModifiable",
+ "response": {
+ "$ref": "Course"
+ },
+ "parameterOrder": [
+ "id"
+ ],
+ "httpMethod": "PATCH",
"scopes": [
"https://www.googleapis.com/auth/classroom.courses"
],
@@ -581,31 +369,78 @@
"type": "string",
"required": true,
"location": "path"
+ },
+ "updateMask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Mask that identifies which fields on the course to update.\nThis field is required to do an update. The update will fail if invalid\nfields are specified. The following fields are valid:\n\n* `name`\n* `section`\n* `descriptionHeading`\n* `description`\n* `room`\n* `courseState`\n* `ownerId`\n\nNote: patches to ownerId are treated as being effective immediately, but in\npractice it may take some time for the ownership transfer of all affected\nresources to complete.\n\nWhen set in a query parameter, this field should be specified as\n\n`updateMask=\u003cfield1\u003e,\u003cfield2\u003e,...`",
+ "type": "string"
}
},
"flatPath": "v1/courses/{id}",
- "id": "classroom.courses.update",
- "path": "v1/courses/{id}",
- "request": {
- "$ref": "Course"
- },
- "description": "Updates a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseNotModifiable",
+ "id": "classroom.courses.patch",
+ "path": "v1/courses/{id}"
+ },
+ "get": {
+ "description": "Returns a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.",
"response": {
"$ref": "Course"
},
"parameterOrder": [
"id"
],
- "httpMethod": "PUT"
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses",
+ "https://www.googleapis.com/auth/classroom.courses.readonly"
+ ],
+ "parameters": {
+ "id": {
+ "location": "path",
+ "description": "Identifier of the course to return.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/courses/{id}",
+ "id": "classroom.courses.get",
+ "path": "v1/courses/{id}"
+ },
+ "update": {
+ "description": "Updates a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseNotModifiable",
+ "request": {
+ "$ref": "Course"
+ },
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "id"
+ ],
+ "response": {
+ "$ref": "Course"
+ },
+ "parameters": {
+ "id": {
+ "location": "path",
+ "description": "Identifier of the course to update.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses"
+ ],
+ "flatPath": "v1/courses/{id}",
+ "path": "v1/courses/{id}",
+ "id": "classroom.courses.update"
},
"delete": {
- "httpMethod": "DELETE",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"id"
],
+ "httpMethod": "DELETE",
"parameters": {
"id": {
"location": "path",
@@ -618,8 +453,8 @@
"https://www.googleapis.com/auth/classroom.courses"
],
"flatPath": "v1/courses/{id}",
- "path": "v1/courses/{id}",
"id": "classroom.courses.delete",
+ "path": "v1/courses/{id}",
"description": "Deletes a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID."
},
"list": {
@@ -629,7 +464,17 @@
},
"parameterOrder": [],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses",
+ "https://www.googleapis.com/auth/classroom.courses.readonly"
+ ],
"parameters": {
+ "pageSize": {
+ "format": "int32",
+ "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
+ "type": "integer",
+ "location": "query"
+ },
"courseStates": {
"description": "Restricts returned courses to those in one of the specified states\nThe default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.",
"type": "string",
@@ -645,50 +490,160 @@
]
},
"teacherId": {
- "location": "query",
"description": "Restricts returned courses to those having a teacher with the specified\nidentifier. The identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"studentId": {
- "location": "query",
"description": "Restricts returned courses to those having a student with the specified\nidentifier. The identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageToken": {
- "location": "query",
"description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
- "type": "integer"
+ "type": "string",
+ "location": "query"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses",
- "https://www.googleapis.com/auth/classroom.courses.readonly"
- ],
"flatPath": "v1/courses",
"id": "classroom.courses.list",
"path": "v1/courses"
+ },
+ "create": {
+ "request": {
+ "$ref": "Course"
+ },
+ "description": "Creates a course.\n\nThe user specified in `ownerId` is the owner of the created course\nand added as a teacher.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\ncourses or for access errors.\n* `NOT_FOUND` if the primary teacher is not a valid user.\n* `FAILED_PRECONDITION` if the course owner's account is disabled or for\nthe following request errors:\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if an alias was specified in the `id` and\nalready exists.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Course"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses"
+ ],
+ "parameters": {},
+ "flatPath": "v1/courses",
+ "path": "v1/courses",
+ "id": "classroom.courses.create"
}
},
"resources": {
- "announcements": {
+ "teachers": {
"methods": {
- "modifyAssignees": {
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "courseId"
+ ],
"response": {
- "$ref": "Announcement"
+ "$ref": "ListTeachersResponse"
},
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.",
+ "type": "integer"
+ },
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating that\nthe subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.profile.emails",
+ "https://www.googleapis.com/auth/classroom.profile.photos",
+ "https://www.googleapis.com/auth/classroom.rosters",
+ "https://www.googleapis.com/auth/classroom.rosters.readonly"
+ ],
+ "flatPath": "v1/courses/{courseId}/teachers",
+ "path": "v1/courses/{courseId}/teachers",
+ "id": "classroom.courses.teachers.list",
+ "description": "Returns a list of teachers of this course that the requester\nis permitted to view.\n\nThis method returns the following error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_DENIED` for access errors."
+ },
+ "get": {
+ "description": "Returns a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\nteachers of this course or for access errors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\ncourse does not exist.",
+ "httpMethod": "GET",
"parameterOrder": [
"courseId",
- "id"
+ "userId"
+ ],
+ "response": {
+ "$ref": "Teacher"
+ },
+ "parameters": {
+ "userId": {
+ "location": "path",
+ "description": "Identifier of the teacher to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "type": "string",
+ "required": true
+ },
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.profile.emails",
+ "https://www.googleapis.com/auth/classroom.profile.photos",
+ "https://www.googleapis.com/auth/classroom.rosters",
+ "https://www.googleapis.com/auth/classroom.rosters.readonly"
+ ],
+ "flatPath": "v1/courses/{courseId}/teachers/{userId}",
+ "path": "v1/courses/{courseId}/teachers/{userId}",
+ "id": "classroom.courses.teachers.get"
+ },
+ "create": {
+ "description": "Creates a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\nteachers in this course or for access errors.\n* `NOT_FOUND` if the requested course ID does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled,\nfor the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * CourseTeacherLimitReached\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if the user is already a teacher or student in the\ncourse.",
+ "request": {
+ "$ref": "Teacher"
+ },
+ "response": {
+ "$ref": "Teacher"
+ },
+ "parameterOrder": [
+ "courseId"
],
"httpMethod": "POST",
+ "parameters": {
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
"scopes": [
- "https://www.googleapis.com/auth/classroom.announcements"
+ "https://www.googleapis.com/auth/classroom.profile.emails",
+ "https://www.googleapis.com/auth/classroom.profile.photos",
+ "https://www.googleapis.com/auth/classroom.rosters"
+ ],
+ "flatPath": "v1/courses/{courseId}/teachers",
+ "id": "classroom.courses.teachers.create",
+ "path": "v1/courses/{courseId}/teachers"
+ },
+ "delete": {
+ "description": "Deletes a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete\nteachers of this course or for access errors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\ncourse does not exist.\n* `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher\nof this course.",
+ "parameterOrder": [
+ "courseId",
+ "userId"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters"
],
"parameters": {
"courseId": {
@@ -697,31 +652,37 @@
"required": true,
"location": "path"
},
- "id": {
+ "userId": {
"location": "path",
- "description": "Identifier of the announcement.",
+ "description": "Identifier of the teacher to delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
"type": "string",
"required": true
}
},
- "flatPath": "v1/courses/{courseId}/announcements/{id}:modifyAssignees",
- "id": "classroom.courses.announcements.modifyAssignees",
- "path": "v1/courses/{courseId}/announcements/{id}:modifyAssignees",
- "request": {
- "$ref": "ModifyAnnouncementAssigneesRequest"
- },
- "description": "Modifies assignee mode and options of an announcement.\n\nOnly a teacher of the course that contains the announcement may\ncall this method.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or course work does not exist."
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "Announcement"
- },
+ "flatPath": "v1/courses/{courseId}/teachers/{userId}",
+ "id": "classroom.courses.teachers.delete",
+ "path": "v1/courses/{courseId}/teachers/{userId}"
+ }
+ }
+ },
+ "announcements": {
+ "methods": {
+ "patch": {
+ "httpMethod": "PATCH",
"parameterOrder": [
"courseId",
"id"
],
+ "response": {
+ "$ref": "Announcement"
+ },
"parameters": {
+ "updateMask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Mask that identifies which fields on the announcement to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified. If a field supports empty values, it can be cleared\nby specifying it in the update mask and not in the Announcement object. If\na field that does not support empty values is included in the update mask\nand not set in the Announcement object, an `INVALID_ARGUMENT` error will be\nreturned.\n\nThe following fields may be specified by teachers:\n\n* `text`\n* `state`\n* `scheduled_time`",
+ "type": "string"
+ },
"courseId": {
"location": "path",
"description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
@@ -736,56 +697,49 @@
}
},
"scopes": [
+ "https://www.googleapis.com/auth/classroom.announcements"
+ ],
+ "flatPath": "v1/courses/{courseId}/announcements/{id}",
+ "path": "v1/courses/{courseId}/announcements/{id}",
+ "id": "classroom.courses.announcements.patch",
+ "description": "Updates one or more fields of an announcement.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding announcement or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `FAILED_PRECONDITION` if the requested announcement has already been\ndeleted.\n* `NOT_FOUND` if the requested course or announcement does not exist",
+ "request": {
+ "$ref": "Announcement"
+ }
+ },
+ "get": {
+ "response": {
+ "$ref": "Announcement"
+ },
+ "parameterOrder": [
+ "courseId",
+ "id"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
"https://www.googleapis.com/auth/classroom.announcements",
"https://www.googleapis.com/auth/classroom.announcements.readonly"
],
- "flatPath": "v1/courses/{courseId}/announcements/{id}",
- "path": "v1/courses/{courseId}/announcements/{id}",
- "id": "classroom.courses.announcements.get",
- "description": "Returns an announcement.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or announcement, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or announcement does not exist."
- },
- "patch": {
- "request": {
- "$ref": "Announcement"
- },
- "description": "Updates one or more fields of an announcement.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding announcement or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `FAILED_PRECONDITION` if the requested announcement has already been\ndeleted.\n* `NOT_FOUND` if the requested course or announcement does not exist",
- "response": {
- "$ref": "Announcement"
- },
- "parameterOrder": [
- "courseId",
- "id"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.announcements"
- ],
"parameters": {
"courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "id": {
"location": "path",
- "description": "Identifier of the announcement.",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"type": "string",
"required": true
},
- "updateMask": {
- "format": "google-fieldmask",
- "description": "Mask that identifies which fields on the announcement to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified. If a field supports empty values, it can be cleared\nby specifying it in the update mask and not in the Announcement object. If\na field that does not support empty values is included in the update mask\nand not set in the Announcement object, an `INVALID_ARGUMENT` error will be\nreturned.\n\nThe following fields may be specified by teachers:\n\n* `text`\n* `state`\n* `scheduled_time`",
+ "id": {
+ "description": "Identifier of the announcement.",
"type": "string",
- "location": "query"
+ "required": true,
+ "location": "path"
}
},
"flatPath": "v1/courses/{courseId}/announcements/{id}",
- "id": "classroom.courses.announcements.patch",
- "path": "v1/courses/{courseId}/announcements/{id}"
+ "id": "classroom.courses.announcements.get",
+ "path": "v1/courses/{courseId}/announcements/{id}",
+ "description": "Returns an announcement.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or announcement, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or announcement does not exist."
},
"delete": {
- "description": "Deletes an announcement.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding announcement item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding announcement, if the requesting user is not permitted\nto delete the requested course or for access errors.\n* `FAILED_PRECONDITION` if the requested announcement has already been\ndeleted.\n* `NOT_FOUND` if no course exists with the requested ID.",
"response": {
"$ref": "Empty"
},
@@ -794,9 +748,6 @@
"id"
],
"httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.announcements"
- ],
"parameters": {
"courseId": {
"description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
@@ -805,29 +756,46 @@
"location": "path"
},
"id": {
+ "location": "path",
"description": "Identifier of the announcement to delete.\nThis identifier is a Classroom-assigned identifier.",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.announcements"
+ ],
"flatPath": "v1/courses/{courseId}/announcements/{id}",
"id": "classroom.courses.announcements.delete",
- "path": "v1/courses/{courseId}/announcements/{id}"
+ "path": "v1/courses/{courseId}/announcements/{id}",
+ "description": "Deletes an announcement.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding announcement item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding announcement, if the requesting user is not permitted\nto delete the requested course or for access errors.\n* `FAILED_PRECONDITION` if the requested announcement has already been\ndeleted.\n* `NOT_FOUND` if no course exists with the requested ID."
},
"list": {
+ "description": "Returns a list of announcements that the requester is permitted to view.\n\nCourse students may only view `PUBLISHED` announcements. Course teachers\nand domain administrators may view all announcements.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthe requested course or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.",
"httpMethod": "GET",
- "parameterOrder": [
- "courseId"
- ],
"response": {
"$ref": "ListAnnouncementsResponse"
},
+ "parameterOrder": [
+ "courseId"
+ ],
"scopes": [
"https://www.googleapis.com/auth/classroom.announcements",
"https://www.googleapis.com/auth/classroom.announcements.readonly"
],
"parameters": {
+ "pageSize": {
+ "format": "int32",
+ "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
+ "type": "integer",
+ "location": "query"
+ },
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true
+ },
"announcementStates": {
"location": "query",
"enum": [
@@ -841,37 +809,21 @@
"repeated": true
},
"pageToken": {
- "type": "string",
"location": "query",
- "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token."
- },
- "orderBy": {
- "location": "query",
- "description": "Optional sort ordering for results. A comma-separated list of fields with\nan optional sort direction keyword. Supported field is `updateTime`.\nSupported direction keywords are `asc` and `desc`.\nIf not specified, `updateTime desc` is the default behavior.\nExamples: `updateTime asc`, `updateTime`",
+ "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
"type": "string"
},
- "pageSize": {
- "format": "int32",
- "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
- "type": "integer",
- "location": "query"
- },
- "courseId": {
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "orderBy": {
+ "description": "Optional sort ordering for results. A comma-separated list of fields with\nan optional sort direction keyword. Supported field is `updateTime`.\nSupported direction keywords are `asc` and `desc`.\nIf not specified, `updateTime desc` is the default behavior.\nExamples: `updateTime asc`, `updateTime`",
"type": "string",
- "required": true
+ "location": "query"
}
},
"flatPath": "v1/courses/{courseId}/announcements",
"path": "v1/courses/{courseId}/announcements",
- "id": "classroom.courses.announcements.list",
- "description": "Returns a list of announcements that the requester is permitted to view.\n\nCourse students may only view `PUBLISHED` announcements. Course teachers\nand domain administrators may view all announcements.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthe requested course or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist."
+ "id": "classroom.courses.announcements.list"
},
"create": {
- "flatPath": "v1/courses/{courseId}/announcements",
- "id": "classroom.courses.announcements.create",
- "path": "v1/courses/{courseId}/announcements",
"description": "Creates an announcement.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, create announcements in the requested course, share a\nDrive attachment, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.\n* `FAILED_PRECONDITION` for the following request error:\n * AttachmentNotVisible",
"request": {
"$ref": "Announcement"
@@ -885,29 +837,69 @@
"httpMethod": "POST",
"parameters": {
"courseId": {
+ "location": "path",
"description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.announcements"
+ ],
+ "flatPath": "v1/courses/{courseId}/announcements",
+ "id": "classroom.courses.announcements.create",
+ "path": "v1/courses/{courseId}/announcements"
+ },
+ "modifyAssignees": {
+ "description": "Modifies assignee mode and options of an announcement.\n\nOnly a teacher of the course that contains the announcement may\ncall this method.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or course work does not exist.",
+ "request": {
+ "$ref": "ModifyAnnouncementAssigneesRequest"
+ },
+ "response": {
+ "$ref": "Announcement"
+ },
+ "parameterOrder": [
+ "courseId",
+ "id"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true
+ },
+ "id": {
+ "description": "Identifier of the announcement.",
+ "type": "string",
"required": true,
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/classroom.announcements"
- ]
+ ],
+ "flatPath": "v1/courses/{courseId}/announcements/{id}:modifyAssignees",
+ "id": "classroom.courses.announcements.modifyAssignees",
+ "path": "v1/courses/{courseId}/announcements/{id}:modifyAssignees"
}
}
},
"aliases": {
"methods": {
"list": {
- "description": "Returns a list of aliases for a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\ncourse or for access errors.\n* `NOT_FOUND` if the course does not exist.",
- "httpMethod": "GET",
- "parameterOrder": [
- "courseId"
- ],
"response": {
"$ref": "ListCourseAliasesResponse"
},
+ "parameterOrder": [
+ "courseId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses",
+ "https://www.googleapis.com/auth/classroom.courses.readonly"
+ ],
"parameters": {
"pageToken": {
"description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
@@ -915,10 +907,10 @@
"location": "query"
},
"pageSize": {
- "type": "integer",
"location": "query",
"format": "int32",
- "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results."
+ "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
+ "type": "integer"
},
"courseId": {
"location": "path",
@@ -927,36 +919,33 @@
"required": true
}
},
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses",
- "https://www.googleapis.com/auth/classroom.courses.readonly"
- ],
"flatPath": "v1/courses/{courseId}/aliases",
+ "id": "classroom.courses.aliases.list",
"path": "v1/courses/{courseId}/aliases",
- "id": "classroom.courses.aliases.list"
+ "description": "Returns a list of aliases for a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\ncourse or for access errors.\n* `NOT_FOUND` if the course does not exist."
},
"create": {
- "response": {
- "$ref": "CourseAlias"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"courseId"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "CourseAlias"
+ },
"parameters": {
"courseId": {
- "location": "path",
"description": "Identifier of the course to alias.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/classroom.courses"
],
"flatPath": "v1/courses/{courseId}/aliases",
- "id": "classroom.courses.aliases.create",
"path": "v1/courses/{courseId}/aliases",
+ "id": "classroom.courses.aliases.create",
"description": "Creates an alias for a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create the\nalias or for access errors.\n* `NOT_FOUND` if the course does not exist.\n* `ALREADY_EXISTS` if the alias already exists.\n* `FAILED_PRECONDITION` if the alias requested does not make sense for the\n requesting user or course (for example, if a user not in a domain\n attempts to access a domain-scoped alias).",
"request": {
"$ref": "CourseAlias"
@@ -973,17 +962,17 @@
"$ref": "Empty"
},
"parameters": {
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course whose alias should be deleted.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true
+ },
"alias": {
"description": "Alias to delete.\nThis may not be the Classroom-assigned identifier.",
"type": "string",
"required": true,
"location": "path"
- },
- "courseId": {
- "description": "Identifier of the course whose alias should be deleted.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true,
- "location": "path"
}
},
"scopes": [
@@ -997,41 +986,8 @@
},
"students": {
"methods": {
- "create": {
- "description": "Adds a user as a student of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\nstudents in this course or for access errors.\n* `NOT_FOUND` if the requested course ID does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled,\nfor the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if the user is already a student or teacher in the\ncourse.",
- "request": {
- "$ref": "Student"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "courseId"
- ],
- "response": {
- "$ref": "Student"
- },
- "parameters": {
- "courseId": {
- "description": "Identifier of the course to create the student in.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "enrollmentCode": {
- "location": "query",
- "description": "Enrollment code of the course to create the student in.\nThis code is required if userId\ncorresponds to the requesting user; it may be omitted if the requesting\nuser has administrative permissions to create students for any user.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.profile.emails",
- "https://www.googleapis.com/auth/classroom.profile.photos",
- "https://www.googleapis.com/auth/classroom.rosters"
- ],
- "flatPath": "v1/courses/{courseId}/students",
- "path": "v1/courses/{courseId}/students",
- "id": "classroom.courses.students.create"
- },
"delete": {
+ "description": "Deletes a student of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete\nstudents of this course or for access errors.\n* `NOT_FOUND` if no student of this course has the requested ID or if the\ncourse does not exist.",
"response": {
"$ref": "Empty"
},
@@ -1040,27 +996,26 @@
"userId"
],
"httpMethod": "DELETE",
- "parameters": {
- "courseId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias."
- },
- "userId": {
- "location": "path",
- "description": "Identifier of the student to delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "type": "string",
- "required": true
- }
- },
"scopes": [
"https://www.googleapis.com/auth/classroom.rosters"
],
+ "parameters": {
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true
+ },
+ "userId": {
+ "description": "Identifier of the student to delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
"flatPath": "v1/courses/{courseId}/students/{userId}",
"id": "classroom.courses.students.delete",
- "path": "v1/courses/{courseId}/students/{userId}",
- "description": "Deletes a student of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete\nstudents of this course or for access errors.\n* `NOT_FOUND` if no student of this course has the requested ID or if the\ncourse does not exist."
+ "path": "v1/courses/{courseId}/students/{userId}"
},
"list": {
"flatPath": "v1/courses/{courseId}/students",
@@ -1075,22 +1030,22 @@
],
"httpMethod": "GET",
"parameters": {
- "pageToken": {
- "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating that\nthe subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
- "type": "string",
- "location": "query"
- },
"pageSize": {
- "type": "integer",
"location": "query",
"format": "int32",
- "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results."
+ "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.",
+ "type": "integer"
},
"courseId": {
"description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"type": "string",
"required": true,
"location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating that\nthe subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
+ "type": "string"
}
},
"scopes": [
@@ -1101,29 +1056,26 @@
]
},
"get": {
- "path": "v1/courses/{courseId}/students/{userId}",
- "id": "classroom.courses.students.get",
- "description": "Returns a student of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\nstudents of this course or for access errors.\n* `NOT_FOUND` if no student of this course has the requested ID or if the\ncourse does not exist.",
- "httpMethod": "GET",
+ "response": {
+ "$ref": "Student"
+ },
"parameterOrder": [
"courseId",
"userId"
],
- "response": {
- "$ref": "Student"
- },
+ "httpMethod": "GET",
"parameters": {
- "userId": {
- "location": "path",
- "description": "Identifier of the student to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "type": "string",
- "required": true
- },
"courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"type": "string",
"required": true,
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias."
+ "location": "path"
+ },
+ "userId": {
+ "description": "Identifier of the student to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "type": "string",
+ "required": true,
+ "location": "path"
}
},
"scopes": [
@@ -1132,200 +1084,53 @@
"https://www.googleapis.com/auth/classroom.rosters",
"https://www.googleapis.com/auth/classroom.rosters.readonly"
],
- "flatPath": "v1/courses/{courseId}/students/{userId}"
+ "flatPath": "v1/courses/{courseId}/students/{userId}",
+ "id": "classroom.courses.students.get",
+ "path": "v1/courses/{courseId}/students/{userId}",
+ "description": "Returns a student of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\nstudents of this course or for access errors.\n* `NOT_FOUND` if no student of this course has the requested ID or if the\ncourse does not exist."
+ },
+ "create": {
+ "request": {
+ "$ref": "Student"
+ },
+ "description": "Adds a user as a student of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\nstudents in this course or for access errors.\n* `NOT_FOUND` if the requested course ID does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled,\nfor the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if the user is already a student or teacher in the\ncourse.",
+ "response": {
+ "$ref": "Student"
+ },
+ "parameterOrder": [
+ "courseId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.profile.emails",
+ "https://www.googleapis.com/auth/classroom.profile.photos",
+ "https://www.googleapis.com/auth/classroom.rosters"
+ ],
+ "parameters": {
+ "courseId": {
+ "description": "Identifier of the course to create the student in.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "enrollmentCode": {
+ "location": "query",
+ "description": "Enrollment code of the course to create the student in.\nThis code is required if userId\ncorresponds to the requesting user; it may be omitted if the requesting\nuser has administrative permissions to create students for any user.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/students",
+ "id": "classroom.courses.students.create",
+ "path": "v1/courses/{courseId}/students"
}
}
},
"courseWork": {
"methods": {
- "delete": {
- "id": "classroom.courses.courseWork.delete",
- "path": "v1/courses/{courseId}/courseWork/{id}",
- "description": "Deletes a course work.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the requesting user is not permitted\nto delete the requested course or for access errors.\n* `FAILED_PRECONDITION` if the requested course work has already been\ndeleted.\n* `NOT_FOUND` if no course exists with the requested ID.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "courseId",
- "id"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "courseId": {
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true
- },
- "id": {
- "location": "path",
- "description": "Identifier of the course work to delete.\nThis identifier is a Classroom-assigned identifier.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.students"
- ],
- "flatPath": "v1/courses/{courseId}/courseWork/{id}"
- },
- "list": {
- "response": {
- "$ref": "ListCourseWorkResponse"
- },
- "parameterOrder": [
- "courseId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
- "type": "string",
- "location": "query"
- },
- "orderBy": {
- "description": "Optional sort ordering for results. A comma-separated list of fields with\nan optional sort direction keyword. Supported fields are `updateTime`\nand `dueDate`. Supported direction keywords are `asc` and `desc`.\nIf not specified, `updateTime desc` is the default behavior.\nExamples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "format": "int32",
- "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
- "type": "integer",
- "location": "query"
- },
- "courseWorkStates": {
- "description": "Restriction on the work status to return. Only courseWork that matches\nis returned. If unspecified, items with a work status of `PUBLISHED`\nis returned.",
- "type": "string",
- "repeated": true,
- "location": "query",
- "enum": [
- "COURSE_WORK_STATE_UNSPECIFIED",
- "PUBLISHED",
- "DRAFT",
- "DELETED"
- ]
- },
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.me",
- "https://www.googleapis.com/auth/classroom.coursework.me.readonly",
- "https://www.googleapis.com/auth/classroom.coursework.students",
- "https://www.googleapis.com/auth/classroom.coursework.students.readonly"
- ],
- "flatPath": "v1/courses/{courseId}/courseWork",
- "id": "classroom.courses.courseWork.list",
- "path": "v1/courses/{courseId}/courseWork",
- "description": "Returns a list of course work that the requester is permitted to view.\n\nCourse students may only view `PUBLISHED` course work. Course teachers\nand domain administrators may view all course work.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthe requested course or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist."
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "courseId"
- ],
- "response": {
- "$ref": "CourseWork"
- },
- "parameters": {
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.students"
- ],
- "flatPath": "v1/courses/{courseId}/courseWork",
- "path": "v1/courses/{courseId}/courseWork",
- "id": "classroom.courses.courseWork.create",
- "description": "Creates course work.\n\nThe resulting course work (and corresponding student submissions) are\nassociated with the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\nmake the request. Classroom API requests to modify course work and student\nsubmissions must be made with an OAuth client ID from the associated\nDeveloper Console project.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, create course work in the requested course, share a\nDrive attachment, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.\n* `FAILED_PRECONDITION` for the following request error:\n * AttachmentNotVisible",
- "request": {
- "$ref": "CourseWork"
- }
- },
- "modifyAssignees": {
- "httpMethod": "POST",
- "parameterOrder": [
- "courseId",
- "id"
- ],
- "response": {
- "$ref": "CourseWork"
- },
- "parameters": {
- "id": {
- "location": "path",
- "description": "Identifier of the coursework.",
- "type": "string",
- "required": true
- },
- "courseId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.students"
- ],
- "flatPath": "v1/courses/{courseId}/courseWork/{id}:modifyAssignees",
- "path": "v1/courses/{courseId}/courseWork/{id}:modifyAssignees",
- "id": "classroom.courses.courseWork.modifyAssignees",
- "description": "Modifies assignee mode and options of a coursework.\n\nOnly a teacher of the course that contains the coursework may\ncall this method.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or course work does not exist.",
- "request": {
- "$ref": "ModifyCourseWorkAssigneesRequest"
- }
- },
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "courseId",
- "id"
- ],
- "response": {
- "$ref": "CourseWork"
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.students"
- ],
- "parameters": {
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "id": {
- "location": "path",
- "description": "Identifier of the course work.",
- "type": "string",
- "required": true
- },
- "updateMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "Mask that identifies which fields on the course work to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified. If a field supports empty values, it can be cleared\nby specifying it in the update mask and not in the CourseWork object. If a\nfield that does not support empty values is included in the update mask and\nnot set in the CourseWork object, an `INVALID_ARGUMENT` error will be\nreturned.\n\nThe following fields may be specified by teachers:\n\n* `title`\n* `description`\n* `state`\n* `due_date`\n* `due_time`\n* `max_points`\n* `scheduled_time`\n* `submission_modification_mode`",
- "type": "string"
- }
- },
- "flatPath": "v1/courses/{courseId}/courseWork/{id}",
- "path": "v1/courses/{courseId}/courseWork/{id}",
- "id": "classroom.courses.courseWork.patch",
- "request": {
- "$ref": "CourseWork"
- },
- "description": "Updates one or more fields of a course work.\n\nSee google.classroom.v1.CourseWork for details\nof which fields may be updated and who may change them.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the user is not permitted to make the\nrequested modification to the student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `FAILED_PRECONDITION` if the requested course work has already been\ndeleted.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist."
- },
"get": {
+ "flatPath": "v1/courses/{courseId}/courseWork/{id}",
+ "id": "classroom.courses.courseWork.get",
+ "path": "v1/courses/{courseId}/courseWork/{id}",
"description": "Returns course work.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or course work does not exist.",
"response": {
"$ref": "CourseWork"
@@ -1343,68 +1148,214 @@
],
"parameters": {
"courseId": {
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true
+ },
+ "id": {
+ "location": "path",
+ "description": "Identifier of the course work.",
+ "type": "string",
+ "required": true
+ }
+ }
+ },
+ "patch": {
+ "description": "Updates one or more fields of a course work.\n\nSee google.classroom.v1.CourseWork for details\nof which fields may be updated and who may change them.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the user is not permitted to make the\nrequested modification to the student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `FAILED_PRECONDITION` if the requested course work has already been\ndeleted.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
+ "request": {
+ "$ref": "CourseWork"
+ },
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "courseId",
+ "id"
+ ],
+ "response": {
+ "$ref": "CourseWork"
+ },
+ "parameters": {
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"type": "string",
"required": true,
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias."
+ "location": "path"
},
"id": {
"description": "Identifier of the course work.",
"type": "string",
"required": true,
"location": "path"
+ },
+ "updateMask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Mask that identifies which fields on the course work to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified. If a field supports empty values, it can be cleared\nby specifying it in the update mask and not in the CourseWork object. If a\nfield that does not support empty values is included in the update mask and\nnot set in the CourseWork object, an `INVALID_ARGUMENT` error will be\nreturned.\n\nThe following fields may be specified by teachers:\n\n* `title`\n* `description`\n* `state`\n* `due_date`\n* `due_time`\n* `max_points`\n* `scheduled_time`\n* `submission_modification_mode`",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.students"
+ ],
+ "flatPath": "v1/courses/{courseId}/courseWork/{id}",
+ "path": "v1/courses/{courseId}/courseWork/{id}",
+ "id": "classroom.courses.courseWork.patch"
+ },
+ "delete": {
+ "parameterOrder": [
+ "courseId",
+ "id"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.students"
+ ],
+ "parameters": {
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true
+ },
+ "id": {
+ "description": "Identifier of the course work to delete.\nThis identifier is a Classroom-assigned identifier.",
+ "type": "string",
+ "required": true,
+ "location": "path"
}
},
"flatPath": "v1/courses/{courseId}/courseWork/{id}",
- "id": "classroom.courses.courseWork.get",
- "path": "v1/courses/{courseId}/courseWork/{id}"
+ "id": "classroom.courses.courseWork.delete",
+ "path": "v1/courses/{courseId}/courseWork/{id}",
+ "description": "Deletes a course work.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the requesting user is not permitted\nto delete the requested course or for access errors.\n* `FAILED_PRECONDITION` if the requested course work has already been\ndeleted.\n* `NOT_FOUND` if no course exists with the requested ID."
+ },
+ "list": {
+ "flatPath": "v1/courses/{courseId}/courseWork",
+ "id": "classroom.courses.courseWork.list",
+ "path": "v1/courses/{courseId}/courseWork",
+ "description": "Returns a list of course work that the requester is permitted to view.\n\nCourse students may only view `PUBLISHED` course work. Course teachers\nand domain administrators may view all course work.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthe requested course or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.",
+ "response": {
+ "$ref": "ListCourseWorkResponse"
+ },
+ "parameterOrder": [
+ "courseId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
+ "type": "string"
+ },
+ "orderBy": {
+ "description": "Optional sort ordering for results. A comma-separated list of fields with\nan optional sort direction keyword. Supported fields are `updateTime`\nand `dueDate`. Supported direction keywords are `asc` and `desc`.\nIf not specified, `updateTime desc` is the default behavior.\nExamples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
+ "type": "integer"
+ },
+ "courseWorkStates": {
+ "location": "query",
+ "enum": [
+ "COURSE_WORK_STATE_UNSPECIFIED",
+ "PUBLISHED",
+ "DRAFT",
+ "DELETED"
+ ],
+ "description": "Restriction on the work status to return. Only courseWork that matches\nis returned. If unspecified, items with a work status of `PUBLISHED`\nis returned.",
+ "type": "string",
+ "repeated": true
+ },
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.me",
+ "https://www.googleapis.com/auth/classroom.coursework.me.readonly",
+ "https://www.googleapis.com/auth/classroom.coursework.students",
+ "https://www.googleapis.com/auth/classroom.coursework.students.readonly"
+ ]
+ },
+ "create": {
+ "flatPath": "v1/courses/{courseId}/courseWork",
+ "id": "classroom.courses.courseWork.create",
+ "path": "v1/courses/{courseId}/courseWork",
+ "description": "Creates course work.\n\nThe resulting course work (and corresponding student submissions) are\nassociated with the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\nmake the request. Classroom API requests to modify course work and student\nsubmissions must be made with an OAuth client ID from the associated\nDeveloper Console project.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, create course work in the requested course, share a\nDrive attachment, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.\n* `FAILED_PRECONDITION` for the following request error:\n * AttachmentNotVisible",
+ "request": {
+ "$ref": "CourseWork"
+ },
+ "response": {
+ "$ref": "CourseWork"
+ },
+ "parameterOrder": [
+ "courseId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.students"
+ ]
+ },
+ "modifyAssignees": {
+ "flatPath": "v1/courses/{courseId}/courseWork/{id}:modifyAssignees",
+ "id": "classroom.courses.courseWork.modifyAssignees",
+ "path": "v1/courses/{courseId}/courseWork/{id}:modifyAssignees",
+ "description": "Modifies assignee mode and options of a coursework.\n\nOnly a teacher of the course that contains the coursework may\ncall this method.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or course work does not exist.",
+ "request": {
+ "$ref": "ModifyCourseWorkAssigneesRequest"
+ },
+ "response": {
+ "$ref": "CourseWork"
+ },
+ "parameterOrder": [
+ "courseId",
+ "id"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true
+ },
+ "id": {
+ "location": "path",
+ "description": "Identifier of the coursework.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.students"
+ ]
}
},
"resources": {
"studentSubmissions": {
"methods": {
- "reclaim": {
- "httpMethod": "POST",
- "parameterOrder": [
- "courseId",
- "courseWorkId",
- "id"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.me"
- ],
- "parameters": {
- "courseWorkId": {
- "location": "path",
- "description": "Identifier of the course work.",
- "type": "string",
- "required": true
- },
- "courseId": {
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true
- },
- "id": {
- "location": "path",
- "description": "Identifier of the student submission.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim",
- "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim",
- "id": "classroom.courses.courseWork.studentSubmissions.reclaim",
- "request": {
- "$ref": "ReclaimStudentSubmissionRequest"
- },
- "description": "Reclaims a student submission on behalf of the student that owns it.\n\nReclaiming a student submission transfers ownership of attached Drive\nfiles to the student and update the submission state.\n\nOnly the student that owns the requested student submission may call this\nmethod, and only for a student submission that has been turned in.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, unsubmit the requested student submission,\nor for access errors.\n* `FAILED_PRECONDITION` if the student submission has not been turned in.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist."
- },
"turnIn": {
+ "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn",
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn",
+ "id": "classroom.courses.courseWork.studentSubmissions.turnIn",
"description": "Turns in a student submission.\n\nTurning in a student submission transfers ownership of attached Drive\nfiles to the teacher and may also update the submission state.\n\nThis may only be called by the student that owns the specified student\nsubmission.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, turn in the requested student submission,\nor for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
"request": {
"$ref": "TurnInStudentSubmissionRequest"
@@ -1419,12 +1370,6 @@
"$ref": "Empty"
},
"parameters": {
- "id": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Identifier of the student submission."
- },
"courseWorkId": {
"description": "Identifier of the course work.",
"type": "string",
@@ -1432,21 +1377,23 @@
"location": "path"
},
"courseId": {
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true
+ },
+ "id": {
+ "description": "Identifier of the student submission.",
"type": "string",
"required": true,
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias."
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/classroom.coursework.me"
- ],
- "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn",
- "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn",
- "id": "classroom.courses.courseWork.studentSubmissions.turnIn"
+ ]
},
"list": {
- "httpMethod": "GET",
"response": {
"$ref": "ListStudentSubmissionsResponse"
},
@@ -1454,20 +1401,8 @@
"courseId",
"courseWorkId"
],
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.me",
- "https://www.googleapis.com/auth/classroom.coursework.me.readonly",
- "https://www.googleapis.com/auth/classroom.coursework.students",
- "https://www.googleapis.com/auth/classroom.coursework.students.readonly",
- "https://www.googleapis.com/auth/classroom.student-submissions.me.readonly",
- "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly"
- ],
+ "httpMethod": "GET",
"parameters": {
- "userId": {
- "description": "Optional argument to restrict returned student work to those owned by the\nstudent with the specified identifier. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "type": "string",
- "location": "query"
- },
"courseWorkId": {
"location": "path",
"description": "Identifier of the student work to request.\nThis may be set to the string literal `\"-\"` to request student work for\nall course work in the specified course.",
@@ -1481,27 +1416,24 @@
"location": "path"
},
"late": {
+ "description": "Requested lateness value. If specified, returned student submissions are\nrestricted by the requested value.\nIf unspecified, submissions are returned regardless of `late` value.",
+ "type": "string",
"location": "query",
"enum": [
"LATE_VALUES_UNSPECIFIED",
"LATE_ONLY",
"NOT_LATE_ONLY"
- ],
- "description": "Requested lateness value. If specified, returned student submissions are\nrestricted by the requested value.\nIf unspecified, submissions are returned regardless of `late` value.",
- "type": "string"
+ ]
},
"pageToken": {
+ "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
"type": "string",
- "location": "query",
- "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token."
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
- "type": "integer"
+ "location": "query"
},
"states": {
+ "description": "Requested submission states. If specified, returned student submissions\nmatch one of the specified submission states.",
+ "type": "string",
+ "repeated": true,
"location": "query",
"enum": [
"SUBMISSION_STATE_UNSPECIFIED",
@@ -1510,69 +1442,20 @@
"TURNED_IN",
"RETURNED",
"RECLAIMED_BY_STUDENT"
- ],
- "description": "Requested submission states. If specified, returned student submissions\nmatch one of the specified submission states.",
- "type": "string",
- "repeated": true
+ ]
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
+ "type": "integer",
+ "location": "query"
+ },
+ "userId": {
+ "location": "query",
+ "description": "Optional argument to restrict returned student work to those owned by the\nstudent with the specified identifier. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "type": "string"
}
},
- "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions",
- "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions",
- "id": "classroom.courses.courseWork.studentSubmissions.list",
- "description": "Returns a list of student submissions that the requester is permitted to\nview, factoring in the OAuth scopes of the request.\n`-` may be specified as the `course_work_id` to include student\nsubmissions for multiple course work items.\n\nCourse students may only view their own work. Course teachers\nand domain administrators may view all student submissions.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist."
- },
- "modifyAttachments": {
- "response": {
- "$ref": "StudentSubmission"
- },
- "parameterOrder": [
- "courseId",
- "courseWorkId",
- "id"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.me",
- "https://www.googleapis.com/auth/classroom.coursework.students"
- ],
- "parameters": {
- "courseId": {
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true
- },
- "id": {
- "location": "path",
- "description": "Identifier of the student submission.",
- "type": "string",
- "required": true
- },
- "courseWorkId": {
- "description": "Identifier of the course work.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments",
- "id": "classroom.courses.courseWork.studentSubmissions.modifyAttachments",
- "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments",
- "request": {
- "$ref": "ModifyAttachmentsRequest"
- },
- "description": "Modifies attachments of student submission.\n\nAttachments may only be added to student submissions belonging to course\nwork objects with a `workType` of `ASSIGNMENT`.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, if the user is not permitted to modify\nattachments on the requested student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist."
- },
- "get": {
- "response": {
- "$ref": "StudentSubmission"
- },
- "httpMethod": "GET",
- "parameterOrder": [
- "courseId",
- "courseWorkId",
- "id"
- ],
"scopes": [
"https://www.googleapis.com/auth/classroom.coursework.me",
"https://www.googleapis.com/auth/classroom.coursework.me.readonly",
@@ -1581,39 +1464,16 @@
"https://www.googleapis.com/auth/classroom.student-submissions.me.readonly",
"https://www.googleapis.com/auth/classroom.student-submissions.students.readonly"
],
- "parameters": {
- "courseWorkId": {
- "location": "path",
- "description": "Identifier of the course work.",
- "type": "string",
- "required": true
- },
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "id": {
- "location": "path",
- "description": "Identifier of the student submission.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
- "id": "classroom.courses.courseWork.studentSubmissions.get",
- "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
- "description": "Returns a student submission.\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, course work, or student submission or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist."
+ "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions",
+ "id": "classroom.courses.courseWork.studentSubmissions.list",
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions",
+ "description": "Returns a list of student submissions that the requester is permitted to\nview, factoring in the OAuth scopes of the request.\n`-` may be specified as the `course_work_id` to include student\nsubmissions for multiple course work items.\n\nCourse students may only view their own work. Course teachers\nand domain administrators may view all student submissions.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist."
},
- "patch": {
- "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
- "id": "classroom.courses.courseWork.studentSubmissions.patch",
- "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
+ "modifyAttachments": {
+ "description": "Modifies attachments of student submission.\n\nAttachments may only be added to student submissions belonging to course\nwork objects with a `workType` of `ASSIGNMENT`.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, if the user is not permitted to modify\nattachments on the requested student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
"request": {
- "$ref": "StudentSubmission"
+ "$ref": "ModifyAttachmentsRequest"
},
- "description": "Updates one or more fields of a student submission.\n\nSee google.classroom.v1.StudentSubmission for details\nof which fields may be updated and who may change them.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the user is not permitted to make the\nrequested modification to the student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
"response": {
"$ref": "StudentSubmission"
},
@@ -1622,11 +1482,94 @@
"courseWorkId",
"id"
],
- "httpMethod": "PATCH",
+ "httpMethod": "POST",
+ "parameters": {
+ "courseWorkId": {
+ "description": "Identifier of the course work.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "id": {
+ "description": "Identifier of the student submission.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/classroom.coursework.me",
"https://www.googleapis.com/auth/classroom.coursework.students"
],
+ "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments",
+ "id": "classroom.courses.courseWork.studentSubmissions.modifyAttachments",
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments"
+ },
+ "patch": {
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "courseId",
+ "courseWorkId",
+ "id"
+ ],
+ "response": {
+ "$ref": "StudentSubmission"
+ },
+ "parameters": {
+ "updateMask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Mask that identifies which fields on the student submission to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified.\n\nThe following fields may be specified by teachers:\n\n* `draft_grade`\n* `assigned_grade`",
+ "type": "string"
+ },
+ "courseWorkId": {
+ "description": "Identifier of the course work.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true
+ },
+ "id": {
+ "description": "Identifier of the student submission.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.me",
+ "https://www.googleapis.com/auth/classroom.coursework.students"
+ ],
+ "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
+ "id": "classroom.courses.courseWork.studentSubmissions.patch",
+ "description": "Updates one or more fields of a student submission.\n\nSee google.classroom.v1.StudentSubmission for details\nof which fields may be updated and who may change them.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the user is not permitted to make the\nrequested modification to the student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
+ "request": {
+ "$ref": "StudentSubmission"
+ }
+ },
+ "get": {
+ "description": "Returns a student submission.\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, course work, or student submission or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "StudentSubmission"
+ },
+ "parameterOrder": [
+ "courseId",
+ "courseWorkId",
+ "id"
+ ],
"parameters": {
"courseWorkId": {
"location": "path",
@@ -1635,41 +1578,40 @@
"required": true
},
"courseId": {
+ "location": "path",
"description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
},
"id": {
"description": "Identifier of the student submission.",
"type": "string",
"required": true,
"location": "path"
- },
- "updateMask": {
- "format": "google-fieldmask",
- "description": "Mask that identifies which fields on the student submission to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified.\n\nThe following fields may be specified by teachers:\n\n* `draft_grade`\n* `assigned_grade`",
- "type": "string",
- "location": "query"
}
- }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.me",
+ "https://www.googleapis.com/auth/classroom.coursework.me.readonly",
+ "https://www.googleapis.com/auth/classroom.coursework.students",
+ "https://www.googleapis.com/auth/classroom.coursework.students.readonly",
+ "https://www.googleapis.com/auth/classroom.student-submissions.me.readonly",
+ "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly"
+ ],
+ "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
+ "id": "classroom.courses.courseWork.studentSubmissions.get"
},
"return": {
- "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return",
- "id": "classroom.courses.courseWork.studentSubmissions.return",
- "request": {
- "$ref": "ReturnStudentSubmissionRequest"
+ "response": {
+ "$ref": "Empty"
},
- "description": "Returns a student submission.\n\nReturning a student submission transfers ownership of attached Drive\nfiles to the student and may also update the submission state.\nUnlike the Classroom application, returning a student submission does not\nset assignedGrade to the draftGrade value.\n\nOnly a teacher of the course that contains the requested student submission\nmay call this method.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, return the requested student submission,\nor for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
- "httpMethod": "POST",
"parameterOrder": [
"courseId",
"courseWorkId",
"id"
],
- "response": {
- "$ref": "Empty"
- },
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/classroom.coursework.students"
],
@@ -1681,158 +1623,202 @@
"required": true
},
"courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "id": {
+ "description": "Identifier of the student submission.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return",
+ "id": "classroom.courses.courseWork.studentSubmissions.return",
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return",
+ "request": {
+ "$ref": "ReturnStudentSubmissionRequest"
+ },
+ "description": "Returns a student submission.\n\nReturning a student submission transfers ownership of attached Drive\nfiles to the student and may also update the submission state.\nUnlike the Classroom application, returning a student submission does not\nset assignedGrade to the draftGrade value.\n\nOnly a teacher of the course that contains the requested student submission\nmay call this method.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, return the requested student submission,\nor for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist."
+ },
+ "reclaim": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "courseId",
+ "courseWorkId",
+ "id"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "courseWorkId": {
+ "description": "Identifier of the course work.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "courseId": {
"location": "path",
"description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"type": "string",
"required": true
},
"id": {
- "location": "path",
"description": "Identifier of the student submission.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
}
},
- "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return"
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.me"
+ ],
+ "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim",
+ "id": "classroom.courses.courseWork.studentSubmissions.reclaim",
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim",
+ "description": "Reclaims a student submission on behalf of the student that owns it.\n\nReclaiming a student submission transfers ownership of attached Drive\nfiles to the student and update the submission state.\n\nOnly the student that owns the requested student submission may call this\nmethod, and only for a student submission that has been turned in.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, unsubmit the requested student submission,\nor for access errors.\n* `FAILED_PRECONDITION` if the student submission has not been turned in.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
+ "request": {
+ "$ref": "ReclaimStudentSubmissionRequest"
+ }
}
}
}
}
- },
- "teachers": {
- "methods": {
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "courseId",
- "userId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "userId": {
- "location": "path",
- "description": "Identifier of the teacher to delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "type": "string",
- "required": true
- },
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters"
- ],
- "flatPath": "v1/courses/{courseId}/teachers/{userId}",
- "id": "classroom.courses.teachers.delete",
- "path": "v1/courses/{courseId}/teachers/{userId}",
- "description": "Deletes a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete\nteachers of this course or for access errors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\ncourse does not exist.\n* `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher\nof this course."
- },
- "list": {
- "id": "classroom.courses.teachers.list",
- "path": "v1/courses/{courseId}/teachers",
- "description": "Returns a list of teachers of this course that the requester\nis permitted to view.\n\nThis method returns the following error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_DENIED` for access errors.",
- "response": {
- "$ref": "ListTeachersResponse"
- },
- "parameterOrder": [
- "courseId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "courseId": {
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true
- },
- "pageToken": {
- "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating that\nthe subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.profile.emails",
- "https://www.googleapis.com/auth/classroom.profile.photos",
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ],
- "flatPath": "v1/courses/{courseId}/teachers"
- },
- "get": {
- "description": "Returns a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\nteachers of this course or for access errors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\ncourse does not exist.",
- "response": {
- "$ref": "Teacher"
- },
- "parameterOrder": [
- "courseId",
- "userId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.profile.emails",
- "https://www.googleapis.com/auth/classroom.profile.photos",
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ],
- "parameters": {
- "userId": {
- "location": "path",
- "description": "Identifier of the teacher to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "type": "string",
- "required": true
- },
- "courseId": {
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/courses/{courseId}/teachers/{userId}",
- "id": "classroom.courses.teachers.get",
- "path": "v1/courses/{courseId}/teachers/{userId}"
- },
- "create": {
- "response": {
- "$ref": "Teacher"
- },
- "parameterOrder": [
- "courseId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.profile.emails",
- "https://www.googleapis.com/auth/classroom.profile.photos",
- "https://www.googleapis.com/auth/classroom.rosters"
- ],
- "parameters": {
- "courseId": {
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/courses/{courseId}/teachers",
- "id": "classroom.courses.teachers.create",
- "path": "v1/courses/{courseId}/teachers",
- "request": {
- "$ref": "Teacher"
- },
- "description": "Creates a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\nteachers in this course or for access errors.\n* `NOT_FOUND` if the requested course ID does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled,\nfor the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * CourseTeacherLimitReached\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if the user is already a teacher or student in the\ncourse."
+ }
+ }
+ },
+ "invitations": {
+ "methods": {
+ "accept": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "id"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "id": {
+ "description": "Identifier of the invitation to accept.",
+ "type": "string",
+ "required": true,
+ "location": "path"
}
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters"
+ ],
+ "flatPath": "v1/invitations/{id}:accept",
+ "id": "classroom.invitations.accept",
+ "path": "v1/invitations/{id}:accept",
+ "description": "Accepts an invitation, removing it and adding the invited user to the\nteachers or students (as appropriate) of the specified course. Only the\ninvited user may accept an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to accept the\nrequested invitation or for access errors.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * CourseTeacherLimitReached\n * UserGroupsMembershipLimitReached\n* `NOT_FOUND` if no invitation exists with the requested ID."
+ },
+ "delete": {
+ "description": "Deletes an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete the\nrequested invitation or for access errors.\n* `NOT_FOUND` if no invitation exists with the requested ID.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "id"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Identifier of the invitation to delete.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/invitations/{id}",
+ "id": "classroom.invitations.delete",
+ "path": "v1/invitations/{id}"
+ },
+ "list": {
+ "flatPath": "v1/invitations",
+ "path": "v1/invitations",
+ "id": "classroom.invitations.list",
+ "description": "Returns a list of invitations that the requesting user is permitted to\nview, restricted to those that match the list request.\n\n*Note:* At least one of `user_id` or `course_id` must be supplied. Both\nfields can be supplied.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` for access errors.",
+ "httpMethod": "GET",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ListInvitationsResponse"
+ },
+ "parameters": {
+ "pageToken": {
+ "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating\nthat the subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
+ "type": "string",
+ "location": "query"
+ },
+ "userId": {
+ "description": "Restricts returned invitations to those for a specific user. The identifier\ncan be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.",
+ "type": "integer",
+ "location": "query"
+ },
+ "courseId": {
+ "location": "query",
+ "description": "Restricts returned invitations to those for a course with the specified\nidentifier.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters",
+ "https://www.googleapis.com/auth/classroom.rosters.readonly"
+ ]
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "id"
+ ],
+ "response": {
+ "$ref": "Invitation"
+ },
+ "parameters": {
+ "id": {
+ "description": "Identifier of the invitation to return.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters",
+ "https://www.googleapis.com/auth/classroom.rosters.readonly"
+ ],
+ "flatPath": "v1/invitations/{id}",
+ "path": "v1/invitations/{id}",
+ "id": "classroom.invitations.get",
+ "description": "Returns an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view the\nrequested invitation or for access errors.\n* `NOT_FOUND` if no invitation exists with the requested ID."
+ },
+ "create": {
+ "response": {
+ "$ref": "Invitation"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters"
+ ],
+ "flatPath": "v1/invitations",
+ "id": "classroom.invitations.create",
+ "path": "v1/invitations",
+ "description": "Creates an invitation. Only one invitation for a user and course may exist\nat a time. Delete and re-create an invitation to make changes.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\ninvitations for this course or for access errors.\n* `NOT_FOUND` if the course or the user does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled or if\nthe user already has this role or a role with greater permissions.\n* `ALREADY_EXISTS` if an invitation for the specified user and course\nalready exists.",
+ "request": {
+ "$ref": "Invitation"
}
}
}
@@ -1840,29 +1826,32 @@
},
"parameters": {
"upload_protocol": {
- "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "default": "true",
- "type": "boolean",
- "location": "query",
- "description": "Returns response with indentations and line breaks."
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
},
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
"$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -1871,15 +1860,11 @@
"enum": [
"1",
"2"
- ]
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
+ ],
+ "description": "V1 error format.",
"type": "string"
},
"alt": {
- "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -1892,7 +1877,8 @@
"json",
"media",
"proto"
- ]
+ ],
+ "type": "string"
},
"access_token": {
"description": "OAuth access token.",
@@ -1905,47 +1891,177 @@
"type": "string"
},
"quotaUser": {
+ "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pp": {
+ "description": "Pretty-print response.",
"default": "true",
"type": "boolean",
- "location": "query",
- "description": "Pretty-print response."
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
"location": "query"
},
"oauth_token": {
- "location": "query",
"description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
"type": "string"
}
},
"schemas": {
+ "Material": {
+ "description": "Material attached to course work.\n\nWhen creating attachments, setting the `form` field is not supported.",
+ "type": "object",
+ "properties": {
+ "driveFile": {
+ "description": "Google Drive file material.",
+ "$ref": "SharedDriveFile"
+ },
+ "form": {
+ "description": "Google Forms material.",
+ "$ref": "Form"
+ },
+ "link": {
+ "description": "Link material. On creation, will be upgraded to a more appropriate type\nif possible, and this will be reflected in the response.",
+ "$ref": "Link"
+ },
+ "youtubeVideo": {
+ "$ref": "YouTubeVideo",
+ "description": "YouTube video material."
+ }
+ },
+ "id": "Material"
+ },
+ "Feed": {
+ "description": "A class of notifications that an application can register to receive.\nFor example: \"all roster changes for a domain\".",
+ "type": "object",
+ "properties": {
+ "feedType": {
+ "enumDescriptions": [
+ "Should never be returned or provided.",
+ "All roster changes for a particular domain.\n\nNotifications will be generated whenever a user joins or leaves a course.\n\nNo notifications will be generated when an invitation is created or\ndeleted, but notifications will be generated when a user joins a course\nby accepting an invitation.",
+ "All roster changes for a particular course.\n\nNotifications will be generated whenever a user joins or leaves a course.\n\nNo notifications will be generated when an invitation is created or\ndeleted, but notifications will be generated when a user joins a course\nby accepting an invitation."
+ ],
+ "enum": [
+ "FEED_TYPE_UNSPECIFIED",
+ "DOMAIN_ROSTER_CHANGES",
+ "COURSE_ROSTER_CHANGES"
+ ],
+ "description": "The type of feed.",
+ "type": "string"
+ },
+ "courseRosterChangesInfo": {
+ "description": "Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`.\nThis field must be specified if `feed_type` is `COURSE_ROSTER_CHANGES`.",
+ "$ref": "CourseRosterChangesInfo"
+ }
+ },
+ "id": "Feed"
+ },
+ "Student": {
+ "description": "Student in a course.",
+ "type": "object",
+ "properties": {
+ "studentWorkFolder": {
+ "$ref": "DriveFolder",
+ "description": "Information about a Drive Folder for this student's work in this course.\nOnly visible to the student and domain administrators.\n\nRead-only."
+ },
+ "profile": {
+ "$ref": "UserProfile",
+ "description": "Global user information for the student.\n\nRead-only."
+ },
+ "userId": {
+ "description": "Identifier of the user.\n\nWhen specified as a parameter of a request, this identifier can be one of\nthe following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "type": "string"
+ },
+ "courseId": {
+ "description": "Identifier of the course.\n\nRead-only.",
+ "type": "string"
+ }
+ },
+ "id": "Student"
+ },
+ "Invitation": {
+ "description": "An invitation to join a course.",
+ "type": "object",
+ "properties": {
+ "courseId": {
+ "description": "Identifier of the course to invite the user to.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Identifier assigned by Classroom.\n\nRead-only.",
+ "type": "string"
+ },
+ "role": {
+ "enumDescriptions": [
+ "No course role.",
+ "Student in the course.",
+ "Teacher of the course.",
+ "Owner of the course."
+ ],
+ "enum": [
+ "COURSE_ROLE_UNSPECIFIED",
+ "STUDENT",
+ "TEACHER",
+ "OWNER"
+ ],
+ "description": "Role to invite the user to have.\nMust not be `COURSE_ROLE_UNSPECIFIED`.",
+ "type": "string"
+ },
+ "userId": {
+ "description": "Identifier of the invited user.\n\nWhen specified as a parameter of a request, this identifier can be set to\none of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "type": "string"
+ }
+ },
+ "id": "Invitation"
+ },
+ "TurnInStudentSubmissionRequest": {
+ "description": "Request to turn in a student submission.",
+ "type": "object",
+ "properties": {},
+ "id": "TurnInStudentSubmissionRequest"
+ },
+ "ListCourseWorkResponse": {
+ "description": "Response when listing course work.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
+ },
+ "courseWork": {
+ "description": "Course work items that match the request.",
+ "items": {
+ "$ref": "CourseWork"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListCourseWorkResponse"
+ },
"Attachment": {
"description": "Attachment added to student assignment work.\n\nWhen creating attachments, setting the `form` field is not supported.",
"type": "object",
"properties": {
"youTubeVideo": {
- "description": "Youtube video attachment.",
- "$ref": "YouTubeVideo"
+ "$ref": "YouTubeVideo",
+ "description": "Youtube video attachment."
},
"driveFile": {
- "$ref": "DriveFile",
- "description": "Google Drive file attachment."
+ "description": "Google Drive file attachment.",
+ "$ref": "DriveFile"
},
"form": {
- "$ref": "Form",
- "description": "Google Forms attachment."
+ "description": "Google Forms attachment.",
+ "$ref": "Form"
},
"link": {
- "description": "Link attachment.",
- "$ref": "Link"
+ "$ref": "Link",
+ "description": "Link attachment."
}
},
"id": "Attachment"
@@ -1954,16 +2070,16 @@
"description": "Response when listing course work.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
- "type": "string"
- },
"announcements": {
"description": "Announcement items that match the request.",
"items": {
"$ref": "Announcement"
},
"type": "array"
+ },
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
}
},
"id": "ListAnnouncementsResponse"
@@ -1988,30 +2104,30 @@
"type": "integer"
},
"minutes": {
- "type": "integer",
"format": "int32",
- "description": "Minutes of hour of day. Must be from 0 to 59."
+ "description": "Minutes of hour of day. Must be from 0 to 59.",
+ "type": "integer"
}
},
"id": "TimeOfDay"
},
"ListCoursesResponse": {
+ "description": "Response when listing courses.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
- "type": "string"
- },
"courses": {
"description": "Courses that match the list request.",
"items": {
"$ref": "Course"
},
"type": "array"
+ },
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
}
},
- "id": "ListCoursesResponse",
- "description": "Response when listing courses."
+ "id": "ListCoursesResponse"
},
"Form": {
"description": "Google Forms item.",
@@ -2037,8 +2153,12 @@
"id": "Form"
},
"ModifyCourseWorkAssigneesRequest": {
+ "description": "Request to modify assignee mode and options of a coursework.",
+ "type": "object",
"properties": {
"assigneeMode": {
+ "description": "Mode of the coursework describing whether it will be assigned to all\nstudents or specified individual students.",
+ "type": "string",
"enumDescriptions": [
"No mode specified. This is never returned.",
"All students can see the item.\nThis is the default state.",
@@ -2048,21 +2168,16 @@
"ASSIGNEE_MODE_UNSPECIFIED",
"ALL_STUDENTS",
"INDIVIDUAL_STUDENTS"
- ],
- "description": "Mode of the coursework describing whether it will be assigned to all\nstudents or specified individual students.",
- "type": "string"
+ ]
},
"modifyIndividualStudentsOptions": {
"description": "Set which students are assigned or not assigned to the coursework.\nMust be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`.",
"$ref": "ModifyIndividualStudentsOptions"
}
},
- "id": "ModifyCourseWorkAssigneesRequest",
- "description": "Request to modify assignee mode and options of a coursework.",
- "type": "object"
+ "id": "ModifyCourseWorkAssigneesRequest"
},
"ListGuardiansResponse": {
- "id": "ListGuardiansResponse",
"description": "Response when listing guardians.",
"type": "object",
"properties": {
@@ -2071,13 +2186,14 @@
"type": "string"
},
"guardians": {
+ "description": "Guardians on this page of results that met the criteria specified in\nthe request.",
"items": {
"$ref": "Guardian"
},
- "type": "array",
- "description": "Guardians on this page of results that met the criteria specified in\nthe request."
+ "type": "array"
}
- }
+ },
+ "id": "ListGuardiansResponse"
},
"CourseAlias": {
"description": "Alternative identifier for a course.\n\nAn alias uniquely identifies a course. It must be unique within one of the\nfollowing scopes:\n\n* domain: A domain-scoped alias is visible to all users within the alias\ncreator's domain and can be created only by a domain admin. A domain-scoped\nalias is often used when a course has an identifier external to Classroom.\n\n* project: A project-scoped alias is visible to any request from an\napplication using the Developer Console project ID that created the alias\nand can be created by any project. A project-scoped alias is often used when\nan application has alternative identifiers. A random value can also be used\nto avoid duplicate courses in the event of transmission failures, as retrying\na request will return `ALREADY_EXISTS` if a previous one has succeeded.",
@@ -2109,25 +2225,24 @@
"id": "ListCourseAliasesResponse"
},
"ListGuardianInvitationsResponse": {
+ "description": "Response when listing guardian invitations.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
+ },
"guardianInvitations": {
"description": "Guardian invitations that matched the list request.",
"items": {
"$ref": "GuardianInvitation"
},
"type": "array"
- },
- "nextPageToken": {
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
- "type": "string"
}
},
- "id": "ListGuardianInvitationsResponse",
- "description": "Response when listing guardian invitations."
+ "id": "ListGuardianInvitationsResponse"
},
"IndividualStudentsOptions": {
- "id": "IndividualStudentsOptions",
"description": "Assignee details about a coursework/announcement.\nThis field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.",
"type": "object",
"properties": {
@@ -2138,7 +2253,8 @@
},
"type": "array"
}
- }
+ },
+ "id": "IndividualStudentsOptions"
},
"MultipleChoiceSubmission": {
"description": "Student work for a multiple-choice question.",
@@ -2155,22 +2271,22 @@
"description": "An instruction to Classroom to send notifications from the `feed` to the\nprovided `destination`.",
"type": "object",
"properties": {
+ "registrationId": {
+ "description": "A server-generated unique identifier for this `Registration`.\n\nRead-only.",
+ "type": "string"
+ },
"expiryTime": {
- "type": "string",
"format": "google-datetime",
- "description": "The time until which the `Registration` is effective.\n\nThis is a read-only field assigned by the server."
+ "description": "The time until which the `Registration` is effective.\n\nThis is a read-only field assigned by the server.",
+ "type": "string"
},
"cloudPubsubTopic": {
- "$ref": "CloudPubsubTopic",
- "description": "The Cloud Pub/Sub topic that notifications are to be sent to."
+ "description": "The Cloud Pub/Sub topic that notifications are to be sent to.",
+ "$ref": "CloudPubsubTopic"
},
"feed": {
"description": "Specification for the class of notifications that Classroom should deliver\nto the `destination`.",
"$ref": "Feed"
- },
- "registrationId": {
- "type": "string",
- "description": "A server-generated unique identifier for this `Registration`.\n\nRead-only."
}
},
"id": "Registration"
@@ -2188,18 +2304,17 @@
"$ref": "DriveFile"
},
"form": {
- "description": "Google Forms attachment.",
- "$ref": "Form"
+ "$ref": "Form",
+ "description": "Google Forms attachment."
},
"link": {
- "$ref": "Link",
- "description": "Link atatchment."
+ "description": "Link atatchment.",
+ "$ref": "Link"
}
},
"id": "CourseMaterial"
},
"MultipleChoiceQuestion": {
- "id": "MultipleChoiceQuestion",
"description": "Additional details for multiple-choice questions.",
"type": "object",
"properties": {
@@ -2210,16 +2325,13 @@
},
"type": "array"
}
- }
+ },
+ "id": "MultipleChoiceQuestion"
},
"Course": {
"description": "A Course in Classroom.",
"type": "object",
"properties": {
- "guardiansEnabled": {
- "description": "Whether or not guardian notifications are enabled for this course.\n\nRead-only.",
- "type": "boolean"
- },
"ownerId": {
"description": "The identifier of the owner of a course.\n\nWhen specified as a parameter of a\ncreate course request, this\nfield is required.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n\nThis must be set in a create request. Admins can also specify this field\nin a patch course request to\ntransfer ownership. In other contexts, it is read-only.",
"type": "string"
@@ -2274,8 +2386,8 @@
"type": "string"
},
"room": {
- "type": "string",
- "description": "Optional room location.\nFor example, \"301\".\nIf set, this field must be a valid UTF-8 string and no longer than 650\ncharacters."
+ "description": "Optional room location.\nFor example, \"301\".\nIf set, this field must be a valid UTF-8 string and no longer than 650\ncharacters.",
+ "type": "string"
},
"courseGroupEmail": {
"description": "The email address of a Google group containing all members of the course.\nThis group does not accept email and can only be used for permissions.\n\nRead-only.",
@@ -2306,8 +2418,12 @@
"type": "string"
},
"alternateLink": {
- "type": "string",
- "description": "Absolute link to this course in the Classroom web UI.\n\nRead-only."
+ "description": "Absolute link to this course in the Classroom web UI.\n\nRead-only.",
+ "type": "string"
+ },
+ "guardiansEnabled": {
+ "description": "Whether or not guardian notifications are enabled for this course.\n\nRead-only.",
+ "type": "boolean"
}
},
"id": "Course"
@@ -2316,6 +2432,14 @@
"description": "Representation of a Google Drive file.",
"type": "object",
"properties": {
+ "thumbnailUrl": {
+ "description": "URL of a thumbnail image of the Drive item.\n\nRead-only.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Drive API resource ID.",
+ "type": "string"
+ },
"title": {
"description": "Title of the Drive item.\n\nRead-only.",
"type": "string"
@@ -2323,14 +2447,6 @@
"alternateLink": {
"description": "URL that can be used to access the Drive item.\n\nRead-only.",
"type": "string"
- },
- "thumbnailUrl": {
- "type": "string",
- "description": "URL of a thumbnail image of the Drive item.\n\nRead-only."
- },
- "id": {
- "description": "Drive API resource ID.",
- "type": "string"
}
},
"id": "DriveFile"
@@ -2362,115 +2478,13 @@
"description": "Course work created by a teacher for students of the course.",
"type": "object",
"properties": {
- "creationTime": {
- "format": "google-datetime",
- "description": "Timestamp when this course work was created.\n\nRead-only.",
- "type": "string"
- },
- "dueDate": {
- "description": "Optional date, in UTC, that submissions for this this course work are due.\nThis must be specified if `due_time` is specified.",
- "$ref": "Date"
- },
- "individualStudentsOptions": {
- "description": "Identifiers of students with access to the coursework.\nThis field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.\nIf the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students\nspecified in this field will be assigned the coursework.",
- "$ref": "IndividualStudentsOptions"
- },
- "creatorUserId": {
- "description": "Identifier for the user that created the coursework.\n\nRead-only.",
- "type": "string"
- },
- "state": {
- "enumDescriptions": [
- "No state specified. This is never returned.",
- "Status for work that has been published.\nThis is the default state.",
- "Status for work that is not yet published.\nWork in this state is visible only to course teachers and domain\nadministrators.",
- "Status for work that was published but is now deleted.\nWork in this state is visible only to course teachers and domain\nadministrators.\nWork in this state is deleted after some time."
- ],
- "enum": [
- "COURSE_WORK_STATE_UNSPECIFIED",
- "PUBLISHED",
- "DRAFT",
- "DELETED"
- ],
- "description": "Status of this course work.\nIf unspecified, the default state is `DRAFT`.",
- "type": "string"
- },
- "submissionModificationMode": {
- "type": "string",
- "enumDescriptions": [
- "No modification mode specified. This is never returned.",
- "Submisisons can be modified before being turned in.",
- "Submisisons can be modified at any time."
- ],
- "enum": [
- "SUBMISSION_MODIFICATION_MODE_UNSPECIFIED",
- "MODIFIABLE_UNTIL_TURNED_IN",
- "MODIFIABLE"
- ],
- "description": "Setting to determine when students are allowed to modify submissions.\nIf unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`."
- },
- "courseId": {
- "description": "Identifier of the course.\n\nRead-only.",
- "type": "string"
- },
- "id": {
- "type": "string",
- "description": "Classroom-assigned identifier of this course work, unique per course.\n\nRead-only."
- },
- "dueTime": {
- "$ref": "TimeOfDay",
- "description": "Optional time of day, in UTC, that submissions for this this course work\nare due.\nThis must be specified if `due_date` is specified."
- },
- "title": {
- "description": "Title of this course work.\nThe title must be a valid UTF-8 string containing between 1 and 3000\ncharacters.",
- "type": "string"
- },
- "associatedWithDeveloper": {
- "type": "boolean",
- "description": "Whether this course work item is associated with the Developer Console\nproject making the request.\n\nSee google.classroom.Work.CreateCourseWork for more\ndetails.\n\nRead-only."
- },
- "materials": {
- "description": "Additional materials.\n\nCourseWork must have no more than 20 material items.",
- "items": {
- "$ref": "Material"
- },
- "type": "array"
- },
- "updateTime": {
- "format": "google-datetime",
- "description": "Timestamp of the most recent change to this course work.\n\nRead-only.",
- "type": "string"
- },
- "assigneeMode": {
- "description": "Assignee mode of the coursework.\nIf unspecified, the default value is `ALL_STUDENTS`.",
- "type": "string",
- "enumDescriptions": [
- "No mode specified. This is never returned.",
- "All students can see the item.\nThis is the default state.",
- "A subset of the students can see the item."
- ],
- "enum": [
- "ASSIGNEE_MODE_UNSPECIFIED",
- "ALL_STUDENTS",
- "INDIVIDUAL_STUDENTS"
- ]
- },
- "alternateLink": {
- "type": "string",
- "description": "Absolute link to this course work in the Classroom web UI.\nThis is only populated if `state` is `PUBLISHED`.\n\nRead-only."
- },
- "maxPoints": {
- "type": "number",
- "format": "double",
- "description": "Maximum grade for this course work.\nIf zero or unspecified, this assignment is considered ungraded.\nThis must be a non-negative integer value."
- },
"multipleChoiceQuestion": {
"description": "Multiple choice question details.\nFor read operations, this field is populated only when `work_type` is\n`MULTIPLE_CHOICE_QUESTION`.\nFor write operations, this field must be specified when creating course\nwork with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be\nset otherwise.",
"$ref": "MultipleChoiceQuestion"
},
"assignment": {
- "description": "Assignment details.\nThis is populated only when `work_type` is `ASSIGNMENT`.\n\nRead-only.",
- "$ref": "Assignment"
+ "$ref": "Assignment",
+ "description": "Assignment details.\nThis is populated only when `work_type` is `ASSIGNMENT`.\n\nRead-only."
},
"workType": {
"description": "Type of this course work.\n\nThe type is set when the course work is created and cannot be changed.",
@@ -2488,20 +2502,128 @@
"MULTIPLE_CHOICE_QUESTION"
]
},
- "description": {
- "description": "Optional description of this course work.\nIf set, the description must be a valid UTF-8 string containing no more\nthan 30,000 characters.",
- "type": "string"
- },
"scheduledTime": {
"format": "google-datetime",
"description": "Optional timestamp when this course work is scheduled to be published.",
"type": "string"
+ },
+ "description": {
+ "description": "Optional description of this course work.\nIf set, the description must be a valid UTF-8 string containing no more\nthan 30,000 characters.",
+ "type": "string"
+ },
+ "creationTime": {
+ "format": "google-datetime",
+ "description": "Timestamp when this course work was created.\n\nRead-only.",
+ "type": "string"
+ },
+ "creatorUserId": {
+ "description": "Identifier for the user that created the coursework.\n\nRead-only.",
+ "type": "string"
+ },
+ "individualStudentsOptions": {
+ "$ref": "IndividualStudentsOptions",
+ "description": "Identifiers of students with access to the coursework.\nThis field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.\nIf the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students\nspecified in this field will be assigned the coursework."
+ },
+ "dueDate": {
+ "description": "Optional date, in UTC, that submissions for this this course work are due.\nThis must be specified if `due_time` is specified.",
+ "$ref": "Date"
+ },
+ "submissionModificationMode": {
+ "description": "Setting to determine when students are allowed to modify submissions.\nIf unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.",
+ "type": "string",
+ "enumDescriptions": [
+ "No modification mode specified. This is never returned.",
+ "Submisisons can be modified before being turned in.",
+ "Submisisons can be modified at any time."
+ ],
+ "enum": [
+ "SUBMISSION_MODIFICATION_MODE_UNSPECIFIED",
+ "MODIFIABLE_UNTIL_TURNED_IN",
+ "MODIFIABLE"
+ ]
+ },
+ "state": {
+ "description": "Status of this course work.\nIf unspecified, the default state is `DRAFT`.",
+ "type": "string",
+ "enumDescriptions": [
+ "No state specified. This is never returned.",
+ "Status for work that has been published.\nThis is the default state.",
+ "Status for work that is not yet published.\nWork in this state is visible only to course teachers and domain\nadministrators.",
+ "Status for work that was published but is now deleted.\nWork in this state is visible only to course teachers and domain\nadministrators.\nWork in this state is deleted after some time."
+ ],
+ "enum": [
+ "COURSE_WORK_STATE_UNSPECIFIED",
+ "PUBLISHED",
+ "DRAFT",
+ "DELETED"
+ ]
+ },
+ "courseId": {
+ "description": "Identifier of the course.\n\nRead-only.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Classroom-assigned identifier of this course work, unique per course.\n\nRead-only.",
+ "type": "string"
+ },
+ "dueTime": {
+ "$ref": "TimeOfDay",
+ "description": "Optional time of day, in UTC, that submissions for this this course work\nare due.\nThis must be specified if `due_date` is specified."
+ },
+ "title": {
+ "description": "Title of this course work.\nThe title must be a valid UTF-8 string containing between 1 and 3000\ncharacters.",
+ "type": "string"
+ },
+ "associatedWithDeveloper": {
+ "description": "Whether this course work item is associated with the Developer Console\nproject making the request.\n\nSee google.classroom.Work.CreateCourseWork for more\ndetails.\n\nRead-only.",
+ "type": "boolean"
+ },
+ "materials": {
+ "description": "Additional materials.\n\nCourseWork must have no more than 20 material items.",
+ "items": {
+ "$ref": "Material"
+ },
+ "type": "array"
+ },
+ "updateTime": {
+ "format": "google-datetime",
+ "description": "Timestamp of the most recent change to this course work.\n\nRead-only.",
+ "type": "string"
+ },
+ "alternateLink": {
+ "description": "Absolute link to this course work in the Classroom web UI.\nThis is only populated if `state` is `PUBLISHED`.\n\nRead-only.",
+ "type": "string"
+ },
+ "assigneeMode": {
+ "enumDescriptions": [
+ "No mode specified. This is never returned.",
+ "All students can see the item.\nThis is the default state.",
+ "A subset of the students can see the item."
+ ],
+ "enum": [
+ "ASSIGNEE_MODE_UNSPECIFIED",
+ "ALL_STUDENTS",
+ "INDIVIDUAL_STUDENTS"
+ ],
+ "description": "Assignee mode of the coursework.\nIf unspecified, the default value is `ALL_STUDENTS`.",
+ "type": "string"
+ },
+ "maxPoints": {
+ "format": "double",
+ "description": "Maximum grade for this course work.\nIf zero or unspecified, this assignment is considered ungraded.\nThis must be a non-negative integer value.",
+ "type": "number"
}
},
"id": "CourseWork"
},
"Guardian": {
+ "description": "Association between a student and a guardian of that student. The guardian\nmay receive information about the student's course work.",
+ "type": "object",
"properties": {
+ "studentId": {
+ "description": "Identifier for the student to whom the guardian relationship applies.",
+ "type": "string"
+ },
"invitedEmailAddress": {
"description": "The email address to which the initial guardian invitation was sent.\nThis field is only visible to domain administrators.",
"type": "string"
@@ -2513,15 +2635,9 @@
"guardianProfile": {
"$ref": "UserProfile",
"description": "User profile for the guardian."
- },
- "studentId": {
- "description": "Identifier for the student to whom the guardian relationship applies.",
- "type": "string"
}
},
- "id": "Guardian",
- "description": "Association between a student and a guardian of that student. The guardian\nmay receive information about the student's course work.",
- "type": "object"
+ "id": "Guardian"
},
"ListStudentsResponse": {
"description": "Response when listing students.",
@@ -2545,21 +2661,13 @@
"description": "Global information for a user.",
"type": "object",
"properties": {
- "id": {
- "description": "Identifier of the user.\n\nRead-only.",
- "type": "string"
- },
- "verifiedTeacher": {
- "description": "Represents whether a G Suite for Education user's domain administrator has\nexplicitly verified them as being a teacher. If the user is not a member of\na G Suite for Education domain, than this field will always be false.\n\nRead-only",
- "type": "boolean"
- },
"emailAddress": {
"description": "Email address of the user.\n\nRead-only.",
"type": "string"
},
"photoUrl": {
- "type": "string",
- "description": "URL of user's profile photo.\n\nRead-only."
+ "description": "URL of user's profile photo.\n\nRead-only.",
+ "type": "string"
},
"permissions": {
"description": "Global permissions of the user.\n\nRead-only.",
@@ -2569,8 +2677,16 @@
"type": "array"
},
"name": {
- "description": "Name of the user.\n\nRead-only.",
- "$ref": "Name"
+ "$ref": "Name",
+ "description": "Name of the user.\n\nRead-only."
+ },
+ "id": {
+ "description": "Identifier of the user.\n\nRead-only.",
+ "type": "string"
+ },
+ "verifiedTeacher": {
+ "description": "Represents whether a G Suite for Education user's domain administrator has\nexplicitly verified them as being a teacher. If the user is not a member of\na G Suite for Education domain, than this field will always be false.\n\nRead-only",
+ "type": "boolean"
}
},
"id": "UserProfile"
@@ -2580,20 +2696,14 @@
"type": "object",
"properties": {
"individualStudentsOptions": {
- "$ref": "IndividualStudentsOptions",
- "description": "Identifiers of students with access to the announcement.\nThis field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.\nIf the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this\nfield will be able to see the announcement."
+ "description": "Identifiers of students with access to the announcement.\nThis field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.\nIf the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this\nfield will be able to see the announcement.",
+ "$ref": "IndividualStudentsOptions"
},
"creatorUserId": {
"description": "Identifier for the user that created the announcement.\n\nRead-only.",
"type": "string"
},
"state": {
- "enum": [
- "ANNOUNCEMENT_STATE_UNSPECIFIED",
- "PUBLISHED",
- "DRAFT",
- "DELETED"
- ],
"description": "Status of this announcement.\nIf unspecified, the default state is `DRAFT`.",
"type": "string",
"enumDescriptions": [
@@ -2601,6 +2711,12 @@
"Status for announcement that has been published.\nThis is the default state.",
"Status for an announcement that is not yet published.\nAnnouncement in this state is visible only to course teachers and domain\nadministrators.",
"Status for announcement that was published but is now deleted.\nAnnouncement in this state is visible only to course teachers and domain\nadministrators.\nAnnouncement in this state is deleted after some time."
+ ],
+ "enum": [
+ "ANNOUNCEMENT_STATE_UNSPECIFIED",
+ "PUBLISHED",
+ "DRAFT",
+ "DELETED"
]
},
"text": {
@@ -2627,6 +2743,10 @@
"description": "Timestamp of the most recent change to this announcement.\n\nRead-only.",
"type": "string"
},
+ "alternateLink": {
+ "description": "Absolute link to this announcement in the Classroom web UI.\nThis is only populated if `state` is `PUBLISHED`.\n\nRead-only.",
+ "type": "string"
+ },
"assigneeMode": {
"enumDescriptions": [
"No mode specified. This is never returned.",
@@ -2641,10 +2761,6 @@
"description": "Assignee mode of the announcement.\nIf unspecified, the default value is `ALL_STUDENTS`.",
"type": "string"
},
- "alternateLink": {
- "description": "Absolute link to this announcement in the Classroom web UI.\nThis is only populated if `state` is `PUBLISHED`.\n\nRead-only.",
- "type": "string"
- },
"scheduledTime": {
"format": "google-datetime",
"description": "Optional timestamp when this announcement is scheduled to be published.",
@@ -2659,6 +2775,8 @@
"id": "Announcement"
},
"ModifyIndividualStudentsOptions": {
+ "description": "Contains fields to add or remove students from a course work or announcement\nwhere the `assigneeMode` is set to `INDIVIDUAL_STUDENTS`.",
+ "type": "object",
"properties": {
"addStudentIds": {
"description": "Ids of students to be added as having access to this\ncoursework/announcement.",
@@ -2675,11 +2793,11 @@
"type": "array"
}
},
- "id": "ModifyIndividualStudentsOptions",
- "description": "Contains fields to add or remove students from a course work or announcement\nwhere the `assigneeMode` is set to `INDIVIDUAL_STUDENTS`.",
- "type": "object"
+ "id": "ModifyIndividualStudentsOptions"
},
"DriveFolder": {
+ "description": "Representation of a Google Drive folder.",
+ "type": "object",
"properties": {
"id": {
"description": "Drive API resource ID.",
@@ -2690,61 +2808,105 @@
"type": "string"
},
"alternateLink": {
- "type": "string",
- "description": "URL that can be used to access the Drive folder.\n\nRead-only."
+ "description": "URL that can be used to access the Drive folder.\n\nRead-only.",
+ "type": "string"
}
},
- "id": "DriveFolder",
- "description": "Representation of a Google Drive folder.",
- "type": "object"
+ "id": "DriveFolder"
},
"SubmissionHistory": {
"description": "The history of the submission. This currently includes state and grade\nhistories.",
"type": "object",
"properties": {
"gradeHistory": {
- "$ref": "GradeHistory",
- "description": "The grade history information of the submission, if present."
+ "description": "The grade history information of the submission, if present.",
+ "$ref": "GradeHistory"
},
"stateHistory": {
- "$ref": "StateHistory",
- "description": "The state history information of the submission, if present."
+ "description": "The state history information of the submission, if present.",
+ "$ref": "StateHistory"
}
},
"id": "SubmissionHistory"
},
"ShortAnswerSubmission": {
- "id": "ShortAnswerSubmission",
"description": "Student work for a short answer question.",
"type": "object",
"properties": {
"answer": {
- "type": "string",
- "description": "Student response to a short-answer question."
+ "description": "Student response to a short-answer question.",
+ "type": "string"
}
- }
+ },
+ "id": "ShortAnswerSubmission"
},
"ListStudentSubmissionsResponse": {
+ "description": "Response when listing student submissions.",
"type": "object",
"properties": {
"nextPageToken": {
- "type": "string",
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available."
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
},
"studentSubmissions": {
+ "description": "Student work that matches the request.",
"items": {
"$ref": "StudentSubmission"
},
- "type": "array",
- "description": "Student work that matches the request."
+ "type": "array"
}
},
- "id": "ListStudentSubmissionsResponse",
- "description": "Response when listing student submissions."
+ "id": "ListStudentSubmissionsResponse"
},
"StudentSubmission": {
+ "description": "Student submission for course work.\n\nStudentSubmission items are generated when a CourseWork item is created.\n\nStudentSubmissions that have never been accessed (i.e. with `state` = NEW)\nmay not have a creation time or update time.",
"type": "object",
"properties": {
+ "courseWorkId": {
+ "description": "Identifier for the course work this corresponds to.\n\nRead-only.",
+ "type": "string"
+ },
+ "courseId": {
+ "description": "Identifier of the course.\n\nRead-only.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Classroom-assigned Identifier for the student submission.\nThis is unique among submissions for the relevant course work.\n\nRead-only.",
+ "type": "string"
+ },
+ "submissionHistory": {
+ "description": "The history of the submission (includes state and grade histories).\n\nRead-only.",
+ "items": {
+ "$ref": "SubmissionHistory"
+ },
+ "type": "array"
+ },
+ "assignedGrade": {
+ "format": "double",
+ "description": "Optional grade. If unset, no grade was set.\nThis value must be non-negative. Decimal (i.e. non-integer) values are\nallowed, but will be rounded to two decimal places.\n\nThis may be modified only by course teachers.",
+ "type": "number"
+ },
+ "multipleChoiceSubmission": {
+ "description": "Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION.",
+ "$ref": "MultipleChoiceSubmission"
+ },
+ "assignmentSubmission": {
+ "description": "Submission content when course_work_type is ASSIGNMENT.\n\nStudents can modify this content using\ngoogle.classroom.Work.ModifyAttachments.",
+ "$ref": "AssignmentSubmission"
+ },
+ "shortAnswerSubmission": {
+ "$ref": "ShortAnswerSubmission",
+ "description": "Submission content when course_work_type is SHORT_ANSWER_QUESTION."
+ },
+ "associatedWithDeveloper": {
+ "description": "Whether this student submission is associated with the Developer Console\nproject making the request.\n\nSee google.classroom.Work.CreateCourseWork for more\ndetails.\n\nRead-only.",
+ "type": "boolean"
+ },
+ "updateTime": {
+ "format": "google-datetime",
+ "description": "Last update time of this submission.\nThis may be unset if the student has not accessed this item.\n\nRead-only.",
+ "type": "string"
+ },
"alternateLink": {
"description": "Absolute link to the submission in the Classroom web UI.\n\nRead-only.",
"type": "string"
@@ -2754,13 +2916,11 @@
"type": "boolean"
},
"draftGrade": {
- "type": "number",
"format": "double",
- "description": "Optional pending grade. If unset, no grade was set.\nThis value must be non-negative. Decimal (i.e. non-integer) values are\nallowed, but will be rounded to two decimal places.\n\nThis is only visible to and modifiable by course teachers."
+ "description": "Optional pending grade. If unset, no grade was set.\nThis value must be non-negative. Decimal (i.e. non-integer) values are\nallowed, but will be rounded to two decimal places.\n\nThis is only visible to and modifiable by course teachers.",
+ "type": "number"
},
"courseWorkType": {
- "description": "Type of course work this submission is for.\n\nRead-only.",
- "type": "string",
"enumDescriptions": [
"No work type specified. This is never returned.",
"An assignment.",
@@ -2772,7 +2932,9 @@
"ASSIGNMENT",
"SHORT_ANSWER_QUESTION",
"MULTIPLE_CHOICE_QUESTION"
- ]
+ ],
+ "description": "Type of course work this submission is for.\n\nRead-only.",
+ "type": "string"
},
"creationTime": {
"format": "google-datetime",
@@ -2780,6 +2942,8 @@
"type": "string"
},
"state": {
+ "description": "State of this submission.\n\nRead-only.",
+ "type": "string",
"enumDescriptions": [
"No state specified. This should never be returned.",
"The student has never accessed this submission. Attachments are not\nreturned and timestamps is not set.",
@@ -2795,64 +2959,17 @@
"TURNED_IN",
"RETURNED",
"RECLAIMED_BY_STUDENT"
- ],
- "description": "State of this submission.\n\nRead-only.",
- "type": "string"
+ ]
},
"userId": {
"description": "Identifier for the student that owns this submission.\n\nRead-only.",
"type": "string"
- },
- "courseWorkId": {
- "description": "Identifier for the course work this corresponds to.\n\nRead-only.",
- "type": "string"
- },
- "courseId": {
- "type": "string",
- "description": "Identifier of the course.\n\nRead-only."
- },
- "id": {
- "type": "string",
- "description": "Classroom-assigned Identifier for the student submission.\nThis is unique among submissions for the relevant course work.\n\nRead-only."
- },
- "submissionHistory": {
- "items": {
- "$ref": "SubmissionHistory"
- },
- "type": "array",
- "description": "The history of the submission (includes state and grade histories).\n\nRead-only."
- },
- "assignedGrade": {
- "format": "double",
- "description": "Optional grade. If unset, no grade was set.\nThis value must be non-negative. Decimal (i.e. non-integer) values are\nallowed, but will be rounded to two decimal places.\n\nThis may be modified only by course teachers.",
- "type": "number"
- },
- "multipleChoiceSubmission": {
- "$ref": "MultipleChoiceSubmission",
- "description": "Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION."
- },
- "assignmentSubmission": {
- "$ref": "AssignmentSubmission",
- "description": "Submission content when course_work_type is ASSIGNMENT.\n\nStudents can modify this content using\ngoogle.classroom.Work.ModifyAttachments."
- },
- "shortAnswerSubmission": {
- "$ref": "ShortAnswerSubmission",
- "description": "Submission content when course_work_type is SHORT_ANSWER_QUESTION."
- },
- "associatedWithDeveloper": {
- "description": "Whether this student submission is associated with the Developer Console\nproject making the request.\n\nSee google.classroom.Work.CreateCourseWork for more\ndetails.\n\nRead-only.",
- "type": "boolean"
- },
- "updateTime": {
- "format": "google-datetime",
- "description": "Last update time of this submission.\nThis may be unset if the student has not accessed this item.\n\nRead-only.",
- "type": "string"
}
},
- "id": "StudentSubmission",
- "description": "Student submission for course work.\n\nStudentSubmission items are generated when a CourseWork item is created.\n\nStudentSubmissions that have never been accessed (i.e. with `state` = NEW)\nmay not have a creation time or update time."
+ "id": "StudentSubmission"
},
"ModifyAttachmentsRequest": {
+ "description": "Request to modify the attachments of a student submission.",
"type": "object",
"properties": {
"addAttachments": {
@@ -2863,17 +2980,12 @@
"type": "array"
}
},
- "id": "ModifyAttachmentsRequest",
- "description": "Request to modify the attachments of a student submission."
+ "id": "ModifyAttachmentsRequest"
},
"YouTubeVideo": {
"description": "YouTube video item.",
"type": "object",
"properties": {
- "id": {
- "description": "YouTube API resource ID.",
- "type": "string"
- },
"title": {
"description": "Title of the YouTube video.\n\nRead-only.",
"type": "string"
@@ -2883,8 +2995,12 @@
"type": "string"
},
"thumbnailUrl": {
- "type": "string",
- "description": "URL of a thumbnail image of the YouTube video.\n\nRead-only."
+ "description": "URL of a thumbnail image of the YouTube video.\n\nRead-only.",
+ "type": "string"
+ },
+ "id": {
+ "description": "YouTube API resource ID.",
+ "type": "string"
}
},
"id": "YouTubeVideo"
@@ -2894,8 +3010,8 @@
"type": "object",
"properties": {
"nextPageToken": {
- "type": "string",
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available."
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
},
"invitations": {
"description": "Invitations that match the list request.",
@@ -2919,22 +3035,25 @@
"id": "CloudPubsubTopic"
},
"GuardianInvitation": {
- "id": "GuardianInvitation",
"description": "An invitation to become the guardian of a specified user, sent to a specified\nemail address.",
"type": "object",
"properties": {
+ "invitationId": {
+ "description": "Unique identifier for this invitation.\n\nRead-only.",
+ "type": "string"
+ },
"state": {
- "enum": [
- "GUARDIAN_INVITATION_STATE_UNSPECIFIED",
- "PENDING",
- "COMPLETE"
- ],
"description": "The state that this invitation is in.",
"type": "string",
"enumDescriptions": [
"Should never be returned.",
"The invitation is active and awaiting a response.",
"The invitation is no longer active. It may have been accepted, declined,\nwithdrawn or it may have expired."
+ ],
+ "enum": [
+ "GUARDIAN_INVITATION_STATE_UNSPECIFIED",
+ "PENDING",
+ "COMPLETE"
]
},
"studentId": {
@@ -2949,27 +3068,26 @@
"format": "google-datetime",
"description": "The time that this invitation was created.\n\nRead-only.",
"type": "string"
- },
- "invitationId": {
- "type": "string",
- "description": "Unique identifier for this invitation.\n\nRead-only."
}
- }
+ },
+ "id": "GuardianInvitation"
},
"StateHistory": {
"description": "The history of each state this submission has been in.",
"type": "object",
"properties": {
"stateTimestamp": {
- "type": "string",
"format": "google-datetime",
- "description": "When the submission entered this state."
+ "description": "When the submission entered this state.",
+ "type": "string"
},
"actorUserId": {
"description": "The teacher or student who made the change",
"type": "string"
},
"state": {
+ "description": "The workflow pipeline stage.",
+ "type": "string",
"enumDescriptions": [
"No state specified. This should never be returned.",
"The Submission has been created.",
@@ -2985,14 +3103,13 @@
"RETURNED",
"RECLAIMED_BY_STUDENT",
"STUDENT_EDITED_AFTER_TURN_IN"
- ],
- "description": "The workflow pipeline stage.",
- "type": "string"
+ ]
}
},
"id": "StateHistory"
},
"CourseMaterialSet": {
+ "description": "A set of materials that appears on the \"About\" page of the course.\nThese materials might include a syllabus, schedule, or other background\ninformation relating to the course as a whole.",
"type": "object",
"properties": {
"materials": {
@@ -3007,14 +3124,15 @@
"type": "string"
}
},
- "id": "CourseMaterialSet",
- "description": "A set of materials that appears on the \"About\" page of the course.\nThese materials might include a syllabus, schedule, or other background\ninformation relating to the course as a whole."
+ "id": "CourseMaterialSet"
},
"ListTeachersResponse": {
+ "description": "Response when listing teachers.",
+ "type": "object",
"properties": {
"nextPageToken": {
- "type": "string",
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available."
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
},
"teachers": {
"description": "Teachers who match the list request.",
@@ -3024,18 +3142,12 @@
"type": "array"
}
},
- "id": "ListTeachersResponse",
- "description": "Response when listing teachers.",
- "type": "object"
+ "id": "ListTeachersResponse"
},
"Link": {
"description": "URL item.",
"type": "object",
"properties": {
- "url": {
- "description": "URL to link to.\nThis must be a valid UTF-8 string containing between 1 and 2024 characters.",
- "type": "string"
- },
"title": {
"description": "Title of the target of the URL.\n\nRead-only.",
"type": "string"
@@ -3043,6 +3155,10 @@
"thumbnailUrl": {
"description": "URL of a thumbnail image of the target URL.\n\nRead-only.",
"type": "string"
+ },
+ "url": {
+ "description": "URL to link to.\nThis must be a valid UTF-8 string containing between 1 and 2024 characters.",
+ "type": "string"
}
},
"id": "Link"
@@ -3051,20 +3167,20 @@
"description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
"type": "object",
"properties": {
- "month": {
- "format": "int32",
- "description": "Month of year. Must be from 1 to 12.",
- "type": "integer"
- },
"day": {
"format": "int32",
"description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.",
"type": "integer"
},
"year": {
- "type": "integer",
"format": "int32",
- "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year."
+ "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
+ "type": "integer"
+ },
+ "month": {
+ "format": "int32",
+ "description": "Month of year. Must be from 1 to 12.",
+ "type": "integer"
}
},
"id": "Date"
@@ -3089,17 +3205,18 @@
"id": "Name"
},
"Assignment": {
+ "description": "Additional details for assignments.",
+ "type": "object",
"properties": {
"studentWorkFolder": {
- "$ref": "DriveFolder",
- "description": "Drive folder where attachments from student submissions are placed.\nThis is only populated for course teachers and administrators."
+ "description": "Drive folder where attachments from student submissions are placed.\nThis is only populated for course teachers and administrators.",
+ "$ref": "DriveFolder"
}
},
- "id": "Assignment",
- "description": "Additional details for assignments.",
- "type": "object"
+ "id": "Assignment"
},
"SharedDriveFile": {
+ "description": "Drive file that is used as material for course work.",
"type": "object",
"properties": {
"shareMode": {
@@ -3123,8 +3240,7 @@
"description": "Drive file details."
}
},
- "id": "SharedDriveFile",
- "description": "Drive file that is used as material for course work."
+ "id": "SharedDriveFile"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
@@ -3158,23 +3274,23 @@
"id": "ModifyAnnouncementAssigneesRequest"
},
"GlobalPermission": {
+ "description": "Global user permission description.",
"type": "object",
"properties": {
"permission": {
+ "enumDescriptions": [
+ "No permission is specified. This is not returned and is not a\nvalid value.",
+ "User is permitted to create a course."
+ ],
"enum": [
"PERMISSION_UNSPECIFIED",
"CREATE_COURSE"
],
"description": "Permission value.",
- "type": "string",
- "enumDescriptions": [
- "No permission is specified. This is not returned and is not a\nvalid value.",
- "User is permitted to create a course."
- ]
+ "type": "string"
}
},
- "id": "GlobalPermission",
- "description": "Global user permission description."
+ "id": "GlobalPermission"
},
"Teacher": {
"description": "Teacher of a course.",
@@ -3189,8 +3305,8 @@
"description": "Global user information for the teacher.\n\nRead-only."
},
"userId": {
- "type": "string",
- "description": "Identifier of the user.\n\nWhen specified as a parameter of a request, this identifier can be one of\nthe following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user"
+ "description": "Identifier of the user.\n\nWhen specified as a parameter of a request, this identifier can be one of\nthe following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "type": "string"
}
},
"id": "Teacher"
@@ -3199,11 +3315,22 @@
"description": "The history of each grade on this submission.",
"type": "object",
"properties": {
+ "pointsEarned": {
+ "format": "double",
+ "description": "The numerator of the grade at this time in the submission grade history.",
+ "type": "number"
+ },
"actorUserId": {
"description": "The teacher who made the grade change.",
"type": "string"
},
"gradeChangeType": {
+ "enumDescriptions": [
+ "No grade change type specified. This should never be returned.",
+ "A change in the numerator of the draft grade.",
+ "A change in the numerator of the assigned grade.",
+ "A change in the denominator of the grade."
+ ],
"enum": [
"UNKNOWN_GRADE_CHANGE_TYPE",
"DRAFT_GRADE_POINTS_EARNED_CHANGE",
@@ -3211,34 +3338,22 @@
"MAX_POINTS_CHANGE"
],
"description": "The type of grade change at this time in the submission grade history.",
- "type": "string",
- "enumDescriptions": [
- "No grade change type specified. This should never be returned.",
- "A change in the numerator of the draft grade.",
- "A change in the numerator of the assigned grade.",
- "A change in the denominator of the grade."
- ]
+ "type": "string"
},
"gradeTimestamp": {
- "type": "string",
"format": "google-datetime",
- "description": "When the grade of the submission was changed."
+ "description": "When the grade of the submission was changed.",
+ "type": "string"
},
"maxPoints": {
"format": "double",
"description": "The denominator of the grade at this time in the submission grade\nhistory.",
"type": "number"
- },
- "pointsEarned": {
- "format": "double",
- "description": "The numerator of the grade at this time in the submission grade history.",
- "type": "number"
}
},
"id": "GradeHistory"
},
"AssignmentSubmission": {
- "id": "AssignmentSubmission",
"description": "Student work for an assignment.",
"type": "object",
"properties": {
@@ -3249,137 +3364,8 @@
},
"type": "array"
}
- }
- },
- "Material": {
- "type": "object",
- "properties": {
- "link": {
- "$ref": "Link",
- "description": "Link material. On creation, will be upgraded to a more appropriate type\nif possible, and this will be reflected in the response."
- },
- "youtubeVideo": {
- "$ref": "YouTubeVideo",
- "description": "YouTube video material."
- },
- "driveFile": {
- "description": "Google Drive file material.",
- "$ref": "SharedDriveFile"
- },
- "form": {
- "$ref": "Form",
- "description": "Google Forms material."
- }
},
- "id": "Material",
- "description": "Material attached to course work.\n\nWhen creating attachments, setting the `form` field is not supported."
- },
- "Feed": {
- "description": "A class of notifications that an application can register to receive.\nFor example: \"all roster changes for a domain\".",
- "type": "object",
- "properties": {
- "courseRosterChangesInfo": {
- "$ref": "CourseRosterChangesInfo",
- "description": "Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`.\nThis field must be specified if `feed_type` is `COURSE_ROSTER_CHANGES`."
- },
- "feedType": {
- "enum": [
- "FEED_TYPE_UNSPECIFIED",
- "DOMAIN_ROSTER_CHANGES",
- "COURSE_ROSTER_CHANGES"
- ],
- "description": "The type of feed.",
- "type": "string",
- "enumDescriptions": [
- "Should never be returned or provided.",
- "All roster changes for a particular domain.\n\nNotifications will be generated whenever a user joins or leaves a course.\n\nNo notifications will be generated when an invitation is created or\ndeleted, but notifications will be generated when a user joins a course\nby accepting an invitation.",
- "All roster changes for a particular course.\n\nNotifications will be generated whenever a user joins or leaves a course.\n\nNo notifications will be generated when an invitation is created or\ndeleted, but notifications will be generated when a user joins a course\nby accepting an invitation."
- ]
- }
- },
- "id": "Feed"
- },
- "Student": {
- "description": "Student in a course.",
- "type": "object",
- "properties": {
- "userId": {
- "description": "Identifier of the user.\n\nWhen specified as a parameter of a request, this identifier can be one of\nthe following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "type": "string"
- },
- "courseId": {
- "description": "Identifier of the course.\n\nRead-only.",
- "type": "string"
- },
- "studentWorkFolder": {
- "description": "Information about a Drive Folder for this student's work in this course.\nOnly visible to the student and domain administrators.\n\nRead-only.",
- "$ref": "DriveFolder"
- },
- "profile": {
- "$ref": "UserProfile",
- "description": "Global user information for the student.\n\nRead-only."
- }
- },
- "id": "Student"
- },
- "Invitation": {
- "id": "Invitation",
- "description": "An invitation to join a course.",
- "type": "object",
- "properties": {
- "courseId": {
- "description": "Identifier of the course to invite the user to.",
- "type": "string"
- },
- "id": {
- "type": "string",
- "description": "Identifier assigned by Classroom.\n\nRead-only."
- },
- "role": {
- "enumDescriptions": [
- "No course role.",
- "Student in the course.",
- "Teacher of the course.",
- "Owner of the course."
- ],
- "enum": [
- "COURSE_ROLE_UNSPECIFIED",
- "STUDENT",
- "TEACHER",
- "OWNER"
- ],
- "description": "Role to invite the user to have.\nMust not be `COURSE_ROLE_UNSPECIFIED`.",
- "type": "string"
- },
- "userId": {
- "type": "string",
- "description": "Identifier of the invited user.\n\nWhen specified as a parameter of a request, this identifier can be set to\none of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user"
- }
- }
- },
- "TurnInStudentSubmissionRequest": {
- "id": "TurnInStudentSubmissionRequest",
- "description": "Request to turn in a student submission.",
- "type": "object",
- "properties": {}
- },
- "ListCourseWorkResponse": {
- "description": "Response when listing course work.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
- "type": "string"
- },
- "courseWork": {
- "description": "Course work items that match the request.",
- "items": {
- "$ref": "CourseWork"
- },
- "type": "array"
- }
- },
- "id": "ListCourseWorkResponse"
+ "id": "AssignmentSubmission"
}
},
"protocol": "rest",
@@ -3392,6 +3378,18 @@
"auth": {
"oauth2": {
"scopes": {
+ "https://www.googleapis.com/auth/classroom.coursework.me": {
+ "description": "Manage your course work and view your grades in Google Classroom"
+ },
+ "https://www.googleapis.com/auth/classroom.rosters": {
+ "description": "Manage your Google Classroom class rosters"
+ },
+ "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly": {
+ "description": "View course work and grades for students in the Google Classroom classes you teach or administer"
+ },
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly": {
+ "description": "View guardians for students in your Google Classroom classes"
+ },
"https://www.googleapis.com/auth/classroom.courses": {
"description": "Manage your Google Classroom classes"
},
@@ -3401,18 +3399,18 @@
"https://www.googleapis.com/auth/classroom.announcements": {
"description": "View and manage announcements in Google Classroom"
},
- "https://www.googleapis.com/auth/classroom.profile.photos": {
- "description": "View the profile photos of people in your classes"
- },
"https://www.googleapis.com/auth/classroom.rosters.readonly": {
"description": "View your Google Classroom class rosters"
},
- "https://www.googleapis.com/auth/classroom.guardianlinks.students": {
- "description": "View and manage guardians for students in your Google Classroom classes"
+ "https://www.googleapis.com/auth/classroom.profile.photos": {
+ "description": "View the profile photos of people in your classes"
},
"https://www.googleapis.com/auth/classroom.announcements.readonly": {
"description": "View announcements in Google Classroom"
},
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students": {
+ "description": "View and manage guardians for students in your Google Classroom classes"
+ },
"https://www.googleapis.com/auth/classroom.student-submissions.me.readonly": {
"description": "View your course work and grades in Google Classroom"
},
@@ -3430,20 +3428,22 @@
},
"https://www.googleapis.com/auth/classroom.profile.emails": {
"description": "View the email addresses of people in your classes"
- },
- "https://www.googleapis.com/auth/classroom.coursework.me": {
- "description": "Manage your course work and view your grades in Google Classroom"
- },
- "https://www.googleapis.com/auth/classroom.rosters": {
- "description": "Manage your Google Classroom class rosters"
- },
- "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly": {
- "description": "View course work and grades for students in the Google Classroom classes you teach or administer"
- },
- "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly": {
- "description": "View guardians for students in your Google Classroom classes"
}
}
}
- }
+ },
+ "kind": "discovery#restDescription",
+ "servicePath": "",
+ "description": "Manages classes, rosters, and invitations in Google Classroom.",
+ "rootUrl": "https://classroom.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "classroom",
+ "batchPath": "batch",
+ "id": "classroom:v1",
+ "documentationLink": "https://developers.google.com/classroom/",
+ "revision": "20171009",
+ "title": "Google Classroom API",
+ "discoveryVersion": "v1",
+ "ownerName": "Google"
}
diff --git a/cloudbuild/v1/cloudbuild-api.json b/cloudbuild/v1/cloudbuild-api.json
index 092abb8..3ad7048 100644
--- a/cloudbuild/v1/cloudbuild-api.json
+++ b/cloudbuild/v1/cloudbuild-api.json
@@ -1,44 +1,300 @@
{
- "ownerDomain": "google.com",
- "name": "cloudbuild",
- "batchPath": "batch",
- "title": "Google Cloud Container Builder API",
"ownerName": "Google",
"resources": {
+ "projects": {
+ "resources": {
+ "triggers": {
+ "methods": {
+ "create": {
+ "description": "Creates a new BuildTrigger.\n\nThis API is experimental.",
+ "request": {
+ "$ref": "BuildTrigger"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "BuildTrigger"
+ },
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "ID of the project for which to configure automatic builds.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/triggers",
+ "path": "v1/projects/{projectId}/triggers",
+ "id": "cloudbuild.projects.triggers.create"
+ },
+ "delete": {
+ "id": "cloudbuild.projects.triggers.delete",
+ "path": "v1/projects/{projectId}/triggers/{triggerId}",
+ "description": "Deletes an BuildTrigger by its project ID and trigger ID.\n\nThis API is experimental.",
+ "parameterOrder": [
+ "projectId",
+ "triggerId"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "httpMethod": "DELETE",
+ "parameters": {
+ "projectId": {
+ "description": "ID of the project that owns the trigger.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "triggerId": {
+ "location": "path",
+ "description": "ID of the BuildTrigger to delete.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/triggers/{triggerId}"
+ },
+ "patch": {
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "projectId",
+ "triggerId"
+ ],
+ "response": {
+ "$ref": "BuildTrigger"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "triggerId": {
+ "location": "path",
+ "description": "ID of the BuildTrigger to update.",
+ "type": "string",
+ "required": true
+ },
+ "projectId": {
+ "location": "path",
+ "description": "ID of the project that owns the trigger.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/triggers/{triggerId}",
+ "path": "v1/projects/{projectId}/triggers/{triggerId}",
+ "id": "cloudbuild.projects.triggers.patch",
+ "request": {
+ "$ref": "BuildTrigger"
+ },
+ "description": "Updates an BuildTrigger by its project ID and trigger ID.\n\nThis API is experimental."
+ },
+ "list": {
+ "description": "Lists existing BuildTrigger.\n\nThis API is experimental.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "ListBuildTriggersResponse"
+ },
+ "parameters": {
+ "projectId": {
+ "description": "ID of the project for which to list BuildTriggers.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/triggers",
+ "path": "v1/projects/{projectId}/triggers",
+ "id": "cloudbuild.projects.triggers.list"
+ },
+ "get": {
+ "description": "Gets information about a BuildTrigger.\n\nThis API is experimental.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId",
+ "triggerId"
+ ],
+ "response": {
+ "$ref": "BuildTrigger"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "triggerId": {
+ "location": "path",
+ "description": "ID of the BuildTrigger to get.",
+ "type": "string",
+ "required": true
+ },
+ "projectId": {
+ "location": "path",
+ "description": "ID of the project that owns the trigger.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/triggers/{triggerId}",
+ "path": "v1/projects/{projectId}/triggers/{triggerId}",
+ "id": "cloudbuild.projects.triggers.get"
+ }
+ }
+ },
+ "builds": {
+ "methods": {
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "projectId": {
+ "description": "ID of the project.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/builds",
+ "path": "v1/projects/{projectId}/builds",
+ "id": "cloudbuild.projects.builds.create",
+ "description": "Starts a build with the specified configuration.\n\nThe long-running Operation returned by this method will include the ID of\nthe build, which can be passed to GetBuild to determine its status (e.g.,\nsuccess or failure).",
+ "request": {
+ "$ref": "Build"
+ }
+ },
+ "cancel": {
+ "request": {
+ "$ref": "CancelBuildRequest"
+ },
+ "description": "Cancels a requested build in progress.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "id"
+ ],
+ "response": {
+ "$ref": "Build"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "id": {
+ "location": "path",
+ "description": "ID of the build.",
+ "type": "string",
+ "required": true
+ },
+ "projectId": {
+ "description": "ID of the project.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/builds/{id}:cancel",
+ "path": "v1/projects/{projectId}/builds/{id}:cancel",
+ "id": "cloudbuild.projects.builds.cancel"
+ },
+ "list": {
+ "id": "cloudbuild.projects.builds.list",
+ "path": "v1/projects/{projectId}/builds",
+ "description": "Lists previously requested builds.\n\nPreviously requested builds may still be in-progress, or may have finished\nsuccessfully or unsuccessfully.",
+ "response": {
+ "$ref": "ListBuildsResponse"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "filter": {
+ "description": "The raw filter text to constrain the results.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Token to provide to skip to a particular spot in the list.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Number of results to return in the list.",
+ "type": "integer",
+ "location": "query"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "ID of the project.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/builds"
+ },
+ "get": {
+ "description": "Returns information about a previously requested build.\n\nThe Build that is returned includes its status (e.g., success or failure,\nor in-progress), and timing information.",
+ "response": {
+ "$ref": "Build"
+ },
+ "parameterOrder": [
+ "projectId",
+ "id"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "ID of the project.",
+ "type": "string",
+ "required": true
+ },
+ "id": {
+ "description": "ID of the build.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/builds/{id}",
+ "id": "cloudbuild.projects.builds.get",
+ "path": "v1/projects/{projectId}/builds/{id}"
+ }
+ }
+ }
+ }
+ },
"operations": {
"methods": {
- "cancel": {
- "request": {
- "$ref": "CancelOperationRequest"
- },
- "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "type": "string",
- "required": true,
- "pattern": "^operations/.+$",
- "location": "path",
- "description": "The name of the operation resource to be cancelled."
- }
- },
- "flatPath": "v1/operations/{operationsId}:cancel",
- "path": "v1/{+name}:cancel",
- "id": "cloudbuild.operations.cancel"
- },
"get": {
- "id": "cloudbuild.operations.get",
- "path": "v1/{+name}",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
"response": {
"$ref": "Operation"
},
@@ -58,10 +314,12 @@
"location": "path"
}
},
- "flatPath": "v1/operations/{operationsId}"
+ "flatPath": "v1/operations/{operationsId}",
+ "id": "cloudbuild.operations.get",
+ "path": "v1/{+name}",
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
},
"list": {
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
"response": {
"$ref": "ListOperationsResponse"
},
@@ -69,11 +327,20 @@
"name"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
+ "pageSize": {
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer",
+ "location": "query"
+ },
"filter": {
- "location": "query",
"description": "The standard list filter.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageToken": {
"location": "query",
@@ -81,397 +348,90 @@
"type": "string"
},
"name": {
- "location": "path",
"description": "The name of the operation's parent resource.",
"type": "string",
"required": true,
- "pattern": "^operations$"
- },
- "pageSize": {
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer",
- "location": "query"
+ "pattern": "^operations$",
+ "location": "path"
}
},
+ "flatPath": "v1/operations",
+ "id": "cloudbuild.operations.list",
+ "path": "v1/{+name}",
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id."
+ },
+ "cancel": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/operations",
- "id": "cloudbuild.operations.list",
- "path": "v1/{+name}"
- }
- }
- },
- "projects": {
- "resources": {
- "builds": {
- "methods": {
- "cancel": {
- "response": {
- "$ref": "Build"
- },
- "parameterOrder": [
- "projectId",
- "id"
- ],
- "httpMethod": "POST",
- "parameters": {
- "id": {
- "location": "path",
- "description": "ID of the build.",
- "type": "string",
- "required": true
- },
- "projectId": {
- "location": "path",
- "description": "ID of the project.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/builds/{id}:cancel",
- "id": "cloudbuild.projects.builds.cancel",
- "path": "v1/projects/{projectId}/builds/{id}:cancel",
- "description": "Cancels a requested build in progress.",
- "request": {
- "$ref": "CancelBuildRequest"
- }
- },
- "list": {
- "description": "Lists previously requested builds.\n\nPreviously requested builds may still be in-progress, or may have finished\nsuccessfully or unsuccessfully.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListBuildsResponse"
- },
- "parameterOrder": [
- "projectId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "filter": {
- "description": "The raw filter text to constrain the results.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "description": "Token to provide to skip to a particular spot in the list.",
- "type": "string"
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "format": "int32",
- "description": "Number of results to return in the list."
- },
- "projectId": {
- "description": "ID of the project.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectId}/builds",
- "path": "v1/projects/{projectId}/builds",
- "id": "cloudbuild.projects.builds.list"
- },
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "projectId",
- "id"
- ],
- "response": {
- "$ref": "Build"
- },
- "parameters": {
- "projectId": {
- "description": "ID of the project.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "id": {
- "description": "ID of the build.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/builds/{id}",
- "path": "v1/projects/{projectId}/builds/{id}",
- "id": "cloudbuild.projects.builds.get",
- "description": "Returns information about a previously requested build.\n\nThe Build that is returned includes its status (e.g., success or failure,\nor in-progress), and timing information."
- },
- "create": {
- "description": "Starts a build with the specified configuration.\n\nThe long-running Operation returned by this method will include the ID of\nthe build, which can be passed to GetBuild to determine its status (e.g.,\nsuccess or failure).",
- "request": {
- "$ref": "Build"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "ID of the project.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/builds",
- "path": "v1/projects/{projectId}/builds",
- "id": "cloudbuild.projects.builds.create"
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be cancelled.",
+ "type": "string",
+ "required": true,
+ "pattern": "^operations/.+$",
+ "location": "path"
}
- }
- },
- "triggers": {
- "methods": {
- "patch": {
- "response": {
- "$ref": "BuildTrigger"
- },
- "parameterOrder": [
- "projectId",
- "triggerId"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "triggerId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "ID of the BuildTrigger to update."
- },
- "projectId": {
- "location": "path",
- "description": "ID of the project that owns the trigger.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/projects/{projectId}/triggers/{triggerId}",
- "id": "cloudbuild.projects.triggers.patch",
- "path": "v1/projects/{projectId}/triggers/{triggerId}",
- "request": {
- "$ref": "BuildTrigger"
- },
- "description": "Updates an BuildTrigger by its project ID and trigger ID.\n\nThis API is experimental."
- },
- "list": {
- "response": {
- "$ref": "ListBuildTriggersResponse"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "projectId": {
- "description": "ID of the project for which to list BuildTriggers.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/triggers",
- "id": "cloudbuild.projects.triggers.list",
- "path": "v1/projects/{projectId}/triggers",
- "description": "Lists existing BuildTrigger.\n\nThis API is experimental."
- },
- "get": {
- "description": "Gets information about a BuildTrigger.\n\nThis API is experimental.",
- "response": {
- "$ref": "BuildTrigger"
- },
- "parameterOrder": [
- "projectId",
- "triggerId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "triggerId": {
- "location": "path",
- "description": "ID of the BuildTrigger to get.",
- "type": "string",
- "required": true
- },
- "projectId": {
- "location": "path",
- "description": "ID of the project that owns the trigger.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/triggers/{triggerId}",
- "id": "cloudbuild.projects.triggers.get",
- "path": "v1/projects/{projectId}/triggers/{triggerId}"
- },
- "create": {
- "description": "Creates a new BuildTrigger.\n\nThis API is experimental.",
- "request": {
- "$ref": "BuildTrigger"
- },
- "response": {
- "$ref": "BuildTrigger"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "ID of the project for which to configure automatic builds."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/triggers",
- "id": "cloudbuild.projects.triggers.create",
- "path": "v1/projects/{projectId}/triggers"
- },
- "delete": {
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "projectId",
- "triggerId"
- ],
- "parameters": {
- "triggerId": {
- "location": "path",
- "description": "ID of the BuildTrigger to delete.",
- "type": "string",
- "required": true
- },
- "projectId": {
- "location": "path",
- "description": "ID of the project that owns the trigger.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/triggers/{triggerId}",
- "path": "v1/projects/{projectId}/triggers/{triggerId}",
- "id": "cloudbuild.projects.triggers.delete",
- "description": "Deletes an BuildTrigger by its project ID and trigger ID.\n\nThis API is experimental."
- }
+ },
+ "flatPath": "v1/operations/{operationsId}:cancel",
+ "path": "v1/{+name}:cancel",
+ "id": "cloudbuild.operations.cancel",
+ "request": {
+ "$ref": "CancelOperationRequest"
+ },
+ "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
}
}
}
}
},
"parameters": {
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
- },
"upload_protocol": {
- "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"prettyPrint": {
+ "location": "query",
"description": "Returns response with indentations and line breaks.",
"default": "true",
- "type": "boolean",
- "location": "query"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
+ "type": "boolean"
},
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
+ "fields": {
"location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "callback": {
+ "type": "string",
+ "location": "query",
+ "description": "JSONP"
+ },
+ "$.xgafv": {
"enum": [
"1",
"2"
],
"description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query"
},
"alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
@@ -480,7 +440,43 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json"
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
}
},
"version": "v1",
@@ -489,58 +485,12 @@
"description": "Builds container images in the cloud.",
"kind": "discovery#restDescription",
"basePath": "",
- "id": "cloudbuild:v1",
+ "revision": "20171011",
"documentationLink": "https://cloud.google.com/container-builder/docs/",
- "revision": "20171010",
+ "id": "cloudbuild:v1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "BuildOptions": {
- "description": "Optional arguments to enable specific features of builds.",
- "type": "object",
- "properties": {
- "substitutionOption": {
- "description": "SubstitutionOption to allow unmatch substitutions.",
- "type": "string",
- "enumDescriptions": [
- "Fails the build if error in substitutions checks, like missing\na substitution in the template or in the map.",
- "Do not fail the build if error in substitutions checks."
- ],
- "enum": [
- "MUST_MATCH",
- "ALLOW_LOOSE"
- ]
- },
- "requestedVerifyOption": {
- "enum": [
- "NOT_VERIFIED",
- "VERIFIED"
- ],
- "description": "Requested verifiability options.",
- "type": "string",
- "enumDescriptions": [
- "Not a verifiable build. (default)",
- "Verified build."
- ]
- },
- "sourceProvenanceHash": {
- "description": "Requested hash for SourceProvenance.",
- "items": {
- "enum": [
- "NONE",
- "SHA256"
- ],
- "type": "string"
- },
- "type": "array",
- "enumDescriptions": [
- "No hash requested.",
- "Use a sha256 hash."
- ]
- }
- },
- "id": "BuildOptions"
- },
"StorageSource": {
"description": "StorageSource describes the location of the source in an archive file in\nGoogle Cloud Storage.",
"type": "object",
@@ -565,41 +515,38 @@
"description": "Results describes the artifacts created by the build pipeline.",
"type": "object",
"properties": {
- "images": {
- "description": "Images that were built as a part of the build.",
- "items": {
- "$ref": "BuiltImage"
- },
- "type": "array"
- },
"buildStepImages": {
"description": "List of build step digests, in order corresponding to build step indices.",
"items": {
"type": "string"
},
"type": "array"
+ },
+ "images": {
+ "description": "Images that were built as a part of the build.",
+ "items": {
+ "$ref": "BuiltImage"
+ },
+ "type": "array"
}
},
"id": "Results"
},
"BuildOperationMetadata": {
- "description": "Metadata for build operations.",
- "type": "object",
"properties": {
"build": {
- "description": "The build that the operation is tracking.",
- "$ref": "Build"
+ "$ref": "Build",
+ "description": "The build that the operation is tracking."
}
},
- "id": "BuildOperationMetadata"
+ "id": "BuildOperationMetadata",
+ "description": "Metadata for build operations.",
+ "type": "object"
},
"SourceProvenance": {
+ "description": "Provenance of the source. Ways to find the original source, or verify that\nsome source was used for this build.",
"type": "object",
"properties": {
- "resolvedStorageSource": {
- "$ref": "StorageSource",
- "description": "A copy of the build's source.storage_source, if exists, with any\ngenerations resolved."
- },
"fileHashes": {
"description": "Hash(es) of the build source, which can be used to verify that the original\nsource integrity was maintained in the build. Note that FileHashes will\nonly be populated if BuildOptions has requested a SourceProvenanceHash.\n\nThe keys to this map are file paths used as build source and the values\ncontain the hash values for those files.\n\nIf the build source came in a single package such as a gzipped tarfile\n(.tar.gz), the FileHash will be for the single path to that file.\n@OutputOnly",
"type": "object",
@@ -608,12 +555,15 @@
}
},
"resolvedRepoSource": {
- "$ref": "RepoSource",
- "description": "A copy of the build's source.repo_source, if exists, with any\nrevisions resolved."
+ "description": "A copy of the build's source.repo_source, if exists, with any\nrevisions resolved.",
+ "$ref": "RepoSource"
+ },
+ "resolvedStorageSource": {
+ "$ref": "StorageSource",
+ "description": "A copy of the build's source.storage_source, if exists, with any\ngenerations resolved."
}
},
- "id": "SourceProvenance",
- "description": "Provenance of the source. Ways to find the original source, or verify that\nsome source was used for this build."
+ "id": "SourceProvenance"
},
"CancelOperationRequest": {
"description": "The request message for Operations.CancelOperation.",
@@ -621,6 +571,41 @@
"properties": {},
"id": "CancelOperationRequest"
},
+ "Operation": {
+ "properties": {
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
+ "type": "string"
+ },
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ }
+ },
+ "id": "Operation",
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object"
+ },
"ListBuildTriggersResponse": {
"description": "Response containing existing BuildTriggers.",
"type": "object",
@@ -635,42 +620,8 @@
},
"id": "ListBuildTriggersResponse"
},
- "Operation": {
- "properties": {
- "response": {
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
- "type": "string"
- },
- "error": {
- "description": "The error result of the operation in case of failure or cancellation.",
- "$ref": "Status"
- },
- "metadata": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any."
- },
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- }
- },
- "id": "Operation",
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object"
- },
"BuiltImage": {
+ "id": "BuiltImage",
"description": "BuiltImage describes an image built by the pipeline.",
"type": "object",
"properties": {
@@ -679,17 +630,23 @@
"type": "string"
},
"digest": {
- "description": "Docker Registry 2.0 digest.",
- "type": "string"
+ "type": "string",
+ "description": "Docker Registry 2.0 digest."
}
- },
- "id": "BuiltImage"
+ }
},
"Hash": {
"description": "Container message for hash values.",
"type": "object",
"properties": {
+ "value": {
+ "format": "byte",
+ "description": "The hash value.",
+ "type": "string"
+ },
"type": {
+ "description": "The type of hash that was performed.",
+ "type": "string",
"enumDescriptions": [
"No hash requested.",
"Use a sha256 hash."
@@ -697,14 +654,7 @@
"enum": [
"NONE",
"SHA256"
- ],
- "description": "The type of hash that was performed.",
- "type": "string"
- },
- "value": {
- "format": "byte",
- "description": "The hash value.",
- "type": "string"
+ ]
}
},
"id": "Hash"
@@ -713,17 +663,9 @@
"description": "RepoSource describes the location of the source in a Google Cloud Source\nRepository.",
"type": "object",
"properties": {
- "commitSha": {
- "description": "Explicit commit SHA to build.",
- "type": "string"
- },
- "tagName": {
- "description": "Name of the tag to build.",
- "type": "string"
- },
"branchName": {
- "type": "string",
- "description": "Name of the branch to build."
+ "description": "Name of the branch to build.",
+ "type": "string"
},
"repoName": {
"description": "Name of the repo. If omitted, the name \"default\" is assumed.",
@@ -732,19 +674,41 @@
"projectId": {
"description": "ID of the project that owns the repo. If omitted, the project ID requesting\nthe build is assumed.",
"type": "string"
+ },
+ "commitSha": {
+ "description": "Explicit commit SHA to build.",
+ "type": "string"
+ },
+ "tagName": {
+ "description": "Name of the tag to build.",
+ "type": "string"
}
},
"id": "RepoSource"
},
"BuildStep": {
- "id": "BuildStep",
"description": "BuildStep describes a step to perform in the build pipeline.",
"type": "object",
"properties": {
+ "args": {
+ "description": "A list of arguments that will be presented to the step when it is started.\n\nIf the image used to run the step's container has an entrypoint, these args\nwill be used as arguments to that entrypoint. If the image does not define\nan entrypoint, the first element in args will be used as the entrypoint,\nand the remainder will be used as arguments.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "The name of the container image that will run this particular build step.\n\nIf the image is already available in the host's Docker daemon's cache, it\nwill be run directly. If not, the host will attempt to pull the image\nfirst, using the builder service account's credentials if necessary.\n\nThe Docker daemon's cache will already have the latest versions of all of\nthe officially supported build steps\n([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)).\nThe Docker daemon will also have cached many of the layers for some popular\nimages, like \"ubuntu\", \"debian\", but they will be refreshed at the time you\nattempt to use them.\n\nIf you built an image in a previous build step, it will be stored in the\nhost's Docker daemon's cache and is available to use as the name for a\nlater build step.",
+ "type": "string"
+ },
"entrypoint": {
"description": "Optional entrypoint to be used instead of the build step image's default\nIf unset, the image's default will be used.",
"type": "string"
},
+ "id": {
+ "description": "Optional unique identifier for this build step, used in wait_for to\nreference this build step as a dependency.",
+ "type": "string"
+ },
"secretEnv": {
"description": "A list of environment variables which are encrypted using a Cloud KMS\ncrypto key. These values must be specified in the build's secrets.",
"items": {
@@ -752,10 +716,6 @@
},
"type": "array"
},
- "id": {
- "description": "Optional unique identifier for this build step, used in wait_for to\nreference this build step as a dependency.",
- "type": "string"
- },
"volumes": {
"description": "List of volumes to mount into the build step.\n\nEach volume will be created as an empty volume prior to execution of the\nbuild step. Upon completion of the build, volumes and their contents will\nbe discarded.\n\nUsing a named volume in only one step is not valid as it is indicative\nof a mis-configured build request.",
"items": {
@@ -767,32 +727,22 @@
"description": "Working directory (relative to project source root) to use when running\nthis operation's container.",
"type": "string"
},
- "waitFor": {
- "description": "The ID(s) of the step(s) that this build step depends on.\nThis build step will not start until all the build steps in wait_for\nhave completed successfully. If wait_for is empty, this build step will\nstart when all previous build steps in the Build.Steps list have completed\nsuccessfully.",
+ "env": {
+ "description": "A list of environment variable definitions to be used when running a step.\n\nThe elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\"\nbeing given the value \"VALUE\".",
"items": {
"type": "string"
},
"type": "array"
},
- "env": {
+ "waitFor": {
"items": {
"type": "string"
},
"type": "array",
- "description": "A list of environment variable definitions to be used when running a step.\n\nThe elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\"\nbeing given the value \"VALUE\"."
- },
- "args": {
- "description": "A list of arguments that will be presented to the step when it is started.\n\nIf the image used to run the step's container has an entrypoint, these args\nwill be used as arguments to that entrypoint. If the image does not define\nan entrypoint, the first element in args will be used as the entrypoint,\nand the remainder will be used as arguments.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "name": {
- "description": "The name of the container image that will run this particular build step.\n\nIf the image is already available in the host's Docker daemon's cache, it\nwill be run directly. If not, the host will attempt to pull the image\nfirst, using the builder service account's credentials if necessary.\n\nThe Docker daemon's cache will already have the latest versions of all of\nthe officially supported build steps\n([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)).\nThe Docker daemon will also have cached many of the layers for some popular\nimages, like \"ubuntu\", \"debian\", but they will be refreshed at the time you\nattempt to use them.\n\nIf you built an image in a previous build step, it will be stored in the\nhost's Docker daemon's cache and is available to use as the name for a\nlater build step.",
- "type": "string"
+ "description": "The ID(s) of the step(s) that this build step depends on.\nThis build step will not start until all the build steps in wait_for\nhave completed successfully. If wait_for is empty, this build step will\nstart when all previous build steps in the Build.Steps list have completed\nsuccessfully."
}
- }
+ },
+ "id": "BuildStep"
},
"FileHashes": {
"description": "Container message for hashes of byte content of files, used in\nSourceProvenance messages to verify integrity of source input to the build.",
@@ -828,16 +778,9 @@
"id": "Secret"
},
"Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
"properties": {
- "code": {
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
@@ -848,50 +791,27 @@
}
},
"type": "array"
+ },
+ "code": {
+ "format": "int32",
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
}
},
- "id": "Status",
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object"
+ "id": "Status"
},
"Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
"type": "object",
"properties": {},
- "id": "Empty",
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`."
+ "id": "Empty"
},
"BuildTrigger": {
- "description": "Configuration for an automated build in response to source repository\nchanges.",
- "type": "object",
"properties": {
- "substitutions": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Substitutions data for Build resource.",
- "type": "object"
- },
- "description": {
- "description": "Human-readable description of this trigger.",
- "type": "string"
- },
- "createTime": {
- "format": "google-datetime",
- "description": "Time when the trigger was created.\n\n@OutputOnly",
- "type": "string"
- },
- "disabled": {
- "type": "boolean",
- "description": "If true, the trigger will never result in a build."
- },
- "filename": {
- "description": "Path, from the source root, to a file whose contents is used for the\ntemplate.",
- "type": "string"
- },
- "triggerTemplate": {
- "$ref": "RepoSource",
- "description": "Template describing the types of source changes to trigger a build.\n\nBranch and tag names in trigger templates are interpreted as regular\nexpressions. Any branch or tag change that matches that regular expression\nwill trigger a build."
- },
"id": {
"description": "Unique identifier of the trigger.\n\n@OutputOnly",
"type": "string"
@@ -899,50 +819,54 @@
"build": {
"$ref": "Build",
"description": "Contents of the build template."
+ },
+ "substitutions": {
+ "description": "Substitutions data for Build resource.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "description": {
+ "description": "Human-readable description of this trigger.",
+ "type": "string"
+ },
+ "disabled": {
+ "description": "If true, the trigger will never result in a build.",
+ "type": "boolean"
+ },
+ "createTime": {
+ "format": "google-datetime",
+ "description": "Time when the trigger was created.\n\n@OutputOnly",
+ "type": "string"
+ },
+ "triggerTemplate": {
+ "description": "Template describing the types of source changes to trigger a build.\n\nBranch and tag names in trigger templates are interpreted as regular\nexpressions. Any branch or tag change that matches that regular expression\nwill trigger a build.",
+ "$ref": "RepoSource"
+ },
+ "filename": {
+ "description": "Path, from the source root, to a file whose contents is used for the\ntemplate.",
+ "type": "string"
}
},
- "id": "BuildTrigger"
+ "id": "BuildTrigger",
+ "description": "Configuration for an automated build in response to source repository\nchanges.",
+ "type": "object"
},
"Build": {
"description": "A build resource in the Container Builder API.\n\nAt a high level, a Build describes where to find source code, how to build\nit (for example, the builder image to run on the source), and what tag to\napply to the built image when it is pushed to Google Container Registry.\n\nFields can include the following variables which will be expanded when the\nbuild is created:\n\n- $PROJECT_ID: the project ID of the build.\n- $BUILD_ID: the autogenerated ID of the build.\n- $REPO_NAME: the source repository name specified by RepoSource.\n- $BRANCH_NAME: the branch name specified by RepoSource.\n- $TAG_NAME: the tag name specified by RepoSource.\n- $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or\n resolved from the specified branch or tag.\n- $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.",
"type": "object",
"properties": {
- "secrets": {
- "items": {
- "$ref": "Secret"
- },
- "type": "array",
- "description": "Secrets to decrypt using Cloud KMS."
- },
- "logsBucket": {
- "description": "Google Cloud Storage bucket where logs should be written (see\n[Bucket Name\nRequirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).\nLogs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.",
- "type": "string"
- },
- "results": {
- "description": "Results of the build.\n@OutputOnly",
- "$ref": "Results"
- },
- "steps": {
- "items": {
- "$ref": "BuildStep"
- },
- "type": "array",
- "description": "Describes the operations to be performed on the workspace."
- },
- "buildTriggerId": {
- "type": "string",
- "description": "The ID of the BuildTrigger that triggered this build, if it was\ntriggered automatically.\n@OutputOnly"
- },
"tags": {
+ "description": "Tags for annotation of a Build. These are not docker tags.",
"items": {
"type": "string"
},
- "type": "array",
- "description": "Tags for annotation of a Build. These are not docker tags."
+ "type": "array"
},
"id": {
- "type": "string",
- "description": "Unique identifier of the build.\n@OutputOnly"
+ "description": "Unique identifier of the build.\n@OutputOnly",
+ "type": "string"
},
"substitutions": {
"description": "Substitutions data for Build resource.",
@@ -981,25 +905,23 @@
"type": "string"
},
"finishTime": {
+ "type": "string",
"format": "google-datetime",
- "description": "Time at which execution of the build was finished.\n\nThe difference between finish_time and start_time is the duration of the\nbuild's execution.\n@OutputOnly",
- "type": "string"
+ "description": "Time at which execution of the build was finished.\n\nThe difference between finish_time and start_time is the duration of the\nbuild's execution.\n@OutputOnly"
},
"options": {
"$ref": "BuildOptions",
"description": "Special options for this build."
},
"source": {
- "$ref": "Source",
- "description": "Describes where to find the source files to build."
+ "description": "Describes where to find the source files to build.",
+ "$ref": "Source"
},
"statusDetail": {
"description": "Customer-readable message about the current status.\n@OutputOnly",
"type": "string"
},
"status": {
- "description": "Status of the build.\n@OutputOnly",
- "type": "string",
"enumDescriptions": [
"Status of the build is unknown.",
"Build is queued; work has not yet begun.",
@@ -1019,60 +941,88 @@
"INTERNAL_ERROR",
"TIMEOUT",
"CANCELLED"
- ]
+ ],
+ "description": "Status of the build.\n@OutputOnly",
+ "type": "string"
},
"timeout": {
"format": "google-duration",
"description": "Amount of time that this build should be allowed to run, to second\ngranularity. If this amount of time elapses, work on the build will cease\nand the build status will be TIMEOUT.\n\nDefault time is ten minutes.",
"type": "string"
+ },
+ "secrets": {
+ "description": "Secrets to decrypt using Cloud KMS.",
+ "items": {
+ "$ref": "Secret"
+ },
+ "type": "array"
+ },
+ "logsBucket": {
+ "description": "Google Cloud Storage bucket where logs should be written (see\n[Bucket Name\nRequirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).\nLogs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.",
+ "type": "string"
+ },
+ "results": {
+ "description": "Results of the build.\n@OutputOnly",
+ "$ref": "Results"
+ },
+ "steps": {
+ "description": "Describes the operations to be performed on the workspace.",
+ "items": {
+ "$ref": "BuildStep"
+ },
+ "type": "array"
+ },
+ "buildTriggerId": {
+ "description": "The ID of the BuildTrigger that triggered this build, if it was\ntriggered automatically.\n@OutputOnly",
+ "type": "string"
}
},
"id": "Build"
},
"CancelBuildRequest": {
+ "description": "Request to cancel an ongoing build.",
"type": "object",
"properties": {},
- "id": "CancelBuildRequest",
- "description": "Request to cancel an ongoing build."
- },
- "Volume": {
- "description": "Volume describes a Docker container volume which is mounted into build steps\nin order to persist files across build step execution.",
- "type": "object",
- "properties": {
- "path": {
- "description": "Path at which to mount the volume.\n\nPaths must be absolute and cannot conflict with other volume paths on the\nsame build step or with certain reserved volume paths.",
- "type": "string"
- },
- "name": {
- "description": "Name of the volume to mount.\n\nVolume names must be unique per build step and must be valid names for\nDocker volumes. Each named volume must be used by at least two build steps.",
- "type": "string"
- }
- },
- "id": "Volume"
+ "id": "CancelBuildRequest"
},
"ListBuildsResponse": {
"description": "Response including listed builds.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "Token to receive the next page of results.",
- "type": "string"
- },
"builds": {
+ "description": "Builds will be sorted by create_time, descending.",
"items": {
"$ref": "Build"
},
- "type": "array",
- "description": "Builds will be sorted by create_time, descending."
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Token to receive the next page of results.",
+ "type": "string"
}
},
"id": "ListBuildsResponse"
},
+ "Volume": {
+ "description": "Volume describes a Docker container volume which is mounted into build steps\nin order to persist files across build step execution.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the volume to mount.\n\nVolume names must be unique per build step and must be valid names for\nDocker volumes. Each named volume must be used by at least two build steps.",
+ "type": "string"
+ },
+ "path": {
+ "type": "string",
+ "description": "Path at which to mount the volume.\n\nPaths must be absolute and cannot conflict with other volume paths on the\nsame build step or with certain reserved volume paths."
+ }
+ },
+ "id": "Volume"
+ },
"ListOperationsResponse": {
"properties": {
"nextPageToken": {
- "type": "string",
- "description": "The standard List next-page token."
+ "description": "The standard List next-page token.",
+ "type": "string"
},
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
@@ -1090,16 +1040,62 @@
"description": "Source describes the location of the source in a supported storage\nservice.",
"type": "object",
"properties": {
- "storageSource": {
- "description": "If provided, get the source from this location in Google Cloud Storage.",
- "$ref": "StorageSource"
- },
"repoSource": {
- "description": "If provided, get source from this location in a Cloud Repo.",
- "$ref": "RepoSource"
+ "$ref": "RepoSource",
+ "description": "If provided, get source from this location in a Cloud Repo."
+ },
+ "storageSource": {
+ "$ref": "StorageSource",
+ "description": "If provided, get the source from this location in Google Cloud Storage."
}
},
"id": "Source"
+ },
+ "BuildOptions": {
+ "properties": {
+ "substitutionOption": {
+ "enumDescriptions": [
+ "Fails the build if error in substitutions checks, like missing\na substitution in the template or in the map.",
+ "Do not fail the build if error in substitutions checks."
+ ],
+ "enum": [
+ "MUST_MATCH",
+ "ALLOW_LOOSE"
+ ],
+ "description": "SubstitutionOption to allow unmatch substitutions.",
+ "type": "string"
+ },
+ "requestedVerifyOption": {
+ "description": "Requested verifiability options.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not a verifiable build. (default)",
+ "Verified build."
+ ],
+ "enum": [
+ "NOT_VERIFIED",
+ "VERIFIED"
+ ]
+ },
+ "sourceProvenanceHash": {
+ "items": {
+ "type": "string",
+ "enum": [
+ "NONE",
+ "SHA256"
+ ]
+ },
+ "type": "array",
+ "enumDescriptions": [
+ "No hash requested.",
+ "Use a sha256 hash."
+ ],
+ "description": "Requested hash for SourceProvenance."
+ }
+ },
+ "id": "BuildOptions",
+ "description": "Optional arguments to enable specific features of builds.",
+ "type": "object"
}
},
"protocol": "rest",
@@ -1117,5 +1113,9 @@
}
}
},
- "rootUrl": "https://cloudbuild.googleapis.com/"
+ "rootUrl": "https://cloudbuild.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "cloudbuild",
+ "batchPath": "batch",
+ "title": "Google Cloud Container Builder API"
}
diff --git a/clouddebugger/v2/clouddebugger-api.json b/clouddebugger/v2/clouddebugger-api.json
index ed08ae5..921c680 100644
--- a/clouddebugger/v2/clouddebugger-api.json
+++ b/clouddebugger/v2/clouddebugger-api.json
@@ -1,8 +1,8 @@
{
"basePath": "",
- "id": "clouddebugger:v2",
- "revision": "20170928",
+ "revision": "20171010",
"documentationLink": "http://cloud.google.com/debugger",
+ "id": "clouddebugger:v2",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
@@ -10,13 +10,13 @@
"description": "A CloudWorkspaceId is a unique identifier for a cloud workspace.\nA cloud workspace is a place associated with a repo where modified files\ncan be stored before they are committed.",
"type": "object",
"properties": {
- "repoId": {
- "$ref": "RepoId",
- "description": "The ID of the repo containing the workspace."
- },
"name": {
"description": "The unique name of the workspace within the repo. This is the name\nchosen by the client in the Source API's CreateWorkspace method.",
"type": "string"
+ },
+ "repoId": {
+ "description": "The ID of the repo containing the workspace.",
+ "$ref": "RepoId"
}
},
"id": "CloudWorkspaceId"
@@ -30,38 +30,48 @@
"type": "string"
},
"breakpoints": {
+ "description": "List of breakpoints matching the request.\nThe fields `id` and `location` are guaranteed to be set on each breakpoint.\nThe fields: `stack_frames`, `evaluated_expressions` and `variable_table`\nare cleared on each breakpoint regardless of its status.",
"items": {
"$ref": "Breakpoint"
},
- "type": "array",
- "description": "List of breakpoints matching the request.\nThe fields `id` and `location` are guaranteed to be set on each breakpoint.\nThe fields: `stack_frames`, `evaluated_expressions` and `variable_table`\nare cleared on each breakpoint regardless of its status."
+ "type": "array"
}
},
"id": "ListBreakpointsResponse"
},
"Breakpoint": {
+ "id": "Breakpoint",
"description": "Represents the breakpoint specification, status and results.",
"type": "object",
"properties": {
+ "location": {
+ "$ref": "SourceLocation",
+ "description": "Breakpoint source location."
+ },
+ "finalTime": {
+ "format": "google-datetime",
+ "description": "Time this breakpoint was finalized as seen by the server in seconds\nresolution.",
+ "type": "string"
+ },
"variableTable": {
+ "description": "The `variable_table` exists to aid with computation, memory and network\ntraffic optimization. It enables storing a variable once and reference\nit from multiple variables, including variables stored in the\n`variable_table` itself.\nFor example, the same `this` object, which may appear at many levels of\nthe stack, can have all of its data stored once in this table. The\nstack frame variables then would hold only a reference to it.\n\nThe variable `var_table_index` field is an index into this repeated field.\nThe stored objects are nameless and get their name from the referencing\nvariable. The effective variable is a merge of the referencing variable\nand the referenced variable.",
"items": {
"$ref": "Variable"
},
- "type": "array",
- "description": "The `variable_table` exists to aid with computation, memory and network\ntraffic optimization. It enables storing a variable once and reference\nit from multiple variables, including variables stored in the\n`variable_table` itself.\nFor example, the same `this` object, which may appear at many levels of\nthe stack, can have all of its data stored once in this table. The\nstack frame variables then would hold only a reference to it.\n\nThe variable `var_table_index` field is an index into this repeated field.\nThe stored objects are nameless and get their name from the referencing\nvariable. The effective variable is a merge of the referencing variable\nand the referenced variable."
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "A set of custom breakpoint properties, populated by the agent, to be\ndisplayed to the user.",
- "type": "object"
+ "type": "array"
},
"createTime": {
"format": "google-datetime",
"description": "Time this breakpoint was created by the server in seconds resolution.",
"type": "string"
},
+ "labels": {
+ "description": "A set of custom breakpoint properties, populated by the agent, to be\ndisplayed to the user.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
"logMessageFormat": {
"description": "Only relevant when action is `LOG`. Defines the message to log when\nthe breakpoint hits. The message may include parameter placeholders `$0`,\n`$1`, etc. These placeholders are replaced with the evaluated value\nof the appropriate expression. Expressions not referenced in\n`log_message_format` are not logged.\n\nExample: `Message received, id = $0, count = $1` with\n`expressions` = `[ message.id, message.count ]`.",
"type": "string"
@@ -81,8 +91,8 @@
"type": "array"
},
"isFinalState": {
- "type": "boolean",
- "description": "When true, indicates that this is a final result and the\nbreakpoint state will not change from here on."
+ "description": "When true, indicates that this is a final result and the\nbreakpoint state will not change from here on.",
+ "type": "boolean"
},
"stackFrames": {
"description": "The stack at breakpoint time.",
@@ -96,15 +106,14 @@
"type": "string"
},
"status": {
- "$ref": "StatusMessage",
- "description": "Breakpoint status.\n\nThe status includes an error flag and a human readable message.\nThis field is usually unset. The message can be either\ninformational or an error message. Regardless, clients should always\ndisplay the text message back to the user.\n\nError status indicates complete failure of the breakpoint.\n\nExample (non-final state): `Still loading symbols...`\n\nExamples (final state):\n\n* `Invalid line number` referring to location\n* `Field f not found in class C` referring to condition"
+ "description": "Breakpoint status.\n\nThe status includes an error flag and a human readable message.\nThis field is usually unset. The message can be either\ninformational or an error message. Regardless, clients should always\ndisplay the text message back to the user.\n\nError status indicates complete failure of the breakpoint.\n\nExample (non-final state): `Still loading symbols...`\n\nExamples (final state):\n\n* `Invalid line number` referring to location\n* `Field f not found in class C` referring to condition",
+ "$ref": "StatusMessage"
},
"userEmail": {
"description": "E-mail address of the user that created this breakpoint",
"type": "string"
},
"action": {
- "type": "string",
"enumDescriptions": [
"Capture stack frame and variables and update the breakpoint.\nThe data is only captured once. After that the breakpoint is set\nin a final state.",
"Log each breakpoint hit. The breakpoint remains active until\ndeleted or expired."
@@ -113,7 +122,8 @@
"CAPTURE",
"LOG"
],
- "description": "Action that the agent should perform when the code at the\nbreakpoint location is hit."
+ "description": "Action that the agent should perform when the code at the\nbreakpoint location is hit.",
+ "type": "string"
},
"logLevel": {
"description": "Indicates the severity of the log. Only relevant when action is `LOG`.",
@@ -132,69 +142,62 @@
"id": {
"description": "Breakpoint identifier, unique in the scope of the debuggee.",
"type": "string"
- },
- "location": {
- "$ref": "SourceLocation",
- "description": "Breakpoint source location."
- },
- "finalTime": {
- "format": "google-datetime",
- "description": "Time this breakpoint was finalized as seen by the server in seconds\nresolution.",
- "type": "string"
}
- },
- "id": "Breakpoint"
+ }
},
"UpdateActiveBreakpointRequest": {
+ "id": "UpdateActiveBreakpointRequest",
"description": "Request to update an active breakpoint.",
"type": "object",
"properties": {
"breakpoint": {
- "$ref": "Breakpoint",
- "description": "Updated breakpoint information.\nThe field `id` must be set.\nThe agent must echo all Breakpoint specification fields in the update."
+ "description": "Updated breakpoint information.\nThe field `id` must be set.\nThe agent must echo all Breakpoint specification fields in the update.",
+ "$ref": "Breakpoint"
}
- },
- "id": "UpdateActiveBreakpointRequest"
+ }
},
"SetBreakpointResponse": {
"description": "Response for setting a breakpoint.",
"type": "object",
"properties": {
"breakpoint": {
- "$ref": "Breakpoint",
- "description": "Breakpoint resource.\nThe field `id` is guaranteed to be set (in addition to the echoed fileds)."
+ "description": "Breakpoint resource.\nThe field `id` is guaranteed to be set (in addition to the echoed fileds).",
+ "$ref": "Breakpoint"
}
},
"id": "SetBreakpointResponse"
},
"SourceContext": {
- "id": "SourceContext",
"description": "A SourceContext is a reference to a tree of files. A SourceContext together\nwith a path point to a unique revision of a single file or directory.",
"type": "object",
"properties": {
- "git": {
- "$ref": "GitSourceContext",
- "description": "A SourceContext referring to any third party Git repo (e.g. GitHub)."
- },
"gerrit": {
"$ref": "GerritSourceContext",
"description": "A SourceContext referring to a Gerrit project."
},
"cloudWorkspace": {
- "description": "A SourceContext referring to a snapshot in a cloud workspace.",
- "$ref": "CloudWorkspaceSourceContext"
+ "$ref": "CloudWorkspaceSourceContext",
+ "description": "A SourceContext referring to a snapshot in a cloud workspace."
},
"cloudRepo": {
"$ref": "CloudRepoSourceContext",
"description": "A SourceContext referring to a revision in a cloud repo."
+ },
+ "git": {
+ "$ref": "GitSourceContext",
+ "description": "A SourceContext referring to any third party Git repo (e.g. GitHub)."
}
- }
+ },
+ "id": "SourceContext"
},
"CloudRepoSourceContext": {
- "id": "CloudRepoSourceContext",
"description": "A CloudRepoSourceContext denotes a particular revision in a cloud\nrepo (a repo hosted by the Google Cloud Platform).",
"type": "object",
"properties": {
+ "aliasContext": {
+ "$ref": "AliasContext",
+ "description": "An alias, which may be a branch or tag."
+ },
"revisionId": {
"description": "A revision ID.",
"type": "string"
@@ -204,28 +207,13 @@
"type": "string"
},
"repoId": {
- "$ref": "RepoId",
- "description": "The ID of the repo."
- },
- "aliasContext": {
- "$ref": "AliasContext",
- "description": "An alias, which may be a branch or tag."
- }
- }
- },
- "RegisterDebuggeeRequest": {
- "properties": {
- "debuggee": {
- "$ref": "Debuggee",
- "description": "Debuggee information to register.\nThe fields `project`, `uniquifier`, `description` and `agent_version`\nof the debuggee must be set."
+ "description": "The ID of the repo.",
+ "$ref": "RepoId"
}
},
- "id": "RegisterDebuggeeRequest",
- "description": "Request to register a debuggee.",
- "type": "object"
+ "id": "CloudRepoSourceContext"
},
"RegisterDebuggeeResponse": {
- "description": "Response for registering a debuggee.",
"type": "object",
"properties": {
"debuggee": {
@@ -233,42 +221,42 @@
"description": "Debuggee resource.\nThe field `id` is guranteed to be set (in addition to the echoed fields).\nIf the field `is_disabled` is set to `true`, the agent should disable\nitself by removing all breakpoints and detaching from the application.\nIt should however continue to poll `RegisterDebuggee` until reenabled."
}
},
- "id": "RegisterDebuggeeResponse"
+ "id": "RegisterDebuggeeResponse",
+ "description": "Response for registering a debuggee."
+ },
+ "RegisterDebuggeeRequest": {
+ "type": "object",
+ "properties": {
+ "debuggee": {
+ "$ref": "Debuggee",
+ "description": "Debuggee information to register.\nThe fields `project`, `uniquifier`, `description` and `agent_version`\nof the debuggee must be set."
+ }
+ },
+ "id": "RegisterDebuggeeRequest",
+ "description": "Request to register a debuggee."
},
"GetBreakpointResponse": {
+ "type": "object",
"properties": {
"breakpoint": {
- "description": "Complete breakpoint state.\nThe fields `id` and `location` are guaranteed to be set.",
- "$ref": "Breakpoint"
+ "$ref": "Breakpoint",
+ "description": "Complete breakpoint state.\nThe fields `id` and `location` are guaranteed to be set."
}
},
"id": "GetBreakpointResponse",
- "description": "Response for getting breakpoint information.",
- "type": "object"
+ "description": "Response for getting breakpoint information."
},
"StatusMessage": {
- "description": "Represents a contextual status message.\nThe message can indicate an error or informational status, and refer to\nspecific parts of the containing object.\nFor example, the `Breakpoint.status` field can indicate an error referring\nto the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`.",
- "type": "object",
"properties": {
"description": {
- "$ref": "FormatMessage",
- "description": "Status message text."
+ "description": "Status message text.",
+ "$ref": "FormatMessage"
},
"isError": {
- "type": "boolean",
- "description": "Distinguishes errors from informational messages."
+ "description": "Distinguishes errors from informational messages.",
+ "type": "boolean"
},
"refersTo": {
- "type": "string",
- "enumDescriptions": [
- "Status doesn't refer to any particular input.",
- "Status applies to the breakpoint and is related to its location.",
- "Status applies to the breakpoint and is related to its condition.",
- "Status applies to the breakpoint and is related to its expressions.",
- "Status applies to the breakpoint and is related to its age.",
- "Status applies to the entire variable.",
- "Status applies to variable value (variable name is valid)."
- ],
"enum": [
"UNSPECIFIED",
"BREAKPOINT_SOURCE_LOCATION",
@@ -278,10 +266,22 @@
"VARIABLE_NAME",
"VARIABLE_VALUE"
],
- "description": "Reference to which the message applies."
+ "description": "Reference to which the message applies.",
+ "type": "string",
+ "enumDescriptions": [
+ "Status doesn't refer to any particular input.",
+ "Status applies to the breakpoint and is related to its location.",
+ "Status applies to the breakpoint and is related to its condition.",
+ "Status applies to the breakpoint and is related to its expressions.",
+ "Status applies to the breakpoint and is related to its age.",
+ "Status applies to the entire variable.",
+ "Status applies to variable value (variable name is valid)."
+ ]
}
},
- "id": "StatusMessage"
+ "id": "StatusMessage",
+ "description": "Represents a contextual status message.\nThe message can indicate an error or informational status, and refer to\nspecific parts of the containing object.\nFor example, the `Breakpoint.status` field can indicate an error referring\nto the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`.",
+ "type": "object"
},
"GitSourceContext": {
"description": "A GitSourceContext denotes a particular revision in a third party Git\nrepository (e.g. GitHub).",
@@ -299,7 +299,6 @@
"id": "GitSourceContext"
},
"Variable": {
- "description": "Represents a variable or an argument possibly of a compound object type.\nNote how the following variables are represented:\n\n1) A simple variable:\n\n int x = 5\n\n { name: \"x\", value: \"5\", type: \"int\" } // Captured variable\n\n2) A compound object:\n\n struct T {\n int m1;\n int m2;\n };\n T x = { 3, 7 };\n\n { // Captured variable\n name: \"x\",\n type: \"T\",\n members { name: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n }\n\n3) A pointer where the pointee was captured:\n\n T x = { 3, 7 };\n T* p = &x;\n\n { // Captured variable\n name: \"p\",\n type: \"T*\",\n value: \"0x00500500\",\n members { name: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n }\n\n4) A pointer where the pointee was not captured:\n\n T* p = new T;\n\n { // Captured variable\n name: \"p\",\n type: \"T*\",\n value: \"0x00400400\"\n status { is_error: true, description { format: \"unavailable\" } }\n }\n\nThe status should describe the reason for the missing value,\nsuch as `\u003coptimized out\u003e`, `\u003cinaccessible\u003e`, `\u003cpointers limit reached\u003e`.\n\nNote that a null pointer should not have members.\n\n5) An unnamed value:\n\n int* p = new int(7);\n\n { // Captured variable\n name: \"p\",\n value: \"0x00500500\",\n type: \"int*\",\n members { value: \"7\", type: \"int\" } }\n\n6) An unnamed pointer where the pointee was not captured:\n\n int* p = new int(7);\n int** pp = &p;\n\n { // Captured variable\n name: \"pp\",\n value: \"0x00500500\",\n type: \"int**\",\n members {\n value: \"0x00400400\",\n type: \"int*\"\n status {\n is_error: true,\n description: { format: \"unavailable\" } }\n }\n }\n }\n\nTo optimize computation, memory and network traffic, variables that\nrepeat in the output multiple times can be stored once in a shared\nvariable table and be referenced using the `var_table_index` field. The\nvariables stored in the shared table are nameless and are essentially\na partition of the complete variable. To reconstruct the complete\nvariable, merge the referencing variable with the referenced variable.\n\nWhen using the shared variable table, the following variables:\n\n T x = { 3, 7 };\n T* p = &x;\n T& r = x;\n\n { name: \"x\", var_table_index: 3, type: \"T\" } // Captured variables\n { name: \"p\", value \"0x00500500\", type=\"T*\", var_table_index: 3 }\n { name: \"r\", type=\"T&\", var_table_index: 3 }\n\n { // Shared variable table entry #3:\n members { name: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n }\n\nNote that the pointer address is stored with the referencing variable\nand not with the referenced variable. This allows the referenced variable\nto be shared between pointers and references.\n\nThe type field is optional. The debugger agent may or may not support it.",
"type": "object",
"properties": {
"members": {
@@ -310,38 +309,32 @@
"type": "array"
},
"status": {
- "description": "Status associated with the variable. This field will usually stay\nunset. A status of a single variable only applies to that variable or\nexpression. The rest of breakpoint data still remains valid. Variables\nmight be reported in error state even when breakpoint is not in final\nstate.\n\nThe message may refer to variable name with `refers_to` set to\n`VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`.\nIn either case variable value and members will be unset.\n\nExample of error message applied to name: `Invalid expression syntax`.\n\nExample of information message applied to value: `Not captured`.\n\nExamples of error message applied to value:\n\n* `Malformed string`,\n* `Field f not found in class C`\n* `Null pointer dereference`",
- "$ref": "StatusMessage"
+ "$ref": "StatusMessage",
+ "description": "Status associated with the variable. This field will usually stay\nunset. A status of a single variable only applies to that variable or\nexpression. The rest of breakpoint data still remains valid. Variables\nmight be reported in error state even when breakpoint is not in final\nstate.\n\nThe message may refer to variable name with `refers_to` set to\n`VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`.\nIn either case variable value and members will be unset.\n\nExample of error message applied to name: `Invalid expression syntax`.\n\nExample of information message applied to value: `Not captured`.\n\nExamples of error message applied to value:\n\n* `Malformed string`,\n* `Field f not found in class C`\n* `Null pointer dereference`"
},
"name": {
"description": "Name of the variable, if any.",
"type": "string"
},
"type": {
- "description": "Variable type (e.g. `MyClass`). If the variable is split with\n`var_table_index`, `type` goes next to `value`. The interpretation of\na type is agent specific. It is recommended to include the dynamic type\nrather than a static type of an object.",
- "type": "string"
- },
- "value": {
- "description": "Simple value of the variable.",
- "type": "string"
+ "type": "string",
+ "description": "Variable type (e.g. `MyClass`). If the variable is split with\n`var_table_index`, `type` goes next to `value`. The interpretation of\na type is agent specific. It is recommended to include the dynamic type\nrather than a static type of an object."
},
"varTableIndex": {
"format": "int32",
"description": "Reference to a variable in the shared variable table. More than\none variable can reference the same variable in the table. The\n`var_table_index` field is an index into `variable_table` in Breakpoint.",
"type": "integer"
+ },
+ "value": {
+ "description": "Simple value of the variable.",
+ "type": "string"
}
},
- "id": "Variable"
+ "id": "Variable",
+ "description": "Represents a variable or an argument possibly of a compound object type.\nNote how the following variables are represented:\n\n1) A simple variable:\n\n int x = 5\n\n { name: \"x\", value: \"5\", type: \"int\" } // Captured variable\n\n2) A compound object:\n\n struct T {\n int m1;\n int m2;\n };\n T x = { 3, 7 };\n\n { // Captured variable\n name: \"x\",\n type: \"T\",\n members { name: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n }\n\n3) A pointer where the pointee was captured:\n\n T x = { 3, 7 };\n T* p = &x;\n\n { // Captured variable\n name: \"p\",\n type: \"T*\",\n value: \"0x00500500\",\n members { name: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n }\n\n4) A pointer where the pointee was not captured:\n\n T* p = new T;\n\n { // Captured variable\n name: \"p\",\n type: \"T*\",\n value: \"0x00400400\"\n status { is_error: true, description { format: \"unavailable\" } }\n }\n\nThe status should describe the reason for the missing value,\nsuch as `\u003coptimized out\u003e`, `\u003cinaccessible\u003e`, `\u003cpointers limit reached\u003e`.\n\nNote that a null pointer should not have members.\n\n5) An unnamed value:\n\n int* p = new int(7);\n\n { // Captured variable\n name: \"p\",\n value: \"0x00500500\",\n type: \"int*\",\n members { value: \"7\", type: \"int\" } }\n\n6) An unnamed pointer where the pointee was not captured:\n\n int* p = new int(7);\n int** pp = &p;\n\n { // Captured variable\n name: \"pp\",\n value: \"0x00500500\",\n type: \"int**\",\n members {\n value: \"0x00400400\",\n type: \"int*\"\n status {\n is_error: true,\n description: { format: \"unavailable\" } }\n }\n }\n }\n\nTo optimize computation, memory and network traffic, variables that\nrepeat in the output multiple times can be stored once in a shared\nvariable table and be referenced using the `var_table_index` field. The\nvariables stored in the shared table are nameless and are essentially\na partition of the complete variable. To reconstruct the complete\nvariable, merge the referencing variable with the referenced variable.\n\nWhen using the shared variable table, the following variables:\n\n T x = { 3, 7 };\n T* p = &x;\n T& r = x;\n\n { name: \"x\", var_table_index: 3, type: \"T\" } // Captured variables\n { name: \"p\", value \"0x00500500\", type=\"T*\", var_table_index: 3 }\n { name: \"r\", type=\"T&\", var_table_index: 3 }\n\n { // Shared variable table entry #3:\n members { name: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n }\n\nNote that the pointer address is stored with the referencing variable\nand not with the referenced variable. This allows the referenced variable\nto be shared between pointers and references.\n\nThe type field is optional. The debugger agent may or may not support it."
},
"StackFrame": {
"properties": {
- "arguments": {
- "description": "Set of arguments passed to this function.\nNote that this might not be populated for all stack frames.",
- "items": {
- "$ref": "Variable"
- },
- "type": "array"
- },
"locals": {
"description": "Set of local variables at the stack frame location.\nNote that this might not be populated for all stack frames.",
"items": {
@@ -350,12 +343,19 @@
"type": "array"
},
"location": {
- "$ref": "SourceLocation",
- "description": "Source location of the call site."
+ "description": "Source location of the call site.",
+ "$ref": "SourceLocation"
},
"function": {
"description": "Demangled function name at the call site.",
"type": "string"
+ },
+ "arguments": {
+ "description": "Set of arguments passed to this function.\nNote that this might not be populated for all stack frames.",
+ "items": {
+ "$ref": "Variable"
+ },
+ "type": "array"
}
},
"id": "StackFrame",
@@ -366,13 +366,13 @@
"description": "A unique identifier for a cloud repo.",
"type": "object",
"properties": {
- "projectRepoId": {
- "description": "A combination of a project ID and a repo name.",
- "$ref": "ProjectRepoId"
- },
"uid": {
"description": "A server-assigned, globally unique identifier.",
"type": "string"
+ },
+ "projectRepoId": {
+ "$ref": "ProjectRepoId",
+ "description": "A combination of a project ID and a repo name."
}
},
"id": "RepoId"
@@ -398,16 +398,16 @@
"ExtendedSourceContext": {
"type": "object",
"properties": {
+ "context": {
+ "$ref": "SourceContext",
+ "description": "Any source context."
+ },
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels with user defined metadata.",
"type": "object"
- },
- "context": {
- "$ref": "SourceContext",
- "description": "Any source context."
}
},
"id": "ExtendedSourceContext",
@@ -422,6 +422,12 @@
"type": "string"
},
"kind": {
+ "enum": [
+ "ANY",
+ "FIXED",
+ "MOVABLE",
+ "OTHER"
+ ],
"description": "The alias kind.",
"type": "string",
"enumDescriptions": [
@@ -429,18 +435,13 @@
"Git tag",
"Git branch",
"OTHER is used to specify non-standard aliases, those not of the kinds\nabove. For example, if a Git repo has a ref named \"refs/foo/bar\", it\nis considered to be of kind OTHER."
- ],
- "enum": [
- "ANY",
- "FIXED",
- "MOVABLE",
- "OTHER"
]
}
},
"id": "AliasContext"
},
"ListDebuggeesResponse": {
+ "id": "ListDebuggeesResponse",
"description": "Response for listing debuggees.",
"type": "object",
"properties": {
@@ -451,8 +452,7 @@
},
"type": "array"
}
- },
- "id": "ListDebuggeesResponse"
+ }
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
@@ -463,47 +463,32 @@
"SourceLocation": {
"type": "object",
"properties": {
+ "line": {
+ "format": "int32",
+ "description": "Line inside the file. The first line in the file has the value `1`.",
+ "type": "integer"
+ },
"path": {
"description": "Path to the source file within the source context of the target binary.",
"type": "string"
- },
- "line": {
- "type": "integer",
- "format": "int32",
- "description": "Line inside the file. The first line in the file has the value `1`."
}
},
"id": "SourceLocation",
"description": "Represents a location in the source code."
},
"Debuggee": {
+ "id": "Debuggee",
"description": "Represents the debugged application. The application may include one or more\nreplicated processes executing the same code. Each of these processes is\nattached with a debugger agent, carrying out the debugging commands.\nAgents attached to the same debuggee identify themselves as such by using\nexactly the same Debuggee message value when registering.",
"type": "object",
"properties": {
- "project": {
- "description": "Project the debuggee is associated with.\nUse project number or id when registering a Google Cloud Platform project.",
- "type": "string"
- },
- "isDisabled": {
- "description": "If set to `true`, indicates that the agent should disable itself and\ndetach from the debuggee.",
- "type": "boolean"
- },
- "agentVersion": {
- "description": "Version ID of the agent.\nSchema: `domain/language-platform/vmajor.minor` (for example\n`google.com/java-gcp/v1.1`).",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the debuggee generated by the controller service.",
+ "uniquifier": {
+ "description": "Uniquifier to further distiguish the application.\nIt is possible that different applications might have identical values in\nthe debuggee message, thus, incorrectly identified as a single application\nby the Controller service. This field adds salt to further distiguish the\napplication. Agents should consider seeding this field with value that\nidentifies the code, binary, configuration and environment.",
"type": "string"
},
"description": {
"description": "Human readable description of the debuggee.\nIncluding a human-readable project name, environment name and version\ninformation is recommended.",
"type": "string"
},
- "uniquifier": {
- "description": "Uniquifier to further distiguish the application.\nIt is possible that different applications might have identical values in\nthe debuggee message, thus, incorrectly identified as a single application\nby the Controller service. This field adds salt to further distiguish the\napplication. Agents should consider seeding this field with value that\nidentifies the code, binary, configuration and environment.",
- "type": "string"
- },
"sourceContexts": {
"description": "References to the locations and revisions of the source code used in the\ndeployed application.",
"items": {
@@ -519,24 +504,62 @@
"type": "array"
},
"labels": {
- "description": "A set of custom debuggee properties, populated by the agent, to be\ndisplayed to the user.",
- "type": "object",
"additionalProperties": {
"type": "string"
- }
+ },
+ "description": "A set of custom debuggee properties, populated by the agent, to be\ndisplayed to the user.",
+ "type": "object"
},
"status": {
- "$ref": "StatusMessage",
- "description": "Human readable message to be displayed to the user about this debuggee.\nAbsence of this field indicates no status. The message can be either\ninformational or an error status."
+ "description": "Human readable message to be displayed to the user about this debuggee.\nAbsence of this field indicates no status. The message can be either\ninformational or an error status.",
+ "$ref": "StatusMessage"
},
"isInactive": {
"description": "If set to `true`, indicates that Controller service does not detect any\nactivity from the debuggee agents and the application is possibly stopped.",
"type": "boolean"
+ },
+ "project": {
+ "description": "Project the debuggee is associated with.\nUse project number or id when registering a Google Cloud Platform project.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the debuggee generated by the controller service.",
+ "type": "string"
+ },
+ "agentVersion": {
+ "description": "Version ID of the agent.\nSchema: `domain/language-platform/vmajor.minor` (for example\n`google.com/java-gcp/v1.1`).",
+ "type": "string"
+ },
+ "isDisabled": {
+ "description": "If set to `true`, indicates that the agent should disable itself and\ndetach from the debuggee.",
+ "type": "boolean"
}
- },
- "id": "Debuggee"
+ }
+ },
+ "ListActiveBreakpointsResponse": {
+ "id": "ListActiveBreakpointsResponse",
+ "description": "Response for listing active breakpoints.",
+ "type": "object",
+ "properties": {
+ "breakpoints": {
+ "description": "List of all active breakpoints.\nThe fields `id` and `location` are guaranteed to be set on each breakpoint.",
+ "items": {
+ "$ref": "Breakpoint"
+ },
+ "type": "array"
+ },
+ "waitExpired": {
+ "description": "If set to `true`, indicates that there is no change to the\nlist of active breakpoints and the server-selected timeout has expired.\nThe `breakpoints` field would be empty and should be ignored.",
+ "type": "boolean"
+ },
+ "nextWaitToken": {
+ "description": "A token that can be used in the next method call to block until\nthe list of breakpoints changes.",
+ "type": "string"
+ }
+ }
},
"ProjectRepoId": {
+ "id": "ProjectRepoId",
"description": "Selects a repo using a Google Cloud Platform project ID\n(e.g. winged-cargo-31) and a repo name within that project.",
"type": "object",
"properties": {
@@ -548,42 +571,19 @@
"description": "The ID of the project.",
"type": "string"
}
- },
- "id": "ProjectRepoId"
- },
- "ListActiveBreakpointsResponse": {
- "type": "object",
- "properties": {
- "breakpoints": {
- "description": "List of all active breakpoints.\nThe fields `id` and `location` are guaranteed to be set on each breakpoint.",
- "items": {
- "$ref": "Breakpoint"
- },
- "type": "array"
- },
- "waitExpired": {
- "type": "boolean",
- "description": "If set to `true`, indicates that there is no change to the\nlist of active breakpoints and the server-selected timeout has expired.\nThe `breakpoints` field would be empty and should be ignored."
- },
- "nextWaitToken": {
- "description": "A token that can be used in the next method call to block until\nthe list of breakpoints changes.",
- "type": "string"
- }
- },
- "id": "ListActiveBreakpointsResponse",
- "description": "Response for listing active breakpoints."
+ }
},
"CloudWorkspaceSourceContext": {
"description": "A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot.",
"type": "object",
"properties": {
- "workspaceId": {
- "description": "The ID of the workspace.",
- "$ref": "CloudWorkspaceId"
- },
"snapshotId": {
"description": "The ID of the snapshot.\nAn empty snapshot_id refers to the most recent snapshot.",
"type": "string"
+ },
+ "workspaceId": {
+ "$ref": "CloudWorkspaceId",
+ "description": "The ID of the workspace."
}
},
"id": "CloudWorkspaceSourceContext"
@@ -595,16 +595,7 @@
"id": "UpdateActiveBreakpointResponse"
},
"GerritSourceContext": {
- "type": "object",
"properties": {
- "revisionId": {
- "description": "A revision (commit) ID.",
- "type": "string"
- },
- "hostUri": {
- "type": "string",
- "description": "The URI of a running Gerrit instance."
- },
"aliasName": {
"description": "The name of an alias (branch, tag, etc.).",
"type": "string"
@@ -616,10 +607,19 @@
"gerritProject": {
"description": "The full project name within the host. Projects may be nested, so\n\"project/subproject\" is a valid project name.\nThe \"repo name\" is hostURI/project.",
"type": "string"
+ },
+ "revisionId": {
+ "type": "string",
+ "description": "A revision (commit) ID."
+ },
+ "hostUri": {
+ "description": "The URI of a running Gerrit instance.",
+ "type": "string"
}
},
"id": "GerritSourceContext",
- "description": "A SourceContext referring to a Gerrit project."
+ "description": "A SourceContext referring to a Gerrit project.",
+ "type": "object"
}
},
"icons": {
@@ -652,24 +652,26 @@
"debuggees": {
"methods": {
"list": {
- "path": "v2/debugger/debuggees",
- "id": "clouddebugger.debugger.debuggees.list",
"description": "Lists all the debuggees that the user has access to.",
- "httpMethod": "GET",
"response": {
"$ref": "ListDebuggeesResponse"
},
"parameterOrder": [],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ],
"parameters": {
"includeInactive": {
- "description": "When set to `true`, the result includes all debuggees. Otherwise, the\nresult includes only debuggees that are active.",
"type": "boolean",
- "location": "query"
+ "location": "query",
+ "description": "When set to `true`, the result includes all debuggees. Otherwise, the\nresult includes only debuggees that are active."
},
"project": {
- "type": "string",
"location": "query",
- "description": "Project number of a Google Cloud project whose debuggees to list."
+ "description": "Project number of a Google Cloud project whose debuggees to list.",
+ "type": "string"
},
"clientVersion": {
"location": "query",
@@ -677,29 +679,32 @@
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
- "flatPath": "v2/debugger/debuggees"
+ "flatPath": "v2/debugger/debuggees",
+ "id": "clouddebugger.debugger.debuggees.list",
+ "path": "v2/debugger/debuggees"
}
},
"resources": {
"breakpoints": {
"methods": {
"list": {
- "response": {
- "$ref": "ListBreakpointsResponse"
- },
+ "description": "Lists all breakpoints for the debuggee.",
"parameterOrder": [
"debuggeeId"
],
+ "response": {
+ "$ref": "ListBreakpointsResponse"
+ },
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ],
"parameters": {
"clientVersion": {
+ "location": "query",
"description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"action.value": {
"enum": [
@@ -710,20 +715,20 @@
"type": "string",
"location": "query"
},
+ "includeInactive": {
+ "type": "boolean",
+ "location": "query",
+ "description": "When set to `true`, the response includes active and inactive\nbreakpoints. Otherwise, it includes only active breakpoints."
+ },
"includeAllUsers": {
"description": "When set to `true`, the response includes the list of breakpoints set by\nany user. Otherwise, it includes only breakpoints set by the caller.",
"type": "boolean",
"location": "query"
},
- "includeInactive": {
- "location": "query",
- "description": "When set to `true`, the response includes active and inactive\nbreakpoints. Otherwise, it includes only active breakpoints.",
- "type": "boolean"
- },
"stripResults": {
+ "description": "This field is deprecated. The following fields are always stripped out of\nthe result: `stack_frames`, `evaluated_expressions` and `variable_table`.",
"type": "boolean",
- "location": "query",
- "description": "This field is deprecated. The following fields are always stripped out of\nthe result: `stack_frames`, `evaluated_expressions` and `variable_table`."
+ "location": "query"
},
"debuggeeId": {
"type": "string",
@@ -737,54 +742,48 @@
"location": "query"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
"flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints",
"id": "clouddebugger.debugger.debuggees.breakpoints.list",
- "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints",
- "description": "Lists all breakpoints for the debuggee."
+ "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints"
},
"get": {
- "httpMethod": "GET",
+ "response": {
+ "$ref": "GetBreakpointResponse"
+ },
"parameterOrder": [
"debuggeeId",
"breakpointId"
],
- "response": {
- "$ref": "GetBreakpointResponse"
- },
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ],
"parameters": {
+ "debuggeeId": {
+ "location": "path",
+ "description": "ID of the debuggee whose breakpoint to get.",
+ "type": "string",
+ "required": true
+ },
"clientVersion": {
"description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
"type": "string",
"location": "query"
},
"breakpointId": {
- "location": "path",
"description": "ID of the breakpoint to get.",
"type": "string",
- "required": true
- },
- "debuggeeId": {
- "location": "path",
- "description": "ID of the debuggee whose breakpoint to get.",
- "type": "string",
- "required": true
+ "required": true,
+ "location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
"flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
- "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
"id": "clouddebugger.debugger.debuggees.breakpoints.get",
+ "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
"description": "Gets breakpoint information."
},
"delete": {
- "httpMethod": "DELETE",
"response": {
"$ref": "Empty"
},
@@ -792,62 +791,63 @@
"debuggeeId",
"breakpointId"
],
+ "httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud_debugger"
],
"parameters": {
+ "debuggeeId": {
+ "location": "path",
+ "description": "ID of the debuggee whose breakpoint to delete.",
+ "type": "string",
+ "required": true
+ },
+ "clientVersion": {
+ "type": "string",
+ "location": "query",
+ "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`)."
+ },
"breakpointId": {
"description": "ID of the breakpoint to delete.",
"type": "string",
"required": true,
"location": "path"
- },
- "debuggeeId": {
- "description": "ID of the debuggee whose breakpoint to delete.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "clientVersion": {
- "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
- "type": "string",
- "location": "query"
}
},
"flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
- "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
"id": "clouddebugger.debugger.debuggees.breakpoints.delete",
+ "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
"description": "Deletes the breakpoint from the debuggee."
},
"set": {
- "httpMethod": "POST",
- "parameterOrder": [
- "debuggeeId"
- ],
"response": {
"$ref": "SetBreakpointResponse"
},
+ "parameterOrder": [
+ "debuggeeId"
+ ],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud_debugger"
],
"parameters": {
"clientVersion": {
+ "location": "query",
"description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"debuggeeId": {
- "location": "path",
- "description": "ID of the debuggee where the breakpoint is to be set.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path",
+ "description": "ID of the debuggee where the breakpoint is to be set."
}
},
"flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints/set",
- "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/set",
"id": "clouddebugger.debugger.debuggees.breakpoints.set",
+ "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/set",
"request": {
"$ref": "Breakpoint"
},
@@ -864,51 +864,48 @@
"debuggees": {
"methods": {
"register": {
+ "request": {
+ "$ref": "RegisterDebuggeeRequest"
+ },
+ "description": "Registers the debuggee with the controller service.\n\nAll agents attached to the same application must call this method with\nexactly the same request content to get back the same stable `debuggee_id`.\nAgents should call this method again whenever `google.rpc.Code.NOT_FOUND`\nis returned from any controller method.\n\nThis protocol allows the controller service to disable debuggees, recover\nfrom data loss, or change the `debuggee_id` format. Agents must handle\n`debuggee_id` value changing upon re-registration.",
"response": {
"$ref": "RegisterDebuggeeResponse"
},
"parameterOrder": [],
"httpMethod": "POST",
- "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud_debugger"
],
+ "parameters": {},
"flatPath": "v2/controller/debuggees/register",
"id": "clouddebugger.controller.debuggees.register",
- "path": "v2/controller/debuggees/register",
- "description": "Registers the debuggee with the controller service.\n\nAll agents attached to the same application must call this method with\nexactly the same request content to get back the same stable `debuggee_id`.\nAgents should call this method again whenever `google.rpc.Code.NOT_FOUND`\nis returned from any controller method.\n\nThis protocol allows the controller service to disable debuggees, recover\nfrom data loss, or change the `debuggee_id` format. Agents must handle\n`debuggee_id` value changing upon re-registration.",
- "request": {
- "$ref": "RegisterDebuggeeRequest"
- }
+ "path": "v2/controller/debuggees/register"
}
},
"resources": {
"breakpoints": {
"methods": {
"list": {
- "response": {
- "$ref": "ListActiveBreakpointsResponse"
- },
+ "description": "Returns the list of all active breakpoints for the debuggee.\n\nThe breakpoint specification (`location`, `condition`, and `expressions`\nfields) is semantically immutable, although the field values may\nchange. For example, an agent may update the location line number\nto reflect the actual line where the breakpoint was set, but this\ndoesn't change the breakpoint semantics.\n\nThis means that an agent does not need to check if a breakpoint has changed\nwhen it encounters the same breakpoint on a successive call.\nMoreover, an agent should remember the breakpoints that are completed\nuntil the controller removes them from the active list to avoid\nsetting those breakpoints again.",
+ "httpMethod": "GET",
"parameterOrder": [
"debuggeeId"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
+ "response": {
+ "$ref": "ListActiveBreakpointsResponse"
+ },
"parameters": {
"successOnTimeout": {
+ "type": "boolean",
"location": "query",
- "description": "If set to `true` (recommended), returns `google.rpc.Code.OK` status and\nsets the `wait_expired` response field to `true` when the server-selected\ntimeout has expired.\n\nIf set to `false` (deprecated), returns `google.rpc.Code.ABORTED` status\nwhen the server-selected timeout has expired.",
- "type": "boolean"
+ "description": "If set to `true` (recommended), returns `google.rpc.Code.OK` status and\nsets the `wait_expired` response field to `true` when the server-selected\ntimeout has expired.\n\nIf set to `false` (deprecated), returns `google.rpc.Code.ABORTED` status\nwhen the server-selected timeout has expired."
},
"debuggeeId": {
+ "location": "path",
"description": "Identifies the debuggee.",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
},
"waitToken": {
"location": "query",
@@ -916,14 +913,15 @@
"type": "string"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ],
"flatPath": "v2/controller/debuggees/{debuggeeId}/breakpoints",
- "id": "clouddebugger.controller.debuggees.breakpoints.list",
"path": "v2/controller/debuggees/{debuggeeId}/breakpoints",
- "description": "Returns the list of all active breakpoints for the debuggee.\n\nThe breakpoint specification (`location`, `condition`, and `expressions`\nfields) is semantically immutable, although the field values may\nchange. For example, an agent may update the location line number\nto reflect the actual line where the breakpoint was set, but this\ndoesn't change the breakpoint semantics.\n\nThis means that an agent does not need to check if a breakpoint has changed\nwhen it encounters the same breakpoint on a successive call.\nMoreover, an agent should remember the breakpoints that are completed\nuntil the controller removes them from the active list to avoid\nsetting those breakpoints again."
+ "id": "clouddebugger.controller.debuggees.breakpoints.list"
},
"update": {
- "id": "clouddebugger.controller.debuggees.breakpoints.update",
- "path": "v2/controller/debuggees/{debuggeeId}/breakpoints/{id}",
"description": "Updates the breakpoint state or mutable fields.\nThe entire Breakpoint message must be sent back to the controller service.\n\nUpdates to active breakpoint fields are only allowed if the new value\ndoes not change the breakpoint specification. Updates to the `location`,\n`condition` and `expressions` fields should not alter the breakpoint\nsemantics. These may only make changes such as canonicalizing a value\nor snapping the location to the correct line of code.",
"request": {
"$ref": "UpdateActiveBreakpointRequest"
@@ -937,15 +935,15 @@
],
"httpMethod": "PUT",
"parameters": {
- "debuggeeId": {
+ "id": {
+ "description": "Breakpoint identifier, unique in the scope of the debuggee.",
"type": "string",
"required": true,
- "location": "path",
- "description": "Identifies the debuggee being debugged."
+ "location": "path"
},
- "id": {
+ "debuggeeId": {
"location": "path",
- "description": "Breakpoint identifier, unique in the scope of the debuggee.",
+ "description": "Identifies the debuggee being debugged.",
"type": "string",
"required": true
}
@@ -954,7 +952,9 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud_debugger"
],
- "flatPath": "v2/controller/debuggees/{debuggeeId}/breakpoints/{id}"
+ "flatPath": "v2/controller/debuggees/{debuggeeId}/breakpoints/{id}",
+ "id": "clouddebugger.controller.debuggees.breakpoints.update",
+ "path": "v2/controller/debuggees/{debuggeeId}/breakpoints/{id}"
}
}
}
@@ -964,10 +964,36 @@
}
},
"parameters": {
- "quotaUser": {
- "type": "string",
+ "alt": {
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
"location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
},
"pp": {
"location": "query",
@@ -976,14 +1002,14 @@
"type": "boolean"
},
"bearer_token": {
- "description": "OAuth bearer token.",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "OAuth bearer token."
},
"oauth_token": {
+ "location": "query",
"description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"upload_protocol": {
"location": "query",
@@ -991,22 +1017,24 @@
"type": "string"
},
"prettyPrint": {
- "default": "true",
- "type": "boolean",
"location": "query",
- "description": "Returns response with indentations and line breaks."
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "fields": {
+ "type": "string",
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response."
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
},
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
"$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -1015,40 +1043,12 @@
"enum": [
"1",
"2"
- ],
- "description": "V1 error format.",
- "type": "string"
+ ]
},
"callback": {
- "type": "string",
"location": "query",
- "description": "JSONP"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "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.",
+ "description": "JSONP",
"type": "string"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
}
},
"version": "v2",
diff --git a/clouderrorreporting/v1beta1/clouderrorreporting-api.json b/clouderrorreporting/v1beta1/clouderrorreporting-api.json
index b3a13e0..a3f124e 100644
--- a/clouderrorreporting/v1beta1/clouderrorreporting-api.json
+++ b/clouderrorreporting/v1beta1/clouderrorreporting-api.json
@@ -1,36 +1,431 @@
{
+ "canonicalName": "Clouderrorreporting",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://clouderrorreporting.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "clouderrorreporting",
+ "batchPath": "batch",
+ "title": "Stackdriver Error Reporting API",
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "resources": {
+ "groupStats": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListGroupStatsResponse"
+ },
+ "parameterOrder": [
+ "projectName"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "timeRange.period": {
+ "enum": [
+ "PERIOD_UNSPECIFIED",
+ "PERIOD_1_HOUR",
+ "PERIOD_6_HOURS",
+ "PERIOD_1_DAY",
+ "PERIOD_1_WEEK",
+ "PERIOD_30_DAYS"
+ ],
+ "description": "Restricts the query to the specified time range.",
+ "type": "string",
+ "location": "query"
+ },
+ "alignment": {
+ "enum": [
+ "ERROR_COUNT_ALIGNMENT_UNSPECIFIED",
+ "ALIGNMENT_EQUAL_ROUNDED",
+ "ALIGNMENT_EQUAL_AT_END"
+ ],
+ "description": "[Optional] The alignment of the timed counts to be returned.\nDefault is `ALIGNMENT_EQUAL_AT_END`.",
+ "type": "string",
+ "location": "query"
+ },
+ "groupId": {
+ "repeated": true,
+ "location": "query",
+ "description": "[Optional] List all \u003ccode\u003eErrorGroupStats\u003c/code\u003e with these IDs.",
+ "type": "string"
+ },
+ "serviceFilter.service": {
+ "description": "[Optional] The exact value to match against\n[`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "[Optional] The maximum number of results to return per response.\nDefault is 20.",
+ "type": "integer",
+ "location": "query"
+ },
+ "order": {
+ "enum": [
+ "GROUP_ORDER_UNSPECIFIED",
+ "COUNT_DESC",
+ "LAST_SEEN_DESC",
+ "CREATED_DESC",
+ "AFFECTED_USERS_DESC"
+ ],
+ "description": "[Optional] The sort order in which the results are returned.\nDefault is `COUNT_DESC`.",
+ "type": "string",
+ "location": "query"
+ },
+ "serviceFilter.version": {
+ "description": "[Optional] The exact value to match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).",
+ "type": "string",
+ "location": "query"
+ },
+ "serviceFilter.resourceType": {
+ "location": "query",
+ "description": "[Optional] The exact value to match against\n[`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).",
+ "type": "string"
+ },
+ "alignmentTime": {
+ "format": "google-datetime",
+ "description": "[Optional] Time where the timed counts shall be aligned if rounded\nalignment is chosen. Default is 00:00 UTC.",
+ "type": "string",
+ "location": "query"
+ },
+ "projectName": {
+ "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas \u003ccode\u003eprojects/\u003c/code\u003e plus the\n\u003ca href=\"https://support.google.com/cloud/answer/6158840\"\u003eGoogle Cloud\nPlatform project ID\u003c/a\u003e.\n\nExample: \u003ccode\u003eprojects/my-project-123\u003c/code\u003e.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "timedCountDuration": {
+ "format": "google-duration",
+ "description": "[Optional] The preferred duration for a single returned `TimedCount`.\nIf not set, no timed counts are returned.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "[Optional] A `next_page_token` provided by a previous response. To view\nadditional results, pass this token along with the identical query\nparameters as the first request.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/groupStats",
+ "id": "clouderrorreporting.projects.groupStats.list",
+ "path": "v1beta1/{+projectName}/groupStats",
+ "description": "Lists the specified groups."
+ }
+ }
+ },
+ "groups": {
+ "methods": {
+ "get": {
+ "path": "v1beta1/{+groupName}",
+ "id": "clouderrorreporting.projects.groups.get",
+ "description": "Get the specified group.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "groupName"
+ ],
+ "response": {
+ "$ref": "ErrorGroup"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "groupName": {
+ "pattern": "^projects/[^/]+/groups/[^/]+$",
+ "location": "path",
+ "description": "[Required] The group resource name. Written as\n\u003ccode\u003eprojects/\u003cvar\u003eprojectID\u003c/var\u003e/groups/\u003cvar\u003egroup_name\u003c/var\u003e\u003c/code\u003e.\nCall\n\u003ca href=\"/error-reporting/reference/rest/v1beta1/projects.groupStats/list\"\u003e\n\u003ccode\u003egroupStats.list\u003c/code\u003e\u003c/a\u003e to return a list of groups belonging to\nthis project.\n\nExample: \u003ccode\u003eprojects/my-project-123/groups/my-group\u003c/code\u003e",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/groups/{groupsId}"
+ },
+ "update": {
+ "response": {
+ "$ref": "ErrorGroup"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/groups/[^/]+$",
+ "location": "path",
+ "description": "The group resource name.\nExample: \u003ccode\u003eprojects/my-project-123/groups/my-groupid\u003c/code\u003e",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/groups/{groupsId}",
+ "id": "clouderrorreporting.projects.groups.update",
+ "path": "v1beta1/{+name}",
+ "description": "Replace the data for the specified group.\nFails if the group does not exist.",
+ "request": {
+ "$ref": "ErrorGroup"
+ }
+ }
+ }
+ },
+ "events": {
+ "methods": {
+ "report": {
+ "response": {
+ "$ref": "ReportErrorEventResponse"
+ },
+ "parameterOrder": [
+ "projectName"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectName": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840).\nExample: `projects/my-project-123`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/events:report",
+ "id": "clouderrorreporting.projects.events.report",
+ "path": "v1beta1/{+projectName}/events:report",
+ "request": {
+ "$ref": "ReportedErrorEvent"
+ },
+ "description": "Report an individual error event.\n\nThis endpoint accepts \u003cstrong\u003eeither\u003c/strong\u003e an OAuth token,\n\u003cstrong\u003eor\u003c/strong\u003e an\n\u003ca href=\"https://support.google.com/cloud/answer/6158862\"\u003eAPI key\u003c/a\u003e\nfor authentication. To use an API key, append it to the URL as the value of\na `key` parameter. For example:\n\u003cpre\u003ePOST https://clouderrorreporting.googleapis.com/v1beta1/projects/example-project/events:report?key=123ABC456\u003c/pre\u003e"
+ },
+ "list": {
+ "id": "clouderrorreporting.projects.events.list",
+ "path": "v1beta1/{+projectName}/events",
+ "description": "Lists the specified events.",
+ "response": {
+ "$ref": "ListEventsResponse"
+ },
+ "parameterOrder": [
+ "projectName"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "serviceFilter.version": {
+ "location": "query",
+ "description": "[Optional] The exact value to match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).",
+ "type": "string"
+ },
+ "serviceFilter.resourceType": {
+ "location": "query",
+ "description": "[Optional] The exact value to match against\n[`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).",
+ "type": "string"
+ },
+ "timeRange.period": {
+ "enum": [
+ "PERIOD_UNSPECIFIED",
+ "PERIOD_1_HOUR",
+ "PERIOD_6_HOURS",
+ "PERIOD_1_DAY",
+ "PERIOD_1_WEEK",
+ "PERIOD_30_DAYS"
+ ],
+ "description": "Restricts the query to the specified time range.",
+ "type": "string",
+ "location": "query"
+ },
+ "projectName": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google Cloud Platform project\nID](https://support.google.com/cloud/answer/6158840).\nExample: `projects/my-project-123`.",
+ "type": "string",
+ "required": true
+ },
+ "groupId": {
+ "location": "query",
+ "description": "[Required] The group for which events shall be returned.",
+ "type": "string"
+ },
+ "serviceFilter.service": {
+ "description": "[Optional] The exact value to match against\n[`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "description": "[Optional] A `next_page_token` provided by a previous response.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "[Optional] The maximum number of results to return per response.",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/events"
+ }
+ }
+ }
+ },
+ "methods": {
+ "deleteEvents": {
+ "response": {
+ "$ref": "DeleteEventsResponse"
+ },
+ "parameterOrder": [
+ "projectName"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectName": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google Cloud Platform project\nID](https://support.google.com/cloud/answer/6158840).\nExample: `projects/my-project-123`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/events",
+ "id": "clouderrorreporting.projects.deleteEvents",
+ "path": "v1beta1/{+projectName}/events",
+ "description": "Deletes all error events of a given project."
+ }
+ }
+ }
+ },
+ "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.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query"
+ },
+ "alt": {
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ }
+ },
+ "version": "v1beta1",
+ "baseUrl": "https://clouderrorreporting.googleapis.com/",
+ "servicePath": "",
+ "description": "Groups and counts similar errors from cloud services and applications, reports new errors, and provides access to error groups and their associated errors.\n",
+ "kind": "discovery#restDescription",
"basePath": "",
"documentationLink": "https://cloud.google.com/error-reporting/",
- "revision": "20171002",
"id": "clouderrorreporting:v1beta1",
+ "revision": "20171006",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "DeleteEventsResponse": {
- "description": "Response message for deleting error events.",
- "type": "object",
- "properties": {},
- "id": "DeleteEventsResponse"
- },
- "SourceReference": {
- "description": "A reference to a particular snapshot of the source tree used to build and\ndeploy an application.",
- "type": "object",
- "properties": {
- "revisionId": {
- "description": "The canonical and persistent identifier of the deployed revision.\nExample (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b\"",
- "type": "string"
- },
- "repository": {
- "description": "Optional. A URI string identifying the repository.\nExample: \"https://github.com/GoogleCloudPlatform/kubernetes.git\"",
- "type": "string"
- }
- },
- "id": "SourceReference"
- },
"ErrorEvent": {
"description": "An error event which is returned by the Error Reporting system.",
"type": "object",
"properties": {
+ "context": {
+ "description": "Data about the context in which the error occurred.",
+ "$ref": "ErrorContext"
+ },
+ "message": {
+ "description": "The stack trace that was reported or logged by the service.",
+ "type": "string"
+ },
"serviceContext": {
"description": "The `ServiceContext` for which this error was reported.",
"$ref": "ServiceContext"
@@ -39,21 +434,20 @@
"format": "google-datetime",
"description": "Time when the event occurred as provided in the error report.\nIf the report did not contain a timestamp, the time the error was received\nby the Error Reporting system is used.",
"type": "string"
- },
- "context": {
- "description": "Data about the context in which the error occurred.",
- "$ref": "ErrorContext"
- },
- "message": {
- "description": "The stack trace that was reported or logged by the service.",
- "type": "string"
}
},
"id": "ErrorEvent"
},
"ReportedErrorEvent": {
- "type": "object",
"properties": {
+ "context": {
+ "description": "[Optional] A description of the context in which the error occurred.",
+ "$ref": "ErrorContext"
+ },
+ "message": {
+ "description": "[Required] The error message.\nIf no `context.reportLocation` is provided, the message must contain a\nheader (typically consisting of the exception type name and an error\nmessage) and an exception stack trace in one of the supported programming\nlanguages and formats.\nSupported languages are Java, Python, JavaScript, Ruby, C#, PHP, and Go.\nSupported stack trace formats are:\n\n* **Java**: Must be the return value of [`Throwable.printStackTrace()`](https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html#printStackTrace%28%29).\n* **Python**: Must be the return value of [`traceback.format_exc()`](https://docs.python.org/2/library/traceback.html#traceback.format_exc).\n* **JavaScript**: Must be the value of [`error.stack`](https://github.com/v8/v8/wiki/Stack-Trace-API)\nas returned by V8.\n* **Ruby**: Must contain frames returned by [`Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method-i-backtrace).\n* **C#**: Must be the return value of [`Exception.ToString()`](https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx).\n* **PHP**: Must start with `PHP (Notice|Parse error|Fatal error|Warning)`\nand contain the result of [`(string)$exception`](http://php.net/manual/en/exception.tostring.php).\n* **Go**: Must be the return value of [`runtime.Stack()`](https://golang.org/pkg/runtime/debug/#Stack).",
+ "type": "string"
+ },
"serviceContext": {
"description": "[Required] The service context in which this error has occurred.",
"$ref": "ServiceContext"
@@ -62,29 +456,14 @@
"format": "google-datetime",
"description": "[Optional] Time when the event occurred.\nIf not provided, the time when the event was received by the\nError Reporting system will be used.",
"type": "string"
- },
- "context": {
- "description": "[Optional] A description of the context in which the error occurred.",
- "$ref": "ErrorContext"
- },
- "message": {
- "description": "[Required] The error message.\nIf no `context.reportLocation` is provided, the message must contain a\nheader (typically consisting of the exception type name and an error\nmessage) and an exception stack trace in one of the supported programming\nlanguages and formats.\nSupported languages are Java, Python, JavaScript, Ruby, C#, PHP, and Go.\nSupported stack trace formats are:\n\n* **Java**: Must be the return value of [`Throwable.printStackTrace()`](https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html#printStackTrace%28%29).\n* **Python**: Must be the return value of [`traceback.format_exc()`](https://docs.python.org/2/library/traceback.html#traceback.format_exc).\n* **JavaScript**: Must be the value of [`error.stack`](https://github.com/v8/v8/wiki/Stack-Trace-API)\nas returned by V8.\n* **Ruby**: Must contain frames returned by [`Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method-i-backtrace).\n* **C#**: Must be the return value of [`Exception.ToString()`](https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx).\n* **PHP**: Must start with `PHP (Notice|Parse error|Fatal error|Warning)`\nand contain the result of [`(string)$exception`](http://php.net/manual/en/exception.tostring.php).\n* **Go**: Must be the return value of [`runtime.Stack()`](https://golang.org/pkg/runtime/debug/#Stack).",
- "type": "string"
}
},
"id": "ReportedErrorEvent",
- "description": "An error event which is reported to the Error Reporting system."
+ "description": "An error event which is reported to the Error Reporting system.",
+ "type": "object"
},
"ErrorContext": {
"properties": {
- "httpRequest": {
- "$ref": "HttpRequestContext",
- "description": "The HTTP request which was processed when the error was\ntriggered."
- },
- "user": {
- "description": "The user who caused or was affected by the crash.\nThis can be a user ID, an email address, or an arbitrary token that\nuniquely identifies the user.\nWhen sending an error report, leave this field empty if the user was not\nlogged in. In this case the\nError Reporting system will use other data, such as remote IP address, to\ndistinguish affected users. See `affected_users_count` in\n`ErrorGroupStats`.",
- "type": "string"
- },
"sourceReferences": {
"description": "Source code that was used to build the executable which has\ncaused the given error message.",
"items": {
@@ -95,6 +474,14 @@
"reportLocation": {
"$ref": "SourceLocation",
"description": "The location in the source code where the decision was made to\nreport the error, usually the place where it was logged.\nFor a logged exception this would be the source line where the\nexception is logged, usually close to the place where it was\ncaught."
+ },
+ "httpRequest": {
+ "$ref": "HttpRequestContext",
+ "description": "The HTTP request which was processed when the error was\ntriggered."
+ },
+ "user": {
+ "description": "The user who caused or was affected by the crash.\nThis can be a user ID, an email address, or an arbitrary token that\nuniquely identifies the user.\nWhen sending an error report, leave this field empty if the user was not\nlogged in. In this case the\nError Reporting system will use other data, such as remote IP address, to\ndistinguish affected users. See `affected_users_count` in\n`ErrorGroupStats`.",
+ "type": "string"
}
},
"id": "ErrorContext",
@@ -102,19 +489,22 @@
"type": "object"
},
"TrackingIssue": {
- "description": "Information related to tracking the progress on resolving the error.",
- "type": "object",
"properties": {
"url": {
"description": "A URL pointing to a related entry in an issue tracking system.\nExample: https://github.com/user/project/issues/4",
"type": "string"
}
},
- "id": "TrackingIssue"
+ "id": "TrackingIssue",
+ "description": "Information related to tracking the progress on resolving the error.",
+ "type": "object"
},
"ErrorGroupStats": {
- "type": "object",
"properties": {
+ "group": {
+ "$ref": "ErrorGroup",
+ "description": "Group data that is independent of the filter criteria."
+ },
"firstSeenTime": {
"format": "google-datetime",
"description": "Approximate first occurrence that was ever seen for this group\nand which matches the given filter criteria, ignoring the\ntime_range that was specified in the request.",
@@ -125,15 +515,20 @@
"description": "Approximate total number of events in the given group that match\nthe filter criteria.",
"type": "string"
},
+ "lastSeenTime": {
+ "format": "google-datetime",
+ "description": "Approximate last occurrence that was ever seen for this group and\nwhich matches the given filter criteria, ignoring the time_range\nthat was specified in the request.",
+ "type": "string"
+ },
"affectedUsersCount": {
"format": "int64",
"description": "Approximate number of affected users in the given group that\nmatch the filter criteria.\nUsers are distinguished by data in the `ErrorContext` of the\nindividual error events, such as their login name or their remote\nIP address in case of HTTP requests.\nThe number of affected users can be zero even if the number of\nerrors is non-zero if no data was provided from which the\naffected user could be deduced.\nUsers are counted based on data in the request\ncontext that was provided in the error report. If more users are\nimplicitly affected, such as due to a crash of the whole service,\nthis is not reflected here.",
"type": "string"
},
- "lastSeenTime": {
- "format": "google-datetime",
- "description": "Approximate last occurrence that was ever seen for this group and\nwhich matches the given filter criteria, ignoring the time_range\nthat was specified in the request.",
- "type": "string"
+ "numAffectedServices": {
+ "format": "int32",
+ "description": "The total number of services with a non-zero error count for the given\nfilter criteria.",
+ "type": "integer"
},
"affectedServices": {
"description": "Service contexts with a non-zero error count for the given filter\ncriteria. This list can be truncated if multiple services are affected.\nRefer to `num_affected_services` for the total count.",
@@ -142,14 +537,9 @@
},
"type": "array"
},
- "numAffectedServices": {
- "format": "int32",
- "description": "The total number of services with a non-zero error count for the given\nfilter criteria.",
- "type": "integer"
- },
"representative": {
- "$ref": "ErrorEvent",
- "description": "An arbitrary event that is chosen as representative for the whole group.\nThe representative event is intended to be used as a quick preview for\nthe whole group. Events in the group are usually sufficiently similar\nto each other such that showing an arbitrary representative provides\ninsight into the characteristics of the group as a whole."
+ "description": "An arbitrary event that is chosen as representative for the whole group.\nThe representative event is intended to be used as a quick preview for\nthe whole group. Events in the group are usually sufficiently similar\nto each other such that showing an arbitrary representative provides\ninsight into the characteristics of the group as a whole.",
+ "$ref": "ErrorEvent"
},
"timedCounts": {
"description": "Approximate number of occurrences over time.\nTimed counts returned by ListGroups are guaranteed to be:\n\n- Inside the requested time interval\n- Non-overlapping, and\n- Ordered by ascending time.",
@@ -157,21 +547,24 @@
"$ref": "TimedCount"
},
"type": "array"
- },
- "group": {
- "$ref": "ErrorGroup",
- "description": "Group data that is independent of the filter criteria."
}
},
"id": "ErrorGroupStats",
- "description": "Data extracted for a specific group based on certain filter criteria,\nsuch as a given time period and/or service filter."
+ "description": "Data extracted for a specific group based on certain filter criteria,\nsuch as a given time period and/or service filter.",
+ "type": "object"
},
"ListEventsResponse": {
+ "description": "Contains a set of requested error events.",
+ "type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "If non-empty, more results are available.\nPass this token, along with the same query parameters as the first\nrequest, to view the next page of results.",
+ "type": "string"
+ },
"timeRangeBegin": {
- "type": "string",
"format": "google-datetime",
- "description": "The timestamp specifies the start time to which the request was restricted."
+ "description": "The timestamp specifies the start time to which the request was restricted.",
+ "type": "string"
},
"errorEvents": {
"description": "The error events which match the given request.",
@@ -179,19 +572,11 @@
"$ref": "ErrorEvent"
},
"type": "array"
- },
- "nextPageToken": {
- "description": "If non-empty, more results are available.\nPass this token, along with the same query parameters as the first\nrequest, to view the next page of results.",
- "type": "string"
}
},
- "id": "ListEventsResponse",
- "description": "Contains a set of requested error events.",
- "type": "object"
+ "id": "ListEventsResponse"
},
"TimedCount": {
- "description": "The number of errors in a given time period.\nAll numbers are approximate since the error events are sampled\nbefore counting them.",
- "type": "object",
"properties": {
"endTime": {
"format": "google-datetime",
@@ -209,11 +594,11 @@
"type": "string"
}
},
- "id": "TimedCount"
+ "id": "TimedCount",
+ "description": "The number of errors in a given time period.\nAll numbers are approximate since the error events are sampled\nbefore counting them.",
+ "type": "object"
},
"ErrorGroup": {
- "description": "Description of a group of similar error events.",
- "type": "object",
"properties": {
"trackingIssues": {
"description": "Associated tracking issues.",
@@ -231,34 +616,17 @@
"type": "string"
}
},
- "id": "ErrorGroup"
- },
- "ServiceContext": {
- "description": "Describes a running service that sends errors.\nIts version changes over time and multiple versions can run in parallel.",
- "type": "object",
- "properties": {
- "resourceType": {
- "description": "Type of the MonitoredResource. List of possible values:\nhttps://cloud.google.com/monitoring/api/resources\n\nValue is set automatically for incoming errors and must not be set when\nreporting errors.",
- "type": "string"
- },
- "version": {
- "description": "Represents the source code version that the developer provided,\nwhich could represent a version label or a Git SHA-1 hash, for example.\nFor App Engine standard environment, the version is set to the version of\nthe app.",
- "type": "string"
- },
- "service": {
- "description": "An identifier of the service, such as the name of the\nexecutable, job, or Google App Engine service name. This field is expected\nto have a low number of values that are relatively stable over time, as\nopposed to `version`, which can be changed whenever new code is deployed.\n\nContains the service name for error reports extracted from Google\nApp Engine logs or `default` if the App Engine default service is used.",
- "type": "string"
- }
- },
- "id": "ServiceContext"
+ "id": "ErrorGroup",
+ "description": "Description of a group of similar error events.",
+ "type": "object"
},
"SourceLocation": {
"description": "Indicates a location in the source code of the service for which errors are\nreported. `functionName` must be provided by the application when reporting\nan error, unless the error report contains a `message` with a supported\nexception stack trace. All fields are optional for the later case.",
"type": "object",
"properties": {
"functionName": {
- "type": "string",
- "description": "Human-readable name of a function or method.\nThe value can include optional context like the class or package name.\nFor example, `my.package.MyClass.method` in case of Java."
+ "description": "Human-readable name of a function or method.\nThe value can include optional context like the class or package name.\nFor example, `my.package.MyClass.method` in case of Java.",
+ "type": "string"
},
"filePath": {
"description": "The source code filename, which can include a truncated relative\npath, or a full path from a production machine.",
@@ -272,26 +640,35 @@
},
"id": "SourceLocation"
},
+ "ServiceContext": {
+ "properties": {
+ "version": {
+ "description": "Represents the source code version that the developer provided,\nwhich could represent a version label or a Git SHA-1 hash, for example.\nFor App Engine standard environment, the version is set to the version of\nthe app.",
+ "type": "string"
+ },
+ "service": {
+ "description": "An identifier of the service, such as the name of the\nexecutable, job, or Google App Engine service name. This field is expected\nto have a low number of values that are relatively stable over time, as\nopposed to `version`, which can be changed whenever new code is deployed.\n\nContains the service name for error reports extracted from Google\nApp Engine logs or `default` if the App Engine default service is used.",
+ "type": "string"
+ },
+ "resourceType": {
+ "description": "Type of the MonitoredResource. List of possible values:\nhttps://cloud.google.com/monitoring/api/resources\n\nValue is set automatically for incoming errors and must not be set when\nreporting errors.",
+ "type": "string"
+ }
+ },
+ "id": "ServiceContext",
+ "description": "Describes a running service that sends errors.\nIts version changes over time and multiple versions can run in parallel.",
+ "type": "object"
+ },
"ReportErrorEventResponse": {
- "id": "ReportErrorEventResponse",
"description": "Response for reporting an individual error event.\nData may be added to this message in the future.",
"type": "object",
- "properties": {}
+ "properties": {},
+ "id": "ReportErrorEventResponse"
},
"HttpRequestContext": {
- "id": "HttpRequestContext",
"description": "HTTP request data that is related to a reported error.\nThis data should be provided by the application when reporting an error,\nunless the\nerror report has been generated automatically from Google App Engine logs.",
"type": "object",
"properties": {
- "responseStatusCode": {
- "format": "int32",
- "description": "The HTTP response status code for the request.",
- "type": "integer"
- },
- "method": {
- "type": "string",
- "description": "The type of HTTP request, such as `GET`, `POST`, etc."
- },
"remoteIp": {
"description": "The IP address from which the request originated.\nThis can be IPv4, IPv6, or a token which is derived from the\nIP address, depending on the data that has been provided\nin the error report.",
"type": "string"
@@ -307,8 +684,18 @@
"url": {
"description": "The URL of the request.",
"type": "string"
+ },
+ "responseStatusCode": {
+ "format": "int32",
+ "description": "The HTTP response status code for the request.",
+ "type": "integer"
+ },
+ "method": {
+ "description": "The type of HTTP request, such as `GET`, `POST`, etc.",
+ "type": "string"
}
- }
+ },
+ "id": "HttpRequestContext"
},
"ListGroupStatsResponse": {
"properties": {
@@ -332,419 +719,32 @@
"id": "ListGroupStatsResponse",
"description": "Contains a set of requested error group stats.",
"type": "object"
+ },
+ "SourceReference": {
+ "description": "A reference to a particular snapshot of the source tree used to build and\ndeploy an application.",
+ "type": "object",
+ "properties": {
+ "revisionId": {
+ "description": "The canonical and persistent identifier of the deployed revision.\nExample (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b\"",
+ "type": "string"
+ },
+ "repository": {
+ "description": "Optional. A URI string identifying the repository.\nExample: \"https://github.com/GoogleCloudPlatform/kubernetes.git\"",
+ "type": "string"
+ }
+ },
+ "id": "SourceReference"
+ },
+ "DeleteEventsResponse": {
+ "description": "Response message for deleting error events.",
+ "type": "object",
+ "properties": {},
+ "id": "DeleteEventsResponse"
}
},
- "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": "Clouderrorreporting",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "rootUrl": "https://clouderrorreporting.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "clouderrorreporting",
- "batchPath": "batch",
- "title": "Stackdriver Error Reporting API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "methods": {
- "deleteEvents": {
- "description": "Deletes all error events of a given project.",
- "response": {
- "$ref": "DeleteEventsResponse"
- },
- "parameterOrder": [
- "projectName"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectName": {
- "location": "path",
- "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google Cloud Platform project\nID](https://support.google.com/cloud/answer/6158840).\nExample: `projects/my-project-123`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/events",
- "id": "clouderrorreporting.projects.deleteEvents",
- "path": "v1beta1/{+projectName}/events"
- }
- },
- "resources": {
- "groupStats": {
- "methods": {
- "list": {
- "flatPath": "v1beta1/projects/{projectsId}/groupStats",
- "id": "clouderrorreporting.projects.groupStats.list",
- "path": "v1beta1/{+projectName}/groupStats",
- "description": "Lists the specified groups.",
- "response": {
- "$ref": "ListGroupStatsResponse"
- },
- "parameterOrder": [
- "projectName"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "pageToken": {
- "description": "[Optional] A `next_page_token` provided by a previous response. To view\nadditional results, pass this token along with the identical query\nparameters as the first request.",
- "type": "string",
- "location": "query"
- },
- "timeRange.period": {
- "description": "Restricts the query to the specified time range.",
- "type": "string",
- "location": "query",
- "enum": [
- "PERIOD_UNSPECIFIED",
- "PERIOD_1_HOUR",
- "PERIOD_6_HOURS",
- "PERIOD_1_DAY",
- "PERIOD_1_WEEK",
- "PERIOD_30_DAYS"
- ]
- },
- "alignment": {
- "location": "query",
- "enum": [
- "ERROR_COUNT_ALIGNMENT_UNSPECIFIED",
- "ALIGNMENT_EQUAL_ROUNDED",
- "ALIGNMENT_EQUAL_AT_END"
- ],
- "description": "[Optional] The alignment of the timed counts to be returned.\nDefault is `ALIGNMENT_EQUAL_AT_END`.",
- "type": "string"
- },
- "groupId": {
- "location": "query",
- "description": "[Optional] List all \u003ccode\u003eErrorGroupStats\u003c/code\u003e with these IDs.",
- "type": "string",
- "repeated": true
- },
- "serviceFilter.service": {
- "description": "[Optional] The exact value to match against\n[`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "[Optional] The maximum number of results to return per response.\nDefault is 20.",
- "type": "integer"
- },
- "serviceFilter.version": {
- "description": "[Optional] The exact value to match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).",
- "type": "string",
- "location": "query"
- },
- "order": {
- "location": "query",
- "enum": [
- "GROUP_ORDER_UNSPECIFIED",
- "COUNT_DESC",
- "LAST_SEEN_DESC",
- "CREATED_DESC",
- "AFFECTED_USERS_DESC"
- ],
- "description": "[Optional] The sort order in which the results are returned.\nDefault is `COUNT_DESC`.",
- "type": "string"
- },
- "alignmentTime": {
- "format": "google-datetime",
- "description": "[Optional] Time where the timed counts shall be aligned if rounded\nalignment is chosen. Default is 00:00 UTC.",
- "type": "string",
- "location": "query"
- },
- "serviceFilter.resourceType": {
- "type": "string",
- "location": "query",
- "description": "[Optional] The exact value to match against\n[`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type)."
- },
- "projectName": {
- "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas \u003ccode\u003eprojects/\u003c/code\u003e plus the\n\u003ca href=\"https://support.google.com/cloud/answer/6158840\"\u003eGoogle Cloud\nPlatform project ID\u003c/a\u003e.\n\nExample: \u003ccode\u003eprojects/my-project-123\u003c/code\u003e.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "timedCountDuration": {
- "format": "google-duration",
- "description": "[Optional] The preferred duration for a single returned `TimedCount`.\nIf not set, no timed counts are returned.",
- "type": "string",
- "location": "query"
- }
- }
- }
- }
- },
- "groups": {
- "methods": {
- "get": {
- "response": {
- "$ref": "ErrorGroup"
- },
- "parameterOrder": [
- "groupName"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "groupName": {
- "pattern": "^projects/[^/]+/groups/[^/]+$",
- "location": "path",
- "description": "[Required] The group resource name. Written as\n\u003ccode\u003eprojects/\u003cvar\u003eprojectID\u003c/var\u003e/groups/\u003cvar\u003egroup_name\u003c/var\u003e\u003c/code\u003e.\nCall\n\u003ca href=\"/error-reporting/reference/rest/v1beta1/projects.groupStats/list\"\u003e\n\u003ccode\u003egroupStats.list\u003c/code\u003e\u003c/a\u003e to return a list of groups belonging to\nthis project.\n\nExample: \u003ccode\u003eprojects/my-project-123/groups/my-group\u003c/code\u003e",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/groups/{groupsId}",
- "id": "clouderrorreporting.projects.groups.get",
- "path": "v1beta1/{+groupName}",
- "description": "Get the specified group."
- },
- "update": {
- "flatPath": "v1beta1/projects/{projectsId}/groups/{groupsId}",
- "id": "clouderrorreporting.projects.groups.update",
- "path": "v1beta1/{+name}",
- "request": {
- "$ref": "ErrorGroup"
- },
- "description": "Replace the data for the specified group.\nFails if the group does not exist.",
- "response": {
- "$ref": "ErrorGroup"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/groups/[^/]+$",
- "location": "path",
- "description": "The group resource name.\nExample: \u003ccode\u003eprojects/my-project-123/groups/my-groupid\u003c/code\u003e",
- "type": "string",
- "required": true
- }
- }
- }
- }
- },
- "events": {
- "methods": {
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "projectName"
- ],
- "response": {
- "$ref": "ListEventsResponse"
- },
- "parameters": {
- "serviceFilter.resourceType": {
- "location": "query",
- "description": "[Optional] The exact value to match against\n[`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).",
- "type": "string"
- },
- "timeRange.period": {
- "location": "query",
- "enum": [
- "PERIOD_UNSPECIFIED",
- "PERIOD_1_HOUR",
- "PERIOD_6_HOURS",
- "PERIOD_1_DAY",
- "PERIOD_1_WEEK",
- "PERIOD_30_DAYS"
- ],
- "description": "Restricts the query to the specified time range.",
- "type": "string"
- },
- "projectName": {
- "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google Cloud Platform project\nID](https://support.google.com/cloud/answer/6158840).\nExample: `projects/my-project-123`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "groupId": {
- "location": "query",
- "description": "[Required] The group for which events shall be returned.",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "[Optional] A `next_page_token` provided by a previous response.",
- "type": "string"
- },
- "serviceFilter.service": {
- "location": "query",
- "description": "[Optional] The exact value to match against\n[`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "[Optional] The maximum number of results to return per response.",
- "type": "integer"
- },
- "serviceFilter.version": {
- "description": "[Optional] The exact value to match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/events",
- "path": "v1beta1/{+projectName}/events",
- "id": "clouderrorreporting.projects.events.list",
- "description": "Lists the specified events."
- },
- "report": {
- "flatPath": "v1beta1/projects/{projectsId}/events:report",
- "id": "clouderrorreporting.projects.events.report",
- "path": "v1beta1/{+projectName}/events:report",
- "request": {
- "$ref": "ReportedErrorEvent"
- },
- "description": "Report an individual error event.\n\nThis endpoint accepts \u003cstrong\u003eeither\u003c/strong\u003e an OAuth token,\n\u003cstrong\u003eor\u003c/strong\u003e an\n\u003ca href=\"https://support.google.com/cloud/answer/6158862\"\u003eAPI key\u003c/a\u003e\nfor authentication. To use an API key, append it to the URL as the value of\na `key` parameter. For example:\n\u003cpre\u003ePOST https://clouderrorreporting.googleapis.com/v1beta1/projects/example-project/events:report?key=123ABC456\u003c/pre\u003e",
- "response": {
- "$ref": "ReportErrorEventResponse"
- },
- "parameterOrder": [
- "projectName"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectName": {
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840).\nExample: `projects/my-project-123`."
- }
- }
- }
- }
- }
- }
- }
- },
- "parameters": {
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "alt": {
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- }
- },
- "version": "v1beta1",
- "baseUrl": "https://clouderrorreporting.googleapis.com/",
- "servicePath": "",
- "description": "Groups and counts similar errors from cloud services and applications, reports new errors, and provides access to error groups and their associated errors.\n",
- "kind": "discovery#restDescription"
+ "protocol": "rest"
}
diff --git a/cloudfunctions/v1/cloudfunctions-api.json b/cloudfunctions/v1/cloudfunctions-api.json
index 6ab2564..f7e670b 100644
--- a/cloudfunctions/v1/cloudfunctions-api.json
+++ b/cloudfunctions/v1/cloudfunctions-api.json
@@ -1,11 +1,77 @@
{
+ "canonicalName": "Cloud Functions",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://cloudfunctions.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "cloudfunctions",
+ "batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "Google Cloud Functions API",
"ownerName": "Google",
"resources": {
+ "projects": {
+ "resources": {
+ "locations": {
+ "methods": {
+ "list": {
+ "description": "Lists information about the supported locations for this service.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer"
+ },
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "The standard list page token."
+ },
+ "name": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The resource that owns the locations collection, if applicable.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations",
+ "path": "v1/{+name}/locations",
+ "id": "cloudfunctions.projects.locations.list"
+ }
+ }
+ }
+ }
+ },
"operations": {
"methods": {
"get": {
+ "path": "v1/{+name}",
+ "id": "cloudfunctions.operations.get",
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
"httpMethod": "GET",
"parameterOrder": [
"name"
@@ -15,182 +81,104 @@
},
"parameters": {
"name": {
+ "pattern": "^operations/[^/]+$",
+ "location": "path",
"description": "The name of the operation resource.",
"type": "string",
- "required": true,
- "pattern": "^operations/[^/]+$",
- "location": "path"
+ "required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/operations/{operationsId}",
- "path": "v1/{+name}",
- "id": "cloudfunctions.operations.get",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
+ "flatPath": "v1/operations/{operationsId}"
},
"list": {
- "httpMethod": "GET",
"response": {
"$ref": "ListOperationsResponse"
},
"parameterOrder": [],
- "parameters": {
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "description": "The name of the operation's parent resource.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer"
- },
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- }
- },
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/operations",
- "path": "v1/operations",
- "id": "cloudfunctions.operations.list",
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id."
- }
- }
- },
- "projects": {
- "resources": {
- "locations": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListLocationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "filter": {
- "type": "string",
- "location": "query",
- "description": "The standard list filter."
- },
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "description": "The resource that owns the locations collection, if applicable.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "pageSize": {
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer",
- "location": "query"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations",
- "id": "cloudfunctions.projects.locations.list",
- "path": "v1/{+name}/locations",
- "description": "Lists information about the supported locations for this service."
+ "parameters": {
+ "pageSize": {
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer",
+ "location": "query"
+ },
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "The standard list filter."
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "name": {
+ "location": "query",
+ "description": "The name of the operation's parent resource.",
+ "type": "string"
}
- }
+ },
+ "flatPath": "v1/operations",
+ "id": "cloudfunctions.operations.list",
+ "path": "v1/operations",
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id."
}
}
}
},
"parameters": {
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
+ "upload_protocol": {
"location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string"
},
- "pp": {
+ "prettyPrint": {
"location": "query",
- "description": "Pretty-print response.",
+ "description": "Returns response with indentations and line breaks.",
"default": "true",
"type": "boolean"
},
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
},
- "fields": {
- "type": "string",
+ "callback": {
"location": "query",
- "description": "Selector specifying which fields to include in a partial response."
+ "description": "JSONP",
+ "type": "string"
},
"$.xgafv": {
+ "enum": [
+ "1",
+ "2"
+ ],
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
"location": "query"
},
"alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
@@ -199,18 +187,44 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
+ "default": "json"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "type": "string",
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
}
},
"version": "v1",
"baseUrl": "https://cloudfunctions.googleapis.com/",
- "kind": "discovery#restDescription",
"description": "API for managing lightweight user-provided functions executed in response to events.",
+ "kind": "discovery#restDescription",
"servicePath": "",
"basePath": "",
"id": "cloudfunctions:v1",
@@ -219,61 +233,7 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
- "items": {
- "$ref": "Operation"
- },
- "type": "array"
- }
- },
- "id": "ListOperationsResponse"
- },
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
- "properties": {
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
- "type": "object"
- },
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- },
- "response": {
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
- "type": "object",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
- }
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
- "type": "string"
- },
- "error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure or cancellation."
- }
- },
- "id": "Operation"
- },
"OperationMetadataV1Beta2": {
- "id": "OperationMetadataV1Beta2",
"description": "Metadata describing an Operation",
"type": "object",
"properties": {
@@ -295,12 +255,6 @@
"type": "object"
},
"type": {
- "enumDescriptions": [
- "Unknown operation type.",
- "Triggered by CreateFunction call",
- "Triggered by UpdateFunction call",
- "Triggered by DeleteFunction call."
- ],
"enum": [
"OPERATION_UNSPECIFIED",
"CREATE_FUNCTION",
@@ -308,24 +262,22 @@
"DELETE_FUNCTION"
],
"description": "Type of operation.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown operation type.",
+ "Triggered by CreateFunction call",
+ "Triggered by UpdateFunction call",
+ "Triggered by DeleteFunction call."
+ ]
}
- }
+ },
+ "id": "OperationMetadataV1Beta2"
},
"Status": {
+ "id": "Status",
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "type": "array"
- },
"code": {
"format": "int32",
"description": "The status code, which should be an enum value of google.rpc.Code.",
@@ -334,18 +286,28 @@
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
"type": "string"
+ },
+ "details": {
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array",
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use."
}
- },
- "id": "Status",
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons."
+ }
},
"ListLocationsResponse": {
+ "id": "ListLocationsResponse",
"description": "The response message for Locations.ListLocations.",
"type": "object",
"properties": {
"nextPageToken": {
- "type": "string",
- "description": "The standard List next-page token."
+ "description": "The standard List next-page token.",
+ "type": "string"
},
"locations": {
"description": "A list of locations that matches the specified filter in the request.",
@@ -354,28 +316,23 @@
},
"type": "array"
}
- },
- "id": "ListLocationsResponse"
+ }
},
"Location": {
"description": "A resource that represents Google Cloud Platform location.",
"type": "object",
"properties": {
- "name": {
- "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
- "type": "string"
- },
"locationId": {
"description": "The canonical id for this location. For example: `\"us-east1\"`.",
"type": "string"
},
"metadata": {
- "description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
- "type": "object",
"additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
- }
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
+ "type": "object"
},
"labels": {
"description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
@@ -383,28 +340,71 @@
"additionalProperties": {
"type": "string"
}
+ },
+ "name": {
+ "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
+ "type": "string"
}
},
"id": "Location"
+ },
+ "Operation": {
+ "id": "Operation",
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object",
+ "properties": {
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ },
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
+ "type": "string"
+ }
+ }
+ },
+ "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"
+ }
+ },
+ "id": "ListOperationsResponse",
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object"
}
},
"protocol": "rest",
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "canonicalName": "Cloud Functions",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "rootUrl": "https://cloudfunctions.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "cloudfunctions",
- "batchPath": "batch"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ }
}
diff --git a/cloudfunctions/v1beta2/cloudfunctions-api.json b/cloudfunctions/v1beta2/cloudfunctions-api.json
index 7884fa0..a536a72 100644
--- a/cloudfunctions/v1beta2/cloudfunctions-api.json
+++ b/cloudfunctions/v1beta2/cloudfunctions-api.json
@@ -1,8 +1,141 @@
{
+ "id": "cloudfunctions:v1beta2",
+ "documentationLink": "https://cloud.google.com/functions",
+ "revision": "20171009",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "ListLocationsResponse": {
+ "id": "ListLocationsResponse",
+ "description": "The response message for Locations.ListLocations.",
+ "type": "object",
+ "properties": {
+ "locations": {
+ "description": "A list of locations that matches the specified filter in the request.",
+ "items": {
+ "$ref": "Location"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ }
+ }
+ },
+ "CallFunctionResponse": {
+ "description": "Response of `CallFunction` method.",
+ "type": "object",
+ "properties": {
+ "executionId": {
+ "description": "Execution id of function invocation.",
+ "type": "string"
+ },
+ "error": {
+ "description": "Either system or user-function generated error. Set if execution\nwas not successful.",
+ "type": "string"
+ },
+ "result": {
+ "description": "Result populated for successful execution of synchronous function. Will\nnot be populated if function does not return a result through context.",
+ "type": "string"
+ }
+ },
+ "id": "CallFunctionResponse"
+ },
+ "EventTrigger": {
+ "id": "EventTrigger",
+ "description": "Describes EventTrigger, used to request events be sent from another\nservice.",
+ "type": "object",
+ "properties": {
+ "failurePolicy": {
+ "description": "Specifies policy for failed executions.",
+ "$ref": "FailurePolicy"
+ },
+ "eventType": {
+ "description": "`event_type` names contain the service that is sending an event and the\nkind of event that was fired. Must be of the form\n`providers/*/eventTypes/*` e.g. Directly handle a Message published to\nGoogle Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish`\n\n Handle an object changing in Google Cloud Storage\n `providers/cloud.storage/eventTypes/object.change`\n\n Handle a write to the Firebase Realtime Database\n `providers/google.firebase.database/eventTypes/ref.write`",
+ "type": "string"
+ },
+ "resource": {
+ "description": "Which instance of the source's service should send events. E.g. for Pub/Sub\nthis would be a Pub/Sub topic at `projects/*/topics/*`. For Google Cloud\nStorage this would be a bucket at `projects/*/buckets/*`. For any source\nthat only supports one instance per-project, this should be the name of the\nproject (`projects/*`)",
+ "type": "string"
+ },
+ "service": {
+ "description": "The hostname of the service that should be observed.\n\nIf no string is provided, the default service implementing the API will\nbe used. For example, `storage.googleapis.com` is the default for all\nevent types in the 'google.storage` namespace.",
+ "type": "string"
+ }
+ }
+ },
+ "HTTPSTrigger": {
+ "description": "Describes HTTPSTrigger, could be used to connect web hooks to function.",
+ "type": "object",
+ "properties": {
+ "url": {
+ "description": "Output only. The deployed url for the function.",
+ "type": "string"
+ }
+ },
+ "id": "HTTPSTrigger"
+ },
+ "GenerateDownloadUrlRequest": {
+ "description": "Request of `GenerateDownloadUrl` method.",
+ "type": "object",
+ "properties": {
+ "versionId": {
+ "format": "uint64",
+ "description": "The optional version of function.",
+ "type": "string"
+ }
+ },
+ "id": "GenerateDownloadUrlRequest"
+ },
+ "FailurePolicy": {
+ "description": "Describes the policy in case of function's execution failure.\nIf empty, then defaults to ignoring failures (i.e. not retrying them).",
+ "type": "object",
+ "properties": {
+ "retry": {
+ "description": "If specified, then the function will be retried in case of a failure.",
+ "$ref": "Retry"
+ }
+ },
+ "id": "FailurePolicy"
+ },
+ "Operation": {
+ "id": "Operation",
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object",
+ "properties": {
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ },
+ "response": {
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
+ "type": "string"
+ },
+ "error": {
+ "description": "The error result of the operation in case of failure or cancellation.",
+ "$ref": "Status"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object"
+ }
+ }
+ },
"OperationMetadataV1Beta2": {
+ "id": "OperationMetadataV1Beta2",
"description": "Metadata describing an Operation",
"type": "object",
"properties": {
@@ -16,14 +149,16 @@
"type": "string"
},
"request": {
+ "description": "The original request that started the operation.",
"type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- },
- "description": "The original request that started the operation."
+ }
},
"type": {
+ "description": "Type of operation.",
+ "type": "string",
"enumDescriptions": [
"Unknown operation type.",
"Triggered by CreateFunction call",
@@ -35,41 +170,39 @@
"CREATE_FUNCTION",
"UPDATE_FUNCTION",
"DELETE_FUNCTION"
- ],
- "description": "Type of operation.",
- "type": "string"
+ ]
}
- },
- "id": "OperationMetadataV1Beta2"
+ }
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "type": "array"
+ },
"code": {
"format": "int32",
"description": "The status code, which should be an enum value of google.rpc.Code.",
"type": "integer"
- },
- "message": {
- "type": "string",
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client."
- },
- "details": {
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- },
- "type": "array",
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use."
}
},
"id": "Status"
},
"CallFunctionRequest": {
+ "description": "Request for the `CallFunction` method.",
"type": "object",
"properties": {
"data": {
@@ -77,10 +210,10 @@
"type": "string"
}
},
- "id": "CallFunctionRequest",
- "description": "Request for the `CallFunction` method."
+ "id": "CallFunctionRequest"
},
"SourceRepository": {
+ "id": "SourceRepository",
"description": "Describes the location of the function source in a remote repository.",
"type": "object",
"properties": {
@@ -108,49 +241,13 @@
"description": "The path within the repository where the function is defined. The path\nshould point to the directory where Cloud Functions files are located. Use\n\"/\" if the function is defined directly in the root directory of a\nrepository.",
"type": "string"
}
- },
- "id": "SourceRepository"
+ }
},
"CloudFunction": {
+ "id": "CloudFunction",
"description": "Describes a Cloud Function that contains user computation executed in\nresponse to an event. It encapsulate function and triggers configurations.",
"type": "object",
"properties": {
- "httpsTrigger": {
- "description": "An HTTPS endpoint type of source that can be triggered via URL.",
- "$ref": "HTTPSTrigger"
- },
- "timeout": {
- "format": "google-duration",
- "description": "The function execution timeout. Execution is considered failed and\ncan be terminated if the function is not completed at the end of the\ntimeout period. Defaults to 60 seconds.",
- "type": "string"
- },
- "status": {
- "type": "string",
- "enumDescriptions": [
- "Status not specified.",
- "Successfully deployed.",
- "Not deployed correctly - behavior is undefined. The item should be updated\nor deleted to move it out of this state.",
- "Creation or update in progress.",
- "Deletion in progress."
- ],
- "enum": [
- "STATUS_UNSPECIFIED",
- "READY",
- "FAILED",
- "DEPLOYING",
- "DELETING"
- ],
- "description": "Output only. Status of the function deployment."
- },
- "eventTrigger": {
- "$ref": "EventTrigger",
- "description": "A source that fires events in response to a condition in another service."
- },
- "availableMemoryMb": {
- "format": "int32",
- "description": "The amount of memory in MB available for a function.\nDefaults to 256MB.",
- "type": "integer"
- },
"name": {
"description": "A user-defined name of the function. Function names must be unique\nglobally and match pattern `projects/*/locations/*/functions/*`",
"type": "string"
@@ -172,10 +269,6 @@
"$ref": "SourceRepository",
"description": "The hosted repository where the function is defined."
},
- "entryPoint": {
- "type": "string",
- "description": "The name of the function (as defined in source code) that will be\nexecuted. Defaults to the resource name suffix, if not specified. For\nbackward compatibility, if function with given name is not found, then the\nsystem will try to use function named \"function\".\nFor Node.js this is name of a function exported by the module specified\nin `source_location`."
- },
"labels": {
"additionalProperties": {
"type": "string"
@@ -183,6 +276,10 @@
"description": "Labels associated with this Cloud Function.",
"type": "object"
},
+ "entryPoint": {
+ "description": "The name of the function (as defined in source code) that will be\nexecuted. Defaults to the resource name suffix, if not specified. For\nbackward compatibility, if function with given name is not found, then the\nsystem will try to use function named \"function\".\nFor Node.js this is name of a function exported by the module specified\nin `source_location`.",
+ "type": "string"
+ },
"updateTime": {
"format": "google-datetime",
"description": "Output only. The last update timestamp of a Cloud Function.",
@@ -195,11 +292,51 @@
"latestOperation": {
"description": "Output only. Name of the most recent operation modifying the function. If\nthe function status is `DEPLOYING` or `DELETING`, then it points to the\nactive operation.",
"type": "string"
+ },
+ "httpsTrigger": {
+ "$ref": "HTTPSTrigger",
+ "description": "An HTTPS endpoint type of source that can be triggered via URL."
+ },
+ "sourceUploadUrl": {
+ "description": "The Google Cloud Storage signed URL used for source uploading, generated\nby google.cloud.functions.v1beta2.GenerateUploadUrl",
+ "type": "string"
+ },
+ "eventTrigger": {
+ "description": "A source that fires events in response to a condition in another service.",
+ "$ref": "EventTrigger"
+ },
+ "status": {
+ "enumDescriptions": [
+ "Status not specified.",
+ "Successfully deployed.",
+ "Not deployed correctly - behavior is undefined. The item should be updated\nor deleted to move it out of this state.",
+ "Creation or update in progress.",
+ "Deletion in progress."
+ ],
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "READY",
+ "FAILED",
+ "DEPLOYING",
+ "DELETING"
+ ],
+ "description": "Output only. Status of the function deployment.",
+ "type": "string"
+ },
+ "timeout": {
+ "format": "google-duration",
+ "description": "The function execution timeout. Execution is considered failed and\ncan be terminated if the function is not completed at the end of the\ntimeout period. Defaults to 60 seconds.",
+ "type": "string"
+ },
+ "availableMemoryMb": {
+ "format": "int32",
+ "description": "The amount of memory in MB available for a function.\nDefaults to 256MB.",
+ "type": "integer"
}
- },
- "id": "CloudFunction"
+ }
},
"Location": {
+ "description": "A resource that represents Google Cloud Platform location.",
"type": "object",
"properties": {
"name": {
@@ -211,23 +348,33 @@
"type": "string"
},
"metadata": {
+ "description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- },
- "description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
- "type": "object"
+ }
},
"labels": {
+ "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
- "type": "object"
+ }
}
},
- "id": "Location",
- "description": "A resource that represents Google Cloud Platform location."
+ "id": "Location"
+ },
+ "GenerateDownloadUrlResponse": {
+ "description": "Response of `GenerateDownloadUrl` method.",
+ "type": "object",
+ "properties": {
+ "downloadUrl": {
+ "description": "The generated Google Cloud Storage signed URL that should be used for\nfunction source code download.",
+ "type": "string"
+ }
+ },
+ "id": "GenerateDownloadUrlResponse"
},
"Retry": {
"description": "Describes the retry policy in case of function's execution failure.\nA function execution will be retried on any failure.\nA failed execution will be retried up to 7 days with an exponential backoff\n(capped at 10 seconds).\nRetried execution is charged as any other execution.",
@@ -235,165 +382,65 @@
"properties": {},
"id": "Retry"
},
+ "GenerateUploadUrlRequest": {
+ "id": "GenerateUploadUrlRequest",
+ "description": "Request of `GenerateUploadUrl` method.",
+ "type": "object",
+ "properties": {}
+ },
"ListOperationsResponse": {
+ "id": "ListOperationsResponse",
"description": "The response message for Operations.ListOperations.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "Operation"
},
"type": "array"
- },
- "nextPageToken": {
- "type": "string",
- "description": "The standard List next-page token."
+ }
+ }
+ },
+ "GenerateUploadUrlResponse": {
+ "description": "Response of `GenerateUploadUrl` method.",
+ "type": "object",
+ "properties": {
+ "uploadUrl": {
+ "description": "The generated Google Cloud Storage signed URL that should be used for a\nfunction source code upload. The uploaded file should be a zip archive\nwhich contains a function.",
+ "type": "string"
}
},
- "id": "ListOperationsResponse"
+ "id": "GenerateUploadUrlResponse"
},
"ListFunctionsResponse": {
+ "description": "Response for the `ListFunctions` method.",
+ "type": "object",
"properties": {
- "nextPageToken": {
- "description": "If not empty, indicates that there may be more functions that match\nthe request; this value should be passed in a new\ngoogle.cloud.functions.v1beta2.ListFunctionsRequest\nto get more functions.",
- "type": "string"
- },
"functions": {
"description": "The functions that match the request.",
"items": {
"$ref": "CloudFunction"
},
"type": "array"
- }
- },
- "id": "ListFunctionsResponse",
- "description": "Response for the `ListFunctions` method.",
- "type": "object"
- },
- "CallFunctionResponse": {
- "description": "Response of `CallFunction` method.",
- "type": "object",
- "properties": {
- "error": {
- "description": "Either system or user-function generated error. Set if execution\nwas not successful.",
- "type": "string"
- },
- "result": {
- "description": "Result populated for successful execution of synchronous function. Will\nnot be populated if function does not return a result through context.",
- "type": "string"
- },
- "executionId": {
- "description": "Execution id of function invocation.",
- "type": "string"
- }
- },
- "id": "CallFunctionResponse"
- },
- "ListLocationsResponse": {
- "description": "The response message for Locations.ListLocations.",
- "type": "object",
- "properties": {
- "locations": {
- "description": "A list of locations that matches the specified filter in the request.",
- "items": {
- "$ref": "Location"
- },
- "type": "array"
},
"nextPageToken": {
- "description": "The standard List next-page token.",
+ "description": "If not empty, indicates that there may be more functions that match\nthe request; this value should be passed in a new\ngoogle.cloud.functions.v1beta2.ListFunctionsRequest\nto get more functions.",
"type": "string"
}
},
- "id": "ListLocationsResponse"
- },
- "EventTrigger": {
- "type": "object",
- "properties": {
- "failurePolicy": {
- "description": "Specifies policy for failed executions.",
- "$ref": "FailurePolicy"
- },
- "eventType": {
- "description": "`event_type` names contain the service that is sending an event and the\nkind of event that was fired. Must be of the form\n`providers/*/eventTypes/*` e.g. Directly handle a Message published to\nGoogle Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish`\n\n Handle an object changing in Google Cloud Storage\n `providers/cloud.storage/eventTypes/object.change`\n\n Handle a write to the Firebase Realtime Database\n `providers/google.firebase.database/eventTypes/ref.write`",
- "type": "string"
- },
- "resource": {
- "type": "string",
- "description": "Which instance of the source's service should send events. E.g. for Pub/Sub\nthis would be a Pub/Sub topic at `projects/*/topics/*`. For Google Cloud\nStorage this would be a bucket at `projects/*/buckets/*`. For any source\nthat only supports one instance per-project, this should be the name of the\nproject (`projects/*`)"
- },
- "service": {
- "description": "The hostname of the service that should be observed.\n\nIf no string is provided, the default service implementing the API will\nbe used. For example, `storage.googleapis.com` is the default for all\nevent types in the 'google.storage` namespace.",
- "type": "string"
- }
- },
- "id": "EventTrigger",
- "description": "Describes EventTrigger, used to request events be sent from another\nservice."
- },
- "HTTPSTrigger": {
- "id": "HTTPSTrigger",
- "description": "Describes HTTPSTrigger, could be used to connect web hooks to function.",
- "type": "object",
- "properties": {
- "url": {
- "description": "Output only. The deployed url for the function.",
- "type": "string"
- }
- }
- },
- "FailurePolicy": {
- "properties": {
- "retry": {
- "$ref": "Retry",
- "description": "If specified, then the function will be retried in case of a failure."
- }
- },
- "id": "FailurePolicy",
- "description": "Describes the policy in case of function's execution failure.\nIf empty, then defaults to ignoring failures (i.e. not retrying them).",
- "type": "object"
- },
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
- "properties": {
- "response": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
- "type": "object"
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
- "type": "string"
- },
- "error": {
- "description": "The error result of the operation in case of failure or cancellation.",
- "$ref": "Status"
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
- "type": "object"
- },
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- }
- },
- "id": "Operation"
+ "id": "ListFunctionsResponse"
}
},
- "protocol": "rest",
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
+ "protocol": "rest",
"canonicalName": "Cloud Functions",
"auth": {
"oauth2": {
@@ -412,16 +459,299 @@
"title": "Google Cloud Functions API",
"ownerName": "Google",
"resources": {
+ "projects": {
+ "resources": {
+ "locations": {
+ "methods": {
+ "list": {
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The resource that owns the locations collection, if applicable.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer",
+ "location": "query"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/locations",
+ "path": "v1beta2/{+name}/locations",
+ "id": "cloudfunctions.projects.locations.list",
+ "description": "Lists information about the supported locations for this service.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "ListLocationsResponse"
+ }
+ }
+ },
+ "resources": {
+ "functions": {
+ "methods": {
+ "generateDownloadUrl": {
+ "id": "cloudfunctions.projects.locations.functions.generateDownloadUrl",
+ "path": "v1beta2/{+name}:generateDownloadUrl",
+ "request": {
+ "$ref": "GenerateDownloadUrlRequest"
+ },
+ "description": "Returns a signed URL for downloading deployed function source code.\nThe URL is only valid for a limited period and should be used within\nminutes after generation.\nFor more information about the signed URL usage see:\nhttps://cloud.google.com/storage/docs/access-control/signed-urls",
+ "response": {
+ "$ref": "GenerateDownloadUrlResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "location": "path",
+ "description": "The name of function for which source code Google Cloud Storage signed\nURL should be generated.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:generateDownloadUrl"
+ },
+ "get": {
+ "description": "Returns a function with the given name from the requested project.",
+ "response": {
+ "$ref": "CloudFunction"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the function which details should be obtained.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
+ "id": "cloudfunctions.projects.locations.functions.get",
+ "path": "v1beta2/{+name}"
+ },
+ "update": {
+ "request": {
+ "$ref": "CloudFunction"
+ },
+ "description": "Updates existing function.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the function to be updated.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
+ "id": "cloudfunctions.projects.locations.functions.update",
+ "path": "v1beta2/{+name}"
+ },
+ "delete": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "location": "path",
+ "description": "The name of the function which should be deleted.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
+ "id": "cloudfunctions.projects.locations.functions.delete",
+ "path": "v1beta2/{+name}",
+ "description": "Deletes a function with the given name from the specified project. If the\ngiven function is used by some trigger, the trigger will be updated to\nremove this function.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE"
+ },
+ "list": {
+ "description": "Returns a list of functions that belong to the requested project.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListFunctionsResponse"
+ },
+ "parameterOrder": [
+ "location"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "The value returned by the last\n`ListFunctionsResponse`; indicates that\nthis is a continuation of a prior `ListFunctions` call, and that the\nsystem should return the next page of data.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Maximum number of functions to return per call.",
+ "type": "integer",
+ "location": "query"
+ },
+ "location": {
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path",
+ "description": "The project and location from which the function should be listed,\nspecified in the format `projects/*/locations/*`\nIf you want to list functions in all locations, use \"-\" in place of a\nlocation.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions",
+ "path": "v1beta2/{+location}/functions",
+ "id": "cloudfunctions.projects.locations.functions.list"
+ },
+ "call": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "CallFunctionResponse"
+ },
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "location": "path",
+ "description": "The name of the function to be called.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:call",
+ "path": "v1beta2/{+name}:call",
+ "id": "cloudfunctions.projects.locations.functions.call",
+ "description": "Invokes synchronously deployed function. To be used for testing, very\nlimited traffic allowed.",
+ "request": {
+ "$ref": "CallFunctionRequest"
+ }
+ },
+ "create": {
+ "description": "Creates a new function. If a function with the given name already exists in\nthe specified project, the long running operation will return\n`ALREADY_EXISTS` error.",
+ "request": {
+ "$ref": "CloudFunction"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "location"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "location": {
+ "description": "The project and location in which the function should be created, specified\nin the format `projects/*/locations/*`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions",
+ "path": "v1beta2/{+location}/functions",
+ "id": "cloudfunctions.projects.locations.functions.create"
+ },
+ "generateUploadUrl": {
+ "response": {
+ "$ref": "GenerateUploadUrlResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "The project and location in which the Google Cloud Storage signed URL\nshould be generated, specified in the format `projects/*/locations/*",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions:generateUploadUrl",
+ "id": "cloudfunctions.projects.locations.functions.generateUploadUrl",
+ "path": "v1beta2/{+parent}/functions:generateUploadUrl",
+ "request": {
+ "$ref": "GenerateUploadUrlRequest"
+ },
+ "description": "Returns a signed URL for uploading a function source code.\nFor more information about the signed URL usage see:\nhttps://cloud.google.com/storage/docs/access-control/signed-urls\nOnce the function source code upload is complete, the used signed\nURL should be provided in CreateFunction or UpdateFunction request\nas a reference to the function source code."
+ }
+ }
+ }
+ }
+ }
+ }
+ },
"operations": {
"methods": {
"get": {
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
"httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
"response": {
"$ref": "Operation"
},
- "parameterOrder": [
- "name"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
@@ -432,28 +762,16 @@
"location": "path"
}
},
+ "flatPath": "v1beta2/operations/{operationsId}",
+ "path": "v1beta2/{+name}",
+ "id": "cloudfunctions.operations.get",
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
+ },
+ "list": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1beta2/operations/{operationsId}",
- "path": "v1beta2/{+name}",
- "id": "cloudfunctions.operations.get"
- },
- "list": {
- "id": "cloudfunctions.operations.list",
- "path": "v1beta2/operations",
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
"parameters": {
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- },
"pageToken": {
"location": "query",
"description": "The standard list page token.",
@@ -469,236 +787,21 @@
"description": "The standard list page size.",
"type": "integer",
"location": "query"
+ },
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/operations"
- }
- }
- },
- "projects": {
- "resources": {
- "locations": {
- "resources": {
- "functions": {
- "methods": {
- "delete": {
- "id": "cloudfunctions.projects.locations.functions.delete",
- "path": "v1beta2/{+name}",
- "description": "Deletes a function with the given name from the specified project. If the\ngiven function is used by some trigger, the trigger will be updated to\nremove this function.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "description": "The name of the function which should be deleted.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}"
- },
- "list": {
- "id": "cloudfunctions.projects.locations.functions.list",
- "path": "v1beta2/{+location}/functions",
- "description": "Returns a list of functions that belong to the requested project.",
- "response": {
- "$ref": "ListFunctionsResponse"
- },
- "parameterOrder": [
- "location"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "description": "The value returned by the last\n`ListFunctionsResponse`; indicates that\nthis is a continuation of a prior `ListFunctions` call, and that the\nsystem should return the next page of data.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Maximum number of functions to return per call.",
- "type": "integer"
- },
- "location": {
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path",
- "description": "The project and location from which the function should be listed,\nspecified in the format `projects/*/locations/*`\nIf you want to list functions in all locations, use \"-\" in place of a\nlocation.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions"
- },
- "create": {
- "description": "Creates a new function. If a function with the given name already exists in\nthe specified project, the long running operation will return\n`ALREADY_EXISTS` error.",
- "request": {
- "$ref": "CloudFunction"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "location"
- ],
- "httpMethod": "POST",
- "parameters": {
- "location": {
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path",
- "description": "The project and location in which the function should be created, specified\nin the format `projects/*/locations/*`",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions",
- "id": "cloudfunctions.projects.locations.functions.create",
- "path": "v1beta2/{+location}/functions"
- },
- "call": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "CallFunctionResponse"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the function to be called.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:call",
- "path": "v1beta2/{+name}:call",
- "id": "cloudfunctions.projects.locations.functions.call",
- "description": "Invokes synchronously deployed function. To be used for testing, very\nlimited traffic allowed.",
- "request": {
- "$ref": "CallFunctionRequest"
- }
- },
- "get": {
- "response": {
- "$ref": "CloudFunction"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
- "location": "path",
- "description": "The name of the function which details should be obtained."
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
- "id": "cloudfunctions.projects.locations.functions.get",
- "path": "v1beta2/{+name}",
- "description": "Returns a function with the given name from the requested project."
- },
- "update": {
- "id": "cloudfunctions.projects.locations.functions.update",
- "path": "v1beta2/{+name}",
- "description": "Updates existing function.",
- "request": {
- "$ref": "CloudFunction"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the function to be updated.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}"
- }
- }
- }
- },
- "methods": {
- "list": {
- "flatPath": "v1beta2/projects/{projectsId}/locations",
- "id": "cloudfunctions.projects.locations.list",
- "path": "v1beta2/{+name}/locations",
- "description": "Lists information about the supported locations for this service.",
- "response": {
- "$ref": "ListLocationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "name": {
- "location": "path",
- "description": "The resource that owns the locations collection, if applicable.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer"
- },
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
+ "flatPath": "v1beta2/operations",
+ "path": "v1beta2/operations",
+ "id": "cloudfunctions.operations.list",
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
+ "httpMethod": "GET",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ListOperationsResponse"
}
}
}
@@ -706,25 +809,25 @@
},
"parameters": {
"upload_protocol": {
- "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"prettyPrint": {
- "location": "query",
"description": "Returns response with indentations and line breaks.",
"default": "true",
- "type": "boolean"
+ "type": "boolean",
+ "location": "query"
},
"uploadType": {
- "type": "string",
"location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
},
"fields": {
- "location": "query",
"description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"callback": {
"location": "query",
@@ -732,17 +835,17 @@
"type": "string"
},
"$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
"location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ]
+ "type": "string"
},
"alt": {
"description": "Data format for response.",
@@ -761,14 +864,14 @@
"location": "query"
},
"key": {
- "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"access_token": {
- "type": "string",
"location": "query",
- "description": "OAuth access token."
+ "description": "OAuth access token.",
+ "type": "string"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
@@ -776,10 +879,10 @@
"location": "query"
},
"pp": {
- "location": "query",
"description": "Pretty-print response.",
"default": "true",
- "type": "boolean"
+ "type": "boolean",
+ "location": "query"
},
"oauth_token": {
"location": "query",
@@ -787,18 +890,15 @@
"type": "string"
},
"bearer_token": {
+ "location": "query",
"description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
+ "type": "string"
}
},
"version": "v1beta2",
"baseUrl": "https://cloudfunctions.googleapis.com/",
- "servicePath": "",
- "description": "API for managing lightweight user-provided functions executed in response to events.",
"kind": "discovery#restDescription",
- "basePath": "",
- "id": "cloudfunctions:v1beta2",
- "documentationLink": "https://cloud.google.com/functions",
- "revision": "20171009"
+ "description": "API for managing lightweight user-provided functions executed in response to events.",
+ "servicePath": "",
+ "basePath": ""
}
diff --git a/cloudfunctions/v1beta2/cloudfunctions-gen.go b/cloudfunctions/v1beta2/cloudfunctions-gen.go
index 8523c05..5ed358c 100644
--- a/cloudfunctions/v1beta2/cloudfunctions-gen.go
+++ b/cloudfunctions/v1beta2/cloudfunctions-gen.go
@@ -271,6 +271,11 @@
// You may omit `paths/*` if you want to use the main directory.
SourceRepositoryUrl string `json:"sourceRepositoryUrl,omitempty"`
+ // SourceUploadUrl: The Google Cloud Storage signed URL used for source
+ // uploading, generated
+ // by google.cloud.functions.v1beta2.GenerateUploadUrl
+ SourceUploadUrl string `json:"sourceUploadUrl,omitempty"`
+
// Status: Output only. Status of the function deployment.
//
// Possible values:
@@ -426,6 +431,109 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// GenerateDownloadUrlRequest: Request of `GenerateDownloadUrl` method.
+type GenerateDownloadUrlRequest struct {
+ // VersionId: The optional version of function.
+ VersionId uint64 `json:"versionId,omitempty,string"`
+
+ // ForceSendFields is a list of field names (e.g. "VersionId") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "VersionId") to include in
+ // API requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *GenerateDownloadUrlRequest) MarshalJSON() ([]byte, error) {
+ type noMethod GenerateDownloadUrlRequest
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// GenerateDownloadUrlResponse: Response of `GenerateDownloadUrl`
+// method.
+type GenerateDownloadUrlResponse struct {
+ // DownloadUrl: The generated Google Cloud Storage signed URL that
+ // should be used for
+ // function source code download.
+ DownloadUrl string `json:"downloadUrl,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "DownloadUrl") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "DownloadUrl") to include
+ // in API requests with the JSON null value. By default, fields with
+ // empty values are omitted from API requests. However, any field with
+ // an empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *GenerateDownloadUrlResponse) MarshalJSON() ([]byte, error) {
+ type noMethod GenerateDownloadUrlResponse
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// GenerateUploadUrlRequest: Request of `GenerateUploadUrl` method.
+type GenerateUploadUrlRequest struct {
+}
+
+// GenerateUploadUrlResponse: Response of `GenerateUploadUrl` method.
+type GenerateUploadUrlResponse struct {
+ // UploadUrl: The generated Google Cloud Storage signed URL that should
+ // be used for a
+ // function source code upload. The uploaded file should be a zip
+ // archive
+ // which contains a function.
+ UploadUrl string `json:"uploadUrl,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "UploadUrl") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "UploadUrl") to include in
+ // API requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *GenerateUploadUrlResponse) MarshalJSON() ([]byte, error) {
+ type noMethod GenerateUploadUrlResponse
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// HTTPSTrigger: Describes HTTPSTrigger, could be used to connect web
// hooks to function.
type HTTPSTrigger struct {
@@ -1888,6 +1996,291 @@
}
+// method id "cloudfunctions.projects.locations.functions.generateDownloadUrl":
+
+type ProjectsLocationsFunctionsGenerateDownloadUrlCall struct {
+ s *Service
+ name string
+ generatedownloadurlrequest *GenerateDownloadUrlRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// GenerateDownloadUrl: Returns a signed URL for downloading deployed
+// function source code.
+// The URL is only valid for a limited period and should be used
+// within
+// minutes after generation.
+// For more information about the signed URL usage
+// see:
+// https://cloud.google.com/storage/docs/access-control/signed-urls
+func (r *ProjectsLocationsFunctionsService) GenerateDownloadUrl(name string, generatedownloadurlrequest *GenerateDownloadUrlRequest) *ProjectsLocationsFunctionsGenerateDownloadUrlCall {
+ c := &ProjectsLocationsFunctionsGenerateDownloadUrlCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ c.generatedownloadurlrequest = generatedownloadurlrequest
+ return c
+}
+
+// Fields allows partial responses to be retrieved. See
+// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
+// for more information.
+func (c *ProjectsLocationsFunctionsGenerateDownloadUrlCall) Fields(s ...googleapi.Field) *ProjectsLocationsFunctionsGenerateDownloadUrlCall {
+ c.urlParams_.Set("fields", googleapi.CombineFields(s))
+ return c
+}
+
+// Context sets the context to be used in this call's Do method. Any
+// pending HTTP request will be aborted if the provided context is
+// canceled.
+func (c *ProjectsLocationsFunctionsGenerateDownloadUrlCall) Context(ctx context.Context) *ProjectsLocationsFunctionsGenerateDownloadUrlCall {
+ c.ctx_ = ctx
+ return c
+}
+
+// Header returns an http.Header that can be modified by the caller to
+// add HTTP headers to the request.
+func (c *ProjectsLocationsFunctionsGenerateDownloadUrlCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsFunctionsGenerateDownloadUrlCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.generatedownloadurlrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta2/{+name}:generateDownloadUrl")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "name": c.name,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "cloudfunctions.projects.locations.functions.generateDownloadUrl" call.
+// Exactly one of *GenerateDownloadUrlResponse or error will be non-nil.
+// Any non-2xx status code is an error. Response headers are in either
+// *GenerateDownloadUrlResponse.ServerResponse.Header or (if a response
+// was returned at all) in error.(*googleapi.Error).Header. Use
+// googleapi.IsNotModified to check whether the returned error was
+// because http.StatusNotModified was returned.
+func (c *ProjectsLocationsFunctionsGenerateDownloadUrlCall) Do(opts ...googleapi.CallOption) (*GenerateDownloadUrlResponse, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &GenerateDownloadUrlResponse{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Returns a signed URL for downloading deployed function source code.\nThe URL is only valid for a limited period and should be used within\nminutes after generation.\nFor more information about the signed URL usage see:\nhttps://cloud.google.com/storage/docs/access-control/signed-urls",
+ // "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:generateDownloadUrl",
+ // "httpMethod": "POST",
+ // "id": "cloudfunctions.projects.locations.functions.generateDownloadUrl",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "The name of function for which source code Google Cloud Storage signed\nURL should be generated.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta2/{+name}:generateDownloadUrl",
+ // "request": {
+ // "$ref": "GenerateDownloadUrlRequest"
+ // },
+ // "response": {
+ // "$ref": "GenerateDownloadUrlResponse"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "cloudfunctions.projects.locations.functions.generateUploadUrl":
+
+type ProjectsLocationsFunctionsGenerateUploadUrlCall struct {
+ s *Service
+ parent string
+ generateuploadurlrequest *GenerateUploadUrlRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// GenerateUploadUrl: Returns a signed URL for uploading a function
+// source code.
+// For more information about the signed URL usage
+// see:
+// https://cloud.google.com/storage/docs/access-control/signed-urls
+//
+// Once the function source code upload is complete, the used signed
+// URL should be provided in CreateFunction or UpdateFunction request
+// as a reference to the function source code.
+func (r *ProjectsLocationsFunctionsService) GenerateUploadUrl(parent string, generateuploadurlrequest *GenerateUploadUrlRequest) *ProjectsLocationsFunctionsGenerateUploadUrlCall {
+ c := &ProjectsLocationsFunctionsGenerateUploadUrlCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.parent = parent
+ c.generateuploadurlrequest = generateuploadurlrequest
+ return c
+}
+
+// Fields allows partial responses to be retrieved. See
+// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
+// for more information.
+func (c *ProjectsLocationsFunctionsGenerateUploadUrlCall) Fields(s ...googleapi.Field) *ProjectsLocationsFunctionsGenerateUploadUrlCall {
+ c.urlParams_.Set("fields", googleapi.CombineFields(s))
+ return c
+}
+
+// Context sets the context to be used in this call's Do method. Any
+// pending HTTP request will be aborted if the provided context is
+// canceled.
+func (c *ProjectsLocationsFunctionsGenerateUploadUrlCall) Context(ctx context.Context) *ProjectsLocationsFunctionsGenerateUploadUrlCall {
+ c.ctx_ = ctx
+ return c
+}
+
+// Header returns an http.Header that can be modified by the caller to
+// add HTTP headers to the request.
+func (c *ProjectsLocationsFunctionsGenerateUploadUrlCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsFunctionsGenerateUploadUrlCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.generateuploadurlrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta2/{+parent}/functions:generateUploadUrl")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "parent": c.parent,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "cloudfunctions.projects.locations.functions.generateUploadUrl" call.
+// Exactly one of *GenerateUploadUrlResponse or error will be non-nil.
+// Any non-2xx status code is an error. Response headers are in either
+// *GenerateUploadUrlResponse.ServerResponse.Header or (if a response
+// was returned at all) in error.(*googleapi.Error).Header. Use
+// googleapi.IsNotModified to check whether the returned error was
+// because http.StatusNotModified was returned.
+func (c *ProjectsLocationsFunctionsGenerateUploadUrlCall) Do(opts ...googleapi.CallOption) (*GenerateUploadUrlResponse, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &GenerateUploadUrlResponse{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Returns a signed URL for uploading a function source code.\nFor more information about the signed URL usage see:\nhttps://cloud.google.com/storage/docs/access-control/signed-urls\nOnce the function source code upload is complete, the used signed\nURL should be provided in CreateFunction or UpdateFunction request\nas a reference to the function source code.",
+ // "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions:generateUploadUrl",
+ // "httpMethod": "POST",
+ // "id": "cloudfunctions.projects.locations.functions.generateUploadUrl",
+ // "parameterOrder": [
+ // "parent"
+ // ],
+ // "parameters": {
+ // "parent": {
+ // "description": "The project and location in which the Google Cloud Storage signed URL\nshould be generated, specified in the format `projects/*/locations/*",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta2/{+parent}/functions:generateUploadUrl",
+ // "request": {
+ // "$ref": "GenerateUploadUrlRequest"
+ // },
+ // "response": {
+ // "$ref": "GenerateUploadUrlResponse"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
// method id "cloudfunctions.projects.locations.functions.get":
type ProjectsLocationsFunctionsGetCall struct {
diff --git a/cloudiot/v1/cloudiot-api.json b/cloudiot/v1/cloudiot-api.json
index 8044a56..4f10ec0 100644
--- a/cloudiot/v1/cloudiot-api.json
+++ b/cloudiot/v1/cloudiot-api.json
@@ -1,314 +1,12 @@
{
- "servicePath": "",
- "description": "Registers and manages IoT (Internet of Things) devices that connect to the Google Cloud Platform.\n",
- "kind": "discovery#restDescription",
- "basePath": "",
"id": "cloudiot:v1",
"documentationLink": "https://cloud.google.com/iot",
"revision": "20171003",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "DeviceRegistry": {
- "description": "A container for a group of devices.",
- "type": "object",
- "properties": {
- "stateNotificationConfig": {
- "$ref": "StateNotificationConfig",
- "description": "The configuration for notification of new states received from the device.\nState updates are guaranteed to be stored in the state history, but\nnotifications to Cloud Pub/Sub are not guaranteed. For example, if\npermissions are misconfigured or the specified topic doesn't exist, no\nnotification will be published but the state will still be stored in Cloud\nIoT Core."
- },
- "credentials": {
- "description": "The credentials used to verify the device credentials. No more than 10\ncredentials can be bound to a single registry at a time. The verification\nprocess occurs at the time of device creation or update. If this field is\nempty, no verification is performed. Otherwise, the credentials of a newly\ncreated device or added credentials of an updated device should be signed\nwith one of these registry credentials.\n\nNote, however, that existing devices will never be affected by\nmodifications to this list of credentials: after a device has been\nsuccessfully created in a registry, it should be able to connect even if\nits registry credentials are revoked, deleted, or modified.",
- "items": {
- "$ref": "RegistryCredential"
- },
- "type": "array"
- },
- "name": {
- "description": "The resource path name. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
- "type": "string"
- },
- "eventNotificationConfigs": {
- "description": "The configuration for notification of telemetry events received from the\ndevice. All telemetry events that were successfully published by the\ndevice and acknowledged by Cloud IoT Core are guaranteed to be\ndelivered to Cloud Pub/Sub. Only the first configuration is used.",
- "items": {
- "$ref": "EventNotificationConfig"
- },
- "type": "array"
- },
- "httpConfig": {
- "description": "The DeviceService (HTTP) configuration for this device registry.",
- "$ref": "HttpConfig"
- },
- "id": {
- "description": "The identifier of this device registry. For example, `myRegistry`.",
- "type": "string"
- },
- "mqttConfig": {
- "description": "The MQTT configuration for this device registry.",
- "$ref": "MqttConfig"
- }
- },
- "id": "DeviceRegistry"
- },
- "ListDevicesResponse": {
- "properties": {
- "devices": {
- "description": "The devices that match the request.",
- "items": {
- "$ref": "Device"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "If not empty, indicates that there may be more devices that match the\nrequest; this value should be passed in a new `ListDevicesRequest`.",
- "type": "string"
- }
- },
- "id": "ListDevicesResponse",
- "description": "Response for `ListDevices`.",
- "type": "object"
- },
- "DeviceCredential": {
- "description": "A server-stored device credential used for authentication.",
- "type": "object",
- "properties": {
- "expirationTime": {
- "format": "google-datetime",
- "description": "[Optional] The time at which this credential becomes invalid. This\ncredential will be ignored for new client authentication requests after\nthis timestamp; however, it will not be automatically deleted.",
- "type": "string"
- },
- "publicKey": {
- "description": "A public key used to verify the signature of JSON Web Tokens (JWTs).\nWhen adding a new device credential, either via device creation or via\nmodifications, this public key credential may be required to be signed by\none of the registry level certificates. More specifically, if the\nregistry contains at least one certificate, any new device credential\nmust be signed by one of the registry certificates. As a result,\nwhen the registry contains certificates, only X.509 certificates are\naccepted as device credentials. However, if the registry does\nnot contain a certificate, self-signed certificates and public keys will\nbe accepted. New device credentials must be different from every\nregistry-level certificate.",
- "$ref": "PublicKeyCredential"
- }
- },
- "id": "DeviceCredential"
- },
- "HttpConfig": {
- "description": "The configuration of the HTTP bridge for a device registry.",
- "type": "object",
- "properties": {
- "httpEnabledState": {
- "enumDescriptions": [
- "No HTTP state specified. If not specified, DeviceService will be\nenabled by default.",
- "Enables DeviceService (HTTP) service for the registry.",
- "Disables DeviceService (HTTP) service for the registry."
- ],
- "enum": [
- "HTTP_STATE_UNSPECIFIED",
- "HTTP_ENABLED",
- "HTTP_DISABLED"
- ],
- "description": "If enabled, allows devices to use DeviceService via the HTTP protocol.\nOtherwise, any requests to DeviceService will fail for this registry.",
- "type": "string"
- }
- },
- "id": "HttpConfig"
- },
- "AuditConfig": {
- "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
- "type": "object",
- "properties": {
- "service": {
- "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
- "type": "string"
- },
- "auditLogConfigs": {
- "description": "The configuration for logging of each type of permission.\nNext ID: 4",
- "items": {
- "$ref": "AuditLogConfig"
- },
- "type": "array"
- },
- "exemptedMembers": {
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "AuditConfig"
- },
- "DeviceConfig": {
- "properties": {
- "binaryData": {
- "format": "byte",
- "description": "The device configuration data.",
- "type": "string"
- },
- "deviceAckTime": {
- "format": "google-datetime",
- "description": "[Output only] The time at which Cloud IoT Core received the\nacknowledgment from the device, indicating that the device has received\nthis configuration version. If this field is not present, the device has\nnot yet acknowledged that it received this version. Note that when\nthe config was sent to the device, many config versions may have been\navailable in Cloud IoT Core while the device was disconnected, and on\nconnection, only the latest version is sent to the device. Some\nversions may never be sent to the device, and therefore are never\nacknowledged. This timestamp is set by Cloud IoT Core.",
- "type": "string"
- },
- "cloudUpdateTime": {
- "format": "google-datetime",
- "description": "[Output only] The time at which this configuration version was updated in\nCloud IoT Core. This timestamp is set by the server.",
- "type": "string"
- },
- "version": {
- "format": "int64",
- "description": "[Output only] The version of this update. The version number is assigned by\nthe server, and is always greater than 0 after device creation. The\nversion must be 0 on the `CreateDevice` request if a `config` is\nspecified; the response of `CreateDevice` will always have a value of 1.",
- "type": "string"
- }
- },
- "id": "DeviceConfig",
- "description": "The device configuration. Eventually delivered to devices.",
- "type": "object"
- },
- "MqttConfig": {
- "description": "The configuration of MQTT for a device registry.",
- "type": "object",
- "properties": {
- "mqttEnabledState": {
- "enumDescriptions": [
- "No MQTT state specified. If not specified, MQTT will be enabled by default.",
- "Enables a MQTT connection.",
- "Disables a MQTT connection."
- ],
- "enum": [
- "MQTT_STATE_UNSPECIFIED",
- "MQTT_ENABLED",
- "MQTT_DISABLED"
- ],
- "description": "If enabled, allows connections using the MQTT protocol. Otherwise, MQTT\nconnections to this registry will fail.",
- "type": "string"
- }
- },
- "id": "MqttConfig"
- },
- "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.",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- },
- "type": "array"
- },
- "code": {
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- }
- },
- "id": "Status",
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object"
- },
- "Binding": {
- "properties": {
- "condition": {
- "description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently.\nThis field is GOOGLE_INTERNAL.",
- "$ref": "Expr"
- },
- "members": {
- "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "role": {
- "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
- "type": "string"
- }
- },
- "id": "Binding",
- "description": "Associates `members` with a `role`.",
- "type": "object"
- },
- "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"
- }
- },
- "id": "Expr",
- "description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"",
- "type": "object"
- },
- "ModifyCloudToDeviceConfigRequest": {
- "properties": {
- "versionToUpdate": {
- "format": "int64",
- "description": "The version number to update. If this value is zero, it will not check the\nversion number of the server and will always update the current version;\notherwise, this update will fail if the version number found on the server\ndoes not match this version number. This is used to support multiple\nsimultaneous updates without losing data.",
- "type": "string"
- },
- "binaryData": {
- "format": "byte",
- "description": "The configuration data for the device.",
- "type": "string"
- }
- },
- "id": "ModifyCloudToDeviceConfigRequest",
- "description": "Request for `ModifyCloudToDeviceConfig`.",
- "type": "object"
- },
- "ListDeviceStatesResponse": {
- "description": "Response for `ListDeviceStates`.",
- "type": "object",
- "properties": {
- "deviceStates": {
- "description": "The last few device states. States are listed in descending order of server\nupdate time, starting from the most recent one.",
- "items": {
- "$ref": "DeviceState"
- },
- "type": "array"
- }
- },
- "id": "ListDeviceStatesResponse"
- },
- "GetIamPolicyRequest": {
- "properties": {},
- "id": "GetIamPolicyRequest",
- "description": "Request message for `GetIamPolicy` method.",
- "type": "object"
- },
- "TestIamPermissionsResponse": {
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "TestIamPermissionsResponse"
- },
"Device": {
- "description": "The device resource.",
- "type": "object",
"properties": {
- "numId": {
- "format": "uint64",
- "description": "[Output only] A server-defined unique numeric ID for the device. This is a\nmore compact way to identify devices, and it is globally unique.",
- "type": "string"
- },
"lastHeartbeatTime": {
"format": "google-datetime",
"description": "[Output only] The last time a heartbeat was received. Timestamps are\nperiodically collected and written to storage; they may be stale by a few\nminutes. This field is only for devices connecting through MQTT.",
@@ -337,14 +35,14 @@
"description": "[Output only] The last time a state event was received. Timestamps are\nperiodically collected and written to storage; they may be stale by a few\nminutes.",
"type": "string"
},
+ "state": {
+ "$ref": "DeviceState",
+ "description": "[Output only] The state most recently received from the device. If no state\nhas been reported, this field is not present."
+ },
"config": {
"$ref": "DeviceConfig",
"description": "The most recent device configuration, which is eventually sent from\nCloud IoT Core to the device. If not present on creation, the\nconfiguration will be initialized with an empty payload and version value\nof `1`. To update this field after creation, use the\n`DeviceManager.ModifyCloudToDeviceConfig` method."
},
- "state": {
- "description": "[Output only] The state most recently received from the device. If no state\nhas been reported, this field is not present.",
- "$ref": "DeviceState"
- },
"name": {
"description": "The resource path name. For example,\n`projects/p1/locations/us-central1/registries/registry0/devices/dev0` or\n`projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`.\nWhen `name` is populated as a response from the service, it always ends\nin the device numeric ID.",
"type": "string"
@@ -376,9 +74,16 @@
"format": "google-datetime",
"description": "[Output only] The last time a cloud-to-device config version acknowledgment\nwas received from the device. This field is only for configurations\nsent through MQTT.",
"type": "string"
+ },
+ "numId": {
+ "format": "uint64",
+ "description": "[Output only] A server-defined unique numeric ID for the device. This is a\nmore compact way to identify devices, and it is globally unique.",
+ "type": "string"
}
},
- "id": "Device"
+ "id": "Device",
+ "description": "The device resource.",
+ "type": "object"
},
"ListDeviceConfigVersionsResponse": {
"description": "Response for `ListDeviceConfigVersions`.",
@@ -455,18 +160,27 @@
"id": "EventNotificationConfig"
},
"Empty": {
- "properties": {},
- "id": "Empty",
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object"
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
},
"PublicKeyCredential": {
+ "description": "A public key format and data.",
+ "type": "object",
"properties": {
"key": {
"description": "The key data.",
"type": "string"
},
"format": {
+ "enumDescriptions": [
+ "The format has not been specified. This is an invalid default value and\nmust not be used.",
+ "An RSA public key encoded in base64, and wrapped by\n`-----BEGIN PUBLIC KEY-----` and `-----END PUBLIC KEY-----`. This can be\nused to verify `RS256` signatures in JWT tokens ([RFC7518](\nhttps://www.ietf.org/rfc/rfc7518.txt)).",
+ "As RSA_PEM, but wrapped in an X.509v3 certificate ([RFC5280](\nhttps://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, and wrapped by\n`-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----`.",
+ "Public key for the ECDSA algorithm using P-256 and SHA-256, encoded in\nbase64, and wrapped by `-----BEGIN PUBLIC KEY-----` and `-----END\nPUBLIC KEY-----`. This can be used to verify JWT tokens with the `ES256`\nalgorithm ([RFC7518](https://www.ietf.org/rfc/rfc7518.txt)). This curve is\ndefined in [OpenSSL](https://www.openssl.org/) as the `prime256v1` curve.",
+ "As ES256_PEM, but wrapped in an X.509v3 certificate ([RFC5280](\nhttps://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, and wrapped by\n`-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----`."
+ ],
"enum": [
"UNSPECIFIED_PUBLIC_KEY_FORMAT",
"RSA_PEM",
@@ -475,75 +189,57 @@
"ES256_X509_PEM"
],
"description": "The format of the key.",
- "type": "string",
- "enumDescriptions": [
- "The format has not been specified. This is an invalid default value and\nmust not be used.",
- "An RSA public key encoded in base64, and wrapped by\n`-----BEGIN PUBLIC KEY-----` and `-----END PUBLIC KEY-----`. This can be\nused to verify `RS256` signatures in JWT tokens ([RFC7518](\nhttps://www.ietf.org/rfc/rfc7518.txt)).",
- "As RSA_PEM, but wrapped in an X.509v3 certificate ([RFC5280](\nhttps://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, and wrapped by\n`-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----`.",
- "Public key for the ECDSA algorithm using P-256 and SHA-256, encoded in\nbase64, and wrapped by `-----BEGIN PUBLIC KEY-----` and `-----END\nPUBLIC KEY-----`. This can be used to verify JWT tokens with the `ES256`\nalgorithm ([RFC7518](https://www.ietf.org/rfc/rfc7518.txt)). This curve is\ndefined in [OpenSSL](https://www.openssl.org/) as the `prime256v1` curve.",
- "As ES256_PEM, but wrapped in an X.509v3 certificate ([RFC5280](\nhttps://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, and wrapped by\n`-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----`."
- ]
+ "type": "string"
}
},
- "id": "PublicKeyCredential",
- "description": "A public key format and data.",
- "type": "object"
+ "id": "PublicKeyCredential"
},
"PublicKeyCertificate": {
+ "description": "A public key certificate format and data.",
+ "type": "object",
"properties": {
- "certificate": {
- "description": "The certificate data.",
- "type": "string"
- },
"x509Details": {
- "description": "[Output only] The certificate details. Used only for X.509 certificates.",
- "$ref": "X509CertificateDetails"
+ "$ref": "X509CertificateDetails",
+ "description": "[Output only] The certificate details. Used only for X.509 certificates."
},
"format": {
- "enumDescriptions": [
- "The format has not been specified. This is an invalid default value and\nmust not be used.",
- "An X.509v3 certificate ([RFC5280](https://www.ietf.org/rfc/rfc5280.txt)),\nencoded in base64, and wrapped by `-----BEGIN CERTIFICATE-----` and\n`-----END CERTIFICATE-----`."
- ],
"enum": [
"UNSPECIFIED_PUBLIC_KEY_CERTIFICATE_FORMAT",
"X509_CERTIFICATE_PEM"
],
"description": "The certificate format.",
+ "type": "string",
+ "enumDescriptions": [
+ "The format has not been specified. This is an invalid default value and\nmust not be used.",
+ "An X.509v3 certificate ([RFC5280](https://www.ietf.org/rfc/rfc5280.txt)),\nencoded in base64, and wrapped by `-----BEGIN CERTIFICATE-----` and\n`-----END CERTIFICATE-----`."
+ ]
+ },
+ "certificate": {
+ "description": "The certificate data.",
"type": "string"
}
},
- "id": "PublicKeyCertificate",
- "description": "A public key certificate format and data.",
- "type": "object"
+ "id": "PublicKeyCertificate"
},
"DeviceState": {
+ "description": "The device state, as reported by the device.",
+ "type": "object",
"properties": {
- "binaryData": {
- "format": "byte",
- "description": "The device state data.",
- "type": "string"
- },
"updateTime": {
"format": "google-datetime",
"description": "[Output only] The time at which this state version was updated in Cloud\nIoT Core.",
"type": "string"
+ },
+ "binaryData": {
+ "format": "byte",
+ "description": "The device state data.",
+ "type": "string"
}
},
- "id": "DeviceState",
- "description": "The device state, as reported by the device.",
- "type": "object"
+ "id": "DeviceState"
},
"AuditLogConfig": {
- "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
- "type": "object",
"properties": {
- "exemptedMembers": {
- "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
"logType": {
"enum": [
"LOG_TYPE_UNSPECIFIED",
@@ -559,20 +255,18 @@
"Data writes. Example: CloudSQL Users create",
"Data reads. Example: CloudSQL Users list"
]
+ },
+ "exemptedMembers": {
+ "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
},
- "id": "AuditLogConfig"
- },
- "StateNotificationConfig": {
- "description": "The configuration for notification of new states received from the device.",
- "type": "object",
- "properties": {
- "pubsubTopicName": {
- "description": "A Cloud Pub/Sub topic name. For example,\n`projects/myProject/topics/deviceEvents`.",
- "type": "string"
- }
- },
- "id": "StateNotificationConfig"
+ "id": "AuditLogConfig",
+ "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
+ "type": "object"
},
"TestIamPermissionsRequest": {
"description": "Request message for `TestIamPermissions` method.",
@@ -588,13 +282,19 @@
},
"id": "TestIamPermissionsRequest"
},
- "Policy": {
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
+ "StateNotificationConfig": {
+ "description": "The configuration for notification of new states received from the device.",
"type": "object",
"properties": {
- "iamOwned": {
- "type": "boolean"
- },
+ "pubsubTopicName": {
+ "description": "A Cloud Pub/Sub topic name. For example,\n`projects/myProject/topics/deviceEvents`.",
+ "type": "string"
+ }
+ },
+ "id": "StateNotificationConfig"
+ },
+ "Policy": {
+ "properties": {
"etag": {
"format": "byte",
"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.",
@@ -618,38 +318,334 @@
"$ref": "Binding"
},
"type": "array"
+ },
+ "iamOwned": {
+ "type": "boolean"
}
},
- "id": "Policy"
+ "id": "Policy",
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
+ "type": "object"
},
"RegistryCredential": {
+ "description": "A server-stored registry credential used to validate device credentials.",
+ "type": "object",
"properties": {
"publicKeyCertificate": {
- "description": "A public key certificate used to verify the device credentials.",
- "$ref": "PublicKeyCertificate"
+ "$ref": "PublicKeyCertificate",
+ "description": "A public key certificate used to verify the device credentials."
}
},
- "id": "RegistryCredential",
- "description": "A server-stored registry credential used to validate device credentials.",
- "type": "object"
+ "id": "RegistryCredential"
},
"ListDeviceRegistriesResponse": {
"description": "Response for `ListDeviceRegistries`.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "If not empty, indicates that there may be more registries that match the\nrequest; this value should be passed in a new\n`ListDeviceRegistriesRequest`.",
- "type": "string"
- },
"deviceRegistries": {
"description": "The registries that matched the query.",
"items": {
"$ref": "DeviceRegistry"
},
"type": "array"
+ },
+ "nextPageToken": {
+ "description": "If not empty, indicates that there may be more registries that match the\nrequest; this value should be passed in a new\n`ListDeviceRegistriesRequest`.",
+ "type": "string"
}
},
"id": "ListDeviceRegistriesResponse"
+ },
+ "DeviceRegistry": {
+ "description": "A container for a group of devices.",
+ "type": "object",
+ "properties": {
+ "stateNotificationConfig": {
+ "$ref": "StateNotificationConfig",
+ "description": "The configuration for notification of new states received from the device.\nState updates are guaranteed to be stored in the state history, but\nnotifications to Cloud Pub/Sub are not guaranteed. For example, if\npermissions are misconfigured or the specified topic doesn't exist, no\nnotification will be published but the state will still be stored in Cloud\nIoT Core."
+ },
+ "name": {
+ "description": "The resource path name. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
+ "type": "string"
+ },
+ "credentials": {
+ "description": "The credentials used to verify the device credentials. No more than 10\ncredentials can be bound to a single registry at a time. The verification\nprocess occurs at the time of device creation or update. If this field is\nempty, no verification is performed. Otherwise, the credentials of a newly\ncreated device or added credentials of an updated device should be signed\nwith one of these registry credentials.\n\nNote, however, that existing devices will never be affected by\nmodifications to this list of credentials: after a device has been\nsuccessfully created in a registry, it should be able to connect even if\nits registry credentials are revoked, deleted, or modified.",
+ "items": {
+ "$ref": "RegistryCredential"
+ },
+ "type": "array"
+ },
+ "eventNotificationConfigs": {
+ "description": "The configuration for notification of telemetry events received from the\ndevice. All telemetry events that were successfully published by the\ndevice and acknowledged by Cloud IoT Core are guaranteed to be\ndelivered to Cloud Pub/Sub. Only the first configuration is used.",
+ "items": {
+ "$ref": "EventNotificationConfig"
+ },
+ "type": "array"
+ },
+ "httpConfig": {
+ "description": "The DeviceService (HTTP) configuration for this device registry.",
+ "$ref": "HttpConfig"
+ },
+ "id": {
+ "description": "The identifier of this device registry. For example, `myRegistry`.",
+ "type": "string"
+ },
+ "mqttConfig": {
+ "$ref": "MqttConfig",
+ "description": "The MQTT configuration for this device registry."
+ }
+ },
+ "id": "DeviceRegistry"
+ },
+ "ListDevicesResponse": {
+ "description": "Response for `ListDevices`.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "If not empty, indicates that there may be more devices that match the\nrequest; this value should be passed in a new `ListDevicesRequest`.",
+ "type": "string"
+ },
+ "devices": {
+ "description": "The devices that match the request.",
+ "items": {
+ "$ref": "Device"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListDevicesResponse"
+ },
+ "AuditConfig": {
+ "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
+ "type": "object",
+ "properties": {
+ "service": {
+ "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
+ "type": "string"
+ },
+ "auditLogConfigs": {
+ "description": "The configuration for logging of each type of permission.\nNext ID: 4",
+ "items": {
+ "$ref": "AuditLogConfig"
+ },
+ "type": "array"
+ },
+ "exemptedMembers": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "AuditConfig"
+ },
+ "HttpConfig": {
+ "properties": {
+ "httpEnabledState": {
+ "description": "If enabled, allows devices to use DeviceService via the HTTP protocol.\nOtherwise, any requests to DeviceService will fail for this registry.",
+ "type": "string",
+ "enumDescriptions": [
+ "No HTTP state specified. If not specified, DeviceService will be\nenabled by default.",
+ "Enables DeviceService (HTTP) service for the registry.",
+ "Disables DeviceService (HTTP) service for the registry."
+ ],
+ "enum": [
+ "HTTP_STATE_UNSPECIFIED",
+ "HTTP_ENABLED",
+ "HTTP_DISABLED"
+ ]
+ }
+ },
+ "id": "HttpConfig",
+ "description": "The configuration of the HTTP bridge for a device registry.",
+ "type": "object"
+ },
+ "DeviceCredential": {
+ "description": "A server-stored device credential used for authentication.",
+ "type": "object",
+ "properties": {
+ "expirationTime": {
+ "format": "google-datetime",
+ "description": "[Optional] The time at which this credential becomes invalid. This\ncredential will be ignored for new client authentication requests after\nthis timestamp; however, it will not be automatically deleted.",
+ "type": "string"
+ },
+ "publicKey": {
+ "$ref": "PublicKeyCredential",
+ "description": "A public key used to verify the signature of JSON Web Tokens (JWTs).\nWhen adding a new device credential, either via device creation or via\nmodifications, this public key credential may be required to be signed by\none of the registry level certificates. More specifically, if the\nregistry contains at least one certificate, any new device credential\nmust be signed by one of the registry certificates. As a result,\nwhen the registry contains certificates, only X.509 certificates are\naccepted as device credentials. However, if the registry does\nnot contain a certificate, self-signed certificates and public keys will\nbe accepted. New device credentials must be different from every\nregistry-level certificate."
+ }
+ },
+ "id": "DeviceCredential"
+ },
+ "DeviceConfig": {
+ "description": "The device configuration. Eventually delivered to devices.",
+ "type": "object",
+ "properties": {
+ "binaryData": {
+ "format": "byte",
+ "description": "The device configuration data.",
+ "type": "string"
+ },
+ "deviceAckTime": {
+ "format": "google-datetime",
+ "description": "[Output only] The time at which Cloud IoT Core received the\nacknowledgment from the device, indicating that the device has received\nthis configuration version. If this field is not present, the device has\nnot yet acknowledged that it received this version. Note that when\nthe config was sent to the device, many config versions may have been\navailable in Cloud IoT Core while the device was disconnected, and on\nconnection, only the latest version is sent to the device. Some\nversions may never be sent to the device, and therefore are never\nacknowledged. This timestamp is set by Cloud IoT Core.",
+ "type": "string"
+ },
+ "cloudUpdateTime": {
+ "format": "google-datetime",
+ "description": "[Output only] The time at which this configuration version was updated in\nCloud IoT Core. This timestamp is set by the server.",
+ "type": "string"
+ },
+ "version": {
+ "format": "int64",
+ "description": "[Output only] The version of this update. The version number is assigned by\nthe server, and is always greater than 0 after device creation. The\nversion must be 0 on the `CreateDevice` request if a `config` is\nspecified; the response of `CreateDevice` will always have a value of 1.",
+ "type": "string"
+ }
+ },
+ "id": "DeviceConfig"
+ },
+ "MqttConfig": {
+ "description": "The configuration of MQTT for a device registry.",
+ "type": "object",
+ "properties": {
+ "mqttEnabledState": {
+ "enumDescriptions": [
+ "No MQTT state specified. If not specified, MQTT will be enabled by default.",
+ "Enables a MQTT connection.",
+ "Disables a MQTT connection."
+ ],
+ "enum": [
+ "MQTT_STATE_UNSPECIFIED",
+ "MQTT_ENABLED",
+ "MQTT_DISABLED"
+ ],
+ "description": "If enabled, allows connections using the MQTT protocol. Otherwise, MQTT\nconnections to this registry will fail.",
+ "type": "string"
+ }
+ },
+ "id": "MqttConfig"
+ },
+ "Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
+ "properties": {
+ "code": {
+ "format": "int32",
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "type": "array"
+ }
+ },
+ "id": "Status"
+ },
+ "Binding": {
+ "properties": {
+ "condition": {
+ "$ref": "Expr",
+ "description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently.\nThis field is GOOGLE_INTERNAL."
+ },
+ "members": {
+ "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "role": {
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
+ "type": "string"
+ }
+ },
+ "id": "Binding",
+ "description": "Associates `members` with a `role`.",
+ "type": "object"
+ },
+ "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"
+ }
+ },
+ "id": "Expr",
+ "description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"",
+ "type": "object"
+ },
+ "ModifyCloudToDeviceConfigRequest": {
+ "description": "Request for `ModifyCloudToDeviceConfig`.",
+ "type": "object",
+ "properties": {
+ "binaryData": {
+ "format": "byte",
+ "description": "The configuration data for the device.",
+ "type": "string"
+ },
+ "versionToUpdate": {
+ "format": "int64",
+ "description": "The version number to update. If this value is zero, it will not check the\nversion number of the server and will always update the current version;\notherwise, this update will fail if the version number found on the server\ndoes not match this version number. This is used to support multiple\nsimultaneous updates without losing data.",
+ "type": "string"
+ }
+ },
+ "id": "ModifyCloudToDeviceConfigRequest"
+ },
+ "ListDeviceStatesResponse": {
+ "description": "Response for `ListDeviceStates`.",
+ "type": "object",
+ "properties": {
+ "deviceStates": {
+ "description": "The last few device states. States are listed in descending order of server\nupdate time, starting from the most recent one.",
+ "items": {
+ "$ref": "DeviceState"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListDeviceStatesResponse"
+ },
+ "GetIamPolicyRequest": {
+ "description": "Request message for `GetIamPolicy` method.",
+ "type": "object",
+ "properties": {},
+ "id": "GetIamPolicyRequest"
+ },
+ "TestIamPermissionsResponse": {
+ "properties": {
+ "permissions": {
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "TestIamPermissionsResponse",
+ "description": "Response message for `TestIamPermissions` method.",
+ "type": "object"
}
},
"icons": {
@@ -661,11 +657,11 @@
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
"https://www.googleapis.com/auth/cloudiot": {
"description": "Register and manage devices in the Google Cloud IoT service"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
}
}
}
@@ -682,8 +678,383 @@
"locations": {
"resources": {
"registries": {
+ "resources": {
+ "devices": {
+ "methods": {
+ "modifyCloudToDeviceConfig": {
+ "response": {
+ "$ref": "DeviceConfig"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}:modifyCloudToDeviceConfig",
+ "id": "cloudiot.projects.locations.registries.devices.modifyCloudToDeviceConfig",
+ "path": "v1/{+name}:modifyCloudToDeviceConfig",
+ "description": "Modifies the configuration for the device, which is eventually sent from\nthe Cloud IoT Core servers. Returns the modified configuration version and\nits metadata.",
+ "request": {
+ "$ref": "ModifyCloudToDeviceConfigRequest"
+ }
+ },
+ "get": {
+ "description": "Gets details about a device.",
+ "response": {
+ "$ref": "Device"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
+ "location": "path",
+ "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}",
+ "id": "cloudiot.projects.locations.registries.devices.get",
+ "path": "v1/{+name}"
+ },
+ "patch": {
+ "description": "Updates a device.",
+ "request": {
+ "$ref": "Device"
+ },
+ "response": {
+ "$ref": "Device"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "updateMask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Only updates the `device` fields indicated by this mask.\nThe field mask must not be empty, and it must not contain fields that\nare immutable or only set by the server.\nMutable top-level fields: `credentials`, `enabled_state`, and `metadata`",
+ "type": "string"
+ },
+ "name": {
+ "description": "The resource path name. For example,\n`projects/p1/locations/us-central1/registries/registry0/devices/dev0` or\n`projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`.\nWhen `name` is populated as a response from the service, it always ends\nin the device numeric ID.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}",
+ "id": "cloudiot.projects.locations.registries.devices.patch",
+ "path": "v1/{+name}"
+ },
+ "delete": {
+ "description": "Deletes a device.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}",
+ "id": "cloudiot.projects.locations.registries.devices.delete",
+ "path": "v1/{+name}"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListDevicesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "parameters": {
+ "deviceNumIds": {
+ "repeated": true,
+ "location": "query",
+ "format": "uint64",
+ "description": "A list of device numerical ids. If empty, it will ignore this field. This\nfield cannot hold more than 10,000 entries.",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The value returned by the last `ListDevicesResponse`; indicates\nthat this is a continuation of a prior `ListDevices` call, and\nthat the system should return the next page of data.",
+ "type": "string"
+ },
+ "fieldMask": {
+ "format": "google-fieldmask",
+ "description": "The fields of the `Device` resource to be returned in the response. The\nfields `id`, and `num_id` are always returned by default, along with any\nother fields specified.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "The maximum number of devices to return in the response. If this value\nis zero, the service will select a default size. A call may return fewer\nobjects than requested, but if there is a non-empty `page_token`, it\nindicates that more entries are available.",
+ "type": "integer"
+ },
+ "parent": {
+ "location": "path",
+ "description": "The device registry path. Required. For example,\n`projects/my-project/locations/us-central1/registries/my-registry`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$"
+ },
+ "deviceIds": {
+ "location": "query",
+ "description": "A list of device string identifiers. If empty, it will ignore this field.\nFor example, `['device0', 'device12']`. This field cannot hold more than\n10,000 entries.",
+ "type": "string",
+ "repeated": true
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices",
+ "path": "v1/{+parent}/devices",
+ "id": "cloudiot.projects.locations.registries.devices.list",
+ "description": "List devices in a device registry."
+ },
+ "create": {
+ "request": {
+ "$ref": "Device"
+ },
+ "description": "Creates a device in a device registry.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "Device"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "The name of the device registry where this device should be created.\nFor example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices",
+ "path": "v1/{+parent}/devices",
+ "id": "cloudiot.projects.locations.registries.devices.create"
+ }
+ },
+ "resources": {
+ "states": {
+ "methods": {
+ "list": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}/states",
+ "id": "cloudiot.projects.locations.registries.devices.states.list",
+ "path": "v1/{+name}/states",
+ "description": "Lists the last few versions of the device state in descending order (i.e.:\nnewest first).",
+ "response": {
+ "$ref": "ListDeviceStatesResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
+ "location": "path"
+ },
+ "numStates": {
+ "format": "int32",
+ "description": "The number of states to list. States are listed in descending order of\nupdate time. The maximum number of states retained is 10. If this\nvalue is zero, it will return all the states available.",
+ "type": "integer",
+ "location": "query"
+ }
+ }
+ }
+ }
+ },
+ "configVersions": {
+ "methods": {
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListDeviceConfigVersionsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
+ "location": "path"
+ },
+ "numVersions": {
+ "location": "query",
+ "format": "int32",
+ "description": "The number of versions to list. Versions are listed in decreasing order of\nthe version number. The maximum number of versions retained is 10. If this\nvalue is zero, it will return all the versions available.",
+ "type": "integer"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}/configVersions",
+ "path": "v1/{+name}/configVersions",
+ "id": "cloudiot.projects.locations.registries.devices.configVersions.list",
+ "description": "Lists the last few versions of the device configuration in descending\norder (i.e.: newest first)."
+ }
+ }
+ }
+ }
+ }
+ },
"methods": {
+ "getIamPolicy": {
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:getIamPolicy",
+ "id": "cloudiot.projects.locations.registries.getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ },
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset."
+ },
+ "get": {
+ "description": "Gets a device registry configuration.",
+ "response": {
+ "$ref": "DeviceRegistry"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
+ "location": "path",
+ "description": "The name of the device registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}",
+ "id": "cloudiot.projects.locations.registries.get",
+ "path": "v1/{+name}"
+ },
+ "patch": {
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "DeviceRegistry"
+ },
+ "parameters": {
+ "updateMask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Only updates the `device_registry` fields indicated by this mask.\nThe field mask must not be empty, and it must not contain fields that\nare immutable or only set by the server.\nMutable top-level fields: `event_notification_config`, `mqtt_config`, and\n`state_notification_config`.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The resource path name. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}",
+ "path": "v1/{+name}",
+ "id": "cloudiot.projects.locations.registries.patch",
+ "description": "Updates a device registry configuration.",
+ "request": {
+ "$ref": "DeviceRegistry"
+ }
+ },
"testIamPermissions": {
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
"httpMethod": "POST",
"parameterOrder": [
"resource"
@@ -706,20 +1077,21 @@
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:testIamPermissions",
"path": "v1/{+resource}:testIamPermissions",
- "id": "cloudiot.projects.locations.registries.testIamPermissions",
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- }
+ "id": "cloudiot.projects.locations.registries.testIamPermissions"
},
"delete": {
- "httpMethod": "DELETE",
+ "description": "Deletes a device registry configuration.",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"name"
],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
"parameters": {
"name": {
"description": "The name of the device registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
@@ -729,42 +1101,36 @@
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}",
- "path": "v1/{+name}",
"id": "cloudiot.projects.locations.registries.delete",
- "description": "Deletes a device registry configuration."
+ "path": "v1/{+name}"
},
"list": {
- "description": "Lists device registries.",
- "httpMethod": "GET",
"response": {
"$ref": "ListDeviceRegistriesResponse"
},
"parameterOrder": [
"parent"
],
+ "httpMethod": "GET",
"parameters": {
- "pageToken": {
- "description": "The value returned by the last `ListDeviceRegistriesResponse`; indicates\nthat this is a continuation of a prior `ListDeviceRegistries` call, and\nthat the system should return the next page of data.",
- "type": "string",
- "location": "query"
- },
"pageSize": {
- "location": "query",
"format": "int32",
"description": "The maximum number of registries to return in the response. If this value\nis zero, the service will select a default size. A call may return fewer\nobjects than requested, but if there is a non-empty `page_token`, it\nindicates that more entries are available.",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
},
"parent": {
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path",
"description": "The project and cloud region path. For example,\n`projects/example-project/locations/us-central1`.",
"type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
+ "required": true
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The value returned by the last `ListDeviceRegistriesResponse`; indicates\nthat this is a continuation of a prior `ListDeviceRegistries` call, and\nthat the system should return the next page of data.",
+ "type": "string"
}
},
"scopes": [
@@ -772,43 +1138,11 @@
"https://www.googleapis.com/auth/cloudiot"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries",
+ "id": "cloudiot.projects.locations.registries.list",
"path": "v1/{+parent}/registries",
- "id": "cloudiot.projects.locations.registries.list"
- },
- "setIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:setIamPolicy",
- "id": "cloudiot.projects.locations.registries.setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy."
+ "description": "Lists device registries."
},
"create": {
- "request": {
- "$ref": "DeviceRegistry"
- },
- "description": "Creates a device registry that contains devices.",
"response": {
"$ref": "DeviceRegistry"
},
@@ -816,10 +1150,6 @@
"parent"
],
"httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
"parameters": {
"parent": {
"pattern": "^projects/[^/]+/locations/[^/]+$",
@@ -829,11 +1159,25 @@
"required": true
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries",
"id": "cloudiot.projects.locations.registries.create",
- "path": "v1/{+parent}/registries"
+ "path": "v1/{+parent}/registries",
+ "description": "Creates a device registry that contains devices.",
+ "request": {
+ "$ref": "DeviceRegistry"
+ }
},
- "getIamPolicy": {
+ "setIamPolicy": {
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "cloudiot.projects.locations.registries.setIamPolicy",
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
"httpMethod": "POST",
"parameterOrder": [
"resource"
@@ -843,366 +1187,18 @@
},
"parameters": {
"resource": {
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "id": "cloudiot.projects.locations.registries.getIamPolicy",
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
- "request": {
- "$ref": "GetIamPolicyRequest"
- }
- },
- "patch": {
- "response": {
- "$ref": "DeviceRegistry"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "name": {
- "description": "The resource path name. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
- "location": "path"
- },
- "updateMask": {
- "format": "google-fieldmask",
- "description": "Only updates the `device_registry` fields indicated by this mask.\nThe field mask must not be empty, and it must not contain fields that\nare immutable or only set by the server.\nMutable top-level fields: `event_notification_config`, `mqtt_config`, and\n`state_notification_config`.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}",
- "id": "cloudiot.projects.locations.registries.patch",
- "path": "v1/{+name}",
- "description": "Updates a device registry configuration.",
- "request": {
- "$ref": "DeviceRegistry"
- }
- },
- "get": {
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "response": {
- "$ref": "DeviceRegistry"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "parameters": {
- "name": {
- "description": "The name of the device registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
"location": "path"
}
},
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}",
- "id": "cloudiot.projects.locations.registries.get",
- "path": "v1/{+name}",
- "description": "Gets a device registry configuration."
- }
- },
- "resources": {
- "devices": {
- "methods": {
- "create": {
- "description": "Creates a device in a device registry.",
- "request": {
- "$ref": "Device"
- },
- "response": {
- "$ref": "Device"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "description": "The name of the device registry where this device should be created.\nFor example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices",
- "id": "cloudiot.projects.locations.registries.devices.create",
- "path": "v1/{+parent}/devices"
- },
- "modifyCloudToDeviceConfig": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "DeviceConfig"
- },
- "parameters": {
- "name": {
- "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}:modifyCloudToDeviceConfig",
- "path": "v1/{+name}:modifyCloudToDeviceConfig",
- "id": "cloudiot.projects.locations.registries.devices.modifyCloudToDeviceConfig",
- "description": "Modifies the configuration for the device, which is eventually sent from\nthe Cloud IoT Core servers. Returns the modified configuration version and\nits metadata.",
- "request": {
- "$ref": "ModifyCloudToDeviceConfigRequest"
- }
- },
- "get": {
- "description": "Gets details about a device.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Device"
- },
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
- "location": "path",
- "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}",
- "path": "v1/{+name}",
- "id": "cloudiot.projects.locations.registries.devices.get"
- },
- "patch": {
- "response": {
- "$ref": "Device"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "updateMask": {
- "format": "google-fieldmask",
- "description": "Only updates the `device` fields indicated by this mask.\nThe field mask must not be empty, and it must not contain fields that\nare immutable or only set by the server.\nMutable top-level fields: `credentials`, `enabled_state`, and `metadata`",
- "type": "string",
- "location": "query"
- },
- "name": {
- "description": "The resource path name. For example,\n`projects/p1/locations/us-central1/registries/registry0/devices/dev0` or\n`projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`.\nWhen `name` is populated as a response from the service, it always ends\nin the device numeric ID.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}",
- "id": "cloudiot.projects.locations.registries.devices.patch",
- "path": "v1/{+name}",
- "description": "Updates a device.",
- "request": {
- "$ref": "Device"
- }
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "parameters": {
- "name": {
- "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}",
- "id": "cloudiot.projects.locations.registries.devices.delete",
- "path": "v1/{+name}",
- "description": "Deletes a device."
- },
- "list": {
- "description": "List devices in a device registry.",
- "response": {
- "$ref": "ListDevicesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "description": "The value returned by the last `ListDevicesResponse`; indicates\nthat this is a continuation of a prior `ListDevices` call, and\nthat the system should return the next page of data.",
- "type": "string",
- "location": "query"
- },
- "fieldMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "The fields of the `Device` resource to be returned in the response. The\nfields `id`, and `num_id` are always returned by default, along with any\nother fields specified.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The maximum number of devices to return in the response. If this value\nis zero, the service will select a default size. A call may return fewer\nobjects than requested, but if there is a non-empty `page_token`, it\nindicates that more entries are available.",
- "type": "integer"
- },
- "deviceIds": {
- "description": "A list of device string identifiers. If empty, it will ignore this field.\nFor example, `['device0', 'device12']`. This field cannot hold more than\n10,000 entries.",
- "type": "string",
- "repeated": true,
- "location": "query"
- },
- "parent": {
- "description": "The device registry path. Required. For example,\n`projects/my-project/locations/us-central1/registries/my-registry`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
- "location": "path"
- },
- "deviceNumIds": {
- "format": "uint64",
- "description": "A list of device numerical ids. If empty, it will ignore this field. This\nfield cannot hold more than 10,000 entries.",
- "type": "string",
- "repeated": true,
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices",
- "id": "cloudiot.projects.locations.registries.devices.list",
- "path": "v1/{+parent}/devices"
- }
- },
- "resources": {
- "states": {
- "methods": {
- "list": {
- "id": "cloudiot.projects.locations.registries.devices.states.list",
- "path": "v1/{+name}/states",
- "description": "Lists the last few versions of the device state in descending order (i.e.:\nnewest first).",
- "response": {
- "$ref": "ListDeviceStatesResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
- "location": "path"
- },
- "numStates": {
- "location": "query",
- "format": "int32",
- "description": "The number of states to list. States are listed in descending order of\nupdate time. The maximum number of states retained is 10. If this\nvalue is zero, it will return all the states available.",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}/states"
- }
- }
- },
- "configVersions": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListDeviceConfigVersionsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
- "location": "path"
- },
- "numVersions": {
- "location": "query",
- "format": "int32",
- "description": "The number of versions to list. Versions are listed in decreasing order of\nthe version number. The maximum number of versions retained is 10. If this\nvalue is zero, it will return all the versions available.",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}/configVersions",
- "id": "cloudiot.projects.locations.registries.devices.configVersions.list",
- "path": "v1/{+name}/configVersions",
- "description": "Lists the last few versions of the device configuration in descending\norder (i.e.: newest first)."
- }
- }
- }
- }
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:setIamPolicy"
}
}
}
@@ -1213,21 +1209,21 @@
},
"parameters": {
"quotaUser": {
- "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
"type": "string",
"location": "query"
},
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
"oauth_token": {
"location": "query",
"description": "OAuth 2.0 token for the current user.",
@@ -1239,15 +1235,15 @@
"type": "string"
},
"prettyPrint": {
- "location": "query",
"description": "Returns response with indentations and line breaks.",
"default": "true",
- "type": "boolean"
+ "type": "boolean",
+ "location": "query"
},
"uploadType": {
+ "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
@@ -1268,17 +1264,11 @@
"type": "string"
},
"callback": {
- "location": "query",
"description": "JSONP",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -1286,7 +1276,13 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json"
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string"
},
"access_token": {
"location": "query",
@@ -1300,5 +1296,9 @@
}
},
"version": "v1",
- "baseUrl": "https://cloudiot.googleapis.com/"
+ "baseUrl": "https://cloudiot.googleapis.com/",
+ "servicePath": "",
+ "description": "Registers and manages IoT (Internet of Things) devices that connect to the Google Cloud Platform.\n",
+ "kind": "discovery#restDescription",
+ "basePath": ""
}
diff --git a/cloudiot/v1beta1/cloudiot-api.json b/cloudiot/v1beta1/cloudiot-api.json
index 5fe7369..43ec630 100644
--- a/cloudiot/v1beta1/cloudiot-api.json
+++ b/cloudiot/v1beta1/cloudiot-api.json
@@ -1,11 +1,924 @@
{
+ "batchPath": "batch",
+ "title": "Google Cloud IoT API",
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "resources": {
+ "locations": {
+ "resources": {
+ "registries": {
+ "methods": {
+ "getIamPolicy": {
+ "id": "cloudiot.projects.locations.registries.getIamPolicy",
+ "path": "v1beta1/{+resource}:getIamPolicy",
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ },
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:getIamPolicy"
+ },
+ "patch": {
+ "request": {
+ "$ref": "DeviceRegistry"
+ },
+ "description": "Updates a device registry configuration.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "DeviceRegistry"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "parameters": {
+ "updateMask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Only updates the `device_registry` fields indicated by this mask.\nThe field mask must not be empty, and it must not contain fields that\nare immutable or only set by the server.\nMutable top-level fields: `event_notification_config` and `mqtt_config`",
+ "type": "string"
+ },
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
+ "location": "path",
+ "description": "The resource path name. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}",
+ "path": "v1beta1/{+name}",
+ "id": "cloudiot.projects.locations.registries.patch"
+ },
+ "get": {
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}",
+ "path": "v1beta1/{+name}",
+ "id": "cloudiot.projects.locations.registries.get",
+ "description": "Gets a device registry configuration.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "DeviceRegistry"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the device registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ]
+ },
+ "testIamPermissions": {
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:testIamPermissions",
+ "path": "v1beta1/{+resource}:testIamPermissions",
+ "id": "cloudiot.projects.locations.registries.testIamPermissions"
+ },
+ "delete": {
+ "description": "Deletes a device registry configuration.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the device registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}",
+ "id": "cloudiot.projects.locations.registries.delete",
+ "path": "v1beta1/{+name}"
+ },
+ "list": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "The value returned by the last `ListDeviceRegistriesResponse`; indicates\nthat this is a continuation of a prior `ListDeviceRegistries` call, and\nthat the system should return the next page of data.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "The maximum number of registries to return in the response. If this value\nis zero, the service will select a default size. A call may return fewer\nobjects than requested, but if there is a non-empty `page_token`, it\nindicates that more entries are available.",
+ "type": "integer"
+ },
+ "parent": {
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path",
+ "description": "The project and cloud region path. For example,\n`projects/example-project/locations/us-central1`."
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries",
+ "id": "cloudiot.projects.locations.registries.list",
+ "path": "v1beta1/{+parent}/registries",
+ "description": "Lists device registries.",
+ "response": {
+ "$ref": "ListDeviceRegistriesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET"
+ },
+ "create": {
+ "request": {
+ "$ref": "DeviceRegistry"
+ },
+ "description": "Creates a device registry that contains devices.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "DeviceRegistry"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "description": "The project and cloud region where this device registry must be created.\nFor example, `projects/example-project/locations/us-central1`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries",
+ "path": "v1beta1/{+parent}/registries",
+ "id": "cloudiot.projects.locations.registries.create"
+ },
+ "setIamPolicy": {
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:setIamPolicy",
+ "id": "cloudiot.projects.locations.registries.setIamPolicy",
+ "path": "v1beta1/{+resource}:setIamPolicy",
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ }
+ }
+ },
+ "resources": {
+ "devices": {
+ "methods": {
+ "get": {
+ "description": "Gets details about a device.",
+ "response": {
+ "$ref": "Device"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}",
+ "id": "cloudiot.projects.locations.registries.devices.get",
+ "path": "v1beta1/{+name}"
+ },
+ "patch": {
+ "description": "Updates a device.",
+ "request": {
+ "$ref": "Device"
+ },
+ "response": {
+ "$ref": "Device"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "updateMask": {
+ "type": "string",
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Only updates the `device` fields indicated by this mask.\nThe field mask must not be empty, and it must not contain fields that\nare immutable or only set by the server.\nMutable top-level fields: `credentials` and `enabled_state`"
+ },
+ "name": {
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
+ "location": "path",
+ "description": "The resource path name. For example,\n`projects/p1/locations/us-central1/registries/registry0/devices/dev0` or\n`projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`.\nWhen `name` is populated as a response from the service, it always ends\nin the device numeric ID."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}",
+ "id": "cloudiot.projects.locations.registries.devices.patch",
+ "path": "v1beta1/{+name}"
+ },
+ "setState": {
+ "description": "Sets the state of a device.",
+ "request": {
+ "$ref": "HttpSetDeviceStateRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "name": {
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
+ "location": "path",
+ "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0`."
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}:setState",
+ "path": "v1beta1/{+name}:setState",
+ "id": "cloudiot.projects.locations.registries.devices.setState"
+ },
+ "getConfig": {
+ "description": "Gets the configuration of a device.",
+ "response": {
+ "$ref": "HttpDeviceConfig"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
+ "location": "path",
+ "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0`."
+ },
+ "localVersion": {
+ "format": "int64",
+ "description": "If zero, returns the current device configuration from Cloud IoT Core.\nIf nonzero, specifies the local version of the configuration on the device.\nThe server returns config data only if a higher (newer) version is\navailable from Cloud IoT Core.\nIf this value is higher than the latest version available in Cloud IoT\nCore, returns an `OUT_OF_RANGE` error.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}/config",
+ "id": "cloudiot.projects.locations.registries.devices.getConfig",
+ "path": "v1beta1/{+name}/config"
+ },
+ "delete": {
+ "description": "Deletes a device.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}",
+ "id": "cloudiot.projects.locations.registries.devices.delete",
+ "path": "v1beta1/{+name}"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListDevicesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "The value returned by the last `ListDevicesResponse`; indicates\nthat this is a continuation of a prior `ListDevices` call, and\nthat the system should return the next page of data.",
+ "type": "string"
+ },
+ "fieldMask": {
+ "format": "google-fieldmask",
+ "description": "The fields of the `Device` resource to be returned in the response. The\nfields `id`, and `num_id` are always returned by default, along with any\nother fields specified.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "The maximum number of devices to return in the response. If this value\nis zero, the service will select a default size. A call may return fewer\nobjects than requested, but if there is a non-empty `page_token`, it\nindicates that more entries are available.",
+ "type": "integer"
+ },
+ "deviceIds": {
+ "location": "query",
+ "description": "A list of device string identifiers. If empty, it will ignore this field.\nFor example, `['device0', 'device12']`. This field cannot hold more than\n10,000 entries.",
+ "type": "string",
+ "repeated": true
+ },
+ "parent": {
+ "description": "The device registry path. Required. For example,\n`projects/my-project/locations/us-central1/registries/my-registry`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
+ "location": "path"
+ },
+ "deviceNumIds": {
+ "repeated": true,
+ "location": "query",
+ "format": "uint64",
+ "description": "A list of device numerical ids. If empty, it will ignore this field. This\nfield cannot hold more than 10,000 entries.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices",
+ "path": "v1beta1/{+parent}/devices",
+ "id": "cloudiot.projects.locations.registries.devices.list",
+ "description": "List devices in a device registry."
+ },
+ "create": {
+ "parameters": {
+ "parent": {
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
+ "location": "path",
+ "description": "The name of the device registry where this device should be created.\nFor example,\n`projects/example-project/locations/us-central1/registries/my-registry`."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices",
+ "path": "v1beta1/{+parent}/devices",
+ "id": "cloudiot.projects.locations.registries.devices.create",
+ "description": "Creates a device in a device registry.",
+ "request": {
+ "$ref": "Device"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "Device"
+ }
+ },
+ "modifyCloudToDeviceConfig": {
+ "description": "Modifies the configuration for the device, which is eventually sent from\nthe Cloud IoT servers. Returns the modified configuration version and its\nmeta-data.",
+ "request": {
+ "$ref": "ModifyCloudToDeviceConfigRequest"
+ },
+ "response": {
+ "$ref": "DeviceConfig"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
+ "location": "path",
+ "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}:modifyCloudToDeviceConfig",
+ "id": "cloudiot.projects.locations.registries.devices.modifyCloudToDeviceConfig",
+ "path": "v1beta1/{+name}:modifyCloudToDeviceConfig"
+ },
+ "publishEvent": {
+ "id": "cloudiot.projects.locations.registries.devices.publishEvent",
+ "path": "v1beta1/{+name}:publishEvent",
+ "description": "Publishes a telemetry event for a device.",
+ "request": {
+ "$ref": "HttpPublishEventRequest"
+ },
+ "response": {
+ "$ref": "HttpPublishEventResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
+ "location": "path",
+ "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}:publishEvent"
+ }
+ },
+ "resources": {
+ "configVersions": {
+ "methods": {
+ "list": {
+ "description": "Lists the last few versions of the device configuration in descending\norder (i.e.: newest first).",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListDeviceConfigVersionsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "numVersions": {
+ "location": "query",
+ "format": "int32",
+ "description": "The number of versions to list. Versions are listed in decreasing order of\nthe version number. The maximum number of versions retained is 10. If this\nvalue is zero, it will return all the versions available.",
+ "type": "integer"
+ },
+ "name": {
+ "location": "path",
+ "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}/configVersions",
+ "path": "v1beta1/{+name}/configVersions",
+ "id": "cloudiot.projects.locations.registries.devices.configVersions.list"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
+ "callback": {
+ "type": "string",
+ "location": "query",
+ "description": "JSONP"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "version": "v1beta1",
+ "baseUrl": "https://cloudiot.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Registers and manages IoT (Internet of Things) devices that connect to the Google Cloud Platform.\n",
+ "servicePath": "",
+ "basePath": "",
"id": "cloudiot:v1beta1",
- "revision": "20171003",
"documentationLink": "https://cloud.google.com/iot",
+ "revision": "20171003",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
+ "properties": {
+ "code": {
+ "format": "int32",
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "id": "Status"
+ },
+ "Binding": {
+ "description": "Associates `members` with a `role`.",
+ "type": "object",
+ "properties": {
+ "condition": {
+ "description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently.\nThis field is GOOGLE_INTERNAL.",
+ "$ref": "Expr"
+ },
+ "members": {
+ "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "role": {
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
+ "type": "string"
+ }
+ },
+ "id": "Binding"
+ },
+ "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"
+ }
+ },
+ "id": "Expr",
+ "description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"",
+ "type": "object"
+ },
+ "HttpPublishEventResponse": {
+ "description": "Response for `PublishEvent`.",
+ "type": "object",
+ "properties": {},
+ "id": "HttpPublishEventResponse"
+ },
+ "ModifyCloudToDeviceConfigRequest": {
+ "description": "Request for `ModifyCloudToDeviceConfig`.",
+ "type": "object",
+ "properties": {
+ "data": {
+ "$ref": "DeviceConfigData",
+ "description": "The configuration data for the device."
+ },
+ "versionToUpdate": {
+ "format": "int64",
+ "description": "The version number to update. If this value is zero, it will not check the\nversion number of the server and will always update the current version;\notherwise, this update will fail if the version number found on the server\ndoes not match this version number. This is used to support multiple\nsimultaneous updates without losing data.",
+ "type": "string"
+ }
+ },
+ "id": "ModifyCloudToDeviceConfigRequest"
+ },
+ "GetIamPolicyRequest": {
+ "properties": {},
+ "id": "GetIamPolicyRequest",
+ "description": "Request message for `GetIamPolicy` method.",
+ "type": "object"
+ },
+ "TestIamPermissionsResponse": {
+ "properties": {
+ "permissions": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed."
+ }
+ },
+ "id": "TestIamPermissionsResponse",
+ "description": "Response message for `TestIamPermissions` method.",
+ "type": "object"
+ },
+ "HttpDeviceConfig": {
+ "description": "The device configuration obtained from Cloud IoT Core.",
+ "type": "object",
+ "properties": {
+ "version": {
+ "format": "int64",
+ "description": "The version of the configuration in Cloud IoT Core.",
+ "type": "string"
+ },
+ "binaryData": {
+ "format": "byte",
+ "description": "Data in binary format.",
+ "type": "string"
+ }
+ },
+ "id": "HttpDeviceConfig"
+ },
+ "NotificationConfig": {
+ "id": "NotificationConfig",
+ "description": "Configuration to forward messages such as telemetry events.",
+ "type": "object",
+ "properties": {
+ "pubsubTopicName": {
+ "description": "A Cloud Pub/Sub topic name. For example,\n`projects/myProject/topics/deviceEvents`.",
+ "type": "string"
+ }
+ }
+ },
+ "HttpPublishEventRequest": {
+ "id": "HttpPublishEventRequest",
+ "description": "Request for `PublishEvent`.",
+ "type": "object",
+ "properties": {
+ "subFolder": {
+ "description": "Optional subfolder for the telemetry event. This can be used to classify\ntypes of events, and is included in the Pub/Sub message attributes.",
+ "type": "string"
+ },
+ "binaryData": {
+ "format": "byte",
+ "description": "Payload data in binary format.",
+ "type": "string"
+ }
+ }
+ },
+ "Device": {
+ "description": "The device resource.",
+ "type": "object",
+ "properties": {
+ "lastConfigAckTime": {
+ "format": "google-datetime",
+ "description": "[Output only] The last time a cloud-to-device config version acknowledgment\nwas received from the device.",
+ "type": "string"
+ },
+ "lastErrorStatus": {
+ "description": "[Output only] The error message of the last error, e.g., failed to publish\nto Cloud Pub/Sub. 'last_error_time' is the timestamp of this field. If no\nerrors are present, this will have an empty message (whose status code is\n0 == OK), otherwise this field is expected to have a not-OK status code.",
+ "$ref": "Status"
+ },
+ "numId": {
+ "format": "uint64",
+ "description": "[Output only] A server-defined unique numeric ID for the device. This is a\nmore compact way to identify devices, and it is globally unique.",
+ "type": "string"
+ },
+ "config": {
+ "$ref": "DeviceConfig",
+ "description": "The most recent device configuration, which is eventually sent from the\nCloud IoT Core service to the device. If not present on creation, the\nconfiguration will be initialized with an empty payload and version value\nof `1`. To update this field after creation, use the\n`DeviceManager.ModifyCloudToDeviceConfig` method."
+ },
+ "name": {
+ "type": "string",
+ "description": "The resource path name. For example,\n`projects/p1/locations/us-central1/registries/registry0/devices/dev0` or\n`projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`.\nWhen `name` is populated as a response from the service, it always ends\nin the device numeric ID."
+ },
+ "credentials": {
+ "description": "The credentials used to authenticate this device. To allow credential\nrotation without interruption, multiple device credentials can be bound to\nthis device. No more than 3 credentials can be bound to a single device at\na time.",
+ "items": {
+ "$ref": "DeviceCredential"
+ },
+ "type": "array"
+ },
+ "lastErrorTime": {
+ "format": "google-datetime",
+ "description": "[Output only] The last time an error happened, e.g., failed to publish to\nCloud Pub/Sub. This field is the timestamp of 'last_error_status'.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The user-defined device identifier. The device ID must be unique\nwithin a device registry.",
+ "type": "string"
+ },
+ "enabledState": {
+ "enumDescriptions": [
+ "No enabled state specified. If not specified, defaults to enabled\n(communication to Cloud IoT Core allowed).",
+ "Enables a device. By default, devices are enabled, allowing communication\nfrom the device to Cloud IoT Core. When a device is disabled, it is blocked\nfrom communicating with Cloud IoT Core.",
+ "Disables a device, blocking all communication from it to Cloud IoT Core."
+ ],
+ "enum": [
+ "UNSPECIFIED_ENABLED_STATE",
+ "DEVICE_ENABLED",
+ "DEVICE_DISABLED"
+ ],
+ "description": "If a device is disabled, communication from it will be blocked. Can be used\nto temporarily prevent the device from connecting if, for example, the\nsensor is generating bad data and needs maintenance.",
+ "type": "string"
+ },
+ "lastHeartbeatTime": {
+ "type": "string",
+ "format": "google-datetime",
+ "description": "[Output only] The last time a heartbeat was received. Timestamps are\nperiodically collected and written to storage; they may be stale by a few\nminutes."
+ },
+ "lastEventTime": {
+ "format": "google-datetime",
+ "description": "[Output only] The last time an event was received. Timestamps are\nperiodically collected and written to storage; they may be stale by a few\nminutes.",
+ "type": "string"
+ }
+ },
+ "id": "Device"
+ },
+ "HttpSetDeviceStateRequest": {
+ "id": "HttpSetDeviceStateRequest",
+ "description": "Request for `SetDeviceState`.",
+ "type": "object",
+ "properties": {
+ "state": {
+ "$ref": "HttpDeviceState",
+ "description": "The device state."
+ }
+ }
+ },
"ListDeviceConfigVersionsResponse": {
+ "description": "Response for `ListDeviceConfigVersions`.",
"type": "object",
"properties": {
"deviceConfigs": {
@@ -16,36 +929,35 @@
"type": "array"
}
},
- "id": "ListDeviceConfigVersionsResponse",
- "description": "Response for `ListDeviceConfigVersions`."
+ "id": "ListDeviceConfigVersionsResponse"
},
"SetIamPolicyRequest": {
- "type": "object",
"properties": {
"policy": {
- "$ref": "Policy",
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.",
+ "$ref": "Policy"
},
"updateMask": {
+ "type": "string",
"format": "google-fieldmask",
- "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
- "type": "string"
+ "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM."
}
},
"id": "SetIamPolicyRequest",
- "description": "Request message for `SetIamPolicy` method."
+ "description": "Request message for `SetIamPolicy` method.",
+ "type": "object"
},
"HttpDeviceState": {
+ "id": "HttpDeviceState",
"description": "The device state reported to Cloud IoT Core.",
"type": "object",
"properties": {
"binaryData": {
- "type": "string",
"format": "byte",
- "description": "Data in binary format."
+ "description": "Data in binary format.",
+ "type": "string"
}
- },
- "id": "HttpDeviceState"
+ }
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
@@ -54,23 +966,22 @@
"id": "Empty"
},
"DeviceConfigData": {
+ "description": "The data for a device configuration. Only binary data is currently supported.",
"type": "object",
"properties": {
"binaryData": {
- "type": "string",
"format": "byte",
- "description": "The configuration sent to the device, as bytes."
+ "description": "The configuration sent to the device, as bytes.",
+ "type": "string"
}
},
- "id": "DeviceConfigData",
- "description": "The data for a device configuration. Only binary data is currently supported."
+ "id": "DeviceConfigData"
},
"PublicKeyCredential": {
- "type": "object",
"properties": {
"key": {
- "type": "string",
- "description": "The key data."
+ "description": "The key data.",
+ "type": "string"
},
"format": {
"enum": [
@@ -88,25 +999,14 @@
}
},
"id": "PublicKeyCredential",
- "description": "A public key format and data."
+ "description": "A public key format and data.",
+ "type": "object"
},
"AuditLogConfig": {
+ "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
"type": "object",
"properties": {
- "exemptedMembers": {
- "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
"logType": {
- "enum": [
- "LOG_TYPE_UNSPECIFIED",
- "ADMIN_READ",
- "DATA_WRITE",
- "DATA_READ"
- ],
"description": "The log type that this config enables.",
"type": "string",
"enumDescriptions": [
@@ -114,13 +1014,27 @@
"Admin reads. Example: CloudIAM getIamPolicy",
"Data writes. Example: CloudSQL Users create",
"Data reads. Example: CloudSQL Users list"
+ ],
+ "enum": [
+ "LOG_TYPE_UNSPECIFIED",
+ "ADMIN_READ",
+ "DATA_WRITE",
+ "DATA_READ"
]
+ },
+ "exemptedMembers": {
+ "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
},
- "id": "AuditLogConfig",
- "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging."
+ "id": "AuditLogConfig"
},
"TestIamPermissionsRequest": {
+ "id": "TestIamPermissionsRequest",
+ "description": "Request message for `TestIamPermissions` method.",
"type": "object",
"properties": {
"permissions": {
@@ -130,13 +1044,19 @@
},
"type": "array"
}
- },
- "id": "TestIamPermissionsRequest",
- "description": "Request message for `TestIamPermissions` method."
+ }
},
"Policy": {
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
"type": "object",
"properties": {
+ "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": {
@@ -148,52 +1068,41 @@
"type": "boolean"
},
"etag": {
- "type": "string",
"format": "byte",
- "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."
+ "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.",
+ "type": "string"
},
"version": {
"format": "int32",
"description": "Version of the `Policy`. The default version is 0.",
"type": "integer"
- },
- "auditConfigs": {
- "items": {
- "$ref": "AuditConfig"
- },
- "type": "array",
- "description": "Specifies cloud audit logging configuration for this policy."
}
},
- "id": "Policy",
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam)."
+ "id": "Policy"
},
"ListDeviceRegistriesResponse": {
- "description": "Response for `ListDeviceRegistries`.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "If not empty, indicates that there may be more registries that match the\nrequest; this value should be passed in a new\n`ListDeviceRegistriesRequest`.",
+ "type": "string"
+ },
"deviceRegistries": {
+ "description": "The registries that matched the query.",
"items": {
"$ref": "DeviceRegistry"
},
- "type": "array",
- "description": "The registries that matched the query."
- },
- "nextPageToken": {
- "type": "string",
- "description": "If not empty, indicates that there may be more registries that match the\nrequest; this value should be passed in a new\n`ListDeviceRegistriesRequest`."
+ "type": "array"
}
},
- "id": "ListDeviceRegistriesResponse"
+ "id": "ListDeviceRegistriesResponse",
+ "description": "Response for `ListDeviceRegistries`."
},
"DeviceRegistry": {
+ "id": "DeviceRegistry",
"description": "A container for a group of devices.",
"type": "object",
"properties": {
- "id": {
- "description": "The identifier of this device registry. For example, `myRegistry`.",
- "type": "string"
- },
"mqttConfig": {
"$ref": "MqttConfig",
"description": "The configuration of the MQTT broker associated with this device registry,\nincluding enablement, payload data format type, etc."
@@ -203,31 +1112,59 @@
"type": "string"
},
"eventNotificationConfig": {
- "$ref": "NotificationConfig",
- "description": "Configuration to notify events received from the device."
+ "description": "Configuration to notify events received from the device.",
+ "$ref": "NotificationConfig"
+ },
+ "id": {
+ "description": "The identifier of this device registry. For example, `myRegistry`.",
+ "type": "string"
}
- },
- "id": "DeviceRegistry"
+ }
},
"ListDevicesResponse": {
+ "description": "Response for `ListDevices`.",
"type": "object",
"properties": {
"devices": {
+ "description": "The devices that match the request.",
"items": {
"$ref": "Device"
},
- "type": "array",
- "description": "The devices that match the request."
+ "type": "array"
},
"nextPageToken": {
- "description": "If not empty, indicates that there may be more devices that match the\nrequest; this value should be passed in a new `ListDevicesRequest`.",
- "type": "string"
+ "type": "string",
+ "description": "If not empty, indicates that there may be more devices that match the\nrequest; this value should be passed in a new `ListDevicesRequest`."
}
},
- "id": "ListDevicesResponse",
- "description": "Response for `ListDevices`."
+ "id": "ListDevicesResponse"
+ },
+ "AuditConfig": {
+ "properties": {
+ "service": {
+ "type": "string",
+ "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services."
+ },
+ "auditLogConfigs": {
+ "description": "The configuration for logging of each type of permission.\nNext ID: 4",
+ "items": {
+ "$ref": "AuditLogConfig"
+ },
+ "type": "array"
+ },
+ "exemptedMembers": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "AuditConfig",
+ "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
+ "type": "object"
},
"DeviceCredential": {
+ "description": "A server-stored device credential used for authentication.",
"type": "object",
"properties": {
"expirationTime": {
@@ -240,40 +1177,16 @@
"description": "A public key used to verify the signature of JSON Web Tokens (JWTs)."
}
},
- "id": "DeviceCredential",
- "description": "A server-stored device credential used for authentication."
- },
- "AuditConfig": {
- "type": "object",
- "properties": {
- "service": {
- "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
- "type": "string"
- },
- "auditLogConfigs": {
- "items": {
- "$ref": "AuditLogConfig"
- },
- "type": "array",
- "description": "The configuration for logging of each type of permission.\nNext ID: 4"
- },
- "exemptedMembers": {
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "AuditConfig",
- "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging."
+ "id": "DeviceCredential"
},
"DeviceConfig": {
+ "description": "The device configuration and its metadata. Eventually delivered to devices.",
"type": "object",
"properties": {
"deviceAckTime": {
- "type": "string",
"format": "google-datetime",
- "description": "[Output only] The time when the Cloud IoT Core server received the\nacknowledgment from the device, indicating that the device has received\nthis configuration version. If this field is not present, the device has\nnot yet acknowledged that it received this version. Note that when sending\nthe config to the device, there may have been many config versions on the\nCloud IoT Core service while the device was disconnected; and on\nconnection, only the latest version is sent to the device. Some of the\nversions may never be sent to the device, and therefore are never\nacknowledged. This timestamp is set by the Cloud IoT Core service."
+ "description": "[Output only] The time when the Cloud IoT Core server received the\nacknowledgment from the device, indicating that the device has received\nthis configuration version. If this field is not present, the device has\nnot yet acknowledged that it received this version. Note that when sending\nthe config to the device, there may have been many config versions on the\nCloud IoT Core service while the device was disconnected; and on\nconnection, only the latest version is sent to the device. Some of the\nversions may never be sent to the device, and therefore are never\nacknowledged. This timestamp is set by the Cloud IoT Core service.",
+ "type": "string"
},
"cloudUpdateTime": {
"format": "google-datetime",
@@ -286,12 +1199,11 @@
"type": "string"
},
"data": {
- "$ref": "DeviceConfigData",
- "description": "The device configuration data."
+ "description": "The device configuration data.",
+ "$ref": "DeviceConfigData"
}
},
- "id": "DeviceConfig",
- "description": "The device configuration and its metadata. Eventually delivered to devices."
+ "id": "DeviceConfig"
},
"MqttConfig": {
"description": "The configuration of MQTT for a device registry.",
@@ -313,249 +1225,11 @@
}
},
"id": "MqttConfig"
- },
- "Status": {
- "type": "object",
- "properties": {
- "code": {
- "type": "integer",
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code."
- },
- "message": {
- "type": "string",
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client."
- },
- "details": {
- "items": {
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
- },
- "type": "object"
- },
- "type": "array",
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use."
- }
- },
- "id": "Status",
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons."
- },
- "Binding": {
- "type": "object",
- "properties": {
- "condition": {
- "$ref": "Expr",
- "description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently.\nThis field is GOOGLE_INTERNAL."
- },
- "members": {
- "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "role": {
- "type": "string",
- "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired"
- }
- },
- "id": "Binding",
- "description": "Associates `members` with a `role`."
- },
- "Expr": {
- "description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"",
- "type": "object",
- "properties": {
- "location": {
- "type": "string",
- "description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file."
- },
- "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"
- },
- "description": {
- "type": "string",
- "description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI."
- },
- "expression": {
- "type": "string",
- "description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported."
- }
- },
- "id": "Expr"
- },
- "HttpPublishEventResponse": {
- "description": "Response for `PublishEvent`.",
- "type": "object",
- "properties": {},
- "id": "HttpPublishEventResponse"
- },
- "ModifyCloudToDeviceConfigRequest": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "DeviceConfigData",
- "description": "The configuration data for the device."
- },
- "versionToUpdate": {
- "format": "int64",
- "description": "The version number to update. If this value is zero, it will not check the\nversion number of the server and will always update the current version;\notherwise, this update will fail if the version number found on the server\ndoes not match this version number. This is used to support multiple\nsimultaneous updates without losing data.",
- "type": "string"
- }
- },
- "id": "ModifyCloudToDeviceConfigRequest",
- "description": "Request for `ModifyCloudToDeviceConfig`."
- },
- "GetIamPolicyRequest": {
- "type": "object",
- "properties": {},
- "id": "GetIamPolicyRequest",
- "description": "Request message for `GetIamPolicy` method."
- },
- "TestIamPermissionsResponse": {
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "TestIamPermissionsResponse"
- },
- "HttpDeviceConfig": {
- "type": "object",
- "properties": {
- "version": {
- "format": "int64",
- "description": "The version of the configuration in Cloud IoT Core.",
- "type": "string"
- },
- "binaryData": {
- "type": "string",
- "format": "byte",
- "description": "Data in binary format."
- }
- },
- "id": "HttpDeviceConfig",
- "description": "The device configuration obtained from Cloud IoT Core."
- },
- "NotificationConfig": {
- "type": "object",
- "properties": {
- "pubsubTopicName": {
- "description": "A Cloud Pub/Sub topic name. For example,\n`projects/myProject/topics/deviceEvents`.",
- "type": "string"
- }
- },
- "id": "NotificationConfig",
- "description": "Configuration to forward messages such as telemetry events."
- },
- "HttpPublishEventRequest": {
- "type": "object",
- "properties": {
- "subFolder": {
- "description": "Optional subfolder for the telemetry event. This can be used to classify\ntypes of events, and is included in the Pub/Sub message attributes.",
- "type": "string"
- },
- "binaryData": {
- "type": "string",
- "format": "byte",
- "description": "Payload data in binary format."
- }
- },
- "id": "HttpPublishEventRequest",
- "description": "Request for `PublishEvent`."
- },
- "Device": {
- "type": "object",
- "properties": {
- "config": {
- "$ref": "DeviceConfig",
- "description": "The most recent device configuration, which is eventually sent from the\nCloud IoT Core service to the device. If not present on creation, the\nconfiguration will be initialized with an empty payload and version value\nof `1`. To update this field after creation, use the\n`DeviceManager.ModifyCloudToDeviceConfig` method."
- },
- "name": {
- "type": "string",
- "description": "The resource path name. For example,\n`projects/p1/locations/us-central1/registries/registry0/devices/dev0` or\n`projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`.\nWhen `name` is populated as a response from the service, it always ends\nin the device numeric ID."
- },
- "credentials": {
- "items": {
- "$ref": "DeviceCredential"
- },
- "type": "array",
- "description": "The credentials used to authenticate this device. To allow credential\nrotation without interruption, multiple device credentials can be bound to\nthis device. No more than 3 credentials can be bound to a single device at\na time."
- },
- "lastErrorTime": {
- "format": "google-datetime",
- "description": "[Output only] The last time an error happened, e.g., failed to publish to\nCloud Pub/Sub. This field is the timestamp of 'last_error_status'.",
- "type": "string"
- },
- "enabledState": {
- "enum": [
- "UNSPECIFIED_ENABLED_STATE",
- "DEVICE_ENABLED",
- "DEVICE_DISABLED"
- ],
- "description": "If a device is disabled, communication from it will be blocked. Can be used\nto temporarily prevent the device from connecting if, for example, the\nsensor is generating bad data and needs maintenance.",
- "type": "string",
- "enumDescriptions": [
- "No enabled state specified. If not specified, defaults to enabled\n(communication to Cloud IoT Core allowed).",
- "Enables a device. By default, devices are enabled, allowing communication\nfrom the device to Cloud IoT Core. When a device is disabled, it is blocked\nfrom communicating with Cloud IoT Core.",
- "Disables a device, blocking all communication from it to Cloud IoT Core."
- ]
- },
- "id": {
- "type": "string",
- "description": "The user-defined device identifier. The device ID must be unique\nwithin a device registry."
- },
- "lastHeartbeatTime": {
- "type": "string",
- "format": "google-datetime",
- "description": "[Output only] The last time a heartbeat was received. Timestamps are\nperiodically collected and written to storage; they may be stale by a few\nminutes."
- },
- "lastEventTime": {
- "type": "string",
- "format": "google-datetime",
- "description": "[Output only] The last time an event was received. Timestamps are\nperiodically collected and written to storage; they may be stale by a few\nminutes."
- },
- "lastErrorStatus": {
- "$ref": "Status",
- "description": "[Output only] The error message of the last error, e.g., failed to publish\nto Cloud Pub/Sub. 'last_error_time' is the timestamp of this field. If no\nerrors are present, this will have an empty message (whose status code is\n0 == OK), otherwise this field is expected to have a not-OK status code."
- },
- "lastConfigAckTime": {
- "type": "string",
- "format": "google-datetime",
- "description": "[Output only] The last time a cloud-to-device config version acknowledgment\nwas received from the device."
- },
- "numId": {
- "type": "string",
- "format": "uint64",
- "description": "[Output only] A server-defined unique numeric ID for the device. This is a\nmore compact way to identify devices, and it is globally unique."
- }
- },
- "id": "Device",
- "description": "The device resource."
- },
- "HttpSetDeviceStateRequest": {
- "description": "Request for `SetDeviceState`.",
- "type": "object",
- "properties": {
- "state": {
- "$ref": "HttpDeviceState",
- "description": "The device state."
- }
- },
- "id": "HttpSetDeviceStateRequest"
}
},
"icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"protocol": "rest",
"canonicalName": "Cloud Iot",
@@ -573,679 +1247,5 @@
},
"rootUrl": "https://cloudiot.googleapis.com/",
"ownerDomain": "google.com",
- "name": "cloudiot",
- "batchPath": "batch",
- "title": "Google Cloud IoT API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "locations": {
- "resources": {
- "registries": {
- "methods": {
- "get": {
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}",
- "path": "v1beta1/{+name}",
- "id": "cloudiot.projects.locations.registries.get",
- "description": "Gets a device registry configuration.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "DeviceRegistry"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the device registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$"
- }
- }
- },
- "patch": {
- "request": {
- "$ref": "DeviceRegistry"
- },
- "description": "Updates a device registry configuration.",
- "httpMethod": "PATCH",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "DeviceRegistry"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The resource path name. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$"
- },
- "updateMask": {
- "type": "string",
- "location": "query",
- "format": "google-fieldmask",
- "description": "Only updates the `device_registry` fields indicated by this mask.\nThe field mask must not be empty, and it must not contain fields that\nare immutable or only set by the server.\nMutable top-level fields: `event_notification_config` and `mqtt_config`"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}",
- "path": "v1beta1/{+name}",
- "id": "cloudiot.projects.locations.registries.patch"
- },
- "testIamPermissions": {
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:testIamPermissions",
- "id": "cloudiot.projects.locations.registries.testIamPermissions",
- "path": "v1beta1/{+resource}:testIamPermissions",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.",
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "parameters": {
- "resource": {
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field."
- }
- }
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the device registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}",
- "id": "cloudiot.projects.locations.registries.delete",
- "path": "v1beta1/{+name}",
- "description": "Deletes a device registry configuration."
- },
- "list": {
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries",
- "id": "cloudiot.projects.locations.registries.list",
- "path": "v1beta1/{+parent}/registries",
- "description": "Lists device registries.",
- "response": {
- "$ref": "ListDeviceRegistriesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "parent": {
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path",
- "description": "The project and cloud region path. For example,\n`projects/example-project/locations/us-central1`."
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "The value returned by the last `ListDeviceRegistriesResponse`; indicates\nthat this is a continuation of a prior `ListDeviceRegistries` call, and\nthat the system should return the next page of data."
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "format": "int32",
- "description": "The maximum number of registries to return in the response. If this value\nis zero, the service will select a default size. A call may return fewer\nobjects than requested, but if there is a non-empty `page_token`, it\nindicates that more entries are available."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ]
- },
- "setIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:setIamPolicy",
- "id": "cloudiot.projects.locations.registries.setIamPolicy",
- "path": "v1beta1/{+resource}:setIamPolicy",
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "request": {
- "$ref": "SetIamPolicyRequest"
- }
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "DeviceRegistry"
- },
- "parameters": {
- "parent": {
- "location": "path",
- "description": "The project and cloud region where this device registry must be created.\nFor example, `projects/example-project/locations/us-central1`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries",
- "path": "v1beta1/{+parent}/registries",
- "id": "cloudiot.projects.locations.registries.create",
- "description": "Creates a device registry that contains devices.",
- "request": {
- "$ref": "DeviceRegistry"
- }
- },
- "getIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:getIamPolicy",
- "id": "cloudiot.projects.locations.registries.getIamPolicy",
- "path": "v1beta1/{+resource}:getIamPolicy",
- "request": {
- "$ref": "GetIamPolicyRequest"
- },
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset."
- }
- },
- "resources": {
- "devices": {
- "methods": {
- "getConfig": {
- "httpMethod": "GET",
- "response": {
- "$ref": "HttpDeviceConfig"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "localVersion": {
- "type": "string",
- "location": "query",
- "format": "int64",
- "description": "If zero, returns the current device configuration from Cloud IoT Core.\nIf nonzero, specifies the local version of the configuration on the device.\nThe server returns config data only if a higher (newer) version is\navailable from Cloud IoT Core.\nIf this value is higher than the latest version available in Cloud IoT\nCore, returns an `OUT_OF_RANGE` error."
- },
- "name": {
- "location": "path",
- "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}/config",
- "path": "v1beta1/{+name}/config",
- "id": "cloudiot.projects.locations.registries.devices.getConfig",
- "description": "Gets the configuration of a device."
- },
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "parameters": {
- "name": {
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
- "location": "path",
- "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`."
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}",
- "path": "v1beta1/{+name}",
- "id": "cloudiot.projects.locations.registries.devices.delete",
- "description": "Deletes a device."
- },
- "list": {
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices",
- "id": "cloudiot.projects.locations.registries.devices.list",
- "path": "v1beta1/{+parent}/devices",
- "description": "List devices in a device registry.",
- "response": {
- "$ref": "ListDevicesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "parameters": {
- "deviceNumIds": {
- "type": "string",
- "repeated": true,
- "location": "query",
- "format": "uint64",
- "description": "A list of device numerical ids. If empty, it will ignore this field. This\nfield cannot hold more than 10,000 entries."
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "The value returned by the last `ListDevicesResponse`; indicates\nthat this is a continuation of a prior `ListDevices` call, and\nthat the system should return the next page of data."
- },
- "fieldMask": {
- "type": "string",
- "location": "query",
- "format": "google-fieldmask",
- "description": "The fields of the `Device` resource to be returned in the response. The\nfields `id`, and `num_id` are always returned by default, along with any\nother fields specified."
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "format": "int32",
- "description": "The maximum number of devices to return in the response. If this value\nis zero, the service will select a default size. A call may return fewer\nobjects than requested, but if there is a non-empty `page_token`, it\nindicates that more entries are available."
- },
- "parent": {
- "location": "path",
- "description": "The device registry path. Required. For example,\n`projects/my-project/locations/us-central1/registries/my-registry`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$"
- },
- "deviceIds": {
- "type": "string",
- "repeated": true,
- "location": "query",
- "description": "A list of device string identifiers. If empty, it will ignore this field.\nFor example, `['device0', 'device12']`. This field cannot hold more than\n10,000 entries."
- }
- }
- },
- "create": {
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices",
- "path": "v1beta1/{+parent}/devices",
- "id": "cloudiot.projects.locations.registries.devices.create",
- "description": "Creates a device in a device registry.",
- "request": {
- "$ref": "Device"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "Device"
- },
- "parameters": {
- "parent": {
- "location": "path",
- "description": "The name of the device registry where this device should be created.\nFor example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ]
- },
- "modifyCloudToDeviceConfig": {
- "description": "Modifies the configuration for the device, which is eventually sent from\nthe Cloud IoT servers. Returns the modified configuration version and its\nmeta-data.",
- "request": {
- "$ref": "ModifyCloudToDeviceConfigRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "DeviceConfig"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}:modifyCloudToDeviceConfig",
- "path": "v1beta1/{+name}:modifyCloudToDeviceConfig",
- "id": "cloudiot.projects.locations.registries.devices.modifyCloudToDeviceConfig"
- },
- "publishEvent": {
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}:publishEvent",
- "path": "v1beta1/{+name}:publishEvent",
- "id": "cloudiot.projects.locations.registries.devices.publishEvent",
- "description": "Publishes a telemetry event for a device.",
- "request": {
- "$ref": "HttpPublishEventRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "HttpPublishEventResponse"
- },
- "parameters": {
- "name": {
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
- "location": "path",
- "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0`."
- }
- }
- },
- "get": {
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}",
- "path": "v1beta1/{+name}",
- "id": "cloudiot.projects.locations.registries.devices.get",
- "description": "Gets details about a device.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Device"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$"
- }
- }
- },
- "patch": {
- "response": {
- "$ref": "Device"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "parameters": {
- "updateMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "Only updates the `device` fields indicated by this mask.\nThe field mask must not be empty, and it must not contain fields that\nare immutable or only set by the server.\nMutable top-level fields: `credentials` and `enabled_state`",
- "type": "string"
- },
- "name": {
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
- "location": "path",
- "description": "The resource path name. For example,\n`projects/p1/locations/us-central1/registries/registry0/devices/dev0` or\n`projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`.\nWhen `name` is populated as a response from the service, it always ends\nin the device numeric ID."
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}",
- "id": "cloudiot.projects.locations.registries.devices.patch",
- "path": "v1beta1/{+name}",
- "request": {
- "$ref": "Device"
- },
- "description": "Updates a device."
- },
- "setState": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
- "location": "path",
- "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0`."
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}:setState",
- "id": "cloudiot.projects.locations.registries.devices.setState",
- "path": "v1beta1/{+name}:setState",
- "request": {
- "$ref": "HttpSetDeviceStateRequest"
- },
- "description": "Sets the state of a device."
- }
- },
- "resources": {
- "configVersions": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListDeviceConfigVersionsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "parameters": {
- "numVersions": {
- "type": "integer",
- "location": "query",
- "format": "int32",
- "description": "The number of versions to list. Versions are listed in decreasing order of\nthe version number. The maximum number of versions retained is 10. If this\nvalue is zero, it will return all the versions available."
- },
- "name": {
- "location": "path",
- "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}/configVersions",
- "id": "cloudiot.projects.locations.registries.devices.configVersions.list",
- "path": "v1beta1/{+name}/configVersions",
- "description": "Lists the last few versions of the device configuration in descending\norder (i.e.: newest first)."
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "parameters": {
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "default": "true",
- "type": "boolean",
- "location": "query",
- "description": "Returns response with indentations and line breaks."
- },
- "uploadType": {
- "type": "string",
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "$.xgafv": {
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format."
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "alt": {
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ]
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
- }
- },
- "version": "v1beta1",
- "baseUrl": "https://cloudiot.googleapis.com/",
- "servicePath": "",
- "description": "Registers and manages IoT (Internet of Things) devices that connect to the Google Cloud Platform.\n",
- "kind": "discovery#restDescription",
- "basePath": ""
+ "name": "cloudiot"
}
diff --git a/cloudkms/v1/cloudkms-api.json b/cloudkms/v1/cloudkms-api.json
index afe501d..e2097e3 100644
--- a/cloudkms/v1/cloudkms-api.json
+++ b/cloudkms/v1/cloudkms-api.json
@@ -1,4 +1,5 @@
{
+ "title": "Google Cloud Key Management Service (KMS) API",
"ownerName": "Google",
"resources": {
"projects": {
@@ -7,90 +8,110 @@
"resources": {
"keyRings": {
"methods": {
- "testIamPermissions": {
+ "getIamPolicy": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:getIamPolicy",
+ "id": "cloudkms.projects.locations.keyRings.getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
"response": {
- "$ref": "TestIamPermissionsResponse"
+ "$ref": "Policy"
},
"parameterOrder": [
"resource"
],
- "httpMethod": "POST",
+ "httpMethod": "GET",
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "response": {
+ "$ref": "KeyRing"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the KeyRing to get.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}",
+ "id": "cloudkms.projects.locations.keyRings.get",
+ "path": "v1/{+name}",
+ "description": "Returns metadata for a given KeyRing."
+ },
+ "testIamPermissions": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
"parameters": {
"resource": {
+ "location": "path",
"description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:testIamPermissions",
- "id": "cloudkms.projects.locations.keyRings.testIamPermissions",
"path": "v1/{+resource}:testIamPermissions",
+ "id": "cloudkms.projects.locations.keyRings.testIamPermissions",
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
"request": {
"$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning."
+ }
},
"list": {
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings",
- "path": "v1/{+parent}/keyRings",
"id": "cloudkms.projects.locations.keyRings.list",
+ "path": "v1/{+parent}/keyRings",
"description": "Lists KeyRings.",
- "httpMethod": "GET",
"response": {
"$ref": "ListKeyRingsResponse"
},
"parameterOrder": [
"parent"
],
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"pageToken": {
- "location": "query",
"description": "Optional pagination token, returned earlier via\nListKeyRingsResponse.next_page_token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageSize": {
+ "location": "query",
"format": "int32",
"description": "Optional limit on the number of KeyRings to include in the\nresponse. Further KeyRings can subsequently be obtained by\nincluding the ListKeyRingsResponse.next_page_token in a subsequent\nrequest. If unspecified, the server will pick an appropriate default.",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "location": "path",
- "description": "Required. The resource name of the location associated with the\nKeyRings, in the format `projects/*/locations/*`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+$"
- }
- }
- },
- "create": {
- "request": {
- "$ref": "KeyRing"
- },
- "description": "Create a new KeyRing in a given Project and Location.",
- "response": {
- "$ref": "KeyRing"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "keyRingId": {
- "description": "Required. It must be unique within a location and match the regular\nexpression `[a-zA-Z0-9_-]{1,63}`",
- "type": "string",
- "location": "query"
+ "type": "integer"
},
"parent": {
"description": "Required. The resource name of the location associated with the\nKeyRings, in the format `projects/*/locations/*`.",
@@ -99,12 +120,46 @@
"pattern": "^projects/[^/]+/locations/[^/]+$",
"location": "path"
}
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings",
+ }
+ },
+ "create": {
+ "path": "v1/{+parent}/keyRings",
"id": "cloudkms.projects.locations.keyRings.create",
- "path": "v1/{+parent}/keyRings"
+ "request": {
+ "$ref": "KeyRing"
+ },
+ "description": "Create a new KeyRing in a given Project and Location.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "KeyRing"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required. The resource name of the location associated with the\nKeyRings, in the format `projects/*/locations/*`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path"
+ },
+ "keyRingId": {
+ "description": "Required. It must be unique within a location and match the regular\nexpression `[a-zA-Z0-9_-]{1,63}`",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings"
},
"setIamPolicy": {
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
"httpMethod": "POST",
"parameterOrder": [
"resource"
@@ -112,6 +167,9 @@
"response": {
"$ref": "Policy"
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
@@ -121,183 +179,14 @@
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:setIamPolicy",
"path": "v1/{+resource}:setIamPolicy",
- "id": "cloudkms.projects.locations.keyRings.setIamPolicy",
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "request": {
- "$ref": "SetIamPolicyRequest"
- }
- },
- "getIamPolicy": {
- "httpMethod": "GET",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "id": "cloudkms.projects.locations.keyRings.getIamPolicy",
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset."
- },
- "get": {
- "description": "Returns metadata for a given KeyRing.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "KeyRing"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
- "location": "path",
- "description": "The name of the KeyRing to get.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}",
- "path": "v1/{+name}",
- "id": "cloudkms.projects.locations.keyRings.get"
+ "id": "cloudkms.projects.locations.keyRings.setIamPolicy"
}
},
"resources": {
"cryptoKeys": {
"methods": {
- "updatePrimaryVersion": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "CryptoKey"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path",
- "description": "The resource name of the CryptoKey to update.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:updatePrimaryVersion",
- "path": "v1/{+name}:updatePrimaryVersion",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.updatePrimaryVersion",
- "request": {
- "$ref": "UpdateCryptoKeyPrimaryVersionRequest"
- },
- "description": "Update the version of a CryptoKey that will be used in Encrypt"
- },
- "getIamPolicy": {
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:getIamPolicy"
- },
- "get": {
- "description": "Returns metadata for a given CryptoKey, as well as its\nprimary CryptoKeyVersion.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "CryptoKey"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the CryptoKey to get.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}",
- "path": "v1/{+name}",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.get"
- },
- "patch": {
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.patch",
- "path": "v1/{+name}",
- "description": "Update a CryptoKey.",
- "request": {
- "$ref": "CryptoKey"
- },
- "response": {
- "$ref": "CryptoKey"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "name": {
- "description": "Output only. The resource name for this CryptoKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path"
- },
- "updateMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "Required list of fields to be updated in this request.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}"
- },
"testIamPermissions": {
"response": {
"$ref": "TestIamPermissionsResponse"
@@ -308,11 +197,11 @@
"httpMethod": "POST",
"parameters": {
"resource": {
+ "location": "path",
"description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$"
}
},
"scopes": [
@@ -327,34 +216,38 @@
}
},
"decrypt": {
- "response": {
- "$ref": "DecryptResponse"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"name"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "DecryptResponse"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
+ "location": "path",
"description": "Required. The resource name of the CryptoKey to use for decryption.\nThe server will choose the appropriate version.",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$"
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:decrypt",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.decrypt",
"path": "v1/{+name}:decrypt",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.decrypt",
"request": {
"$ref": "DecryptRequest"
},
"description": "Decrypts data that was protected by Encrypt."
},
"list": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.list",
+ "path": "v1/{+parent}/cryptoKeys",
+ "description": "Lists CryptoKeys.",
"response": {
"$ref": "ListCryptoKeysResponse"
},
@@ -362,49 +255,44 @@
"parent"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Optional limit on the number of CryptoKeys to include in the\nresponse. Further CryptoKeys can subsequently be obtained by\nincluding the ListCryptoKeysResponse.next_page_token in a subsequent\nrequest. If unspecified, the server will pick an appropriate default.",
+ "type": "integer"
+ },
"parent": {
+ "location": "path",
"description": "Required. The resource name of the KeyRing to list, in the format\n`projects/*/locations/*/keyRings/*`.",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$"
},
"pageToken": {
+ "location": "query",
"description": "Optional pagination token, returned earlier via\nListCryptoKeysResponse.next_page_token.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "format": "int32",
- "description": "Optional limit on the number of CryptoKeys to include in the\nresponse. Further CryptoKeys can subsequently be obtained by\nincluding the ListCryptoKeysResponse.next_page_token in a subsequent\nrequest. If unspecified, the server will pick an appropriate default.",
- "type": "integer",
- "location": "query"
+ "type": "string"
}
},
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.list",
- "path": "v1/{+parent}/cryptoKeys",
- "description": "Lists CryptoKeys."
- },
- "encrypt": {
- "request": {
- "$ref": "EncryptRequest"
- },
- "description": "Encrypts data, so that it can only be recovered by a call to Decrypt.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "EncryptResponse"
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "encrypt": {
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.encrypt",
+ "path": "v1/{+name}:encrypt",
+ "description": "Encrypts data, so that it can only be recovered by a call to Decrypt.",
+ "request": {
+ "$ref": "EncryptRequest"
+ },
+ "response": {
+ "$ref": "EncryptResponse"
+ },
+ "parameterOrder": [
+ "name"
],
+ "httpMethod": "POST",
"parameters": {
"name": {
"description": "Required. The resource name of the CryptoKey or CryptoKeyVersion\nto use for encryption.\n\nIf a CryptoKey is specified, the server will use its\nprimary version.",
@@ -414,18 +302,26 @@
"location": "path"
}
},
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:encrypt",
- "path": "v1/{+name}:encrypt",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.encrypt"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:encrypt"
},
"create": {
- "response": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys",
+ "path": "v1/{+parent}/cryptoKeys",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.create",
+ "request": {
"$ref": "CryptoKey"
},
+ "description": "Create a new CryptoKey within a KeyRing.\n\nCryptoKey.purpose is required.",
+ "httpMethod": "POST",
"parameterOrder": [
"parent"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "CryptoKey"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
@@ -442,48 +338,308 @@
"type": "string",
"required": true
}
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.create",
- "path": "v1/{+parent}/cryptoKeys",
- "request": {
- "$ref": "CryptoKey"
- },
- "description": "Create a new CryptoKey within a KeyRing.\n\nCryptoKey.purpose is required."
+ }
},
"setIamPolicy": {
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
"response": {
"$ref": "Policy"
},
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"resource": {
- "location": "path",
"description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
"type": "string",
"required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:setIamPolicy",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy."
+ },
+ "updatePrimaryVersion": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:updatePrimaryVersion",
+ "path": "v1/{+name}:updatePrimaryVersion",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.updatePrimaryVersion",
+ "description": "Update the version of a CryptoKey that will be used in Encrypt",
+ "request": {
+ "$ref": "UpdateCryptoKeyPrimaryVersionRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "CryptoKey"
+ },
+ "parameters": {
+ "name": {
+ "description": "The resource name of the CryptoKey to update.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "getIamPolicy": {
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$"
}
},
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.setIamPolicy"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:getIamPolicy"
+ },
+ "patch": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}",
+ "path": "v1/{+name}",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.patch",
+ "request": {
+ "$ref": "CryptoKey"
+ },
+ "description": "Update a CryptoKey.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "CryptoKey"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "updateMask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Required list of fields to be updated in this request.",
+ "type": "string"
+ },
+ "name": {
+ "location": "path",
+ "description": "Output only. The resource name for this CryptoKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$"
+ }
+ }
+ },
+ "get": {
+ "description": "Returns metadata for a given CryptoKey, as well as its\nprimary CryptoKeyVersion.",
+ "response": {
+ "$ref": "CryptoKey"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the CryptoKey to get.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.get",
+ "path": "v1/{+name}"
}
},
"resources": {
"cryptoKeyVersions": {
"methods": {
+ "patch": {
+ "description": "Update a CryptoKeyVersion's metadata.\n\nstate may be changed between\nENABLED and\nDISABLED using this\nmethod. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to\nmove between other states.",
+ "request": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "response": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "Required list of fields to be updated in this request.",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "description": "Output only. The resource name for this CryptoKeyVersion in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.patch",
+ "path": "v1/{+name}"
+ },
+ "get": {
+ "response": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the CryptoKeyVersion to get.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.get",
+ "path": "v1/{+name}",
+ "description": "Returns metadata for a given CryptoKeyVersion."
+ },
+ "list": {
+ "response": {
+ "$ref": "ListCryptoKeyVersionsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Optional pagination token, returned earlier via\nListCryptoKeyVersionsResponse.next_page_token.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Optional limit on the number of CryptoKeyVersions to\ninclude in the response. Further CryptoKeyVersions can\nsubsequently be obtained by including the\nListCryptoKeyVersionsResponse.next_page_token in a subsequent request.\nIf unspecified, the server will pick an appropriate default.",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "location": "path",
+ "description": "Required. The resource name of the CryptoKey to list, in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.list",
+ "path": "v1/{+parent}/cryptoKeyVersions",
+ "description": "Lists CryptoKeyVersions."
+ },
+ "create": {
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.create",
+ "path": "v1/{+parent}/cryptoKeyVersions",
+ "request": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "description": "Create a new CryptoKeyVersion in a CryptoKey.\n\nThe server will assign the next sequential id. If unset,\nstate will be set to\nENABLED.",
+ "response": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the CryptoKey associated with\nthe CryptoKeyVersions.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions"
+ },
+ "destroy": {
+ "request": {
+ "$ref": "DestroyCryptoKeyVersionRequest"
+ },
+ "description": "Schedule a CryptoKeyVersion for destruction.\n\nUpon calling this method, CryptoKeyVersion.state will be set to\nDESTROY_SCHEDULED\nand destroy_time will be set to a time 24\nhours in the future, at which point the state\nwill be changed to\nDESTROYED, and the key\nmaterial will be irrevocably destroyed.\n\nBefore the destroy_time is reached,\nRestoreCryptoKeyVersion may be called to reverse the process.",
+ "response": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The resource name of the CryptoKeyVersion to destroy.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:destroy",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.destroy",
+ "path": "v1/{+name}:destroy"
+ },
"restore": {
+ "description": "Restore a CryptoKeyVersion in the\nDESTROY_SCHEDULED,\nstate.\n\nUpon restoration of the CryptoKeyVersion, state\nwill be set to DISABLED,\nand destroy_time will be cleared.",
+ "request": {
+ "$ref": "RestoreCryptoKeyVersionRequest"
+ },
"response": {
"$ref": "CryptoKeyVersion"
},
@@ -505,162 +661,7 @@
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:restore",
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.restore",
- "path": "v1/{+name}:restore",
- "description": "Restore a CryptoKeyVersion in the\nDESTROY_SCHEDULED,\nstate.\n\nUpon restoration of the CryptoKeyVersion, state\nwill be set to DISABLED,\nand destroy_time will be cleared.",
- "request": {
- "$ref": "RestoreCryptoKeyVersionRequest"
- }
- },
- "get": {
- "response": {
- "$ref": "CryptoKeyVersion"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the CryptoKeyVersion to get.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.get",
- "path": "v1/{+name}",
- "description": "Returns metadata for a given CryptoKeyVersion."
- },
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "CryptoKeyVersion"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "Output only. The resource name for this CryptoKeyVersion in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$"
- },
- "updateMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "Required list of fields to be updated in this request.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}",
- "path": "v1/{+name}",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.patch",
- "description": "Update a CryptoKeyVersion's metadata.\n\nstate may be changed between\nENABLED and\nDISABLED using this\nmethod. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to\nmove between other states.",
- "request": {
- "$ref": "CryptoKeyVersion"
- }
- },
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "ListCryptoKeyVersionsResponse"
- },
- "parameters": {
- "pageToken": {
- "description": "Optional pagination token, returned earlier via\nListCryptoKeyVersionsResponse.next_page_token.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Optional limit on the number of CryptoKeyVersions to\ninclude in the response. Further CryptoKeyVersions can\nsubsequently be obtained by including the\nListCryptoKeyVersionsResponse.next_page_token in a subsequent request.\nIf unspecified, the server will pick an appropriate default.",
- "type": "integer"
- },
- "parent": {
- "description": "Required. The resource name of the CryptoKey to list, in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions",
- "path": "v1/{+parent}/cryptoKeyVersions",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.list",
- "description": "Lists CryptoKeyVersions."
- },
- "create": {
- "description": "Create a new CryptoKeyVersion in a CryptoKey.\n\nThe server will assign the next sequential id. If unset,\nstate will be set to\nENABLED.",
- "request": {
- "$ref": "CryptoKeyVersion"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "CryptoKeyVersion"
- },
- "parameters": {
- "parent": {
- "location": "path",
- "description": "Required. The name of the CryptoKey associated with\nthe CryptoKeyVersions.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions",
- "path": "v1/{+parent}/cryptoKeyVersions",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.create"
- },
- "destroy": {
- "request": {
- "$ref": "DestroyCryptoKeyVersionRequest"
- },
- "description": "Schedule a CryptoKeyVersion for destruction.\n\nUpon calling this method, CryptoKeyVersion.state will be set to\nDESTROY_SCHEDULED\nand destroy_time will be set to a time 24\nhours in the future, at which point the state\nwill be changed to\nDESTROYED, and the key\nmaterial will be irrevocably destroyed.\n\nBefore the destroy_time is reached,\nRestoreCryptoKeyVersion may be called to reverse the process.",
- "response": {
- "$ref": "CryptoKeyVersion"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The resource name of the CryptoKeyVersion to destroy.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:destroy",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.destroy",
- "path": "v1/{+name}:destroy"
+ "path": "v1/{+name}:restore"
}
}
}
@@ -671,6 +672,10 @@
},
"methods": {
"get": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
+ "id": "cloudkms.projects.locations.get",
+ "path": "v1/{+name}",
+ "description": "Get information about a location.",
"response": {
"$ref": "Location"
},
@@ -689,11 +694,7 @@
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
- "id": "cloudkms.projects.locations.get",
- "path": "v1/{+name}",
- "description": "Get information about a location."
+ ]
},
"list": {
"httpMethod": "GET",
@@ -703,22 +704,19 @@
"response": {
"$ref": "ListLocationsResponse"
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer"
- },
"filter": {
- "location": "query",
"description": "The standard list filter.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageToken": {
- "location": "query",
"description": "The standard list page token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"name": {
"description": "The resource that owns the locations collection, if applicable.",
@@ -726,11 +724,14 @@
"required": true,
"pattern": "^projects/[^/]+$",
"location": "path"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer",
+ "location": "query"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v1/projects/{projectsId}/locations",
"path": "v1/{+name}/locations",
"id": "cloudkms.projects.locations.list",
@@ -742,6 +743,37 @@
}
},
"parameters": {
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
@@ -753,13 +785,18 @@
"default": "true",
"type": "boolean"
},
- "uploadType": {
+ "fields": {
"location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "callback": {
+ "description": "JSONP",
"type": "string",
"location": "query"
},
@@ -776,12 +813,13 @@
],
"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",
@@ -789,334 +827,29 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
+ "default": "json"
}
},
"version": "v1",
"baseUrl": "https://cloudkms.googleapis.com/",
"kind": "discovery#restDescription",
- "servicePath": "",
"description": "Manages encryption for your cloud services the same way you do on-premises. You can generate, use, rotate, and destroy AES256 encryption keys.",
+ "servicePath": "",
"basePath": "",
- "id": "cloudkms:v1",
- "documentationLink": "https://cloud.google.com/kms/",
"revision": "20171003",
+ "documentationLink": "https://cloud.google.com/kms/",
+ "id": "cloudkms:v1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "ListCryptoKeysResponse": {
- "description": "Response message for KeyManagementService.ListCryptoKeys.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "A token to retrieve next page of results. Pass this value in\nListCryptoKeysRequest.page_token to retrieve the next page of results.",
- "type": "string"
- },
- "totalSize": {
- "format": "int32",
- "description": "The total number of CryptoKeys that matched the query.",
- "type": "integer"
- },
- "cryptoKeys": {
- "description": "The list of CryptoKeys.",
- "items": {
- "$ref": "CryptoKey"
- },
- "type": "array"
- }
- },
- "id": "ListCryptoKeysResponse"
- },
- "TestIamPermissionsResponse": {
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "TestIamPermissionsResponse"
- },
- "DestroyCryptoKeyVersionRequest": {
- "properties": {},
- "id": "DestroyCryptoKeyVersionRequest",
- "description": "Request message for KeyManagementService.DestroyCryptoKeyVersion.",
- "type": "object"
- },
- "AuditLogConfig": {
- "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
- "type": "object",
- "properties": {
- "exemptedMembers": {
- "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "logType": {
- "description": "The log type that this config enables.",
- "type": "string",
- "enumDescriptions": [
- "Default case. Should never be this.",
- "Admin reads. Example: CloudIAM getIamPolicy",
- "Data writes. Example: CloudSQL Users create",
- "Data reads. Example: CloudSQL Users list"
- ],
- "enum": [
- "LOG_TYPE_UNSPECIFIED",
- "ADMIN_READ",
- "DATA_WRITE",
- "DATA_READ"
- ]
- }
- },
- "id": "AuditLogConfig"
- },
- "CryptoKey": {
- "properties": {
- "labels": {
- "description": "Labels with user defined metadata.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "createTime": {
- "format": "google-datetime",
- "description": "Output only. The time at which this CryptoKey was created.",
- "type": "string"
- },
- "rotationPeriod": {
- "format": "google-duration",
- "description": "next_rotation_time will be advanced by this period when the service\nautomatically rotates a key. Must be at least one day.\n\nIf rotation_period is set, next_rotation_time must also be set.",
- "type": "string"
- },
- "primary": {
- "description": "Output only. A copy of the \"primary\" CryptoKeyVersion that will be used\nby Encrypt when this CryptoKey is given\nin EncryptRequest.name.\n\nThe CryptoKey's primary version can be updated via\nUpdateCryptoKeyPrimaryVersion.",
- "$ref": "CryptoKeyVersion"
- },
- "name": {
- "description": "Output only. The resource name for this CryptoKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
- "type": "string"
- },
- "purpose": {
- "enum": [
- "CRYPTO_KEY_PURPOSE_UNSPECIFIED",
- "ENCRYPT_DECRYPT"
- ],
- "description": "The immutable purpose of this CryptoKey. Currently, the only acceptable\npurpose is ENCRYPT_DECRYPT.",
- "type": "string",
- "enumDescriptions": [
- "Not specified.",
- "CryptoKeys with this purpose may be used with\nEncrypt and\nDecrypt."
- ]
- },
- "nextRotationTime": {
- "format": "google-datetime",
- "description": "At next_rotation_time, the Key Management Service will automatically:\n\n1. Create a new version of this CryptoKey.\n2. Mark the new version as primary.\n\nKey rotations performed manually via\nCreateCryptoKeyVersion and\nUpdateCryptoKeyPrimaryVersion\ndo not affect next_rotation_time.",
- "type": "string"
- }
- },
- "id": "CryptoKey",
- "description": "A CryptoKey represents a logical key that can be used for cryptographic\noperations.\n\nA CryptoKey is made up of one or more versions, which\nrepresent the actual key material used in cryptographic operations.",
- "type": "object"
- },
- "DecryptResponse": {
- "properties": {
- "plaintext": {
- "format": "byte",
- "description": "The decrypted data originally supplied in EncryptRequest.plaintext.",
- "type": "string"
- }
- },
- "id": "DecryptResponse",
- "description": "Response message for KeyManagementService.Decrypt.",
- "type": "object"
- },
- "TestIamPermissionsRequest": {
- "properties": {
- "permissions": {
- "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "TestIamPermissionsRequest",
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object"
- },
- "EncryptResponse": {
- "description": "Response message for KeyManagementService.Encrypt.",
- "type": "object",
- "properties": {
- "ciphertext": {
- "format": "byte",
- "description": "The encrypted data.",
- "type": "string"
- },
- "name": {
- "description": "The resource name of the CryptoKeyVersion used in encryption.",
- "type": "string"
- }
- },
- "id": "EncryptResponse"
- },
- "KeyRing": {
- "description": "A KeyRing is a toplevel logical grouping of CryptoKeys.",
- "type": "object",
- "properties": {
- "createTime": {
- "format": "google-datetime",
- "description": "Output only. The time at which this KeyRing was created.",
- "type": "string"
- },
- "name": {
- "description": "Output only. The resource name for the KeyRing in the format\n`projects/*/locations/*/keyRings/*`.",
- "type": "string"
- }
- },
- "id": "KeyRing"
- },
- "ListLocationsResponse": {
- "properties": {
- "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"
- }
- },
- "id": "ListLocationsResponse",
- "description": "The response message for Locations.ListLocations.",
- "type": "object"
- },
- "Policy": {
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
- "type": "object",
- "properties": {
- "etag": {
- "format": "byte",
- "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.",
- "type": "string"
- },
- "version": {
- "format": "int32",
- "description": "Version of the `Policy`. The default version is 0.",
- "type": "integer"
- },
- "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"
- },
- "iamOwned": {
- "type": "boolean"
- }
- },
- "id": "Policy"
- },
- "UpdateCryptoKeyPrimaryVersionRequest": {
- "description": "Request message for KeyManagementService.UpdateCryptoKeyPrimaryVersion.",
- "type": "object",
- "properties": {
- "cryptoKeyVersionId": {
- "description": "The id of the child CryptoKeyVersion to use as primary.",
- "type": "string"
- }
- },
- "id": "UpdateCryptoKeyPrimaryVersionRequest"
- },
- "RestoreCryptoKeyVersionRequest": {
- "properties": {},
- "id": "RestoreCryptoKeyVersionRequest",
- "description": "Request message for KeyManagementService.RestoreCryptoKeyVersion.",
- "type": "object"
- },
- "ListKeyRingsResponse": {
- "description": "Response message for KeyManagementService.ListKeyRings.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "A token to retrieve next page of results. Pass this value in\nListKeyRingsRequest.page_token to retrieve the next page of results.",
- "type": "string"
- },
- "totalSize": {
- "format": "int32",
- "description": "The total number of KeyRings that matched the query.",
- "type": "integer"
- },
- "keyRings": {
- "description": "The list of KeyRings.",
- "items": {
- "$ref": "KeyRing"
- },
- "type": "array"
- }
- },
- "id": "ListKeyRingsResponse"
- },
"AuditConfig": {
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
"type": "object",
"properties": {
+ "service": {
+ "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
+ "type": "string"
+ },
"auditLogConfigs": {
"description": "The configuration for logging of each type of permission.\nNext ID: 4",
"items": {
@@ -1129,10 +862,6 @@
"type": "string"
},
"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"
}
},
"id": "AuditConfig"
@@ -1157,13 +886,6 @@
"type": "string"
},
"state": {
- "enum": [
- "CRYPTO_KEY_VERSION_STATE_UNSPECIFIED",
- "ENABLED",
- "DISABLED",
- "DESTROYED",
- "DESTROY_SCHEDULED"
- ],
"description": "The current state of the CryptoKeyVersion.",
"type": "string",
"enumDescriptions": [
@@ -1172,6 +894,13 @@
"This version may not be used, but the key material is still available,\nand the version can be placed back into the ENABLED state.",
"This version is destroyed, and the key material is no longer stored.\nA version may not leave this state once entered.",
"This version is scheduled for destruction, and will be destroyed soon.\nCall\nRestoreCryptoKeyVersion\nto put it back into the DISABLED state."
+ ],
+ "enum": [
+ "CRYPTO_KEY_VERSION_STATE_UNSPECIFIED",
+ "ENABLED",
+ "DISABLED",
+ "DESTROYED",
+ "DESTROY_SCHEDULED"
]
},
"name": {
@@ -1198,8 +927,6 @@
"id": "SetIamPolicyRequest"
},
"DecryptRequest": {
- "description": "Request message for KeyManagementService.Decrypt.",
- "type": "object",
"properties": {
"additionalAuthenticatedData": {
"format": "byte",
@@ -1212,7 +939,9 @@
"type": "string"
}
},
- "id": "DecryptRequest"
+ "id": "DecryptRequest",
+ "description": "Request message for KeyManagementService.Decrypt.",
+ "type": "object"
},
"Binding": {
"description": "Associates `members` with a `role`.",
@@ -1237,15 +966,9 @@
"id": "Binding"
},
"Expr": {
+ "description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"",
+ "type": "object",
"properties": {
- "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"
- },
"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"
@@ -1253,15 +976,19 @@
"expression": {
"description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
"type": "string"
+ },
+ "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"
}
},
- "id": "Expr",
- "description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"",
- "type": "object"
+ "id": "Expr"
},
"EncryptRequest": {
- "description": "Request message for KeyManagementService.Encrypt.",
- "type": "object",
"properties": {
"additionalAuthenticatedData": {
"format": "byte",
@@ -1274,9 +1001,13 @@
"type": "string"
}
},
- "id": "EncryptRequest"
+ "id": "EncryptRequest",
+ "description": "Request message for KeyManagementService.Encrypt.",
+ "type": "object"
},
"ListCryptoKeyVersionsResponse": {
+ "description": "Response message for KeyManagementService.ListCryptoKeyVersions.",
+ "type": "object",
"properties": {
"cryptoKeyVersions": {
"description": "The list of CryptoKeyVersions.",
@@ -1295,14 +1026,17 @@
"type": "integer"
}
},
- "id": "ListCryptoKeyVersionsResponse",
- "description": "Response message for KeyManagementService.ListCryptoKeyVersions.",
- "type": "object"
+ "id": "ListCryptoKeyVersionsResponse"
},
"Location": {
- "description": "A resource that represents Google Cloud Platform location.",
- "type": "object",
"properties": {
+ "labels": {
+ "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
"name": {
"description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
"type": "string"
@@ -1312,29 +1046,296 @@
"type": "string"
},
"metadata": {
- "description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
- "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- }
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
},
- "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
+ "description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
"type": "object"
}
},
- "id": "Location"
+ "id": "Location",
+ "description": "A resource that represents Google Cloud Platform location.",
+ "type": "object"
+ },
+ "ListCryptoKeysResponse": {
+ "description": "Response message for KeyManagementService.ListCryptoKeys.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "A token to retrieve next page of results. Pass this value in\nListCryptoKeysRequest.page_token to retrieve the next page of results.",
+ "type": "string"
+ },
+ "totalSize": {
+ "format": "int32",
+ "description": "The total number of CryptoKeys that matched the query.",
+ "type": "integer"
+ },
+ "cryptoKeys": {
+ "description": "The list of CryptoKeys.",
+ "items": {
+ "$ref": "CryptoKey"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListCryptoKeysResponse"
+ },
+ "TestIamPermissionsResponse": {
+ "properties": {
+ "permissions": {
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "TestIamPermissionsResponse",
+ "description": "Response message for `TestIamPermissions` method.",
+ "type": "object"
+ },
+ "DestroyCryptoKeyVersionRequest": {
+ "description": "Request message for KeyManagementService.DestroyCryptoKeyVersion.",
+ "type": "object",
+ "properties": {},
+ "id": "DestroyCryptoKeyVersionRequest"
+ },
+ "AuditLogConfig": {
+ "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
+ "type": "object",
+ "properties": {
+ "logType": {
+ "enumDescriptions": [
+ "Default case. Should never be this.",
+ "Admin reads. Example: CloudIAM getIamPolicy",
+ "Data writes. Example: CloudSQL Users create",
+ "Data reads. Example: CloudSQL Users list"
+ ],
+ "enum": [
+ "LOG_TYPE_UNSPECIFIED",
+ "ADMIN_READ",
+ "DATA_WRITE",
+ "DATA_READ"
+ ],
+ "description": "The log type that this config enables.",
+ "type": "string"
+ },
+ "exemptedMembers": {
+ "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "AuditLogConfig"
+ },
+ "CryptoKey": {
+ "description": "A CryptoKey represents a logical key that can be used for cryptographic\noperations.\n\nA CryptoKey is made up of one or more versions, which\nrepresent the actual key material used in cryptographic operations.",
+ "type": "object",
+ "properties": {
+ "purpose": {
+ "enumDescriptions": [
+ "Not specified.",
+ "CryptoKeys with this purpose may be used with\nEncrypt and\nDecrypt."
+ ],
+ "enum": [
+ "CRYPTO_KEY_PURPOSE_UNSPECIFIED",
+ "ENCRYPT_DECRYPT"
+ ],
+ "description": "The immutable purpose of this CryptoKey. Currently, the only acceptable\npurpose is ENCRYPT_DECRYPT.",
+ "type": "string"
+ },
+ "nextRotationTime": {
+ "format": "google-datetime",
+ "description": "At next_rotation_time, the Key Management Service will automatically:\n\n1. Create a new version of this CryptoKey.\n2. Mark the new version as primary.\n\nKey rotations performed manually via\nCreateCryptoKeyVersion and\nUpdateCryptoKeyPrimaryVersion\ndo not affect next_rotation_time.",
+ "type": "string"
+ },
+ "labels": {
+ "description": "Labels with user defined metadata.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "createTime": {
+ "format": "google-datetime",
+ "description": "Output only. The time at which this CryptoKey was created.",
+ "type": "string"
+ },
+ "rotationPeriod": {
+ "format": "google-duration",
+ "description": "next_rotation_time will be advanced by this period when the service\nautomatically rotates a key. Must be at least one day.\n\nIf rotation_period is set, next_rotation_time must also be set.",
+ "type": "string"
+ },
+ "primary": {
+ "description": "Output only. A copy of the \"primary\" CryptoKeyVersion that will be used\nby Encrypt when this CryptoKey is given\nin EncryptRequest.name.\n\nThe CryptoKey's primary version can be updated via\nUpdateCryptoKeyPrimaryVersion.",
+ "$ref": "CryptoKeyVersion"
+ },
+ "name": {
+ "description": "Output only. The resource name for this CryptoKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
+ "type": "string"
+ }
+ },
+ "id": "CryptoKey"
+ },
+ "DecryptResponse": {
+ "description": "Response message for KeyManagementService.Decrypt.",
+ "type": "object",
+ "properties": {
+ "plaintext": {
+ "format": "byte",
+ "description": "The decrypted data originally supplied in EncryptRequest.plaintext.",
+ "type": "string"
+ }
+ },
+ "id": "DecryptResponse"
+ },
+ "TestIamPermissionsRequest": {
+ "description": "Request message for `TestIamPermissions` method.",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "TestIamPermissionsRequest"
+ },
+ "Policy": {
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
+ "type": "object",
+ "properties": {
+ "auditConfigs": {
+ "description": "Specifies cloud audit logging configuration for this policy.",
+ "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"
+ },
+ "iamOwned": {
+ "type": "boolean"
+ },
+ "etag": {
+ "format": "byte",
+ "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.",
+ "type": "string"
+ },
+ "version": {
+ "format": "int32",
+ "description": "Version of the `Policy`. The default version is 0.",
+ "type": "integer"
+ }
+ },
+ "id": "Policy"
+ },
+ "ListLocationsResponse": {
+ "description": "The response message for Locations.ListLocations.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
+ "locations": {
+ "description": "A list of locations that matches the specified filter in the request.",
+ "items": {
+ "$ref": "Location"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListLocationsResponse"
+ },
+ "KeyRing": {
+ "description": "A KeyRing is a toplevel logical grouping of CryptoKeys.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Output only. The resource name for the KeyRing in the format\n`projects/*/locations/*/keyRings/*`.",
+ "type": "string"
+ },
+ "createTime": {
+ "format": "google-datetime",
+ "description": "Output only. The time at which this KeyRing was created.",
+ "type": "string"
+ }
+ },
+ "id": "KeyRing"
+ },
+ "EncryptResponse": {
+ "description": "Response message for KeyManagementService.Encrypt.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The resource name of the CryptoKeyVersion used in encryption.",
+ "type": "string"
+ },
+ "ciphertext": {
+ "format": "byte",
+ "description": "The encrypted data.",
+ "type": "string"
+ }
+ },
+ "id": "EncryptResponse"
+ },
+ "RestoreCryptoKeyVersionRequest": {
+ "properties": {},
+ "id": "RestoreCryptoKeyVersionRequest",
+ "description": "Request message for KeyManagementService.RestoreCryptoKeyVersion.",
+ "type": "object"
+ },
+ "UpdateCryptoKeyPrimaryVersionRequest": {
+ "description": "Request message for KeyManagementService.UpdateCryptoKeyPrimaryVersion.",
+ "type": "object",
+ "properties": {
+ "cryptoKeyVersionId": {
+ "description": "The id of the child CryptoKeyVersion to use as primary.",
+ "type": "string"
+ }
+ },
+ "id": "UpdateCryptoKeyPrimaryVersionRequest"
+ },
+ "ListKeyRingsResponse": {
+ "description": "Response message for KeyManagementService.ListKeyRings.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "A token to retrieve next page of results. Pass this value in\nListKeyRingsRequest.page_token to retrieve the next page of results.",
+ "type": "string"
+ },
+ "totalSize": {
+ "format": "int32",
+ "description": "The total number of KeyRings that matched the query.",
+ "type": "integer"
+ },
+ "keyRings": {
+ "description": "The list of KeyRings.",
+ "items": {
+ "$ref": "KeyRing"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListKeyRingsResponse"
}
},
- "protocol": "rest",
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
+ "protocol": "rest",
"canonicalName": "Cloud KMS",
"auth": {
"oauth2": {
@@ -1348,6 +1349,5 @@
"rootUrl": "https://cloudkms.googleapis.com/",
"ownerDomain": "google.com",
"name": "cloudkms",
- "batchPath": "batch",
- "title": "Google Cloud Key Management Service (KMS) API"
+ "batchPath": "batch"
}
diff --git a/cloudresourcemanager/v1/cloudresourcemanager-api.json b/cloudresourcemanager/v1/cloudresourcemanager-api.json
index 431564f..c6841c2 100644
--- a/cloudresourcemanager/v1/cloudresourcemanager-api.json
+++ b/cloudresourcemanager/v1/cloudresourcemanager-api.json
@@ -1,696 +1,1168 @@
{
+ "fullyEncodeReservedExpansion": true,
+ "title": "Google Cloud Resource Manager API",
+ "ownerName": "Google",
+ "resources": {
+ "organizations": {
+ "methods": {
+ "getEffectiveOrgPolicy": {
+ "flatPath": "v1/organizations/{organizationsId}:getEffectiveOrgPolicy",
+ "path": "v1/{+resource}:getEffectiveOrgPolicy",
+ "id": "cloudresourcemanager.organizations.getEffectiveOrgPolicy",
+ "description": "Gets the effective `Policy` on a resource. This is the result of merging\n`Policies` in the resource hierarchy. The returned `Policy` will not have\nan `etag`set because it is a computed `Policy` across multiple resources.",
+ "request": {
+ "$ref": "GetEffectiveOrgPolicyRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "OrgPolicy"
+ },
+ "parameters": {
+ "resource": {
+ "description": "The name of the resource to start computing the effective `Policy`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "get": {
+ "description": "Fetches an Organization resource identified by the specified resource name.",
+ "response": {
+ "$ref": "Organization"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^organizations/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the Organization to fetch, e.g. \"organizations/1234\".",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/organizations/{organizationsId}",
+ "id": "cloudresourcemanager.organizations.get",
+ "path": "v1/{+name}"
+ },
+ "testIamPermissions": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+$"
+ }
+ },
+ "flatPath": "v1/organizations/{organizationsId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "cloudresourcemanager.organizations.testIamPermissions",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified Organization.\nThe `resource` field should be the organization's resource name,\ne.g. \"organizations/123\".\n\nThere are no permissions required for making this API call."
+ },
+ "clearOrgPolicy": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "Name of the resource for the `Policy` to clear.",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/organizations/{organizationsId}:clearOrgPolicy",
+ "id": "cloudresourcemanager.organizations.clearOrgPolicy",
+ "path": "v1/{+resource}:clearOrgPolicy",
+ "description": "Clears a `Policy` from a resource.",
+ "request": {
+ "$ref": "ClearOrgPolicyRequest"
+ }
+ },
+ "setOrgPolicy": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "OrgPolicy"
+ },
+ "parameters": {
+ "resource": {
+ "description": "Resource name of the resource to attach the `Policy`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/organizations/{organizationsId}:setOrgPolicy",
+ "path": "v1/{+resource}:setOrgPolicy",
+ "id": "cloudresourcemanager.organizations.setOrgPolicy",
+ "description": "Updates the specified `Policy` on the resource. Creates a new `Policy` for\nthat `Constraint` on the resource if one does not exist.\n\nNot supplying an `etag` on the request `Policy` results in an unconditional\nwrite of the `Policy`.",
+ "request": {
+ "$ref": "SetOrgPolicyRequest"
+ }
+ },
+ "setIamPolicy": {
+ "description": "Sets the access control policy on an Organization resource. Replaces any\nexisting policy. The `resource` field should be the organization's resource\nname, e.g. \"organizations/123\".\n\nAuthorization requires the Google IAM permission\n`resourcemanager.organizations.setIamPolicy` on the specified organization",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/organizations/{organizationsId}:setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "cloudresourcemanager.organizations.setIamPolicy"
+ },
+ "listOrgPolicies": {
+ "flatPath": "v1/organizations/{organizationsId}:listOrgPolicies",
+ "id": "cloudresourcemanager.organizations.listOrgPolicies",
+ "path": "v1/{+resource}:listOrgPolicies",
+ "description": "Lists all the `Policies` set for a particular resource.",
+ "request": {
+ "$ref": "ListOrgPoliciesRequest"
+ },
+ "response": {
+ "$ref": "ListOrgPoliciesResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "description": "Name of the resource to list Policies for.",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "listAvailableOrgPolicyConstraints": {
+ "request": {
+ "$ref": "ListAvailableOrgPolicyConstraintsRequest"
+ },
+ "description": "Lists `Constraints` that could be applied on the specified resource.",
+ "response": {
+ "$ref": "ListAvailableOrgPolicyConstraintsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "Name of the resource to list `Constraints` for.",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+$"
+ }
+ },
+ "flatPath": "v1/organizations/{organizationsId}:listAvailableOrgPolicyConstraints",
+ "id": "cloudresourcemanager.organizations.listAvailableOrgPolicyConstraints",
+ "path": "v1/{+resource}:listAvailableOrgPolicyConstraints"
+ },
+ "getIamPolicy": {
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/organizations/{organizationsId}:getIamPolicy",
+ "id": "cloudresourcemanager.organizations.getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "description": "Gets the access control policy for an Organization resource. May be empty\nif no such policy or resource exists. The `resource` field should be the\norganization's resource name, e.g. \"organizations/123\".\n\nAuthorization requires the Google IAM permission\n`resourcemanager.organizations.getIamPolicy` on the specified organization",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ }
+ },
+ "search": {
+ "request": {
+ "$ref": "SearchOrganizationsRequest"
+ },
+ "description": "Searches Organization resources that are visible to the user and satisfy\nthe specified filter. This method returns Organizations in an unspecified\norder. New Organizations do not necessarily appear at the end of the\nresults.\n\nSearch will only return organizations on which the user has the permission\n`resourcemanager.organizations.get`",
+ "response": {
+ "$ref": "SearchOrganizationsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {},
+ "flatPath": "v1/organizations:search",
+ "id": "cloudresourcemanager.organizations.search",
+ "path": "v1/organizations:search"
+ },
+ "getOrgPolicy": {
+ "response": {
+ "$ref": "OrgPolicy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "Name of the resource the `Policy` is set on.",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/organizations/{organizationsId}:getOrgPolicy",
+ "id": "cloudresourcemanager.organizations.getOrgPolicy",
+ "path": "v1/{+resource}:getOrgPolicy",
+ "request": {
+ "$ref": "GetOrgPolicyRequest"
+ },
+ "description": "Gets a `Policy` on a resource.\n\nIf no `Policy` is set on the resource, a `Policy` is returned with default\nvalues including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The\n`etag` value can be used with `SetOrgPolicy()` to create or update a\n`Policy` during read-modify-write."
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "get": {
+ "flatPath": "v1/operations/{operationsId}",
+ "path": "v1/{+name}",
+ "id": "cloudresourcemanager.operations.get",
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "type": "string",
+ "required": true,
+ "pattern": "^operations/.+$",
+ "location": "path",
+ "description": "The name of the operation resource."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ }
+ }
+ },
+ "liens": {
+ "methods": {
+ "delete": {
+ "description": "Delete a Lien by `name`.\n\nCallers of this method will require permission on the `parent` resource.\nFor example, a Lien with a `parent` of `projects/1234` requires permission\n`resourcemanager.projects.updateLiens`.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^liens/.+$",
+ "location": "path",
+ "description": "The name/identifier of the Lien to delete.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/liens/{liensId}",
+ "id": "cloudresourcemanager.liens.delete",
+ "path": "v1/{+name}"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListLiensResponse"
+ },
+ "parameterOrder": [],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "The `next_page_token` value returned from a previous List request, if any.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "The maximum number of items to return. This is a suggestion for the server.",
+ "type": "integer"
+ },
+ "parent": {
+ "description": "The name of the resource to list all attached Liens.\nFor example, `projects/1234`.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/liens",
+ "path": "v1/liens",
+ "id": "cloudresourcemanager.liens.list",
+ "description": "List all Liens applied to the `parent` resource.\n\nCallers of this method will require permission on the `parent` resource.\nFor example, a Lien with a `parent` of `projects/1234` requires permission\n`resourcemanager.projects.get`."
+ },
+ "create": {
+ "id": "cloudresourcemanager.liens.create",
+ "path": "v1/liens",
+ "request": {
+ "$ref": "Lien"
+ },
+ "description": "Create a Lien which applies to the resource denoted by the `parent` field.\n\nCallers of this method will require permission on the `parent` resource.\nFor example, applying to `projects/1234` requires permission\n`resourcemanager.projects.updateLiens`.\n\nNOTE: Some resources may limit the number of Liens which may be applied.",
+ "response": {
+ "$ref": "Lien"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {},
+ "flatPath": "v1/liens"
+ }
+ }
+ },
+ "folders": {
+ "methods": {
+ "listAvailableOrgPolicyConstraints": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "ListAvailableOrgPolicyConstraintsResponse"
+ },
+ "parameters": {
+ "resource": {
+ "type": "string",
+ "required": true,
+ "pattern": "^folders/[^/]+$",
+ "location": "path",
+ "description": "Name of the resource to list `Constraints` for."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/folders/{foldersId}:listAvailableOrgPolicyConstraints",
+ "path": "v1/{+resource}:listAvailableOrgPolicyConstraints",
+ "id": "cloudresourcemanager.folders.listAvailableOrgPolicyConstraints",
+ "description": "Lists `Constraints` that could be applied on the specified resource.",
+ "request": {
+ "$ref": "ListAvailableOrgPolicyConstraintsRequest"
+ }
+ },
+ "listOrgPolicies": {
+ "response": {
+ "$ref": "ListOrgPoliciesResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "description": "Name of the resource to list Policies for.",
+ "type": "string",
+ "required": true,
+ "pattern": "^folders/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/folders/{foldersId}:listOrgPolicies",
+ "id": "cloudresourcemanager.folders.listOrgPolicies",
+ "path": "v1/{+resource}:listOrgPolicies",
+ "description": "Lists all the `Policies` set for a particular resource.",
+ "request": {
+ "$ref": "ListOrgPoliciesRequest"
+ }
+ },
+ "getOrgPolicy": {
+ "path": "v1/{+resource}:getOrgPolicy",
+ "id": "cloudresourcemanager.folders.getOrgPolicy",
+ "description": "Gets a `Policy` on a resource.\n\nIf no `Policy` is set on the resource, a `Policy` is returned with default\nvalues including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The\n`etag` value can be used with `SetOrgPolicy()` to create or update a\n`Policy` during read-modify-write.",
+ "request": {
+ "$ref": "GetOrgPolicyRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "OrgPolicy"
+ },
+ "parameters": {
+ "resource": {
+ "description": "Name of the resource the `Policy` is set on.",
+ "type": "string",
+ "required": true,
+ "pattern": "^folders/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/folders/{foldersId}:getOrgPolicy"
+ },
+ "getEffectiveOrgPolicy": {
+ "flatPath": "v1/folders/{foldersId}:getEffectiveOrgPolicy",
+ "id": "cloudresourcemanager.folders.getEffectiveOrgPolicy",
+ "path": "v1/{+resource}:getEffectiveOrgPolicy",
+ "request": {
+ "$ref": "GetEffectiveOrgPolicyRequest"
+ },
+ "description": "Gets the effective `Policy` on a resource. This is the result of merging\n`Policies` in the resource hierarchy. The returned `Policy` will not have\nan `etag`set because it is a computed `Policy` across multiple resources.",
+ "response": {
+ "$ref": "OrgPolicy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "The name of the resource to start computing the effective `Policy`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^folders/[^/]+$"
+ }
+ }
+ },
+ "clearOrgPolicy": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "pattern": "^folders/[^/]+$",
+ "location": "path",
+ "description": "Name of the resource for the `Policy` to clear.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/folders/{foldersId}:clearOrgPolicy",
+ "path": "v1/{+resource}:clearOrgPolicy",
+ "id": "cloudresourcemanager.folders.clearOrgPolicy",
+ "request": {
+ "$ref": "ClearOrgPolicyRequest"
+ },
+ "description": "Clears a `Policy` from a resource."
+ },
+ "setOrgPolicy": {
+ "response": {
+ "$ref": "OrgPolicy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "Resource name of the resource to attach the `Policy`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^folders/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/folders/{foldersId}:setOrgPolicy",
+ "id": "cloudresourcemanager.folders.setOrgPolicy",
+ "path": "v1/{+resource}:setOrgPolicy",
+ "request": {
+ "$ref": "SetOrgPolicyRequest"
+ },
+ "description": "Updates the specified `Policy` on the resource. Creates a new `Policy` for\nthat `Constraint` on the resource if one does not exist.\n\nNot supplying an `etag` on the request `Policy` results in an unconditional\nwrite of the `Policy`."
+ }
+ }
+ },
+ "projects": {
+ "methods": {
+ "getEffectiveOrgPolicy": {
+ "response": {
+ "$ref": "OrgPolicy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "The name of the resource to start computing the effective `Policy`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/projects/{projectsId}:getEffectiveOrgPolicy",
+ "id": "cloudresourcemanager.projects.getEffectiveOrgPolicy",
+ "path": "v1/{+resource}:getEffectiveOrgPolicy",
+ "description": "Gets the effective `Policy` on a resource. This is the result of merging\n`Policies` in the resource hierarchy. The returned `Policy` will not have\nan `etag`set because it is a computed `Policy` across multiple resources.",
+ "request": {
+ "$ref": "GetEffectiveOrgPolicyRequest"
+ }
+ },
+ "undelete": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The project ID (for example, `foo-bar-123`).\n\nRequired.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectId}:undelete",
+ "path": "v1/projects/{projectId}:undelete",
+ "id": "cloudresourcemanager.projects.undelete",
+ "request": {
+ "$ref": "UndeleteProjectRequest"
+ },
+ "description": "Restores the Project identified by the specified\n`project_id` (for example, `my-project-123`).\nYou can only use this method for a Project that has a lifecycle state of\nDELETE_REQUESTED.\nAfter deletion starts, the Project cannot be restored.\n\nThe caller must have modify permissions for this Project.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "Empty"
+ }
+ },
+ "update": {
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "Project"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The project ID (for example, `my-project-123`).\n\nRequired.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectId}",
+ "path": "v1/projects/{projectId}",
+ "id": "cloudresourcemanager.projects.update",
+ "request": {
+ "$ref": "Project"
+ },
+ "description": "Updates the attributes of the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have modify permissions for this Project."
+ },
+ "list": {
+ "flatPath": "v1/projects",
+ "path": "v1/projects",
+ "id": "cloudresourcemanager.projects.list",
+ "description": "Lists Projects that are visible to the user and satisfy the\nspecified filter. This method returns Projects in an unspecified order.\nNew Projects do not necessarily appear at the end of the list.",
+ "httpMethod": "GET",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ListProjectsResponse"
+ },
+ "parameters": {
+ "pageToken": {
+ "description": "A pagination token returned from a previous call to ListProjects\nthat indicates from where listing should continue.\n\nOptional.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The maximum number of Projects to return in the response.\nThe server can return fewer Projects than requested.\nIf unspecified, server picks an appropriate default.\n\nOptional.",
+ "type": "integer",
+ "location": "query"
+ },
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n+ `name`\n+ `id`\n+ \u003ccode\u003elabels.\u003cem\u003ekey\u003c/em\u003e\u003c/code\u003e where *key* is the name of a label\n\nSome examples of using labels as filters:\n\n|Filter|Description|\n|------|-----------|\n|name:how*|The project's name starts with \"how\".|\n|name:Howl|The project's name is `Howl` or `howl`.|\n|name:HOWL|Equivalent to above.|\n|NAME:howl|Equivalent to above.|\n|labels.color:*|The project has the label `color`.|\n|labels.color:red|The project's label `color` has the value `red`.|\n|labels.color:red labels.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`.\n\nIf you specify a filter that has both `parent.type` and `parent.id`, then\nthe `resourcemanager.projects.list` permission is checked on the parent.\nIf the user has this permission, all projects under the parent will be\nreturned after remaining filters have been applied. If the user lacks this\npermission, then all projects for which the user has the\n`resourcemanager.projects.get` permission will be returned after remaining\nfilters have been applied. If no filter is specified, the call will return\nprojects for which the user has `resourcemanager.projects.get` permissions.\n\nOptional."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "setOrgPolicy": {
+ "flatPath": "v1/projects/{projectsId}:setOrgPolicy",
+ "path": "v1/{+resource}:setOrgPolicy",
+ "id": "cloudresourcemanager.projects.setOrgPolicy",
+ "description": "Updates the specified `Policy` on the resource. Creates a new `Policy` for\nthat `Constraint` on the resource if one does not exist.\n\nNot supplying an `etag` on the request `Policy` results in an unconditional\nwrite of the `Policy`.",
+ "request": {
+ "$ref": "SetOrgPolicyRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "OrgPolicy"
+ },
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Resource name of the resource to attach the `Policy`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "create": {
+ "description": "Request that a new Project be created. The result is an Operation which\ncan be used to track the creation process. It is automatically deleted\nafter a few hours, so there is no need to call DeleteOperation.\n\nOur SLO permits Project creation to take up to 30 seconds at the 90th\npercentile. As of 2016-08-29, we are observing 6 seconds 50th percentile\nlatency. 95th percentile latency is around 11 seconds. We recommend\npolling at the 5th second with an exponential backoff.\n\nAuthorization requires the Google IAM permission\n`resourcemanager.projects.create` on the specified parent for the new\nproject.",
+ "request": {
+ "$ref": "Project"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects",
+ "id": "cloudresourcemanager.projects.create",
+ "path": "v1/projects"
+ },
+ "listOrgPolicies": {
+ "parameters": {
+ "resource": {
+ "description": "Name of the resource to list Policies for.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/projects/{projectsId}:listOrgPolicies",
+ "id": "cloudresourcemanager.projects.listOrgPolicies",
+ "path": "v1/{+resource}:listOrgPolicies",
+ "description": "Lists all the `Policies` set for a particular resource.",
+ "request": {
+ "$ref": "ListOrgPoliciesRequest"
+ },
+ "response": {
+ "$ref": "ListOrgPoliciesResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST"
+ },
+ "get": {
+ "parameters": {
+ "projectId": {
+ "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/projects/{projectId}",
+ "id": "cloudresourcemanager.projects.get",
+ "path": "v1/projects/{projectId}",
+ "description": "Retrieves the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project.",
+ "response": {
+ "$ref": "Project"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "GET"
+ },
+ "getAncestry": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "GetAncestryResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectId}:getAncestry",
+ "path": "v1/projects/{projectId}:getAncestry",
+ "id": "cloudresourcemanager.projects.getAncestry",
+ "request": {
+ "$ref": "GetAncestryRequest"
+ },
+ "description": "Gets a list of ancestors in the resource hierarchy for the Project\nidentified by the specified `project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project."
+ },
+ "testIamPermissions": {
+ "id": "cloudresourcemanager.projects.testIamPermissions",
+ "path": "v1/projects/{resource}:testIamPermissions",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified Project.\n\nThere are no permissions required for making this API call.",
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{resource}:testIamPermissions"
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Project ID (for example, `foo-bar-123`).\n\nRequired.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}",
+ "path": "v1/projects/{projectId}",
+ "id": "cloudresourcemanager.projects.delete",
+ "description": "Marks the Project identified by the specified\n`project_id` (for example, `my-project-123`) for deletion.\nThis method will only affect the Project if the following criteria are met:\n\n+ The Project does not have a billing account associated with it.\n+ The Project has a lifecycle state of\nACTIVE.\n\nThis method changes the Project's lifecycle state from\nACTIVE\nto DELETE_REQUESTED.\nThe deletion starts at an unspecified time,\nat which point the Project is no longer accessible.\n\nUntil the deletion completes, you can check the lifecycle state\nchecked by retrieving the Project with GetProject,\nand the Project remains visible to ListProjects.\nHowever, you cannot update the project.\n\nAfter the deletion completes, the Project is not retrievable by\nthe GetProject and\nListProjects methods.\n\nThe caller must have modify permissions for this Project."
+ },
+ "clearOrgPolicy": {
+ "request": {
+ "$ref": "ClearOrgPolicyRequest"
+ },
+ "description": "Clears a `Policy` from a resource.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "Name of the resource for the `Policy` to clear.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}:clearOrgPolicy",
+ "path": "v1/{+resource}:clearOrgPolicy",
+ "id": "cloudresourcemanager.projects.clearOrgPolicy"
+ },
+ "setIamPolicy": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{resource}:setIamPolicy",
+ "path": "v1/projects/{resource}:setIamPolicy",
+ "id": "cloudresourcemanager.projects.setIamPolicy",
+ "description": "Sets the IAM access control policy for the specified Project. Replaces\nany existing policy.\n\nThe following constraints apply when using `setIamPolicy()`:\n\n+ Project does not support `allUsers` and `allAuthenticatedUsers` as\n`members` in a `Binding` of a `Policy`.\n\n+ The owner role can be granted only to `user` and `serviceAccount`.\n\n+ Service accounts can be made owners of a project directly\nwithout any restrictions. However, to be added as an owner, a user must be\ninvited via Cloud Platform console and must accept the invitation.\n\n+ A user cannot be granted the owner role using `setIamPolicy()`. The user\nmust be granted the owner role using the Cloud Platform Console and must\nexplicitly accept the invitation.\n\n+ Invitations to grant the owner role cannot be sent using\n`setIamPolicy()`;\nthey must be sent only using the Cloud Platform Console.\n\n+ Membership changes that leave the project without any owners that have\naccepted the Terms of Service (ToS) will be rejected.\n\n+ If the project is not part of an organization, there must be at least\none owner who has accepted the Terms of Service (ToS) agreement in the\npolicy. Calling `setIamPolicy()` to remove the last ToS-accepted owner\nfrom the policy will fail. This restriction also applies to legacy\nprojects that no longer have owners who have accepted the ToS. Edits to\nIAM policies will be rejected until the lack of a ToS-accepting owner is\nrectified.\n\n+ Calling this method requires enabling the App Engine Admin API.\n\nNote: Removing service accounts from policies or changing their roles\ncan render services completely inoperable. It is important to understand\nhow the service account is being used before removing or updating its\nroles.\n\nAuthorization requires the Google IAM permission\n`resourcemanager.projects.setIamPolicy` on the project",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ }
+ },
+ "listAvailableOrgPolicyConstraints": {
+ "description": "Lists `Constraints` that could be applied on the specified resource.",
+ "request": {
+ "$ref": "ListAvailableOrgPolicyConstraintsRequest"
+ },
+ "response": {
+ "$ref": "ListAvailableOrgPolicyConstraintsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "description": "Name of the resource to list `Constraints` for.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/projects/{projectsId}:listAvailableOrgPolicyConstraints",
+ "id": "cloudresourcemanager.projects.listAvailableOrgPolicyConstraints",
+ "path": "v1/{+resource}:listAvailableOrgPolicyConstraints"
+ },
+ "getIamPolicy": {
+ "id": "cloudresourcemanager.projects.getIamPolicy",
+ "path": "v1/projects/{resource}:getIamPolicy",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ },
+ "description": "Returns the IAM access control policy for the specified Project.\nPermission is denied if the policy or the resource does not exist.\n\nAuthorization requires the Google IAM permission\n`resourcemanager.projects.getIamPolicy` on the project",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{resource}:getIamPolicy"
+ },
+ "getOrgPolicy": {
+ "id": "cloudresourcemanager.projects.getOrgPolicy",
+ "path": "v1/{+resource}:getOrgPolicy",
+ "request": {
+ "$ref": "GetOrgPolicyRequest"
+ },
+ "description": "Gets a `Policy` on a resource.\n\nIf no `Policy` is set on the resource, a `Policy` is returned with default\nvalues including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The\n`etag` value can be used with `SetOrgPolicy()` to create or update a\n`Policy` during read-modify-write.",
+ "response": {
+ "$ref": "OrgPolicy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "Name of the resource the `Policy` is set on.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}:getOrgPolicy"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "type": "boolean",
+ "location": "query",
+ "description": "Returns response with indentations and line breaks."
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "alt": {
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ }
+ },
"version": "v1",
"baseUrl": "https://cloudresourcemanager.googleapis.com/",
"servicePath": "",
"description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.",
"kind": "discovery#restDescription",
"basePath": "",
- "id": "cloudresourcemanager:v1",
"documentationLink": "https://cloud.google.com/resource-manager",
"revision": "20170927",
+ "id": "cloudresourcemanager:v1",
"discoveryVersion": "v1",
"schemas": {
- "Project": {
- "description": "A Project is a high-level Google Cloud Platform entity. It is a\ncontainer for ACLs, APIs, App Engine Apps, VMs, and other\nGoogle Cloud Platform resources.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The user-assigned display name of the Project.\nIt must be 4 to 30 characters.\nAllowed characters are: lowercase and uppercase letters, numbers,\nhyphen, single-quote, double-quote, space, and exclamation point.\n\nExample: \u003ccode\u003eMy Project\u003c/code\u003e\nRead-write.",
- "type": "string"
- },
- "projectId": {
- "description": "The unique, user-assigned ID of the Project.\nIt must be 6 to 30 lowercase letters, digits, or hyphens.\nIt must start with a letter.\nTrailing hyphens are prohibited.\n\nExample: \u003ccode\u003etokyo-rain-123\u003c/code\u003e\nRead-only after creation.",
- "type": "string"
- },
- "lifecycleState": {
- "description": "The Project lifecycle state.\n\nRead-only.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified state. This is only used/useful for distinguishing\nunset values.",
- "The normal and active state.",
- "The project has been marked for deletion by the user\n(by invoking\nDeleteProject)\nor by the system (Google Cloud Platform).\nThis can generally be reversed by invoking UndeleteProject.",
- "This lifecycle state is no longer used and not returned by the API."
- ],
- "enum": [
- "LIFECYCLE_STATE_UNSPECIFIED",
- "ACTIVE",
- "DELETE_REQUESTED",
- "DELETE_IN_PROGRESS"
- ]
- },
- "projectNumber": {
- "format": "int64",
- "description": "The number uniquely identifying the project.\n\nExample: \u003ccode\u003e415104041262\u003c/code\u003e\nRead-only.",
- "type": "string"
- },
- "parent": {
- "$ref": "ResourceId",
- "description": "An optional reference to a parent Resource.\n\nThe only supported parent type is \"organization\". Once set, the parent\ncannot be modified. The `parent` can be set on creation or using the\n`UpdateProject` method; the end user must have the\n`resourcemanager.projects.create` permission on the parent.\n\nRead-write."
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "The labels associated with this Project.\n\nLabel keys must be between 1 and 63 characters long and must conform\nto the following regular expression: \\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?.\n\nLabel values must be between 0 and 63 characters long and must conform\nto the regular expression (\\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?)?.\n\nNo more than 256 labels can be associated with a given resource.\n\nClients should store labels in a representation such as JSON that does not\ndepend on specific characters being disallowed.\n\nExample: \u003ccode\u003e\"environment\" : \"dev\"\u003c/code\u003e\nRead-write.",
- "type": "object"
- },
- "createTime": {
- "format": "google-datetime",
- "description": "Creation time.\n\nRead-only.",
- "type": "string"
- }
- },
- "id": "Project"
- },
- "ListOrgPoliciesResponse": {
- "description": "The response returned from the ListOrgPolicies method. It will be empty\nif no `Policies` are set on the resource.",
- "type": "object",
- "properties": {
- "policies": {
- "items": {
- "$ref": "OrgPolicy"
- },
- "type": "array",
- "description": "The `Policies` that are set on the resource. It will be empty if no\n`Policies` are set."
- },
- "nextPageToken": {
- "description": "Page token used to retrieve the next page. This is currently not used, but\nthe server may at any point start supplying a valid token.",
- "type": "string"
- }
- },
- "id": "ListOrgPoliciesResponse"
- },
- "SearchOrganizationsResponse": {
- "description": "The response returned from the `SearchOrganizations` method.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "A pagination token to be used to retrieve the next page of results. If the\nresult is too large to fit within the page size specified in the request,\nthis field will be set with a token that can be used to fetch the next page\nof results. If this field is empty, it indicates that this response\ncontains the last page of results."
- },
- "organizations": {
- "description": "The list of Organizations that matched the search query, possibly\npaginated.",
- "items": {
- "$ref": "Organization"
- },
- "type": "array"
- }
- },
- "id": "SearchOrganizationsResponse"
- },
- "FolderOperationError": {
- "description": "A classification of the Folder Operation error.",
- "type": "object",
- "properties": {
- "errorMessageId": {
- "enumDescriptions": [
- "The error type was unrecognized or unspecified.",
- "The attempted action would violate the max folder depth constraint.",
- "The attempted action would violate the max child folders constraint.",
- "The attempted action would violate the locally-unique folder\ndisplay_name constraint.",
- "The resource being moved has been deleted.",
- "The resource a folder was being added to has been deleted.",
- "The attempted action would introduce cycle in resource path.",
- "The attempted action would move a folder that is already being moved.",
- "The folder the caller is trying to delete contains active resources.",
- "The attempted action would violate the max deleted folder depth\nconstraint."
- ],
- "enum": [
- "ERROR_TYPE_UNSPECIFIED",
- "ACTIVE_FOLDER_HEIGHT_VIOLATION",
- "MAX_CHILD_FOLDERS_VIOLATION",
- "FOLDER_NAME_UNIQUENESS_VIOLATION",
- "RESOURCE_DELETED_VIOLATION",
- "PARENT_DELETED_VIOLATION",
- "CYCLE_INTRODUCED_VIOLATION",
- "FOLDER_BEING_MOVED_VIOLATION",
- "FOLDER_TO_DELETE_NON_EMPTY_VIOLATION",
- "DELETED_FOLDER_HEIGHT_VIOLATION"
- ],
- "description": "The type of operation error experienced.",
- "type": "string"
- }
- },
- "id": "FolderOperationError"
- },
- "OrgPolicy": {
- "description": "Defines a Cloud Organization `Policy` which is used to specify `Constraints`\nfor configurations of Cloud Platform resources.",
- "type": "object",
- "properties": {
- "version": {
- "type": "integer",
- "format": "int32",
- "description": "Version of the `Policy`. Default version is 0;"
- },
- "restoreDefault": {
- "$ref": "RestoreDefault",
- "description": "Restores the default behavior of the constraint; independent of\n`Constraint` type."
- },
- "listPolicy": {
- "$ref": "ListPolicy",
- "description": "List of values either allowed or disallowed."
- },
- "etag": {
- "format": "byte",
- "description": "An opaque tag indicating the current version of the `Policy`, used for\nconcurrency control.\n\nWhen the `Policy` is returned from either a `GetPolicy` or a\n`ListOrgPolicy` request, this `etag` indicates the version of the current\n`Policy` to use when executing a read-modify-write loop.\n\nWhen the `Policy` is returned from a `GetEffectivePolicy` request, the\n`etag` will be unset.\n\nWhen the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value\nthat was returned from a `GetOrgPolicy` request as part of a\nread-modify-write loop for concurrency control. Not setting the `etag`in a\n`SetOrgPolicy` request will result in an unconditional write of the\n`Policy`.",
- "type": "string"
- },
- "constraint": {
- "type": "string",
- "description": "The name of the `Constraint` the `Policy` is configuring, for example,\n`constraints/serviceuser.services`.\n\nImmutable after creation."
- },
- "booleanPolicy": {
- "description": "For boolean `Constraints`, whether to enforce the `Constraint` or not.",
- "$ref": "BooleanPolicy"
- },
- "updateTime": {
- "format": "google-datetime",
- "description": "The time stamp the `Policy` was previously updated. This is set by the\nserver, not specified by the caller, and represents the last time a call to\n`SetOrgPolicy` was made for that `Policy`. Any value set by the client will\nbe ignored.",
- "type": "string"
- }
- },
- "id": "OrgPolicy"
- },
- "BooleanPolicy": {
- "id": "BooleanPolicy",
- "description": "Used in `policy_type` to specify how `boolean_policy` will behave at this\nresource.",
- "type": "object",
- "properties": {
- "enforced": {
- "description": "If `true`, then the `Policy` is enforced. If `false`, then any\nconfiguration is acceptable.\n\nSuppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`\nwith `constraint_default` set to `ALLOW`. A `Policy` for that\n`Constraint` exhibits the following behavior:\n - If the `Policy` at this resource has enforced set to `false`, serial\n port connection attempts will be allowed.\n - If the `Policy` at this resource has enforced set to `true`, serial\n port connection attempts will be refused.\n - If the `Policy` at this resource is `RestoreDefault`, serial port\n connection attempts will be allowed.\n - If no `Policy` is set at this resource or anywhere higher in the\n resource hierarchy, serial port connection attempts will be allowed.\n - If no `Policy` is set at this resource, but one exists higher in the\n resource hierarchy, the behavior is as if the`Policy` were set at\n this resource.\n\nThe following examples demonstrate the different possible layerings:\n\nExample 1 (nearest `Constraint` wins):\n `organizations/foo` has a `Policy` with:\n {enforced: false}\n `projects/bar` has no `Policy` set.\nThe constraint at `projects/bar` and `organizations/foo` will not be\nenforced.\n\nExample 2 (enforcement gets replaced):\n `organizations/foo` has a `Policy` with:\n {enforced: false}\n `projects/bar` has a `Policy` with:\n {enforced: true}\nThe constraint at `organizations/foo` is not enforced.\nThe constraint at `projects/bar` is enforced.\n\nExample 3 (RestoreDefault):\n `organizations/foo` has a `Policy` with:\n {enforced: true}\n `projects/bar` has a `Policy` with:\n {RestoreDefault: {}}\nThe constraint at `organizations/foo` is enforced.\nThe constraint at `projects/bar` is not enforced, because\n`constraint_default` for the `Constraint` is `ALLOW`.",
- "type": "boolean"
- }
- }
- },
- "Lien": {
- "description": "A Lien represents an encumbrance on the actions that can be performed on a\nresource.",
- "type": "object",
- "properties": {
- "parent": {
- "description": "A reference to the resource this Lien is attached to. The server will\nvalidate the parent against those for which Liens are supported.\n\nExample: `projects/1234`",
- "type": "string"
- },
- "createTime": {
- "type": "string",
- "format": "google-datetime",
- "description": "The creation time of this Lien."
- },
- "name": {
- "description": "A system-generated unique identifier for this Lien.\n\nExample: `liens/1234abcd`",
- "type": "string"
- },
- "reason": {
- "description": "Concise user-visible strings indicating why an action cannot be performed\non a resource. Maximum lenth of 200 characters.\n\nExample: 'Holds production API key'",
- "type": "string"
- },
- "origin": {
- "type": "string",
- "description": "A stable, user-visible/meaningful string identifying the origin of the\nLien, intended to be inspected programmatically. Maximum length of 200\ncharacters.\n\nExample: 'compute.googleapis.com'"
- },
- "restrictions": {
- "description": "The types of operations which should be blocked as a result of this Lien.\nEach value should correspond to an IAM permission. The server will\nvalidate the permissions against those for which Liens are supported.\n\nAn empty list is meaningless and will be rejected.\n\nExample: ['resourcemanager.projects.delete']",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "Lien"
- },
- "Ancestor": {
- "description": "Identifying information for a single ancestor of a project.",
- "type": "object",
- "properties": {
- "resourceId": {
- "description": "Resource id of the ancestor.",
- "$ref": "ResourceId"
- }
- },
- "id": "Ancestor"
- },
- "ListConstraint": {
- "description": "A `Constraint` that allows or disallows a list of string values, which are\nconfigured by an Organization's policy administrator with a `Policy`.",
- "type": "object",
- "properties": {
- "suggestedValue": {
- "type": "string",
- "description": "Optional. The Google Cloud Console will try to default to a configuration\nthat matches the value specified in this `Constraint`."
- }
- },
- "id": "ListConstraint"
- },
- "SetOrgPolicyRequest": {
- "description": "The request sent to the SetOrgPolicyRequest method.",
- "type": "object",
- "properties": {
- "policy": {
- "$ref": "OrgPolicy",
- "description": "`Policy` to set on the resource."
- }
- },
- "id": "SetOrgPolicyRequest"
- },
- "SetIamPolicyRequest": {
- "id": "SetIamPolicyRequest",
- "description": "Request message for `SetIamPolicy` method.",
- "type": "object",
- "properties": {
- "updateMask": {
- "format": "google-fieldmask",
- "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
- "type": "string"
- },
- "policy": {
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.",
- "$ref": "Policy"
- }
- }
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "Organization": {
- "type": "object",
- "properties": {
- "displayName": {
- "type": "string",
- "description": "A friendly string to be used to refer to the Organization in the UI.\nAssigned by the server, set to the primary domain of the G Suite\ncustomer that owns the organization.\n@OutputOnly"
- },
- "creationTime": {
- "format": "google-datetime",
- "description": "Timestamp when the Organization was created. Assigned by the server.\n@OutputOnly",
- "type": "string"
- },
- "lifecycleState": {
- "type": "string",
- "enumDescriptions": [
- "Unspecified state. This is only useful for distinguishing unset values.",
- "The normal and active state.",
- "The organization has been marked for deletion by the user."
- ],
- "enum": [
- "LIFECYCLE_STATE_UNSPECIFIED",
- "ACTIVE",
- "DELETE_REQUESTED"
- ],
- "description": "The organization's current lifecycle state. Assigned by the server.\n@OutputOnly"
- },
- "owner": {
- "description": "The owner of this Organization. The owner should be specified on\ncreation. Once set, it cannot be changed.\nThis field is required.",
- "$ref": "OrganizationOwner"
- },
- "name": {
- "description": "Output Only. The resource name of the organization. This is the\norganization's relative path in the API. Its format is\n\"organizations/[organization_id]\". For example, \"organizations/1234\".",
- "type": "string"
- }
- },
- "id": "Organization",
- "description": "The root node in the resource hierarchy to which a particular entity's\n(e.g., company) resources belong."
- },
- "ListAvailableOrgPolicyConstraintsResponse": {
- "properties": {
- "nextPageToken": {
- "description": "Page token used to retrieve the next page. This is currently not used.",
- "type": "string"
- },
- "constraints": {
- "description": "The collection of constraints that are settable on the request resource.",
- "items": {
- "$ref": "Constraint"
- },
- "type": "array"
- }
- },
- "id": "ListAvailableOrgPolicyConstraintsResponse",
- "description": "The response returned from the ListAvailableOrgPolicyConstraints method.\nReturns all `Constraints` that could be set at this level of the hierarchy\n(contrast with the response from `ListPolicies`, which returns all policies\nwhich are set).",
- "type": "object"
- },
- "ListPolicy": {
- "id": "ListPolicy",
- "description": "Used in `policy_type` to specify how `list_policy` behaves at this\nresource.\n\nA `ListPolicy` can define specific values that are allowed or denied by\nsetting either the `allowed_values` or `denied_values` fields. It can also\nbe used to allow or deny all values, by setting the `all_values` field. If\n`all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`\nor `denied_values` must be set (attempting to set both or neither will\nresult in a failed request). If `all_values` is set to either `ALLOW` or\n`DENY`, `allowed_values` and `denied_values` must be unset.",
- "type": "object",
- "properties": {
- "allowedValues": {
- "description": "List of values allowed at this resource. Can only be set if no values\nare set for `denied_values` and `all_values` is set to\n`ALL_VALUES_UNSPECIFIED`.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "inheritFromParent": {
- "description": "Determines the inheritance behavior for this `Policy`.\n\nBy default, a `ListPolicy` set at a resource supercedes any `Policy` set\nanywhere up the resource hierarchy. However, if `inherit_from_parent` is\nset to `true`, then the values from the effective `Policy` of the parent\nresource are inherited, meaning the values set in this `Policy` are\nadded to the values inherited up the hierarchy.\n\nSetting `Policy` hierarchies that inherit both allowed values and denied\nvalues isn't recommended in most circumstances to keep the configuration\nsimple and understandable. However, it is possible to set a `Policy` with\n`allowed_values` set that inherits a `Policy` with `denied_values` set.\nIn this case, the values that are allowed must be in `allowed_values` and\nnot present in `denied_values`.\n\nFor example, suppose you have a `Constraint`\n`constraints/serviceuser.services`, which has a `constraint_type` of\n`list_constraint`, and with `constraint_default` set to `ALLOW`.\nSuppose that at the Organization level, a `Policy` is applied that\nrestricts the allowed API activations to {`E1`, `E2`}. Then, if a\n`Policy` is applied to a project below the Organization that has\n`inherit_from_parent` set to `false` and field all_values set to DENY,\nthen an attempt to activate any API will be denied.\n\nThe following examples demonstrate different possible layerings:\n\nExample 1 (no inherited values):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values:”E2”}\n ``projects/bar`` has `inherit_from_parent` `false` and values:\n {allowed_values: \"E3\" allowed_values: \"E4\"}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe accepted values at `projects/bar` are `E3`, and `E4`.\n\nExample 2 (inherited values):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values:”E2”}\n `projects/bar` has a `Policy` with values:\n {value: “E3” value: ”E4” inherit_from_parent: true}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.\n\nExample 3 (inheriting both allowed and denied values):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: \"E1\" allowed_values: \"E2\"}\n `projects/bar` has a `Policy` with:\n {denied_values: \"E1\"}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe value accepted at `projects/bar` is `E2`.\n\nExample 4 (RestoreDefault):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values:”E2”}\n `projects/bar` has a `Policy` with values:\n {RestoreDefault: {}}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe accepted values at `projects/bar` are either all or none depending on\nthe value of `constraint_default` (if `ALLOW`, all; if\n`DENY`, none).\n\nExample 5 (no policy inherits parent policy):\n `organizations/foo` has no `Policy` set.\n `projects/bar` has no `Policy` set.\nThe accepted values at both levels are either all or none depending on\nthe value of `constraint_default` (if `ALLOW`, all; if\n`DENY`, none).\n\nExample 6 (ListConstraint allowing all):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values: ”E2”}\n `projects/bar` has a `Policy` with:\n {all: ALLOW}\nThe accepted values at `organizations/foo` are `E1`, E2`.\nAny value is accepted at `projects/bar`.\n\nExample 7 (ListConstraint allowing none):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values: ”E2”}\n `projects/bar` has a `Policy` with:\n {all: DENY}\nThe accepted values at `organizations/foo` are `E1`, E2`.\nNo value is accepted at `projects/bar`.",
- "type": "boolean"
- },
- "suggestedValue": {
- "description": "Optional. The Google Cloud Console will try to default to a configuration\nthat matches the value specified in this `Policy`. If `suggested_value`\nis not set, it will inherit the value specified higher in the hierarchy,\nunless `inherit_from_parent` is `false`.",
- "type": "string"
- },
- "deniedValues": {
- "description": "List of values denied at this resource. Can only be set if no values are\nset for `allowed_values` and `all_values` is set to\n`ALL_VALUES_UNSPECIFIED`.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "allValues": {
- "type": "string",
- "enumDescriptions": [
- "Indicates that either allowed_values or denied_values must be set.",
- "A policy with this set allows all values.",
- "A policy with this set denies all values."
- ],
- "enum": [
- "ALL_VALUES_UNSPECIFIED",
- "ALLOW",
- "DENY"
- ],
- "description": "The policy all_values state."
- }
- }
- },
- "GetAncestryResponse": {
- "id": "GetAncestryResponse",
- "description": "Response from the GetAncestry method.",
- "type": "object",
- "properties": {
- "ancestor": {
- "description": "Ancestors are ordered from bottom to top of the resource hierarchy. The\nfirst ancestor is the project itself, followed by the project's parent,\netc.",
- "items": {
- "$ref": "Ancestor"
- },
- "type": "array"
- }
- }
- },
- "AuditLogConfig": {
- "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
- "type": "object",
- "properties": {
- "logType": {
- "enum": [
- "LOG_TYPE_UNSPECIFIED",
- "ADMIN_READ",
- "DATA_WRITE",
- "DATA_READ"
- ],
- "description": "The log type that this config enables.",
- "type": "string",
- "enumDescriptions": [
- "Default case. Should never be this.",
- "Admin reads. Example: CloudIAM getIamPolicy",
- "Data writes. Example: CloudSQL Users create",
- "Data reads. Example: CloudSQL Users list"
- ]
- },
- "exemptedMembers": {
- "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "AuditLogConfig"
- },
- "SearchOrganizationsRequest": {
- "description": "The request sent to the `SearchOrganizations` method.",
- "type": "object",
- "properties": {
- "filter": {
- "description": "An optional query string used to filter the Organizations to return in\nthe response. Filter rules are case-insensitive.\n\n\nOrganizations may be filtered by `owner.directoryCustomerId` or by\n`domain`, where the domain is a Google for Work domain, for example:\n\n|Filter|Description|\n|------|-----------|\n|owner.directorycustomerid:123456789|Organizations with\n`owner.directory_customer_id` equal to `123456789`.|\n|domain:google.com|Organizations corresponding to the domain `google.com`.|\n\nThis field is optional.",
- "type": "string"
- },
- "pageToken": {
- "description": "A pagination token returned from a previous call to `SearchOrganizations`\nthat indicates from where listing should continue.\nThis field is optional.",
- "type": "string"
- },
- "pageSize": {
- "format": "int32",
- "description": "The maximum number of Organizations to return in the response.\nThis field is optional.",
- "type": "integer"
- }
- },
- "id": "SearchOrganizationsRequest"
- },
- "GetAncestryRequest": {
- "description": "The request sent to the\nGetAncestry\nmethod.",
- "type": "object",
- "properties": {},
- "id": "GetAncestryRequest"
- },
- "TestIamPermissionsRequest": {
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "TestIamPermissionsRequest"
- },
- "FolderOperation": {
- "description": "Metadata describing a long running folder operation",
- "type": "object",
- "properties": {
- "operationType": {
- "enumDescriptions": [
- "Operation type not specified.",
- "A create folder operation.",
- "A move folder operation."
- ],
- "enum": [
- "OPERATION_TYPE_UNSPECIFIED",
- "CREATE",
- "MOVE"
- ],
- "description": "The type of this operation.",
- "type": "string"
- },
- "sourceParent": {
- "description": "The resource name of the folder's parent.\nOnly applicable when the operation_type is MOVE.",
- "type": "string"
- },
- "displayName": {
- "description": "The display name of the folder.",
- "type": "string"
- },
- "destinationParent": {
- "description": "The resource name of the folder or organization we are either creating\nthe folder under or moving the folder to.",
- "type": "string"
- }
- },
- "id": "FolderOperation"
- },
- "Policy": {
- "id": "Policy",
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
- "type": "object",
- "properties": {
- "etag": {
- "format": "byte",
- "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.",
- "type": "string"
- },
- "version": {
- "format": "int32",
- "description": "Version of the `Policy`. The default version is 0.",
- "type": "integer"
- },
- "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"
- }
- }
- },
- "ListAvailableOrgPolicyConstraintsRequest": {
- "description": "The request sent to the [ListAvailableOrgPolicyConstraints]\ngoogle.cloud.OrgPolicy.v1.ListAvailableOrgPolicyConstraints] method.",
- "type": "object",
- "properties": {
- "pageToken": {
- "description": "Page token used to retrieve the next page. This is currently unsupported\nand will be ignored. The server may at any point start using this field.",
- "type": "string"
- },
- "pageSize": {
- "format": "int32",
- "description": "Size of the pages to be returned. This is currently unsupported and will\nbe ignored. The server may at any point start using this field to limit\npage size.",
- "type": "integer"
- }
- },
- "id": "ListAvailableOrgPolicyConstraintsRequest"
- },
- "ResourceId": {
- "description": "A container to reference an id for any resource type. A `resource` in Google\nCloud Platform is a generic term for something you (a developer) may want to\ninteract with through one of our API's. Some examples are an App Engine app,\na Compute Engine instance, a Cloud SQL database, and so on.",
- "type": "object",
- "properties": {
- "type": {
- "description": "Required field representing the resource type this id is for.\nAt present, the valid types are: \"organization\"",
- "type": "string"
- },
- "id": {
- "description": "Required field for the type-specific id. This should correspond to the id\nused in the type-specific API's.",
- "type": "string"
- }
- },
- "id": "ResourceId"
- },
- "GetEffectiveOrgPolicyRequest": {
- "description": "The request sent to the GetEffectiveOrgPolicy method.",
- "type": "object",
- "properties": {
- "constraint": {
- "description": "The name of the `Constraint` to compute the effective `Policy`.",
- "type": "string"
- }
- },
- "id": "GetEffectiveOrgPolicyRequest"
- },
- "ListOrgPoliciesRequest": {
- "properties": {
- "pageToken": {
- "description": "Page token used to retrieve the next page. This is currently unsupported\nand will be ignored. The server may at any point start using this field.",
- "type": "string"
- },
- "pageSize": {
- "type": "integer",
- "format": "int32",
- "description": "Size of the pages to be returned. This is currently unsupported and will\nbe ignored. The server may at any point start using this field to limit\npage size."
- }
- },
- "id": "ListOrgPoliciesRequest",
- "description": "The request sent to the ListOrgPolicies method.",
- "type": "object"
- },
- "AuditConfig": {
- "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
- "type": "object",
- "properties": {
- "service": {
- "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
- "type": "string"
- },
- "auditLogConfigs": {
- "description": "The configuration for logging of each type of permission.\nNext ID: 4",
- "items": {
- "$ref": "AuditLogConfig"
- },
- "type": "array"
- }
- },
- "id": "AuditConfig"
- },
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
- "type": "string"
- },
- "error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure or cancellation."
- },
- "metadata": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any."
- },
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- },
- "response": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
- "type": "object"
- }
- },
- "id": "Operation"
- },
- "Status": {
- "type": "object",
- "properties": {
- "message": {
- "type": "string",
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client."
- },
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- },
- "type": "array"
- },
- "code": {
- "type": "integer",
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code."
- }
- },
- "id": "Status",
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons."
- },
- "ListLiensResponse": {
- "description": "The response message for Liens.ListLiens.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Token to retrieve the next page of results, or empty if there are no more\nresults in the list.",
- "type": "string"
- },
- "liens": {
- "description": "A list of Liens.",
- "items": {
- "$ref": "Lien"
- },
- "type": "array"
- }
- },
- "id": "ListLiensResponse"
- },
"Constraint": {
- "id": "Constraint",
"description": "A `Constraint` describes a way in which a resource's configuration can be\nrestricted. For example, it controls which cloud services can be activated\nacross an organization, or whether a Compute Engine instance can have\nserial port connections established. `Constraints` can be configured by the\norganization's policy adminstrator to fit the needs of the organzation by\nsetting Policies for `Constraints` at different locations in the\norganization's resource hierarchy. Policies are inherited down the resource\nhierarchy from higher levels, but can also be overridden. For details about\nthe inheritance rules please read about\nPolicies.\n\n`Constraints` have a default behavior determined by the `constraint_default`\nfield, which is the enforcement behavior that is used in the absence of a\n`Policy` being defined or inherited for the resource in question.",
"type": "object",
"properties": {
- "description": {
- "description": "Detailed description of what this `Constraint` controls as well as how and\nwhere it is enforced.\n\nMutable.",
- "type": "string"
+ "listConstraint": {
+ "description": "Defines this constraint as being a ListConstraint.",
+ "$ref": "ListConstraint"
+ },
+ "version": {
+ "format": "int32",
+ "description": "Version of the `Constraint`. Default version is 0;",
+ "type": "integer"
},
"displayName": {
"description": "The human readable name.\n\nMutable.",
"type": "string"
},
+ "description": {
+ "description": "Detailed description of what this `Constraint` controls as well as how and\nwhere it is enforced.\n\nMutable.",
+ "type": "string"
+ },
"booleanConstraint": {
- "description": "Defines this constraint as being a BooleanConstraint.",
- "$ref": "BooleanConstraint"
+ "$ref": "BooleanConstraint",
+ "description": "Defines this constraint as being a BooleanConstraint."
},
"constraintDefault": {
"enumDescriptions": [
@@ -707,20 +1179,57 @@
"type": "string"
},
"name": {
- "description": "Immutable value, required to globally be unique. For example,\n`constraints/serviceuser.services`",
+ "type": "string",
+ "description": "Immutable value, required to globally be unique. For example,\n`constraints/serviceuser.services`"
+ }
+ },
+ "id": "Constraint"
+ },
+ "ListLiensResponse": {
+ "id": "ListLiensResponse",
+ "description": "The response message for Liens.ListLiens.",
+ "type": "object",
+ "properties": {
+ "liens": {
+ "items": {
+ "$ref": "Lien"
+ },
+ "type": "array",
+ "description": "A list of Liens."
+ },
+ "nextPageToken": {
+ "description": "Token to retrieve the next page of results, or empty if there are no more\nresults in the list.",
"type": "string"
- },
- "listConstraint": {
- "$ref": "ListConstraint",
- "description": "Defines this constraint as being a ListConstraint."
- },
- "version": {
- "format": "int32",
- "description": "Version of the `Constraint`. Default version is 0;",
- "type": "integer"
}
}
},
+ "Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
+ "properties": {
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "type": "array"
+ },
+ "code": {
+ "format": "int32",
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ }
+ },
+ "id": "Status"
+ },
"Binding": {
"description": "Associates `members` with a `role`.",
"type": "object",
@@ -757,20 +1266,20 @@
"id": "RestoreDefault"
},
"ClearOrgPolicyRequest": {
+ "id": "ClearOrgPolicyRequest",
"description": "The request sent to the ClearOrgPolicy method.",
"type": "object",
"properties": {
- "constraint": {
- "description": "Name of the `Constraint` of the `Policy` to clear.",
- "type": "string"
- },
"etag": {
"format": "byte",
"description": "The current version, for concurrency control. Not sending an `etag`\nwill cause the `Policy` to be cleared blindly.",
"type": "string"
+ },
+ "constraint": {
+ "description": "Name of the `Constraint` of the `Policy` to clear.",
+ "type": "string"
}
- },
- "id": "ClearOrgPolicyRequest"
+ }
},
"UndeleteProjectRequest": {
"description": "The request sent to the UndeleteProject\nmethod.",
@@ -779,12 +1288,9 @@
"id": "UndeleteProjectRequest"
},
"ProjectCreationStatus": {
+ "description": "A status object which is used as the `metadata` field for the Operation\nreturned by CreateProject. It provides insight for when significant phases of\nProject creation have completed.",
"type": "object",
"properties": {
- "ready": {
- "description": "True if the project creation process is complete.",
- "type": "boolean"
- },
"gettable": {
"description": "True if the project can be retrieved using GetProject. No other operations\non the project are guaranteed to work until the project creation is\ncomplete.",
"type": "boolean"
@@ -793,10 +1299,13 @@
"format": "google-datetime",
"description": "Creation time of the project creation workflow.",
"type": "string"
+ },
+ "ready": {
+ "description": "True if the project creation process is complete.",
+ "type": "boolean"
}
},
- "id": "ProjectCreationStatus",
- "description": "A status object which is used as the `metadata` field for the Operation\nreturned by CreateProject. It provides insight for when significant phases of\nProject creation have completed."
+ "id": "ProjectCreationStatus"
},
"BooleanConstraint": {
"description": "A `Constraint` that is either enforced or not.\n\nFor example a constraint `constraints/compute.disableSerialPortAccess`.\nIf it is enforced on a VM instance, serial port connections will not be\nopened to that instance.",
@@ -811,6 +1320,8 @@
"id": "GetIamPolicyRequest"
},
"TestIamPermissionsResponse": {
+ "description": "Response message for `TestIamPermissions` method.",
+ "type": "object",
"properties": {
"permissions": {
"items": {
@@ -820,45 +1331,663 @@
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed."
}
},
- "id": "TestIamPermissionsResponse",
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object"
+ "id": "TestIamPermissionsResponse"
},
"OrganizationOwner": {
"type": "object",
"properties": {
"directoryCustomerId": {
- "description": "The Google for Work customer id used in the Directory API.",
- "type": "string"
+ "type": "string",
+ "description": "The Google for Work customer id used in the Directory API."
}
},
"id": "OrganizationOwner",
"description": "The entity that owns an Organization. The lifetime of the Organization and\nall of its descendants are bound to the `OrganizationOwner`. If the\n`OrganizationOwner` is deleted, the Organization and all its descendants will\nbe deleted."
},
"ListProjectsResponse": {
- "description": "A page of the response received from the\nListProjects\nmethod.\n\nA paginated response where more pages are available has\n`next_page_token` set. This token can be used in a subsequent request to\nretrieve the next request page.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "Pagination token.\n\nIf the result set is too large to fit in a single response, this token\nis returned. It encodes the position of the current result cursor.\nFeeding this value into a new list request with the `page_token` parameter\ngives the next page of the results.\n\nWhen `next_page_token` is not filled in, there is no next page and\nthe list returned is the last page in the result set.\n\nPagination tokens have a limited lifetime.",
- "type": "string"
- },
"projects": {
+ "description": "The list of Projects that matched the list filter. This list can\nbe paginated.",
"items": {
"$ref": "Project"
},
- "type": "array",
- "description": "The list of Projects that matched the list filter. This list can\nbe paginated."
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Pagination token.\n\nIf the result set is too large to fit in a single response, this token\nis returned. It encodes the position of the current result cursor.\nFeeding this value into a new list request with the `page_token` parameter\ngives the next page of the results.\n\nWhen `next_page_token` is not filled in, there is no next page and\nthe list returned is the last page in the result set.\n\nPagination tokens have a limited lifetime.",
+ "type": "string"
}
},
- "id": "ListProjectsResponse"
+ "id": "ListProjectsResponse",
+ "description": "A page of the response received from the\nListProjects\nmethod.\n\nA paginated response where more pages are available has\n`next_page_token` set. This token can be used in a subsequent request to\nretrieve the next request page."
+ },
+ "Project": {
+ "id": "Project",
+ "description": "A Project is a high-level Google Cloud Platform entity. It is a\ncontainer for ACLs, APIs, App Engine Apps, VMs, and other\nGoogle Cloud Platform resources.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The user-assigned display name of the Project.\nIt must be 4 to 30 characters.\nAllowed characters are: lowercase and uppercase letters, numbers,\nhyphen, single-quote, double-quote, space, and exclamation point.\n\nExample: \u003ccode\u003eMy Project\u003c/code\u003e\nRead-write.",
+ "type": "string"
+ },
+ "projectId": {
+ "type": "string",
+ "description": "The unique, user-assigned ID of the Project.\nIt must be 6 to 30 lowercase letters, digits, or hyphens.\nIt must start with a letter.\nTrailing hyphens are prohibited.\n\nExample: \u003ccode\u003etokyo-rain-123\u003c/code\u003e\nRead-only after creation."
+ },
+ "lifecycleState": {
+ "enumDescriptions": [
+ "Unspecified state. This is only used/useful for distinguishing\nunset values.",
+ "The normal and active state.",
+ "The project has been marked for deletion by the user\n(by invoking\nDeleteProject)\nor by the system (Google Cloud Platform).\nThis can generally be reversed by invoking UndeleteProject.",
+ "This lifecycle state is no longer used and not returned by the API."
+ ],
+ "enum": [
+ "LIFECYCLE_STATE_UNSPECIFIED",
+ "ACTIVE",
+ "DELETE_REQUESTED",
+ "DELETE_IN_PROGRESS"
+ ],
+ "description": "The Project lifecycle state.\n\nRead-only.",
+ "type": "string"
+ },
+ "projectNumber": {
+ "format": "int64",
+ "description": "The number uniquely identifying the project.\n\nExample: \u003ccode\u003e415104041262\u003c/code\u003e\nRead-only.",
+ "type": "string"
+ },
+ "parent": {
+ "$ref": "ResourceId",
+ "description": "An optional reference to a parent Resource.\n\nThe only supported parent type is \"organization\". Once set, the parent\ncannot be modified. The `parent` can be set on creation or using the\n`UpdateProject` method; the end user must have the\n`resourcemanager.projects.create` permission on the parent.\n\nRead-write."
+ },
+ "createTime": {
+ "format": "google-datetime",
+ "description": "Creation time.\n\nRead-only.",
+ "type": "string"
+ },
+ "labels": {
+ "description": "The labels associated with this Project.\n\nLabel keys must be between 1 and 63 characters long and must conform\nto the following regular expression: \\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?.\n\nLabel values must be between 0 and 63 characters long and must conform\nto the regular expression (\\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?)?.\n\nNo more than 256 labels can be associated with a given resource.\n\nClients should store labels in a representation such as JSON that does not\ndepend on specific characters being disallowed.\n\nExample: \u003ccode\u003e\"environment\" : \"dev\"\u003c/code\u003e\nRead-write.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "SearchOrganizationsResponse": {
+ "description": "The response returned from the `SearchOrganizations` method.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "A pagination token to be used to retrieve the next page of results. If the\nresult is too large to fit within the page size specified in the request,\nthis field will be set with a token that can be used to fetch the next page\nof results. If this field is empty, it indicates that this response\ncontains the last page of results.",
+ "type": "string"
+ },
+ "organizations": {
+ "description": "The list of Organizations that matched the search query, possibly\npaginated.",
+ "items": {
+ "$ref": "Organization"
+ },
+ "type": "array"
+ }
+ },
+ "id": "SearchOrganizationsResponse"
+ },
+ "ListOrgPoliciesResponse": {
+ "description": "The response returned from the ListOrgPolicies method. It will be empty\nif no `Policies` are set on the resource.",
+ "type": "object",
+ "properties": {
+ "policies": {
+ "description": "The `Policies` that are set on the resource. It will be empty if no\n`Policies` are set.",
+ "items": {
+ "$ref": "OrgPolicy"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Page token used to retrieve the next page. This is currently not used, but\nthe server may at any point start supplying a valid token.",
+ "type": "string"
+ }
+ },
+ "id": "ListOrgPoliciesResponse"
+ },
+ "FolderOperationError": {
+ "description": "A classification of the Folder Operation error.",
+ "type": "object",
+ "properties": {
+ "errorMessageId": {
+ "description": "The type of operation error experienced.",
+ "type": "string",
+ "enumDescriptions": [
+ "The error type was unrecognized or unspecified.",
+ "The attempted action would violate the max folder depth constraint.",
+ "The attempted action would violate the max child folders constraint.",
+ "The attempted action would violate the locally-unique folder\ndisplay_name constraint.",
+ "The resource being moved has been deleted.",
+ "The resource a folder was being added to has been deleted.",
+ "The attempted action would introduce cycle in resource path.",
+ "The attempted action would move a folder that is already being moved.",
+ "The folder the caller is trying to delete contains active resources.",
+ "The attempted action would violate the max deleted folder depth\nconstraint."
+ ],
+ "enum": [
+ "ERROR_TYPE_UNSPECIFIED",
+ "ACTIVE_FOLDER_HEIGHT_VIOLATION",
+ "MAX_CHILD_FOLDERS_VIOLATION",
+ "FOLDER_NAME_UNIQUENESS_VIOLATION",
+ "RESOURCE_DELETED_VIOLATION",
+ "PARENT_DELETED_VIOLATION",
+ "CYCLE_INTRODUCED_VIOLATION",
+ "FOLDER_BEING_MOVED_VIOLATION",
+ "FOLDER_TO_DELETE_NON_EMPTY_VIOLATION",
+ "DELETED_FOLDER_HEIGHT_VIOLATION"
+ ]
+ }
+ },
+ "id": "FolderOperationError"
+ },
+ "BooleanPolicy": {
+ "description": "Used in `policy_type` to specify how `boolean_policy` will behave at this\nresource.",
+ "type": "object",
+ "properties": {
+ "enforced": {
+ "description": "If `true`, then the `Policy` is enforced. If `false`, then any\nconfiguration is acceptable.\n\nSuppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`\nwith `constraint_default` set to `ALLOW`. A `Policy` for that\n`Constraint` exhibits the following behavior:\n - If the `Policy` at this resource has enforced set to `false`, serial\n port connection attempts will be allowed.\n - If the `Policy` at this resource has enforced set to `true`, serial\n port connection attempts will be refused.\n - If the `Policy` at this resource is `RestoreDefault`, serial port\n connection attempts will be allowed.\n - If no `Policy` is set at this resource or anywhere higher in the\n resource hierarchy, serial port connection attempts will be allowed.\n - If no `Policy` is set at this resource, but one exists higher in the\n resource hierarchy, the behavior is as if the`Policy` were set at\n this resource.\n\nThe following examples demonstrate the different possible layerings:\n\nExample 1 (nearest `Constraint` wins):\n `organizations/foo` has a `Policy` with:\n {enforced: false}\n `projects/bar` has no `Policy` set.\nThe constraint at `projects/bar` and `organizations/foo` will not be\nenforced.\n\nExample 2 (enforcement gets replaced):\n `organizations/foo` has a `Policy` with:\n {enforced: false}\n `projects/bar` has a `Policy` with:\n {enforced: true}\nThe constraint at `organizations/foo` is not enforced.\nThe constraint at `projects/bar` is enforced.\n\nExample 3 (RestoreDefault):\n `organizations/foo` has a `Policy` with:\n {enforced: true}\n `projects/bar` has a `Policy` with:\n {RestoreDefault: {}}\nThe constraint at `organizations/foo` is enforced.\nThe constraint at `projects/bar` is not enforced, because\n`constraint_default` for the `Constraint` is `ALLOW`.",
+ "type": "boolean"
+ }
+ },
+ "id": "BooleanPolicy"
+ },
+ "OrgPolicy": {
+ "description": "Defines a Cloud Organization `Policy` which is used to specify `Constraints`\nfor configurations of Cloud Platform resources.",
+ "type": "object",
+ "properties": {
+ "restoreDefault": {
+ "$ref": "RestoreDefault",
+ "description": "Restores the default behavior of the constraint; independent of\n`Constraint` type."
+ },
+ "listPolicy": {
+ "description": "List of values either allowed or disallowed.",
+ "$ref": "ListPolicy"
+ },
+ "etag": {
+ "format": "byte",
+ "description": "An opaque tag indicating the current version of the `Policy`, used for\nconcurrency control.\n\nWhen the `Policy` is returned from either a `GetPolicy` or a\n`ListOrgPolicy` request, this `etag` indicates the version of the current\n`Policy` to use when executing a read-modify-write loop.\n\nWhen the `Policy` is returned from a `GetEffectivePolicy` request, the\n`etag` will be unset.\n\nWhen the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value\nthat was returned from a `GetOrgPolicy` request as part of a\nread-modify-write loop for concurrency control. Not setting the `etag`in a\n`SetOrgPolicy` request will result in an unconditional write of the\n`Policy`.",
+ "type": "string"
+ },
+ "constraint": {
+ "description": "The name of the `Constraint` the `Policy` is configuring, for example,\n`constraints/serviceuser.services`.\n\nImmutable after creation.",
+ "type": "string"
+ },
+ "booleanPolicy": {
+ "description": "For boolean `Constraints`, whether to enforce the `Constraint` or not.",
+ "$ref": "BooleanPolicy"
+ },
+ "updateTime": {
+ "format": "google-datetime",
+ "description": "The time stamp the `Policy` was previously updated. This is set by the\nserver, not specified by the caller, and represents the last time a call to\n`SetOrgPolicy` was made for that `Policy`. Any value set by the client will\nbe ignored.",
+ "type": "string"
+ },
+ "version": {
+ "format": "int32",
+ "description": "Version of the `Policy`. Default version is 0;",
+ "type": "integer"
+ }
+ },
+ "id": "OrgPolicy"
+ },
+ "Lien": {
+ "description": "A Lien represents an encumbrance on the actions that can be performed on a\nresource.",
+ "type": "object",
+ "properties": {
+ "createTime": {
+ "format": "google-datetime",
+ "description": "The creation time of this Lien.",
+ "type": "string"
+ },
+ "origin": {
+ "description": "A stable, user-visible/meaningful string identifying the origin of the\nLien, intended to be inspected programmatically. Maximum length of 200\ncharacters.\n\nExample: 'compute.googleapis.com'",
+ "type": "string"
+ },
+ "name": {
+ "description": "A system-generated unique identifier for this Lien.\n\nExample: `liens/1234abcd`",
+ "type": "string"
+ },
+ "reason": {
+ "type": "string",
+ "description": "Concise user-visible strings indicating why an action cannot be performed\non a resource. Maximum lenth of 200 characters.\n\nExample: 'Holds production API key'"
+ },
+ "restrictions": {
+ "description": "The types of operations which should be blocked as a result of this Lien.\nEach value should correspond to an IAM permission. The server will\nvalidate the permissions against those for which Liens are supported.\n\nAn empty list is meaningless and will be rejected.\n\nExample: ['resourcemanager.projects.delete']",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "parent": {
+ "description": "A reference to the resource this Lien is attached to. The server will\nvalidate the parent against those for which Liens are supported.\n\nExample: `projects/1234`",
+ "type": "string"
+ }
+ },
+ "id": "Lien"
+ },
+ "Ancestor": {
+ "properties": {
+ "resourceId": {
+ "description": "Resource id of the ancestor.",
+ "$ref": "ResourceId"
+ }
+ },
+ "id": "Ancestor",
+ "description": "Identifying information for a single ancestor of a project.",
+ "type": "object"
+ },
+ "ListConstraint": {
+ "description": "A `Constraint` that allows or disallows a list of string values, which are\nconfigured by an Organization's policy administrator with a `Policy`.",
+ "type": "object",
+ "properties": {
+ "suggestedValue": {
+ "description": "Optional. The Google Cloud Console will try to default to a configuration\nthat matches the value specified in this `Constraint`.",
+ "type": "string"
+ }
+ },
+ "id": "ListConstraint"
+ },
+ "SetOrgPolicyRequest": {
+ "description": "The request sent to the SetOrgPolicyRequest method.",
+ "type": "object",
+ "properties": {
+ "policy": {
+ "$ref": "OrgPolicy",
+ "description": "`Policy` to set on the resource."
+ }
+ },
+ "id": "SetOrgPolicyRequest"
+ },
+ "SetIamPolicyRequest": {
+ "description": "Request message for `SetIamPolicy` method.",
+ "type": "object",
+ "properties": {
+ "policy": {
+ "$ref": "Policy",
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
+ },
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
+ "type": "string"
+ }
+ },
+ "id": "SetIamPolicyRequest"
+ },
+ "Empty": {
+ "id": "Empty",
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object",
+ "properties": {}
+ },
+ "Organization": {
+ "properties": {
+ "lifecycleState": {
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified state. This is only useful for distinguishing unset values.",
+ "The normal and active state.",
+ "The organization has been marked for deletion by the user."
+ ],
+ "enum": [
+ "LIFECYCLE_STATE_UNSPECIFIED",
+ "ACTIVE",
+ "DELETE_REQUESTED"
+ ],
+ "description": "The organization's current lifecycle state. Assigned by the server.\n@OutputOnly"
+ },
+ "owner": {
+ "$ref": "OrganizationOwner",
+ "description": "The owner of this Organization. The owner should be specified on\ncreation. Once set, it cannot be changed.\nThis field is required."
+ },
+ "name": {
+ "description": "Output Only. The resource name of the organization. This is the\norganization's relative path in the API. Its format is\n\"organizations/[organization_id]\". For example, \"organizations/1234\".",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "A friendly string to be used to refer to the Organization in the UI.\nAssigned by the server, set to the primary domain of the G Suite\ncustomer that owns the organization.\n@OutputOnly",
+ "type": "string"
+ },
+ "creationTime": {
+ "format": "google-datetime",
+ "description": "Timestamp when the Organization was created. Assigned by the server.\n@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "Organization",
+ "description": "The root node in the resource hierarchy to which a particular entity's\n(e.g., company) resources belong.",
+ "type": "object"
+ },
+ "ListAvailableOrgPolicyConstraintsResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "Page token used to retrieve the next page. This is currently not used.",
+ "type": "string"
+ },
+ "constraints": {
+ "description": "The collection of constraints that are settable on the request resource.",
+ "items": {
+ "$ref": "Constraint"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListAvailableOrgPolicyConstraintsResponse",
+ "description": "The response returned from the ListAvailableOrgPolicyConstraints method.\nReturns all `Constraints` that could be set at this level of the hierarchy\n(contrast with the response from `ListPolicies`, which returns all policies\nwhich are set).",
+ "type": "object"
+ },
+ "ListPolicy": {
+ "id": "ListPolicy",
+ "description": "Used in `policy_type` to specify how `list_policy` behaves at this\nresource.\n\nA `ListPolicy` can define specific values that are allowed or denied by\nsetting either the `allowed_values` or `denied_values` fields. It can also\nbe used to allow or deny all values, by setting the `all_values` field. If\n`all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`\nor `denied_values` must be set (attempting to set both or neither will\nresult in a failed request). If `all_values` is set to either `ALLOW` or\n`DENY`, `allowed_values` and `denied_values` must be unset.",
+ "type": "object",
+ "properties": {
+ "deniedValues": {
+ "description": "List of values denied at this resource. Can only be set if no values are\nset for `allowed_values` and `all_values` is set to\n`ALL_VALUES_UNSPECIFIED`.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "allValues": {
+ "type": "string",
+ "enumDescriptions": [
+ "Indicates that either allowed_values or denied_values must be set.",
+ "A policy with this set allows all values.",
+ "A policy with this set denies all values."
+ ],
+ "enum": [
+ "ALL_VALUES_UNSPECIFIED",
+ "ALLOW",
+ "DENY"
+ ],
+ "description": "The policy all_values state."
+ },
+ "allowedValues": {
+ "description": "List of values allowed at this resource. Can only be set if no values\nare set for `denied_values` and `all_values` is set to\n`ALL_VALUES_UNSPECIFIED`.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "inheritFromParent": {
+ "description": "Determines the inheritance behavior for this `Policy`.\n\nBy default, a `ListPolicy` set at a resource supercedes any `Policy` set\nanywhere up the resource hierarchy. However, if `inherit_from_parent` is\nset to `true`, then the values from the effective `Policy` of the parent\nresource are inherited, meaning the values set in this `Policy` are\nadded to the values inherited up the hierarchy.\n\nSetting `Policy` hierarchies that inherit both allowed values and denied\nvalues isn't recommended in most circumstances to keep the configuration\nsimple and understandable. However, it is possible to set a `Policy` with\n`allowed_values` set that inherits a `Policy` with `denied_values` set.\nIn this case, the values that are allowed must be in `allowed_values` and\nnot present in `denied_values`.\n\nFor example, suppose you have a `Constraint`\n`constraints/serviceuser.services`, which has a `constraint_type` of\n`list_constraint`, and with `constraint_default` set to `ALLOW`.\nSuppose that at the Organization level, a `Policy` is applied that\nrestricts the allowed API activations to {`E1`, `E2`}. Then, if a\n`Policy` is applied to a project below the Organization that has\n`inherit_from_parent` set to `false` and field all_values set to DENY,\nthen an attempt to activate any API will be denied.\n\nThe following examples demonstrate different possible layerings:\n\nExample 1 (no inherited values):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values:”E2”}\n ``projects/bar`` has `inherit_from_parent` `false` and values:\n {allowed_values: \"E3\" allowed_values: \"E4\"}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe accepted values at `projects/bar` are `E3`, and `E4`.\n\nExample 2 (inherited values):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values:”E2”}\n `projects/bar` has a `Policy` with values:\n {value: “E3” value: ”E4” inherit_from_parent: true}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.\n\nExample 3 (inheriting both allowed and denied values):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: \"E1\" allowed_values: \"E2\"}\n `projects/bar` has a `Policy` with:\n {denied_values: \"E1\"}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe value accepted at `projects/bar` is `E2`.\n\nExample 4 (RestoreDefault):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values:”E2”}\n `projects/bar` has a `Policy` with values:\n {RestoreDefault: {}}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe accepted values at `projects/bar` are either all or none depending on\nthe value of `constraint_default` (if `ALLOW`, all; if\n`DENY`, none).\n\nExample 5 (no policy inherits parent policy):\n `organizations/foo` has no `Policy` set.\n `projects/bar` has no `Policy` set.\nThe accepted values at both levels are either all or none depending on\nthe value of `constraint_default` (if `ALLOW`, all; if\n`DENY`, none).\n\nExample 6 (ListConstraint allowing all):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values: ”E2”}\n `projects/bar` has a `Policy` with:\n {all: ALLOW}\nThe accepted values at `organizations/foo` are `E1`, E2`.\nAny value is accepted at `projects/bar`.\n\nExample 7 (ListConstraint allowing none):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values: ”E2”}\n `projects/bar` has a `Policy` with:\n {all: DENY}\nThe accepted values at `organizations/foo` are `E1`, E2`.\nNo value is accepted at `projects/bar`.",
+ "type": "boolean"
+ },
+ "suggestedValue": {
+ "description": "Optional. The Google Cloud Console will try to default to a configuration\nthat matches the value specified in this `Policy`. If `suggested_value`\nis not set, it will inherit the value specified higher in the hierarchy,\nunless `inherit_from_parent` is `false`.",
+ "type": "string"
+ }
+ }
+ },
+ "GetAncestryResponse": {
+ "type": "object",
+ "properties": {
+ "ancestor": {
+ "description": "Ancestors are ordered from bottom to top of the resource hierarchy. The\nfirst ancestor is the project itself, followed by the project's parent,\netc.",
+ "items": {
+ "$ref": "Ancestor"
+ },
+ "type": "array"
+ }
+ },
+ "id": "GetAncestryResponse",
+ "description": "Response from the GetAncestry method."
+ },
+ "AuditLogConfig": {
+ "id": "AuditLogConfig",
+ "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
+ "type": "object",
+ "properties": {
+ "exemptedMembers": {
+ "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "logType": {
+ "enum": [
+ "LOG_TYPE_UNSPECIFIED",
+ "ADMIN_READ",
+ "DATA_WRITE",
+ "DATA_READ"
+ ],
+ "description": "The log type that this config enables.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default case. Should never be this.",
+ "Admin reads. Example: CloudIAM getIamPolicy",
+ "Data writes. Example: CloudSQL Users create",
+ "Data reads. Example: CloudSQL Users list"
+ ]
+ }
+ }
+ },
+ "SearchOrganizationsRequest": {
+ "description": "The request sent to the `SearchOrganizations` method.",
+ "type": "object",
+ "properties": {
+ "pageSize": {
+ "format": "int32",
+ "description": "The maximum number of Organizations to return in the response.\nThis field is optional.",
+ "type": "integer"
+ },
+ "filter": {
+ "description": "An optional query string used to filter the Organizations to return in\nthe response. Filter rules are case-insensitive.\n\n\nOrganizations may be filtered by `owner.directoryCustomerId` or by\n`domain`, where the domain is a Google for Work domain, for example:\n\n|Filter|Description|\n|------|-----------|\n|owner.directorycustomerid:123456789|Organizations with\n`owner.directory_customer_id` equal to `123456789`.|\n|domain:google.com|Organizations corresponding to the domain `google.com`.|\n\nThis field is optional.",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "A pagination token returned from a previous call to `SearchOrganizations`\nthat indicates from where listing should continue.\nThis field is optional.",
+ "type": "string"
+ }
+ },
+ "id": "SearchOrganizationsRequest"
+ },
+ "GetAncestryRequest": {
+ "description": "The request sent to the\nGetAncestry\nmethod.",
+ "type": "object",
+ "properties": {},
+ "id": "GetAncestryRequest"
+ },
+ "TestIamPermissionsRequest": {
+ "id": "TestIamPermissionsRequest",
+ "description": "Request message for `TestIamPermissions` method.",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "FolderOperation": {
+ "properties": {
+ "operationType": {
+ "description": "The type of this operation.",
+ "type": "string",
+ "enumDescriptions": [
+ "Operation type not specified.",
+ "A create folder operation.",
+ "A move folder operation."
+ ],
+ "enum": [
+ "OPERATION_TYPE_UNSPECIFIED",
+ "CREATE",
+ "MOVE"
+ ]
+ },
+ "sourceParent": {
+ "description": "The resource name of the folder's parent.\nOnly applicable when the operation_type is MOVE.",
+ "type": "string"
+ },
+ "displayName": {
+ "type": "string",
+ "description": "The display name of the folder."
+ },
+ "destinationParent": {
+ "description": "The resource name of the folder or organization we are either creating\nthe folder under or moving the folder to.",
+ "type": "string"
+ }
+ },
+ "id": "FolderOperation",
+ "description": "Metadata describing a long running folder operation",
+ "type": "object"
+ },
+ "Policy": {
+ "id": "Policy",
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
+ "type": "object",
+ "properties": {
+ "version": {
+ "format": "int32",
+ "description": "Version of the `Policy`. The default version is 0.",
+ "type": "integer"
+ },
+ "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": {
+ "format": "byte",
+ "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.",
+ "type": "string"
+ }
+ }
+ },
+ "ListAvailableOrgPolicyConstraintsRequest": {
+ "description": "The request sent to the [ListAvailableOrgPolicyConstraints]\ngoogle.cloud.OrgPolicy.v1.ListAvailableOrgPolicyConstraints] method.",
+ "type": "object",
+ "properties": {
+ "pageToken": {
+ "description": "Page token used to retrieve the next page. This is currently unsupported\nand will be ignored. The server may at any point start using this field.",
+ "type": "string"
+ },
+ "pageSize": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Size of the pages to be returned. This is currently unsupported and will\nbe ignored. The server may at any point start using this field to limit\npage size."
+ }
+ },
+ "id": "ListAvailableOrgPolicyConstraintsRequest"
+ },
+ "ResourceId": {
+ "id": "ResourceId",
+ "description": "A container to reference an id for any resource type. A `resource` in Google\nCloud Platform is a generic term for something you (a developer) may want to\ninteract with through one of our API's. Some examples are an App Engine app,\na Compute Engine instance, a Cloud SQL database, and so on.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Required field for the type-specific id. This should correspond to the id\nused in the type-specific API's.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Required field representing the resource type this id is for.\nAt present, the valid types are: \"organization\"",
+ "type": "string"
+ }
+ }
+ },
+ "GetEffectiveOrgPolicyRequest": {
+ "id": "GetEffectiveOrgPolicyRequest",
+ "description": "The request sent to the GetEffectiveOrgPolicy method.",
+ "type": "object",
+ "properties": {
+ "constraint": {
+ "description": "The name of the `Constraint` to compute the effective `Policy`.",
+ "type": "string"
+ }
+ }
+ },
+ "ListOrgPoliciesRequest": {
+ "description": "The request sent to the ListOrgPolicies method.",
+ "type": "object",
+ "properties": {
+ "pageToken": {
+ "description": "Page token used to retrieve the next page. This is currently unsupported\nand will be ignored. The server may at any point start using this field.",
+ "type": "string"
+ },
+ "pageSize": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Size of the pages to be returned. This is currently unsupported and will\nbe ignored. The server may at any point start using this field to limit\npage size."
+ }
+ },
+ "id": "ListOrgPoliciesRequest"
+ },
+ "AuditConfig": {
+ "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
+ "type": "object",
+ "properties": {
+ "service": {
+ "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
+ "type": "string"
+ },
+ "auditLogConfigs": {
+ "description": "The configuration for logging of each type of permission.\nNext ID: 4",
+ "items": {
+ "$ref": "AuditLogConfig"
+ },
+ "type": "array"
+ }
+ },
+ "id": "AuditConfig"
+ },
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
+ "type": "string"
+ },
+ "error": {
+ "description": "The error result of the operation in case of failure or cancellation.",
+ "$ref": "Status"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
+ },
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object"
+ },
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ },
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object"
+ }
+ },
+ "id": "Operation"
}
},
- "protocol": "rest",
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
+ "protocol": "rest",
"canonicalName": "Cloud Resource Manager",
"auth": {
"oauth2": {
@@ -875,1134 +2004,5 @@
"rootUrl": "https://cloudresourcemanager.googleapis.com/",
"ownerDomain": "google.com",
"name": "cloudresourcemanager",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Google Cloud Resource Manager API",
- "ownerName": "Google",
- "resources": {
- "folders": {
- "methods": {
- "listAvailableOrgPolicyConstraints": {
- "request": {
- "$ref": "ListAvailableOrgPolicyConstraintsRequest"
- },
- "description": "Lists `Constraints` that could be applied on the specified resource.",
- "response": {
- "$ref": "ListAvailableOrgPolicyConstraintsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "resource": {
- "pattern": "^folders/[^/]+$",
- "location": "path",
- "description": "Name of the resource to list `Constraints` for.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/folders/{foldersId}:listAvailableOrgPolicyConstraints",
- "id": "cloudresourcemanager.folders.listAvailableOrgPolicyConstraints",
- "path": "v1/{+resource}:listAvailableOrgPolicyConstraints"
- },
- "listOrgPolicies": {
- "description": "Lists all the `Policies` set for a particular resource.",
- "request": {
- "$ref": "ListOrgPoliciesRequest"
- },
- "response": {
- "$ref": "ListOrgPoliciesResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "pattern": "^folders/[^/]+$",
- "location": "path",
- "description": "Name of the resource to list Policies for.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/folders/{foldersId}:listOrgPolicies",
- "id": "cloudresourcemanager.folders.listOrgPolicies",
- "path": "v1/{+resource}:listOrgPolicies"
- },
- "getOrgPolicy": {
- "path": "v1/{+resource}:getOrgPolicy",
- "id": "cloudresourcemanager.folders.getOrgPolicy",
- "description": "Gets a `Policy` on a resource.\n\nIf no `Policy` is set on the resource, a `Policy` is returned with default\nvalues including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The\n`etag` value can be used with `SetOrgPolicy()` to create or update a\n`Policy` during read-modify-write.",
- "request": {
- "$ref": "GetOrgPolicyRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "OrgPolicy"
- },
- "parameters": {
- "resource": {
- "description": "Name of the resource the `Policy` is set on.",
- "type": "string",
- "required": true,
- "pattern": "^folders/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/folders/{foldersId}:getOrgPolicy"
- },
- "getEffectiveOrgPolicy": {
- "path": "v1/{+resource}:getEffectiveOrgPolicy",
- "id": "cloudresourcemanager.folders.getEffectiveOrgPolicy",
- "request": {
- "$ref": "GetEffectiveOrgPolicyRequest"
- },
- "description": "Gets the effective `Policy` on a resource. This is the result of merging\n`Policies` in the resource hierarchy. The returned `Policy` will not have\nan `etag`set because it is a computed `Policy` across multiple resources.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "OrgPolicy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "resource": {
- "description": "The name of the resource to start computing the effective `Policy`.",
- "type": "string",
- "required": true,
- "pattern": "^folders/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/folders/{foldersId}:getEffectiveOrgPolicy"
- },
- "clearOrgPolicy": {
- "flatPath": "v1/folders/{foldersId}:clearOrgPolicy",
- "id": "cloudresourcemanager.folders.clearOrgPolicy",
- "path": "v1/{+resource}:clearOrgPolicy",
- "request": {
- "$ref": "ClearOrgPolicyRequest"
- },
- "description": "Clears a `Policy` from a resource.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "location": "path",
- "description": "Name of the resource for the `Policy` to clear.",
- "type": "string",
- "required": true,
- "pattern": "^folders/[^/]+$"
- }
- }
- },
- "setOrgPolicy": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "OrgPolicy"
- },
- "parameters": {
- "resource": {
- "type": "string",
- "required": true,
- "pattern": "^folders/[^/]+$",
- "location": "path",
- "description": "Resource name of the resource to attach the `Policy`."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/folders/{foldersId}:setOrgPolicy",
- "path": "v1/{+resource}:setOrgPolicy",
- "id": "cloudresourcemanager.folders.setOrgPolicy",
- "description": "Updates the specified `Policy` on the resource. Creates a new `Policy` for\nthat `Constraint` on the resource if one does not exist.\n\nNot supplying an `etag` on the request `Policy` results in an unconditional\nwrite of the `Policy`.",
- "request": {
- "$ref": "SetOrgPolicyRequest"
- }
- }
- }
- },
- "projects": {
- "methods": {
- "get": {
- "description": "Retrieves the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project.",
- "httpMethod": "GET",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "Project"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/projects/{projectId}",
- "path": "v1/projects/{projectId}",
- "id": "cloudresourcemanager.projects.get"
- },
- "getAncestry": {
- "flatPath": "v1/projects/{projectId}:getAncestry",
- "id": "cloudresourcemanager.projects.getAncestry",
- "path": "v1/projects/{projectId}:getAncestry",
- "request": {
- "$ref": "GetAncestryRequest"
- },
- "description": "Gets a list of ancestors in the resource hierarchy for the Project\nidentified by the specified `project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project.",
- "response": {
- "$ref": "GetAncestryResponse"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
- "type": "string",
- "required": true
- }
- }
- },
- "testIamPermissions": {
- "path": "v1/projects/{resource}:testIamPermissions",
- "id": "cloudresourcemanager.projects.testIamPermissions",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified Project.\n\nThere are no permissions required for making this API call.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{resource}:testIamPermissions"
- },
- "delete": {
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Project ID (for example, `foo-bar-123`).\n\nRequired.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}",
- "path": "v1/projects/{projectId}",
- "id": "cloudresourcemanager.projects.delete",
- "description": "Marks the Project identified by the specified\n`project_id` (for example, `my-project-123`) for deletion.\nThis method will only affect the Project if the following criteria are met:\n\n+ The Project does not have a billing account associated with it.\n+ The Project has a lifecycle state of\nACTIVE.\n\nThis method changes the Project's lifecycle state from\nACTIVE\nto DELETE_REQUESTED.\nThe deletion starts at an unspecified time,\nat which point the Project is no longer accessible.\n\nUntil the deletion completes, you can check the lifecycle state\nchecked by retrieving the Project with GetProject,\nand the Project remains visible to ListProjects.\nHowever, you cannot update the project.\n\nAfter the deletion completes, the Project is not retrievable by\nthe GetProject and\nListProjects methods.\n\nThe caller must have modify permissions for this Project.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "Empty"
- }
- },
- "clearOrgPolicy": {
- "request": {
- "$ref": "ClearOrgPolicyRequest"
- },
- "description": "Clears a `Policy` from a resource.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "description": "Name of the resource for the `Policy` to clear.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}:clearOrgPolicy",
- "id": "cloudresourcemanager.projects.clearOrgPolicy",
- "path": "v1/{+resource}:clearOrgPolicy"
- },
- "setIamPolicy": {
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the IAM access control policy for the specified Project. Replaces\nany existing policy.\n\nThe following constraints apply when using `setIamPolicy()`:\n\n+ Project does not support `allUsers` and `allAuthenticatedUsers` as\n`members` in a `Binding` of a `Policy`.\n\n+ The owner role can be granted only to `user` and `serviceAccount`.\n\n+ Service accounts can be made owners of a project directly\nwithout any restrictions. However, to be added as an owner, a user must be\ninvited via Cloud Platform console and must accept the invitation.\n\n+ A user cannot be granted the owner role using `setIamPolicy()`. The user\nmust be granted the owner role using the Cloud Platform Console and must\nexplicitly accept the invitation.\n\n+ Invitations to grant the owner role cannot be sent using\n`setIamPolicy()`;\nthey must be sent only using the Cloud Platform Console.\n\n+ Membership changes that leave the project without any owners that have\naccepted the Terms of Service (ToS) will be rejected.\n\n+ If the project is not part of an organization, there must be at least\none owner who has accepted the Terms of Service (ToS) agreement in the\npolicy. Calling `setIamPolicy()` to remove the last ToS-accepted owner\nfrom the policy will fail. This restriction also applies to legacy\nprojects that no longer have owners who have accepted the ToS. Edits to\nIAM policies will be rejected until the lack of a ToS-accepting owner is\nrectified.\n\n+ Calling this method requires enabling the App Engine Admin API.\n\nNote: Removing service accounts from policies or changing their roles\ncan render services completely inoperable. It is important to understand\nhow the service account is being used before removing or updating its\nroles.\n\nAuthorization requires the Google IAM permission\n`resourcemanager.projects.setIamPolicy` on the project",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/projects/{resource}:setIamPolicy",
- "id": "cloudresourcemanager.projects.setIamPolicy",
- "path": "v1/projects/{resource}:setIamPolicy"
- },
- "listAvailableOrgPolicyConstraints": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "resource": {
- "location": "path",
- "description": "Name of the resource to list `Constraints` for.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}:listAvailableOrgPolicyConstraints",
- "path": "v1/{+resource}:listAvailableOrgPolicyConstraints",
- "id": "cloudresourcemanager.projects.listAvailableOrgPolicyConstraints",
- "request": {
- "$ref": "ListAvailableOrgPolicyConstraintsRequest"
- },
- "description": "Lists `Constraints` that could be applied on the specified resource.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "ListAvailableOrgPolicyConstraintsResponse"
- }
- },
- "getIamPolicy": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects/{resource}:getIamPolicy",
- "path": "v1/projects/{resource}:getIamPolicy",
- "id": "cloudresourcemanager.projects.getIamPolicy",
- "description": "Returns the IAM access control policy for the specified Project.\nPermission is denied if the policy or the resource does not exist.\n\nAuthorization requires the Google IAM permission\n`resourcemanager.projects.getIamPolicy` on the project",
- "request": {
- "$ref": "GetIamPolicyRequest"
- }
- },
- "getOrgPolicy": {
- "request": {
- "$ref": "GetOrgPolicyRequest"
- },
- "description": "Gets a `Policy` on a resource.\n\nIf no `Policy` is set on the resource, a `Policy` is returned with default\nvalues including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The\n`etag` value can be used with `SetOrgPolicy()` to create or update a\n`Policy` during read-modify-write.",
- "response": {
- "$ref": "OrgPolicy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Name of the resource the `Policy` is set on.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/projects/{projectsId}:getOrgPolicy",
- "id": "cloudresourcemanager.projects.getOrgPolicy",
- "path": "v1/{+resource}:getOrgPolicy"
- },
- "undelete": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The project ID (for example, `foo-bar-123`).\n\nRequired.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/projects/{projectId}:undelete",
- "id": "cloudresourcemanager.projects.undelete",
- "path": "v1/projects/{projectId}:undelete",
- "request": {
- "$ref": "UndeleteProjectRequest"
- },
- "description": "Restores the Project identified by the specified\n`project_id` (for example, `my-project-123`).\nYou can only use this method for a Project that has a lifecycle state of\nDELETE_REQUESTED.\nAfter deletion starts, the Project cannot be restored.\n\nThe caller must have modify permissions for this Project.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST"
- },
- "getEffectiveOrgPolicy": {
- "path": "v1/{+resource}:getEffectiveOrgPolicy",
- "id": "cloudresourcemanager.projects.getEffectiveOrgPolicy",
- "request": {
- "$ref": "GetEffectiveOrgPolicyRequest"
- },
- "description": "Gets the effective `Policy` on a resource. This is the result of merging\n`Policies` in the resource hierarchy. The returned `Policy` will not have\nan `etag`set because it is a computed `Policy` across multiple resources.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "OrgPolicy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The name of the resource to start computing the effective `Policy`.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/projects/{projectsId}:getEffectiveOrgPolicy"
- },
- "update": {
- "httpMethod": "PUT",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "Project"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The project ID (for example, `my-project-123`).\n\nRequired."
- }
- },
- "flatPath": "v1/projects/{projectId}",
- "path": "v1/projects/{projectId}",
- "id": "cloudresourcemanager.projects.update",
- "request": {
- "$ref": "Project"
- },
- "description": "Updates the attributes of the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have modify permissions for this Project."
- },
- "list": {
- "path": "v1/projects",
- "id": "cloudresourcemanager.projects.list",
- "description": "Lists Projects that are visible to the user and satisfy the\nspecified filter. This method returns Projects in an unspecified order.\nNew Projects do not necessarily appear at the end of the list.",
- "httpMethod": "GET",
- "parameterOrder": [],
- "response": {
- "$ref": "ListProjectsResponse"
- },
- "parameters": {
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "A pagination token returned from a previous call to ListProjects\nthat indicates from where listing should continue.\n\nOptional."
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The maximum number of Projects to return in the response.\nThe server can return fewer Projects than requested.\nIf unspecified, server picks an appropriate default.\n\nOptional.",
- "type": "integer"
- },
- "filter": {
- "location": "query",
- "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n+ `name`\n+ `id`\n+ \u003ccode\u003elabels.\u003cem\u003ekey\u003c/em\u003e\u003c/code\u003e where *key* is the name of a label\n\nSome examples of using labels as filters:\n\n|Filter|Description|\n|------|-----------|\n|name:how*|The project's name starts with \"how\".|\n|name:Howl|The project's name is `Howl` or `howl`.|\n|name:HOWL|Equivalent to above.|\n|NAME:howl|Equivalent to above.|\n|labels.color:*|The project has the label `color`.|\n|labels.color:red|The project's label `color` has the value `red`.|\n|labels.color:red labels.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`.\n\nIf you specify a filter that has both `parent.type` and `parent.id`, then\nthe `resourcemanager.projects.list` permission is checked on the parent.\nIf the user has this permission, all projects under the parent will be\nreturned after remaining filters have been applied. If the user lacks this\npermission, then all projects for which the user has the\n`resourcemanager.projects.get` permission will be returned after remaining\nfilters have been applied. If no filter is specified, the call will return\nprojects for which the user has `resourcemanager.projects.get` permissions.\n\nOptional.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects"
- },
- "setOrgPolicy": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "OrgPolicy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Resource name of the resource to attach the `Policy`.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/projects/{projectsId}:setOrgPolicy",
- "path": "v1/{+resource}:setOrgPolicy",
- "id": "cloudresourcemanager.projects.setOrgPolicy",
- "request": {
- "$ref": "SetOrgPolicyRequest"
- },
- "description": "Updates the specified `Policy` on the resource. Creates a new `Policy` for\nthat `Constraint` on the resource if one does not exist.\n\nNot supplying an `etag` on the request `Policy` results in an unconditional\nwrite of the `Policy`."
- },
- "create": {
- "request": {
- "$ref": "Project"
- },
- "description": "Request that a new Project be created. The result is an Operation which\ncan be used to track the creation process. It is automatically deleted\nafter a few hours, so there is no need to call DeleteOperation.\n\nOur SLO permits Project creation to take up to 30 seconds at the 90th\npercentile. As of 2016-08-29, we are observing 6 seconds 50th percentile\nlatency. 95th percentile latency is around 11 seconds. We recommend\npolling at the 5th second with an exponential backoff.\n\nAuthorization requires the Google IAM permission\n`resourcemanager.projects.create` on the specified parent for the new\nproject.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v1/projects",
- "path": "v1/projects",
- "id": "cloudresourcemanager.projects.create"
- },
- "listOrgPolicies": {
- "parameters": {
- "resource": {
- "description": "Name of the resource to list Policies for.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects/{projectsId}:listOrgPolicies",
- "id": "cloudresourcemanager.projects.listOrgPolicies",
- "path": "v1/{+resource}:listOrgPolicies",
- "description": "Lists all the `Policies` set for a particular resource.",
- "request": {
- "$ref": "ListOrgPoliciesRequest"
- },
- "response": {
- "$ref": "ListOrgPoliciesResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST"
- }
- }
- },
- "organizations": {
- "methods": {
- "clearOrgPolicy": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+$",
- "location": "path",
- "description": "Name of the resource for the `Policy` to clear."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/organizations/{organizationsId}:clearOrgPolicy",
- "id": "cloudresourcemanager.organizations.clearOrgPolicy",
- "path": "v1/{+resource}:clearOrgPolicy",
- "description": "Clears a `Policy` from a resource.",
- "request": {
- "$ref": "ClearOrgPolicyRequest"
- }
- },
- "setOrgPolicy": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "OrgPolicy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "pattern": "^organizations/[^/]+$",
- "location": "path",
- "description": "Resource name of the resource to attach the `Policy`.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/organizations/{organizationsId}:setOrgPolicy",
- "path": "v1/{+resource}:setOrgPolicy",
- "id": "cloudresourcemanager.organizations.setOrgPolicy",
- "request": {
- "$ref": "SetOrgPolicyRequest"
- },
- "description": "Updates the specified `Policy` on the resource. Creates a new `Policy` for\nthat `Constraint` on the resource if one does not exist.\n\nNot supplying an `etag` on the request `Policy` results in an unconditional\nwrite of the `Policy`."
- },
- "setIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/organizations/{organizationsId}:setIamPolicy",
- "id": "cloudresourcemanager.organizations.setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on an Organization resource. Replaces any\nexisting policy. The `resource` field should be the organization's resource\nname, e.g. \"organizations/123\".\n\nAuthorization requires the Google IAM permission\n`resourcemanager.organizations.setIamPolicy` on the specified organization"
- },
- "listAvailableOrgPolicyConstraints": {
- "response": {
- "$ref": "ListAvailableOrgPolicyConstraintsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "resource": {
- "location": "path",
- "description": "Name of the resource to list `Constraints` for.",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+$"
- }
- },
- "flatPath": "v1/organizations/{organizationsId}:listAvailableOrgPolicyConstraints",
- "id": "cloudresourcemanager.organizations.listAvailableOrgPolicyConstraints",
- "path": "v1/{+resource}:listAvailableOrgPolicyConstraints",
- "request": {
- "$ref": "ListAvailableOrgPolicyConstraintsRequest"
- },
- "description": "Lists `Constraints` that could be applied on the specified resource."
- },
- "listOrgPolicies": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "ListOrgPoliciesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "resource": {
- "location": "path",
- "description": "Name of the resource to list Policies for.",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+$"
- }
- },
- "flatPath": "v1/organizations/{organizationsId}:listOrgPolicies",
- "path": "v1/{+resource}:listOrgPolicies",
- "id": "cloudresourcemanager.organizations.listOrgPolicies",
- "request": {
- "$ref": "ListOrgPoliciesRequest"
- },
- "description": "Lists all the `Policies` set for a particular resource."
- },
- "getIamPolicy": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+$"
- }
- },
- "flatPath": "v1/organizations/{organizationsId}:getIamPolicy",
- "id": "cloudresourcemanager.organizations.getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "request": {
- "$ref": "GetIamPolicyRequest"
- },
- "description": "Gets the access control policy for an Organization resource. May be empty\nif no such policy or resource exists. The `resource` field should be the\norganization's resource name, e.g. \"organizations/123\".\n\nAuthorization requires the Google IAM permission\n`resourcemanager.organizations.getIamPolicy` on the specified organization",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST"
- },
- "search": {
- "request": {
- "$ref": "SearchOrganizationsRequest"
- },
- "description": "Searches Organization resources that are visible to the user and satisfy\nthe specified filter. This method returns Organizations in an unspecified\norder. New Organizations do not necessarily appear at the end of the\nresults.\n\nSearch will only return organizations on which the user has the permission\n`resourcemanager.organizations.get`",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "SearchOrganizationsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {},
- "flatPath": "v1/organizations:search",
- "path": "v1/organizations:search",
- "id": "cloudresourcemanager.organizations.search"
- },
- "getOrgPolicy": {
- "path": "v1/{+resource}:getOrgPolicy",
- "id": "cloudresourcemanager.organizations.getOrgPolicy",
- "description": "Gets a `Policy` on a resource.\n\nIf no `Policy` is set on the resource, a `Policy` is returned with default\nvalues including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The\n`etag` value can be used with `SetOrgPolicy()` to create or update a\n`Policy` during read-modify-write.",
- "request": {
- "$ref": "GetOrgPolicyRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "OrgPolicy"
- },
- "parameters": {
- "resource": {
- "pattern": "^organizations/[^/]+$",
- "location": "path",
- "description": "Name of the resource the `Policy` is set on.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/organizations/{organizationsId}:getOrgPolicy"
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "Organization"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+$",
- "location": "path",
- "description": "The resource name of the Organization to fetch, e.g. \"organizations/1234\"."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/organizations/{organizationsId}",
- "path": "v1/{+name}",
- "id": "cloudresourcemanager.organizations.get",
- "description": "Fetches an Organization resource identified by the specified resource name."
- },
- "getEffectiveOrgPolicy": {
- "request": {
- "$ref": "GetEffectiveOrgPolicyRequest"
- },
- "description": "Gets the effective `Policy` on a resource. This is the result of merging\n`Policies` in the resource hierarchy. The returned `Policy` will not have\nan `etag`set because it is a computed `Policy` across multiple resources.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "OrgPolicy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "resource": {
- "description": "The name of the resource to start computing the effective `Policy`.",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/organizations/{organizationsId}:getEffectiveOrgPolicy",
- "path": "v1/{+resource}:getEffectiveOrgPolicy",
- "id": "cloudresourcemanager.organizations.getEffectiveOrgPolicy"
- },
- "testIamPermissions": {
- "description": "Returns permissions that a caller has on the specified Organization.\nThe `resource` field should be the organization's resource name,\ne.g. \"organizations/123\".\n\nThere are no permissions required for making this API call.",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/organizations/{organizationsId}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "id": "cloudresourcemanager.organizations.testIamPermissions"
- }
- }
- },
- "operations": {
- "methods": {
- "get": {
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "name": {
- "description": "The name of the operation resource.",
- "type": "string",
- "required": true,
- "pattern": "^operations/.+$",
- "location": "path"
- }
- },
- "flatPath": "v1/operations/{operationsId}",
- "id": "cloudresourcemanager.operations.get",
- "path": "v1/{+name}",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
- }
- }
- },
- "liens": {
- "methods": {
- "list": {
- "path": "v1/liens",
- "id": "cloudresourcemanager.liens.list",
- "description": "List all Liens applied to the `parent` resource.\n\nCallers of this method will require permission on the `parent` resource.\nFor example, a Lien with a `parent` of `projects/1234` requires permission\n`resourcemanager.projects.get`.",
- "httpMethod": "GET",
- "parameterOrder": [],
- "response": {
- "$ref": "ListLiensResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "pageToken": {
- "description": "The `next_page_token` value returned from a previous List request, if any.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The maximum number of items to return. This is a suggestion for the server.",
- "type": "integer"
- },
- "parent": {
- "location": "query",
- "description": "The name of the resource to list all attached Liens.\nFor example, `projects/1234`.",
- "type": "string"
- }
- },
- "flatPath": "v1/liens"
- },
- "create": {
- "request": {
- "$ref": "Lien"
- },
- "description": "Create a Lien which applies to the resource denoted by the `parent` field.\n\nCallers of this method will require permission on the `parent` resource.\nFor example, applying to `projects/1234` requires permission\n`resourcemanager.projects.updateLiens`.\n\nNOTE: Some resources may limit the number of Liens which may be applied.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Lien"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {},
- "flatPath": "v1/liens",
- "path": "v1/liens",
- "id": "cloudresourcemanager.liens.create"
- },
- "delete": {
- "path": "v1/{+name}",
- "id": "cloudresourcemanager.liens.delete",
- "description": "Delete a Lien by `name`.\n\nCallers of this method will require permission on the `parent` resource.\nFor example, a Lien with a `parent` of `projects/1234` requires permission\n`resourcemanager.projects.updateLiens`.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "name": {
- "pattern": "^liens/.+$",
- "location": "path",
- "description": "The name/identifier of the Lien to delete.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/liens/{liensId}"
- }
- }
- }
- },
- "parameters": {
- "key": {
- "type": "string",
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "upload_protocol": {
- "type": "string",
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "alt": {
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ]
- }
- }
+ "batchPath": "batch"
}
diff --git a/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json b/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json
index 5608a13..c7f6c64 100644
--- a/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json
+++ b/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json
@@ -1,745 +1,8 @@
{
- "protocol": "rest",
- "icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
- "canonicalName": "Cloud Resource Manager",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform.read-only": {
- "description": "View your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "rootUrl": "https://cloudresourcemanager.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "cloudresourcemanager",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Google Cloud Resource Manager API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "methods": {
- "get": {
- "parameters": {
- "projectId": {
- "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta1/projects/{projectId}",
- "id": "cloudresourcemanager.projects.get",
- "path": "v1beta1/projects/{projectId}",
- "description": "Retrieves the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project.",
- "response": {
- "$ref": "Project"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "GET"
- },
- "undelete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The project ID (for example, `foo-bar-123`).\n\nRequired.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectId}:undelete",
- "id": "cloudresourcemanager.projects.undelete",
- "path": "v1beta1/projects/{projectId}:undelete",
- "description": "Restores the Project identified by the specified\n`project_id` (for example, `my-project-123`).\nYou can only use this method for a Project that has a lifecycle state of\nDELETE_REQUESTED.\nAfter deletion starts, the Project cannot be restored.\n\nThe caller must have modify permissions for this Project.",
- "request": {
- "$ref": "UndeleteProjectRequest"
- }
- },
- "getAncestry": {
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "GetAncestryResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta1/projects/{projectId}:getAncestry",
- "path": "v1beta1/projects/{projectId}:getAncestry",
- "id": "cloudresourcemanager.projects.getAncestry",
- "request": {
- "$ref": "GetAncestryRequest"
- },
- "description": "Gets a list of ancestors in the resource hierarchy for the Project\nidentified by the specified `project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project."
- },
- "update": {
- "httpMethod": "PUT",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "Project"
- },
- "parameters": {
- "projectId": {
- "description": "The project ID (for example, `my-project-123`).\n\nRequired.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectId}",
- "path": "v1beta1/projects/{projectId}",
- "id": "cloudresourcemanager.projects.update",
- "description": "Updates the attributes of the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have modify permissions for this Project.",
- "request": {
- "$ref": "Project"
- }
- },
- "testIamPermissions": {
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta1/projects/{resource}:testIamPermissions",
- "id": "cloudresourcemanager.projects.testIamPermissions",
- "path": "v1beta1/projects/{resource}:testIamPermissions",
- "description": "Returns permissions that a caller has on the specified Project.",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST"
- },
- "delete": {
- "description": "Marks the Project identified by the specified\n`project_id` (for example, `my-project-123`) for deletion.\nThis method will only affect the Project if the following criteria are met:\n\n+ The Project does not have a billing account associated with it.\n+ The Project has a lifecycle state of\nACTIVE.\n\nThis method changes the Project's lifecycle state from\nACTIVE\nto DELETE_REQUESTED.\nThe deletion starts at an unspecified time, at which point the project is\nno longer accessible.\n\nUntil the deletion completes, you can check the lifecycle state\nchecked by retrieving the Project with GetProject,\nand the Project remains visible to ListProjects.\nHowever, you cannot update the project.\n\nAfter the deletion completes, the Project is not retrievable by\nthe GetProject and\nListProjects methods.\n\nThe caller must have modify permissions for this Project.",
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Project ID (for example, `foo-bar-123`).\n\nRequired.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta1/projects/{projectId}",
- "id": "cloudresourcemanager.projects.delete",
- "path": "v1beta1/projects/{projectId}"
- },
- "list": {
- "description": "Lists Projects that are visible to the user and satisfy the\nspecified filter. This method returns Projects in an unspecified order.\nNew Projects do not necessarily appear at the end of the list.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListProjectsResponse"
- },
- "parameterOrder": [],
- "parameters": {
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "A pagination token returned from a previous call to ListProjects\nthat indicates from where listing should continue.\n\nOptional."
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The maximum number of Projects to return in the response.\nThe server can return fewer Projects than requested.\nIf unspecified, server picks an appropriate default.\n\nOptional.",
- "type": "integer"
- },
- "filter": {
- "location": "query",
- "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n+ `name`\n+ `id`\n+ \u003ccode\u003elabels.\u003cem\u003ekey\u003c/em\u003e\u003c/code\u003e where *key* is the name of a label\n\nSome examples of using labels as filters:\n\n|Filter|Description|\n|------|-----------|\n|name:how*|The project's name starts with \"how\".|\n|name:Howl|The project's name is `Howl` or `howl`.|\n|name:HOWL|Equivalent to above.|\n|NAME:howl|Equivalent to above.|\n|labels.color:*|The project has the label `color`.|\n|labels.color:red|The project's label `color` has the value `red`.|\n|labels.color:red labels.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`.\n\nIf you specify a filter that has both `parent.type` and `parent.id`, then\nthe `resourcemanager.projects.list` permission is checked on the parent.\nIf the user has this permission, all projects under the parent will be\nreturned after remaining filters have been applied. If the user lacks this\npermission, then all projects for which the user has the\n`resourcemanager.projects.get` permission will be returned after remaining\nfilters have been applied. If no filter is specified, the call will return\nprojects for which the user has `resourcemanager.projects.get` permissions.\n\nOptional.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta1/projects",
- "path": "v1beta1/projects",
- "id": "cloudresourcemanager.projects.list"
- },
- "setIamPolicy": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{resource}:setIamPolicy",
- "path": "v1beta1/projects/{resource}:setIamPolicy",
- "id": "cloudresourcemanager.projects.setIamPolicy",
- "description": "Sets the IAM access control policy for the specified Project. Replaces\nany existing policy.\n\nThe following constraints apply when using `setIamPolicy()`:\n\n+ Project does not support `allUsers` and `allAuthenticatedUsers` as\n`members` in a `Binding` of a `Policy`.\n\n+ The owner role can be granted only to `user` and `serviceAccount`.\n\n+ Service accounts can be made owners of a project directly\nwithout any restrictions. However, to be added as an owner, a user must be\ninvited via Cloud Platform console and must accept the invitation.\n\n+ A user cannot be granted the owner role using `setIamPolicy()`. The user\nmust be granted the owner role using the Cloud Platform Console and must\nexplicitly accept the invitation.\n\n+ Invitations to grant the owner role cannot be sent using\n`setIamPolicy()`; they must be sent only using the Cloud Platform Console.\n\n+ Membership changes that leave the project without any owners that have\naccepted the Terms of Service (ToS) will be rejected.\n\n+ If the project is not part of an organization, there must be at least\none owner who has accepted the Terms of Service (ToS) agreement in the\npolicy. Calling `setIamPolicy()` to remove the last ToS-accepted owner\nfrom the policy will fail. This restriction also applies to legacy\nprojects that no longer have owners who have accepted the ToS. Edits to\nIAM policies will be rejected until the lack of a ToS-accepting owner is\nrectified.\n\n+ Calling this method requires enabling the App Engine Admin API.\n\nNote: Removing service accounts from policies or changing their roles\ncan render services completely inoperable. It is important to understand\nhow the service account is being used before removing or updating its\nroles.",
- "request": {
- "$ref": "SetIamPolicyRequest"
- }
- },
- "create": {
- "request": {
- "$ref": "Project"
- },
- "description": "Creates a Project resource.\n\nInitially, the Project resource is owned by its creator exclusively.\nThe creator can later grant permission to others to read or update the\nProject.\n\nSeveral APIs are activated automatically for the Project, including\nGoogle Cloud Storage.",
- "response": {
- "$ref": "Project"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "useLegacyStack": {
- "description": "A safety hatch to opt out of the new reliable project creation process.",
- "type": "boolean",
- "location": "query"
- }
- },
- "flatPath": "v1beta1/projects",
- "id": "cloudresourcemanager.projects.create",
- "path": "v1beta1/projects"
- },
- "getIamPolicy": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta1/projects/{resource}:getIamPolicy",
- "path": "v1beta1/projects/{resource}:getIamPolicy",
- "id": "cloudresourcemanager.projects.getIamPolicy",
- "request": {
- "$ref": "GetIamPolicyRequest"
- },
- "description": "Returns the IAM access control policy for the specified Project.\nPermission is denied if the policy or the resource does not exist."
- }
- }
- },
- "organizations": {
- "methods": {
- "getIamPolicy": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta1/organizations/{organizationsId}:getIamPolicy",
- "path": "v1beta1/{+resource}:getIamPolicy",
- "id": "cloudresourcemanager.organizations.getIamPolicy",
- "description": "Gets the access control policy for an Organization resource. May be empty\nif no such policy or resource exists. The `resource` field should be the\norganization's resource name, e.g. \"organizations/123\".",
- "request": {
- "$ref": "GetIamPolicyRequest"
- }
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "Organization"
- },
- "parameterOrder": [
- "name"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "organizationId": {
- "description": "The id of the Organization resource to fetch.\nThis field is deprecated and will be removed in v1. Use name instead.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "pattern": "^organizations/[^/]+$",
- "location": "path",
- "description": "The resource name of the Organization to fetch, e.g. \"organizations/1234\".",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta1/organizations/{organizationsId}",
- "path": "v1beta1/{+name}",
- "id": "cloudresourcemanager.organizations.get",
- "description": "Fetches an Organization resource identified by the specified resource name."
- },
- "update": {
- "request": {
- "$ref": "Organization"
- },
- "description": "Updates an Organization resource identified by the specified resource name.",
- "response": {
- "$ref": "Organization"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^organizations/[^/]+$",
- "location": "path",
- "description": "Output Only. The resource name of the organization. This is the\norganization's relative path in the API. Its format is\n\"organizations/[organization_id]\". For example, \"organizations/1234\".",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta1/organizations/{organizationsId}",
- "id": "cloudresourcemanager.organizations.update",
- "path": "v1beta1/{+name}"
- },
- "testIamPermissions": {
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified Organization.\nThe `resource` field should be the organization's resource name,\ne.g. \"organizations/123\".",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "resource": {
- "pattern": "^organizations/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta1/organizations/{organizationsId}:testIamPermissions",
- "path": "v1beta1/{+resource}:testIamPermissions",
- "id": "cloudresourcemanager.organizations.testIamPermissions"
- },
- "list": {
- "path": "v1beta1/organizations",
- "id": "cloudresourcemanager.organizations.list",
- "description": "Lists Organization resources that are visible to the user and satisfy\nthe specified filter. This method returns Organizations in an unspecified\norder. New Organizations do not necessarily appear at the end of the list.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListOrganizationsResponse"
- },
- "parameterOrder": [],
- "parameters": {
- "filter": {
- "description": "An optional query string used to filter the Organizations to return in\nthe response. Filter rules are case-insensitive.\n\n\nOrganizations may be filtered by `owner.directoryCustomerId` or by\n`domain`, where the domain is a Google for Work domain, for example:\n\n|Filter|Description|\n|------|-----------|\n|owner.directorycustomerid:123456789|Organizations with `owner.directory_customer_id` equal to `123456789`.|\n|domain:google.com|Organizations corresponding to the domain `google.com`.|\n\nThis field is optional.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "A pagination token returned from a previous call to `ListOrganizations`\nthat indicates from where listing should continue.\nThis field is optional."
- },
- "pageSize": {
- "format": "int32",
- "description": "The maximum number of Organizations to return in the response.\nThis field is optional.",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta1/organizations"
- },
- "setIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/organizations/{organizationsId}:setIamPolicy",
- "id": "cloudresourcemanager.organizations.setIamPolicy",
- "path": "v1beta1/{+resource}:setIamPolicy",
- "description": "Sets the access control policy on an Organization resource. Replaces any\nexisting policy. The `resource` field should be the organization's resource\nname, e.g. \"organizations/123\".",
- "request": {
- "$ref": "SetIamPolicyRequest"
- }
- }
- }
- }
- },
- "parameters": {
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- }
- },
- "version": "v1beta1",
- "baseUrl": "https://cloudresourcemanager.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.",
- "servicePath": "",
- "basePath": "",
- "id": "cloudresourcemanager:v1beta1",
- "documentationLink": "https://cloud.google.com/resource-manager",
- "revision": "20170927",
"discoveryVersion": "v1",
"schemas": {
- "TestIamPermissionsRequest": {
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "TestIamPermissionsRequest"
- },
- "FolderOperationError": {
- "properties": {
- "errorMessageId": {
- "description": "The type of operation error experienced.",
- "type": "string",
- "enumDescriptions": [
- "The error type was unrecognized or unspecified.",
- "The attempted action would violate the max folder depth constraint.",
- "The attempted action would violate the max child folders constraint.",
- "The attempted action would violate the locally-unique folder\ndisplay_name constraint.",
- "The resource being moved has been deleted.",
- "The resource a folder was being added to has been deleted.",
- "The attempted action would introduce cycle in resource path.",
- "The attempted action would move a folder that is already being moved.",
- "The folder the caller is trying to delete contains active resources.",
- "The attempted action would violate the max deleted folder depth\nconstraint."
- ],
- "enum": [
- "ERROR_TYPE_UNSPECIFIED",
- "ACTIVE_FOLDER_HEIGHT_VIOLATION",
- "MAX_CHILD_FOLDERS_VIOLATION",
- "FOLDER_NAME_UNIQUENESS_VIOLATION",
- "RESOURCE_DELETED_VIOLATION",
- "PARENT_DELETED_VIOLATION",
- "CYCLE_INTRODUCED_VIOLATION",
- "FOLDER_BEING_MOVED_VIOLATION",
- "FOLDER_TO_DELETE_NON_EMPTY_VIOLATION",
- "DELETED_FOLDER_HEIGHT_VIOLATION"
- ]
- }
- },
- "id": "FolderOperationError",
- "description": "A classification of the Folder Operation error.",
- "type": "object"
- },
- "FolderOperation": {
- "id": "FolderOperation",
- "description": "Metadata describing a long running folder operation",
- "type": "object",
- "properties": {
- "destinationParent": {
- "description": "The resource name of the folder or organization we are either creating\nthe folder under or moving the folder to.",
- "type": "string"
- },
- "operationType": {
- "description": "The type of this operation.",
- "type": "string",
- "enumDescriptions": [
- "Operation type not specified.",
- "A create folder operation.",
- "A move folder operation."
- ],
- "enum": [
- "OPERATION_TYPE_UNSPECIFIED",
- "CREATE",
- "MOVE"
- ]
- },
- "sourceParent": {
- "description": "The resource name of the folder's parent.\nOnly applicable when the operation_type is MOVE.",
- "type": "string"
- },
- "displayName": {
- "description": "The display name of the folder.",
- "type": "string"
- }
- }
- },
- "Policy": {
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "format": "byte",
- "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."
- },
- "version": {
- "format": "int32",
- "description": "Version of the `Policy`. The default version is 0.",
- "type": "integer"
- },
- "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"
- }
- },
- "id": "Policy"
- },
- "ResourceId": {
- "description": "A container to reference an id for any resource type. A `resource` in Google\nCloud Platform is a generic term for something you (a developer) may want to\ninteract with through one of our API's. Some examples are an App Engine app,\na Compute Engine instance, a Cloud SQL database, and so on.",
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "description": "Required field representing the resource type this id is for.\nAt present, the valid types are \"project\", \"folder\", and \"organization\"."
- },
- "id": {
- "description": "Required field for the type-specific id. This should correspond to the id\nused in the type-specific API's.",
- "type": "string"
- }
- },
- "id": "ResourceId"
- },
- "AuditConfig": {
- "id": "AuditConfig",
- "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
- "type": "object",
- "properties": {
- "service": {
- "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
- "type": "string"
- },
- "auditLogConfigs": {
- "description": "The configuration for logging of each type of permission.\nNext ID: 4",
- "items": {
- "$ref": "AuditLogConfig"
- },
- "type": "array"
- }
- }
- },
- "Ancestor": {
- "description": "Identifying information for a single ancestor of a project.",
- "type": "object",
- "properties": {
- "resourceId": {
- "$ref": "ResourceId",
- "description": "Resource id of the ancestor."
- }
- },
- "id": "Ancestor"
- },
"ListOrganizationsResponse": {
+ "description": "The response returned from the `ListOrganizations` method.",
"type": "object",
"properties": {
"nextPageToken": {
@@ -747,15 +10,14 @@
"type": "string"
},
"organizations": {
+ "description": "The list of Organizations that matched the list query, possibly paginated.",
"items": {
"$ref": "Organization"
},
- "type": "array",
- "description": "The list of Organizations that matched the list query, possibly paginated."
+ "type": "array"
}
},
- "id": "ListOrganizationsResponse",
- "description": "The response returned from the `ListOrganizations` method."
+ "id": "ListOrganizationsResponse"
},
"SetIamPolicyRequest": {
"description": "Request message for `SetIamPolicy` method.",
@@ -767,8 +29,8 @@
"type": "string"
},
"policy": {
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.",
- "$ref": "Policy"
+ "$ref": "Policy",
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
}
},
"id": "SetIamPolicyRequest"
@@ -804,27 +66,10 @@
"id": "UndeleteProjectRequest"
},
"Organization": {
+ "description": "The root node in the resource hierarchy to which a particular entity's\n(e.g., company) resources belong.",
"type": "object",
"properties": {
- "creationTime": {
- "type": "string",
- "format": "google-datetime",
- "description": "Timestamp when the Organization was created. Assigned by the server.\n@OutputOnly"
- },
- "owner": {
- "description": "The owner of this Organization. The owner should be specified on\ncreation. Once set, it cannot be changed.\nThis field is required.",
- "$ref": "OrganizationOwner"
- },
- "name": {
- "type": "string",
- "description": "Output Only. The resource name of the organization. This is the\norganization's relative path in the API. Its format is\n\"organizations/[organization_id]\". For example, \"organizations/1234\"."
- },
- "organizationId": {
- "type": "string",
- "description": "An immutable id for the Organization that is assigned on creation. This\nshould be omitted when creating a new Organization.\nThis field is read-only.\nThis field is deprecated and will be removed in v1. Use name instead."
- },
"lifecycleState": {
- "type": "string",
"enumDescriptions": [
"Unspecified state. This is only useful for distinguishing unset values.",
"The normal and active state.",
@@ -835,15 +80,32 @@
"ACTIVE",
"DELETE_REQUESTED"
],
- "description": "The organization's current lifecycle state. Assigned by the server.\n@OutputOnly"
+ "description": "The organization's current lifecycle state. Assigned by the server.\n@OutputOnly",
+ "type": "string"
},
"displayName": {
"description": "A friendly string to be used to refer to the Organization in the UI.\nAssigned by the server, set to the primary domain of the G Suite\ncustomer that owns the organization.\n@OutputOnly",
"type": "string"
+ },
+ "creationTime": {
+ "format": "google-datetime",
+ "description": "Timestamp when the Organization was created. Assigned by the server.\n@OutputOnly",
+ "type": "string"
+ },
+ "owner": {
+ "$ref": "OrganizationOwner",
+ "description": "The owner of this Organization. The owner should be specified on\ncreation. Once set, it cannot be changed.\nThis field is required."
+ },
+ "name": {
+ "description": "Output Only. The resource name of the organization. This is the\norganization's relative path in the API. Its format is\n\"organizations/[organization_id]\". For example, \"organizations/1234\".",
+ "type": "string"
+ },
+ "organizationId": {
+ "description": "An immutable id for the Organization that is assigned on creation. This\nshould be omitted when creating a new Organization.\nThis field is read-only.\nThis field is deprecated and will be removed in v1. Use name instead.",
+ "type": "string"
}
},
- "id": "Organization",
- "description": "The root node in the resource hierarchy to which a particular entity's\n(e.g., company) resources belong."
+ "id": "Organization"
},
"ProjectCreationStatus": {
"description": "A status object which is used as the `metadata` field for the Operation\nreturned by CreateProject. It provides insight for when significant phases of\nProject creation have completed.",
@@ -865,6 +127,12 @@
},
"id": "ProjectCreationStatus"
},
+ "GetIamPolicyRequest": {
+ "description": "Request message for `GetIamPolicy` method.",
+ "type": "object",
+ "properties": {},
+ "id": "GetIamPolicyRequest"
+ },
"TestIamPermissionsResponse": {
"description": "Response message for `TestIamPermissions` method.",
"type": "object",
@@ -879,36 +147,60 @@
},
"id": "TestIamPermissionsResponse"
},
- "GetIamPolicyRequest": {
- "id": "GetIamPolicyRequest",
- "description": "Request message for `GetIamPolicy` method.",
- "type": "object",
- "properties": {}
- },
- "GetAncestryResponse": {
- "type": "object",
- "properties": {
- "ancestor": {
- "items": {
- "$ref": "Ancestor"
- },
- "type": "array",
- "description": "Ancestors are ordered from bottom to top of the resource hierarchy. The\nfirst ancestor is the project itself, followed by the project's parent,\netc."
- }
- },
- "id": "GetAncestryResponse",
- "description": "Response from the GetAncestry method."
- },
"OrganizationOwner": {
+ "description": "The entity that owns an Organization. The lifetime of the Organization and\nall of its descendants are bound to the `OrganizationOwner`. If the\n`OrganizationOwner` is deleted, the Organization and all its descendants will\nbe deleted.",
+ "type": "object",
"properties": {
"directoryCustomerId": {
"description": "The Google for Work customer id used in the Directory API.",
"type": "string"
}
},
- "id": "OrganizationOwner",
- "description": "The entity that owns an Organization. The lifetime of the Organization and\nall of its descendants are bound to the `OrganizationOwner`. If the\n`OrganizationOwner` is deleted, the Organization and all its descendants will\nbe deleted.",
- "type": "object"
+ "id": "OrganizationOwner"
+ },
+ "GetAncestryResponse": {
+ "description": "Response from the GetAncestry method.",
+ "type": "object",
+ "properties": {
+ "ancestor": {
+ "description": "Ancestors are ordered from bottom to top of the resource hierarchy. The\nfirst ancestor is the project itself, followed by the project's parent,\netc.",
+ "items": {
+ "$ref": "Ancestor"
+ },
+ "type": "array"
+ }
+ },
+ "id": "GetAncestryResponse"
+ },
+ "AuditLogConfig": {
+ "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
+ "type": "object",
+ "properties": {
+ "logType": {
+ "enumDescriptions": [
+ "Default case. Should never be this.",
+ "Admin reads. Example: CloudIAM getIamPolicy",
+ "Data writes. Example: CloudSQL Users create",
+ "Data reads. Example: CloudSQL Users list"
+ ],
+ "enum": [
+ "LOG_TYPE_UNSPECIFIED",
+ "ADMIN_READ",
+ "DATA_WRITE",
+ "DATA_READ"
+ ],
+ "description": "The log type that this config enables.",
+ "type": "string"
+ },
+ "exemptedMembers": {
+ "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "AuditLogConfig"
},
"ListProjectsResponse": {
"description": "A page of the response received from the\nListProjects\nmethod.\n\nA paginated response where more pages are available has\n`next_page_token` set. This token can be used in a subsequent request to\nretrieve the next request page.",
@@ -928,36 +220,6 @@
},
"id": "ListProjectsResponse"
},
- "AuditLogConfig": {
- "type": "object",
- "properties": {
- "exemptedMembers": {
- "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "logType": {
- "description": "The log type that this config enables.",
- "type": "string",
- "enumDescriptions": [
- "Default case. Should never be this.",
- "Admin reads. Example: CloudIAM getIamPolicy",
- "Data writes. Example: CloudSQL Users create",
- "Data reads. Example: CloudSQL Users list"
- ],
- "enum": [
- "LOG_TYPE_UNSPECIFIED",
- "ADMIN_READ",
- "DATA_WRITE",
- "DATA_READ"
- ]
- }
- },
- "id": "AuditLogConfig",
- "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging."
- },
"GetAncestryRequest": {
"description": "The request sent to the\nGetAncestry\nmethod.",
"type": "object",
@@ -969,6 +231,8 @@
"type": "object",
"properties": {
"lifecycleState": {
+ "description": "The Project lifecycle state.\n\nRead-only.",
+ "type": "string",
"enumDescriptions": [
"Unspecified state. This is only used/useful for distinguishing\nunset values.",
"The normal and active state.",
@@ -980,9 +244,7 @@
"ACTIVE",
"DELETE_REQUESTED",
"DELETE_IN_PROGRESS"
- ],
- "description": "The Project lifecycle state.\n\nRead-only.",
- "type": "string"
+ ]
},
"projectNumber": {
"format": "int64",
@@ -990,8 +252,8 @@
"type": "string"
},
"parent": {
- "$ref": "ResourceId",
- "description": "An optional reference to a parent Resource.\n\nThe only supported parent type is \"organization\". Once set, the parent\ncannot be modified. The `parent` can be set on creation or using the\n`UpdateProject` method; the end user must have the\n`resourcemanager.projects.create` permission on the parent.\n\nRead-write."
+ "description": "An optional reference to a parent Resource.\n\nThe only supported parent type is \"organization\". Once set, the parent\ncannot be modified. The `parent` can be set on creation or using the\n`UpdateProject` method; the end user must have the\n`resourcemanager.projects.create` permission on the parent.\n\nRead-write.",
+ "$ref": "ResourceId"
},
"labels": {
"additionalProperties": {
@@ -1015,6 +277,744 @@
}
},
"id": "Project"
+ },
+ "TestIamPermissionsRequest": {
+ "description": "Request message for `TestIamPermissions` method.",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "TestIamPermissionsRequest"
+ },
+ "Policy": {
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
+ "type": "object",
+ "properties": {
+ "etag": {
+ "format": "byte",
+ "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.",
+ "type": "string"
+ },
+ "version": {
+ "format": "int32",
+ "description": "Version of the `Policy`. The default version is 0.",
+ "type": "integer"
+ },
+ "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"
+ }
+ },
+ "id": "Policy"
+ },
+ "FolderOperation": {
+ "description": "Metadata describing a long running folder operation",
+ "type": "object",
+ "properties": {
+ "sourceParent": {
+ "description": "The resource name of the folder's parent.\nOnly applicable when the operation_type is MOVE.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "The display name of the folder.",
+ "type": "string"
+ },
+ "destinationParent": {
+ "description": "The resource name of the folder or organization we are either creating\nthe folder under or moving the folder to.",
+ "type": "string"
+ },
+ "operationType": {
+ "description": "The type of this operation.",
+ "type": "string",
+ "enumDescriptions": [
+ "Operation type not specified.",
+ "A create folder operation.",
+ "A move folder operation."
+ ],
+ "enum": [
+ "OPERATION_TYPE_UNSPECIFIED",
+ "CREATE",
+ "MOVE"
+ ]
+ }
+ },
+ "id": "FolderOperation"
+ },
+ "FolderOperationError": {
+ "description": "A classification of the Folder Operation error.",
+ "type": "object",
+ "properties": {
+ "errorMessageId": {
+ "description": "The type of operation error experienced.",
+ "type": "string",
+ "enumDescriptions": [
+ "The error type was unrecognized or unspecified.",
+ "The attempted action would violate the max folder depth constraint.",
+ "The attempted action would violate the max child folders constraint.",
+ "The attempted action would violate the locally-unique folder\ndisplay_name constraint.",
+ "The resource being moved has been deleted.",
+ "The resource a folder was being added to has been deleted.",
+ "The attempted action would introduce cycle in resource path.",
+ "The attempted action would move a folder that is already being moved.",
+ "The folder the caller is trying to delete contains active resources.",
+ "The attempted action would violate the max deleted folder depth\nconstraint."
+ ],
+ "enum": [
+ "ERROR_TYPE_UNSPECIFIED",
+ "ACTIVE_FOLDER_HEIGHT_VIOLATION",
+ "MAX_CHILD_FOLDERS_VIOLATION",
+ "FOLDER_NAME_UNIQUENESS_VIOLATION",
+ "RESOURCE_DELETED_VIOLATION",
+ "PARENT_DELETED_VIOLATION",
+ "CYCLE_INTRODUCED_VIOLATION",
+ "FOLDER_BEING_MOVED_VIOLATION",
+ "FOLDER_TO_DELETE_NON_EMPTY_VIOLATION",
+ "DELETED_FOLDER_HEIGHT_VIOLATION"
+ ]
+ }
+ },
+ "id": "FolderOperationError"
+ },
+ "ResourceId": {
+ "description": "A container to reference an id for any resource type. A `resource` in Google\nCloud Platform is a generic term for something you (a developer) may want to\ninteract with through one of our API's. Some examples are an App Engine app,\na Compute Engine instance, a Cloud SQL database, and so on.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "Required field representing the resource type this id is for.\nAt present, the valid types are \"project\", \"folder\", and \"organization\".",
+ "type": "string"
+ },
+ "id": {
+ "description": "Required field for the type-specific id. This should correspond to the id\nused in the type-specific API's.",
+ "type": "string"
+ }
+ },
+ "id": "ResourceId"
+ },
+ "AuditConfig": {
+ "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
+ "type": "object",
+ "properties": {
+ "service": {
+ "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
+ "type": "string"
+ },
+ "auditLogConfigs": {
+ "description": "The configuration for logging of each type of permission.\nNext ID: 4",
+ "items": {
+ "$ref": "AuditLogConfig"
+ },
+ "type": "array"
+ }
+ },
+ "id": "AuditConfig"
+ },
+ "Ancestor": {
+ "description": "Identifying information for a single ancestor of a project.",
+ "type": "object",
+ "properties": {
+ "resourceId": {
+ "description": "Resource id of the ancestor.",
+ "$ref": "ResourceId"
+ }
+ },
+ "id": "Ancestor"
}
- }
+ },
+ "protocol": "rest",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "canonicalName": "Cloud Resource Manager",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform.read-only": {
+ "description": "View your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://cloudresourcemanager.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "cloudresourcemanager",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Google Cloud Resource Manager API",
+ "ownerName": "Google",
+ "resources": {
+ "organizations": {
+ "methods": {
+ "list": {
+ "description": "Lists Organization resources that are visible to the user and satisfy\nthe specified filter. This method returns Organizations in an unspecified\norder. New Organizations do not necessarily appear at the end of the list.",
+ "response": {
+ "$ref": "ListOrganizationsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "The maximum number of Organizations to return in the response.\nThis field is optional.",
+ "type": "integer"
+ },
+ "filter": {
+ "location": "query",
+ "description": "An optional query string used to filter the Organizations to return in\nthe response. Filter rules are case-insensitive.\n\n\nOrganizations may be filtered by `owner.directoryCustomerId` or by\n`domain`, where the domain is a Google for Work domain, for example:\n\n|Filter|Description|\n|------|-----------|\n|owner.directorycustomerid:123456789|Organizations with `owner.directory_customer_id` equal to `123456789`.|\n|domain:google.com|Organizations corresponding to the domain `google.com`.|\n\nThis field is optional.",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "A pagination token returned from a previous call to `ListOrganizations`\nthat indicates from where listing should continue.\nThis field is optional.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/organizations",
+ "id": "cloudresourcemanager.organizations.list",
+ "path": "v1beta1/organizations"
+ },
+ "setIamPolicy": {
+ "flatPath": "v1beta1/organizations/{organizationsId}:setIamPolicy",
+ "id": "cloudresourcemanager.organizations.setIamPolicy",
+ "path": "v1beta1/{+resource}:setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on an Organization resource. Replaces any\nexisting policy. The `resource` field should be the organization's resource\nname, e.g. \"organizations/123\".",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
+ }
+ }
+ },
+ "getIamPolicy": {
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ },
+ "description": "Gets the access control policy for an Organization resource. May be empty\nif no such policy or resource exists. The `resource` field should be the\norganization's resource name, e.g. \"organizations/123\".",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta1/organizations/{organizationsId}:getIamPolicy",
+ "id": "cloudresourcemanager.organizations.getIamPolicy",
+ "path": "v1beta1/{+resource}:getIamPolicy"
+ },
+ "get": {
+ "description": "Fetches an Organization resource identified by the specified resource name.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Organization"
+ },
+ "parameters": {
+ "name": {
+ "description": "The resource name of the Organization to fetch, e.g. \"organizations/1234\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
+ },
+ "organizationId": {
+ "description": "The id of the Organization resource to fetch.\nThis field is deprecated and will be removed in v1. Use name instead.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta1/organizations/{organizationsId}",
+ "path": "v1beta1/{+name}",
+ "id": "cloudresourcemanager.organizations.get"
+ },
+ "update": {
+ "response": {
+ "$ref": "Organization"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Output Only. The resource name of the organization. This is the\norganization's relative path in the API. Its format is\n\"organizations/[organization_id]\". For example, \"organizations/1234\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta1/organizations/{organizationsId}",
+ "id": "cloudresourcemanager.organizations.update",
+ "path": "v1beta1/{+name}",
+ "request": {
+ "$ref": "Organization"
+ },
+ "description": "Updates an Organization resource identified by the specified resource name."
+ },
+ "testIamPermissions": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta1/organizations/{organizationsId}:testIamPermissions",
+ "path": "v1beta1/{+resource}:testIamPermissions",
+ "id": "cloudresourcemanager.organizations.testIamPermissions",
+ "description": "Returns permissions that a caller has on the specified Organization.\nThe `resource` field should be the organization's resource name,\ne.g. \"organizations/123\".",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ }
+ }
+ }
+ },
+ "projects": {
+ "methods": {
+ "undelete": {
+ "description": "Restores the Project identified by the specified\n`project_id` (for example, `my-project-123`).\nYou can only use this method for a Project that has a lifecycle state of\nDELETE_REQUESTED.\nAfter deletion starts, the Project cannot be restored.\n\nThe caller must have modify permissions for this Project.",
+ "request": {
+ "$ref": "UndeleteProjectRequest"
+ },
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "projectId": {
+ "description": "The project ID (for example, `foo-bar-123`).\n\nRequired.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}:undelete",
+ "id": "cloudresourcemanager.projects.undelete",
+ "path": "v1beta1/projects/{projectId}:undelete"
+ },
+ "get": {
+ "description": "Retrieves the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project.",
+ "response": {
+ "$ref": "Project"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}",
+ "id": "cloudresourcemanager.projects.get",
+ "path": "v1beta1/projects/{projectId}"
+ },
+ "getAncestry": {
+ "response": {
+ "$ref": "GetAncestryResponse"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}:getAncestry",
+ "id": "cloudresourcemanager.projects.getAncestry",
+ "path": "v1beta1/projects/{projectId}:getAncestry",
+ "request": {
+ "$ref": "GetAncestryRequest"
+ },
+ "description": "Gets a list of ancestors in the resource hierarchy for the Project\nidentified by the specified `project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project."
+ },
+ "update": {
+ "description": "Updates the attributes of the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have modify permissions for this Project.",
+ "request": {
+ "$ref": "Project"
+ },
+ "response": {
+ "$ref": "Project"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The project ID (for example, `my-project-123`).\n\nRequired.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}",
+ "id": "cloudresourcemanager.projects.update",
+ "path": "v1beta1/projects/{projectId}"
+ },
+ "testIamPermissions": {
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified Project.",
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{resource}:testIamPermissions",
+ "id": "cloudresourcemanager.projects.testIamPermissions",
+ "path": "v1beta1/projects/{resource}:testIamPermissions"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Project ID (for example, `foo-bar-123`).\n\nRequired.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}",
+ "id": "cloudresourcemanager.projects.delete",
+ "path": "v1beta1/projects/{projectId}",
+ "description": "Marks the Project identified by the specified\n`project_id` (for example, `my-project-123`) for deletion.\nThis method will only affect the Project if the following criteria are met:\n\n+ The Project does not have a billing account associated with it.\n+ The Project has a lifecycle state of\nACTIVE.\n\nThis method changes the Project's lifecycle state from\nACTIVE\nto DELETE_REQUESTED.\nThe deletion starts at an unspecified time, at which point the project is\nno longer accessible.\n\nUntil the deletion completes, you can check the lifecycle state\nchecked by retrieving the Project with GetProject,\nand the Project remains visible to ListProjects.\nHowever, you cannot update the project.\n\nAfter the deletion completes, the Project is not retrievable by\nthe GetProject and\nListProjects methods.\n\nThe caller must have modify permissions for this Project."
+ },
+ "list": {
+ "description": "Lists Projects that are visible to the user and satisfy the\nspecified filter. This method returns Projects in an unspecified order.\nNew Projects do not necessarily appear at the end of the list.",
+ "response": {
+ "$ref": "ListProjectsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "filter": {
+ "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n+ `name`\n+ `id`\n+ \u003ccode\u003elabels.\u003cem\u003ekey\u003c/em\u003e\u003c/code\u003e where *key* is the name of a label\n\nSome examples of using labels as filters:\n\n|Filter|Description|\n|------|-----------|\n|name:how*|The project's name starts with \"how\".|\n|name:Howl|The project's name is `Howl` or `howl`.|\n|name:HOWL|Equivalent to above.|\n|NAME:howl|Equivalent to above.|\n|labels.color:*|The project has the label `color`.|\n|labels.color:red|The project's label `color` has the value `red`.|\n|labels.color:red labels.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`.\n\nIf you specify a filter that has both `parent.type` and `parent.id`, then\nthe `resourcemanager.projects.list` permission is checked on the parent.\nIf the user has this permission, all projects under the parent will be\nreturned after remaining filters have been applied. If the user lacks this\npermission, then all projects for which the user has the\n`resourcemanager.projects.get` permission will be returned after remaining\nfilters have been applied. If no filter is specified, the call will return\nprojects for which the user has `resourcemanager.projects.get` permissions.\n\nOptional.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "description": "A pagination token returned from a previous call to ListProjects\nthat indicates from where listing should continue.\n\nOptional.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The maximum number of Projects to return in the response.\nThe server can return fewer Projects than requested.\nIf unspecified, server picks an appropriate default.\n\nOptional.",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta1/projects",
+ "id": "cloudresourcemanager.projects.list",
+ "path": "v1beta1/projects"
+ },
+ "setIamPolicy": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{resource}:setIamPolicy",
+ "path": "v1beta1/projects/{resource}:setIamPolicy",
+ "id": "cloudresourcemanager.projects.setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the IAM access control policy for the specified Project. Replaces\nany existing policy.\n\nThe following constraints apply when using `setIamPolicy()`:\n\n+ Project does not support `allUsers` and `allAuthenticatedUsers` as\n`members` in a `Binding` of a `Policy`.\n\n+ The owner role can be granted only to `user` and `serviceAccount`.\n\n+ Service accounts can be made owners of a project directly\nwithout any restrictions. However, to be added as an owner, a user must be\ninvited via Cloud Platform console and must accept the invitation.\n\n+ A user cannot be granted the owner role using `setIamPolicy()`. The user\nmust be granted the owner role using the Cloud Platform Console and must\nexplicitly accept the invitation.\n\n+ Invitations to grant the owner role cannot be sent using\n`setIamPolicy()`; they must be sent only using the Cloud Platform Console.\n\n+ Membership changes that leave the project without any owners that have\naccepted the Terms of Service (ToS) will be rejected.\n\n+ If the project is not part of an organization, there must be at least\none owner who has accepted the Terms of Service (ToS) agreement in the\npolicy. Calling `setIamPolicy()` to remove the last ToS-accepted owner\nfrom the policy will fail. This restriction also applies to legacy\nprojects that no longer have owners who have accepted the ToS. Edits to\nIAM policies will be rejected until the lack of a ToS-accepting owner is\nrectified.\n\n+ Calling this method requires enabling the App Engine Admin API.\n\nNote: Removing service accounts from policies or changing their roles\ncan render services completely inoperable. It is important to understand\nhow the service account is being used before removing or updating its\nroles."
+ },
+ "create": {
+ "request": {
+ "$ref": "Project"
+ },
+ "description": "Creates a Project resource.\n\nInitially, the Project resource is owned by its creator exclusively.\nThe creator can later grant permission to others to read or update the\nProject.\n\nSeveral APIs are activated automatically for the Project, including\nGoogle Cloud Storage.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Project"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "useLegacyStack": {
+ "description": "A safety hatch to opt out of the new reliable project creation process.",
+ "type": "boolean",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta1/projects",
+ "path": "v1beta1/projects",
+ "id": "cloudresourcemanager.projects.create"
+ },
+ "getIamPolicy": {
+ "description": "Returns the IAM access control policy for the specified Project.\nPermission is denied if the policy or the resource does not exist.",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ },
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta1/projects/{resource}:getIamPolicy",
+ "id": "cloudresourcemanager.projects.getIamPolicy",
+ "path": "v1beta1/projects/{resource}:getIamPolicy"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "alt": {
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query"
+ }
+ },
+ "version": "v1beta1",
+ "baseUrl": "https://cloudresourcemanager.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.",
+ "servicePath": "",
+ "basePath": "",
+ "id": "cloudresourcemanager:v1beta1",
+ "documentationLink": "https://cloud.google.com/resource-manager",
+ "revision": "20170927"
}
diff --git a/cloudresourcemanager/v2beta1/cloudresourcemanager-api.json b/cloudresourcemanager/v2beta1/cloudresourcemanager-api.json
index 1466823..66b6c31 100644
--- a/cloudresourcemanager/v2beta1/cloudresourcemanager-api.json
+++ b/cloudresourcemanager/v2beta1/cloudresourcemanager-api.json
@@ -1,14 +1,62 @@
{
- "kind": "discovery#restDescription",
- "description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.",
+ "version": "v2beta1",
+ "baseUrl": "https://cloudresourcemanager.googleapis.com/",
"servicePath": "",
+ "description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.",
+ "kind": "discovery#restDescription",
"basePath": "",
- "revision": "20170927",
- "documentationLink": "https://cloud.google.com/resource-manager",
"id": "cloudresourcemanager:v2beta1",
+ "documentationLink": "https://cloud.google.com/resource-manager",
+ "revision": "20170927",
"discoveryVersion": "v1",
"schemas": {
+ "ListFoldersResponse": {
+ "description": "The ListFolders response message.",
+ "type": "object",
+ "properties": {
+ "folders": {
+ "description": "A possibly paginated list of Folders that are direct descendants of\nthe specified parent resource.",
+ "items": {
+ "$ref": "Folder"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A pagination token returned from a previous call to `ListFolders`\nthat indicates from where listing should continue.\nThis field is optional.",
+ "type": "string"
+ }
+ },
+ "id": "ListFoldersResponse"
+ },
+ "MoveFolderRequest": {
+ "description": "The MoveFolder request message.",
+ "type": "object",
+ "properties": {
+ "destinationParent": {
+ "description": "The resource name of the Folder or Organization to reparent\nthe folder under.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.",
+ "type": "string"
+ }
+ },
+ "id": "MoveFolderRequest"
+ },
+ "SetIamPolicyRequest": {
+ "description": "Request message for `SetIamPolicy` method.",
+ "type": "object",
+ "properties": {
+ "policy": {
+ "$ref": "Policy",
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
+ },
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
+ "type": "string"
+ }
+ },
+ "id": "SetIamPolicyRequest"
+ },
"SearchFoldersResponse": {
+ "description": "The response message for searching folders.",
"type": "object",
"properties": {
"folders": {
@@ -23,31 +71,12 @@
"type": "string"
}
},
- "id": "SearchFoldersResponse",
- "description": "The response message for searching folders."
- },
- "SetIamPolicyRequest": {
- "description": "Request message for `SetIamPolicy` method.",
- "type": "object",
- "properties": {
- "updateMask": {
- "format": "google-fieldmask",
- "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
- "type": "string"
- },
- "policy": {
- "$ref": "Policy",
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
- }
- },
- "id": "SetIamPolicyRequest"
+ "id": "SearchFoldersResponse"
},
"Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
"properties": {
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
@@ -63,11 +92,13 @@
"format": "int32",
"description": "The status code, which should be an enum value of google.rpc.Code.",
"type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
}
},
- "id": "Status",
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object"
+ "id": "Status"
},
"Binding": {
"description": "Associates `members` with a `role`.",
@@ -88,6 +119,8 @@
"id": "Binding"
},
"SearchFoldersRequest": {
+ "description": "The request message for searching folders.",
+ "type": "object",
"properties": {
"pageToken": {
"description": "A pagination token returned from a previous call to `SearchFolders`\nthat indicates from where search should continue.\nThis field is optional.",
@@ -103,48 +136,20 @@
"type": "string"
}
},
- "id": "SearchFoldersRequest",
- "description": "The request message for searching folders.",
- "type": "object"
- },
- "ProjectCreationStatus": {
- "description": "A status object which is used as the `metadata` field for the Operation\nreturned by CreateProject. It provides insight for when significant phases of\nProject creation have completed.",
- "type": "object",
- "properties": {
- "ready": {
- "description": "True if the project creation process is complete.",
- "type": "boolean"
- },
- "gettable": {
- "description": "True if the project can be retrieved using GetProject. No other operations\non the project are guaranteed to work until the project creation is\ncomplete.",
- "type": "boolean"
- },
- "createTime": {
- "format": "google-datetime",
- "description": "Creation time of the project creation workflow.",
- "type": "string"
- }
- },
- "id": "ProjectCreationStatus"
+ "id": "SearchFoldersRequest"
},
"Folder": {
"description": "A Folder in an Organization's resource hierarchy, used to\norganize that Organization's resources.",
"type": "object",
"properties": {
- "displayName": {
- "description": "The folder’s display name.\nA folder’s display name must be unique amongst its siblings, e.g.\nno two folders with the same parent can share the same display name.\nThe display name must start and end with a letter or digit, may contain\nletters, digits, spaces, hyphens and underscores and can be no longer\nthan 30 characters. This is captured by the regular expression:\n[\\p{L}\\p{N}]({\\p{L}\\p{N}_- ]{0,28}[\\p{L}\\p{N}])?.",
- "type": "string"
- },
- "parent": {
- "description": "The Folder’s parent's resource name.\nUpdates to the folder's parent must be performed via [MoveFolders].",
- "type": "string"
- },
"createTime": {
- "type": "string",
"format": "google-datetime",
- "description": "Output only. Timestamp when the Folder was created. Assigned by the server."
+ "description": "Output only. Timestamp when the Folder was created. Assigned by the server.",
+ "type": "string"
},
"lifecycleState": {
+ "description": "Output only. The lifecycle state of the folder.\nUpdates to the lifecycle_state must be performed via\n[DeleteFolder] and [UndeleteFolder].",
+ "type": "string",
"enumDescriptions": [
"Unspecified state.",
"The normal and active state.",
@@ -154,17 +159,43 @@
"LIFECYCLE_STATE_UNSPECIFIED",
"ACTIVE",
"DELETE_REQUESTED"
- ],
- "description": "Output only. The lifecycle state of the folder.\nUpdates to the lifecycle_state must be performed via\n[DeleteFolder] and [UndeleteFolder].",
- "type": "string"
+ ]
},
"name": {
- "type": "string",
- "description": "Output only. The resource name of the Folder.\nIts format is `folders/{folder_id}`, for example: \"folders/1234\"."
+ "description": "Output only. The resource name of the Folder.\nIts format is `folders/{folder_id}`, for example: \"folders/1234\".",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "The folder’s display name.\nA folder’s display name must be unique amongst its siblings, e.g.\nno two folders with the same parent can share the same display name.\nThe display name must start and end with a letter or digit, may contain\nletters, digits, spaces, hyphens and underscores and can be no longer\nthan 30 characters. This is captured by the regular expression:\n[\\p{L}\\p{N}]({\\p{L}\\p{N}_- ]{0,28}[\\p{L}\\p{N}])?.",
+ "type": "string"
+ },
+ "parent": {
+ "description": "The Folder’s parent's resource name.\nUpdates to the folder's parent must be performed via [MoveFolders].",
+ "type": "string"
}
},
"id": "Folder"
},
+ "ProjectCreationStatus": {
+ "description": "A status object which is used as the `metadata` field for the Operation\nreturned by CreateProject. It provides insight for when significant phases of\nProject creation have completed.",
+ "type": "object",
+ "properties": {
+ "gettable": {
+ "description": "True if the project can be retrieved using GetProject. No other operations\non the project are guaranteed to work until the project creation is\ncomplete.",
+ "type": "boolean"
+ },
+ "createTime": {
+ "format": "google-datetime",
+ "description": "Creation time of the project creation workflow.",
+ "type": "string"
+ },
+ "ready": {
+ "description": "True if the project creation process is complete.",
+ "type": "boolean"
+ }
+ },
+ "id": "ProjectCreationStatus"
+ },
"TestIamPermissionsResponse": {
"description": "Response message for `TestIamPermissions` method.",
"type": "object",
@@ -186,12 +217,14 @@
"id": "GetIamPolicyRequest"
},
"UndeleteFolderRequest": {
- "properties": {},
- "id": "UndeleteFolderRequest",
"description": "The UndeleteFolder request message.",
- "type": "object"
+ "type": "object",
+ "properties": {},
+ "id": "UndeleteFolderRequest"
},
"AuditLogConfig": {
+ "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
+ "type": "object",
"properties": {
"exemptedMembers": {
"description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
@@ -217,12 +250,9 @@
]
}
},
- "id": "AuditLogConfig",
- "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
- "type": "object"
+ "id": "AuditLogConfig"
},
"TestIamPermissionsRequest": {
- "id": "TestIamPermissionsRequest",
"description": "Request message for `TestIamPermissions` method.",
"type": "object",
"properties": {
@@ -233,74 +263,10 @@
},
"type": "array"
}
- }
- },
- "FolderOperation": {
- "description": "Metadata describing a long running folder operation",
- "type": "object",
- "properties": {
- "operationType": {
- "type": "string",
- "enumDescriptions": [
- "Operation type not specified.",
- "A create folder operation.",
- "A move folder operation."
- ],
- "enum": [
- "OPERATION_TYPE_UNSPECIFIED",
- "CREATE",
- "MOVE"
- ],
- "description": "The type of this operation."
- },
- "sourceParent": {
- "description": "The resource name of the folder's parent.\nOnly applicable when the operation_type is MOVE.",
- "type": "string"
- },
- "displayName": {
- "description": "The display name of the folder.",
- "type": "string"
- },
- "destinationParent": {
- "description": "The resource name of the folder or organization we are either creating\nthe folder under or moving the folder to.",
- "type": "string"
- }
},
- "id": "FolderOperation"
- },
- "Policy": {
- "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": {
- "format": "byte",
- "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.",
- "type": "string"
- },
- "version": {
- "format": "int32",
- "description": "Version of the `Policy`. The default version is 0.",
- "type": "integer"
- }
- },
- "id": "Policy",
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
- "type": "object"
+ "id": "TestIamPermissionsRequest"
},
"FolderOperationError": {
- "id": "FolderOperationError",
"description": "A classification of the Folder Operation error.",
"type": "object",
"properties": {
@@ -332,10 +298,74 @@
"description": "The type of operation error experienced.",
"type": "string"
}
- }
+ },
+ "id": "FolderOperationError"
+ },
+ "FolderOperation": {
+ "description": "Metadata describing a long running folder operation",
+ "type": "object",
+ "properties": {
+ "sourceParent": {
+ "description": "The resource name of the folder's parent.\nOnly applicable when the operation_type is MOVE.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "The display name of the folder.",
+ "type": "string"
+ },
+ "destinationParent": {
+ "description": "The resource name of the folder or organization we are either creating\nthe folder under or moving the folder to.",
+ "type": "string"
+ },
+ "operationType": {
+ "description": "The type of this operation.",
+ "type": "string",
+ "enumDescriptions": [
+ "Operation type not specified.",
+ "A create folder operation.",
+ "A move folder operation."
+ ],
+ "enum": [
+ "OPERATION_TYPE_UNSPECIFIED",
+ "CREATE",
+ "MOVE"
+ ]
+ }
+ },
+ "id": "FolderOperation"
+ },
+ "Policy": {
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
+ "type": "object",
+ "properties": {
+ "etag": {
+ "format": "byte",
+ "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.",
+ "type": "string"
+ },
+ "version": {
+ "format": "int32",
+ "description": "Version of the `Policy`. The default version is 0.",
+ "type": "integer"
+ },
+ "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"
+ }
+ },
+ "id": "Policy"
},
"AuditConfig": {
- "id": "AuditConfig",
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
"type": "object",
"properties": {
@@ -350,19 +380,24 @@
"description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
"type": "string"
}
- }
+ },
+ "id": "AuditConfig"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"type": "object",
"properties": {
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ },
"response": {
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- },
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
- "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`.",
@@ -373,48 +408,15 @@
"$ref": "Status"
},
"metadata": {
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- },
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
- "type": "object"
- },
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
+ }
}
},
"id": "Operation"
- },
- "ListFoldersResponse": {
- "description": "The ListFolders response message.",
- "type": "object",
- "properties": {
- "folders": {
- "description": "A possibly paginated list of Folders that are direct descendants of\nthe specified parent resource.",
- "items": {
- "$ref": "Folder"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "A pagination token returned from a previous call to `ListFolders`\nthat indicates from where listing should continue.\nThis field is optional.",
- "type": "string"
- }
- },
- "id": "ListFoldersResponse"
- },
- "MoveFolderRequest": {
- "type": "object",
- "properties": {
- "destinationParent": {
- "description": "The resource name of the Folder or Organization to reparent\nthe folder under.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.",
- "type": "string"
- }
- },
- "id": "MoveFolderRequest",
- "description": "The MoveFolder request message."
}
},
"protocol": "rest",
@@ -445,38 +447,12 @@
"resources": {
"folders": {
"methods": {
- "delete": {
- "id": "cloudresourcemanager.folders.delete",
- "path": "v2beta1/{+name}",
- "description": "Requests deletion of a Folder. The Folder is moved into the\n[DELETE_REQUESTED] state immediately, and is deleted approximately 30 days\nlater. This method may only be called on an empty Folder in the [ACTIVE]\nstate, where a Folder is empty if it doesn't contain any Folders or\nProjects in the [ACTIVE] state.\nThe caller must have `resourcemanager.folders.delete` permission on the\nidentified folder.",
- "response": {
- "$ref": "Folder"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "type": "string",
- "required": true,
- "pattern": "^folders/[^/]+$",
- "location": "path",
- "description": "the resource name of the Folder to be deleted.\nMust be of the form `folders/{folder_id}`."
- }
- },
- "flatPath": "v2beta1/folders/{foldersId}"
- },
"list": {
- "description": "Lists the Folders that are direct descendants of supplied parent resource.\nList provides a strongly consistent view of the Folders underneath\nthe specified parent resource.\nList returns Folders sorted based upon the (ascending) lexical ordering\nof their display_name.\nThe caller must have `resourcemanager.folders.list` permission on the\nidentified parent.",
- "httpMethod": "GET",
"response": {
"$ref": "ListFoldersResponse"
},
"parameterOrder": [],
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
@@ -493,10 +469,10 @@
"type": "string"
},
"pageSize": {
- "type": "integer",
"location": "query",
"format": "int32",
- "description": "The maximum number of Folders to return in the response.\nThis field is optional."
+ "description": "The maximum number of Folders to return in the response.\nThis field is optional.",
+ "type": "integer"
},
"parent": {
"description": "The resource name of the Organization or Folder whose Folders are\nbeing listed.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.\nAccess to this method is controlled by checking the\n`resourcemanager.folders.list` permission on the `parent`.",
@@ -505,42 +481,22 @@
}
},
"flatPath": "v2beta1/folders",
+ "id": "cloudresourcemanager.folders.list",
"path": "v2beta1/folders",
- "id": "cloudresourcemanager.folders.list"
+ "description": "Lists the Folders that are direct descendants of supplied parent resource.\nList provides a strongly consistent view of the Folders underneath\nthe specified parent resource.\nList returns Folders sorted based upon the (ascending) lexical ordering\nof their display_name.\nThe caller must have `resourcemanager.folders.list` permission on the\nidentified parent."
},
- "create": {
- "flatPath": "v2beta1/folders",
- "id": "cloudresourcemanager.folders.create",
- "path": "v2beta1/folders",
- "request": {
- "$ref": "Folder"
- },
- "description": "Creates a Folder in the resource hierarchy.\nReturns an Operation which can be used to track the progress of the\nfolder creation workflow.\nUpon success the Operation.response field will be populated with the\ncreated Folder.\n\nIn order to succeed, the addition of this new Folder must not violate\nthe Folder naming, height or fanout constraints.\n+ The Folder's display_name must be distinct from all other Folder's that\nshare its parent.\n+ The addition of the Folder must not cause the active Folder hierarchy\nto exceed a height of 4. Note, the full active + deleted Folder hierarchy\nis allowed to reach a height of 8; this provides additional headroom when\nmoving folders that contain deleted folders.\n+ The addition of the Folder must not cause the total number of Folders\nunder its parent to exceed 100.\n\nIf the operation fails due to a folder constraint violation,\na PreconditionFailure explaining the violation will be returned.\nIf the failure occurs synchronously then the PreconditionFailure\nwill be returned via the Status.details field and if it occurs\nasynchronously then the PreconditionFailure will be returned\nvia the the Operation.error field.\n\nThe caller must have `resourcemanager.folders.create` permission on the\nidentified parent.",
+ "setIamPolicy": {
"response": {
- "$ref": "Operation"
+ "$ref": "Policy"
},
- "parameterOrder": [],
+ "parameterOrder": [
+ "resource"
+ ],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "parent": {
- "description": "The resource name of the new Folder's parent.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.",
- "type": "string",
- "location": "query"
- }
- }
- },
- "setIamPolicy": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "parameters": {
"resource": {
"location": "path",
"description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
@@ -549,100 +505,116 @@
"pattern": "^folders/[^/]+$"
}
},
+ "flatPath": "v2beta1/folders/{foldersId}:setIamPolicy",
+ "id": "cloudresourcemanager.folders.setIamPolicy",
+ "path": "v2beta1/{+resource}:setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on a Folder, replacing any existing policy.\nThe `resource` field should be the Folder's resource name, e.g.\n\"folders/1234\".\nThe caller must have `resourcemanager.folders.setIamPolicy` permission\non the identified folder."
+ },
+ "create": {
+ "description": "Creates a Folder in the resource hierarchy.\nReturns an Operation which can be used to track the progress of the\nfolder creation workflow.\nUpon success the Operation.response field will be populated with the\ncreated Folder.\n\nIn order to succeed, the addition of this new Folder must not violate\nthe Folder naming, height or fanout constraints.\n+ The Folder's display_name must be distinct from all other Folder's that\nshare its parent.\n+ The addition of the Folder must not cause the active Folder hierarchy\nto exceed a height of 4. Note, the full active + deleted Folder hierarchy\nis allowed to reach a height of 8; this provides additional headroom when\nmoving folders that contain deleted folders.\n+ The addition of the Folder must not cause the total number of Folders\nunder its parent to exceed 100.\n\nIf the operation fails due to a folder constraint violation,\na PreconditionFailure explaining the violation will be returned.\nIf the failure occurs synchronously then the PreconditionFailure\nwill be returned via the Status.details field and if it occurs\nasynchronously then the PreconditionFailure will be returned\nvia the the Operation.error field.\n\nThe caller must have `resourcemanager.folders.create` permission on the\nidentified parent.",
+ "request": {
+ "$ref": "Folder"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "parent": {
+ "description": "The resource name of the new Folder's parent.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.",
+ "type": "string",
+ "location": "query"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v2beta1/folders/{foldersId}:setIamPolicy",
- "path": "v2beta1/{+resource}:setIamPolicy",
- "id": "cloudresourcemanager.folders.setIamPolicy",
- "description": "Sets the access control policy on a Folder, replacing any existing policy.\nThe `resource` field should be the Folder's resource name, e.g.\n\"folders/1234\".\nThe caller must have `resourcemanager.folders.setIamPolicy` permission\non the identified folder.",
- "request": {
- "$ref": "SetIamPolicyRequest"
- }
+ "flatPath": "v2beta1/folders",
+ "path": "v2beta1/folders",
+ "id": "cloudresourcemanager.folders.create"
},
"getIamPolicy": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "resource": {
- "type": "string",
- "required": true,
- "pattern": "^folders/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field."
- }
- },
"flatPath": "v2beta1/folders/{foldersId}:getIamPolicy",
- "id": "cloudresourcemanager.folders.getIamPolicy",
"path": "v2beta1/{+resource}:getIamPolicy",
+ "id": "cloudresourcemanager.folders.getIamPolicy",
+ "description": "Gets the access control policy for a Folder. The returned policy may be\nempty if no such policy or resource exists. The `resource` field should\nbe the Folder's resource name, e.g. \"folders/1234\".\nThe caller must have `resourcemanager.folders.getIamPolicy` permission\non the identified folder.",
"request": {
"$ref": "GetIamPolicyRequest"
},
- "description": "Gets the access control policy for a Folder. The returned policy may be\nempty if no such policy or resource exists. The `resource` field should\nbe the Folder's resource name, e.g. \"folders/1234\".\nThe caller must have `resourcemanager.folders.getIamPolicy` permission\non the identified folder.",
- "response": {
- "$ref": "Policy"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"resource"
],
- "httpMethod": "POST"
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^folders/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
},
"search": {
- "path": "v2beta1/folders:search",
- "id": "cloudresourcemanager.folders.search",
+ "description": "Search for folders that match specific filter criteria.\nSearch provides an eventually consistent view of the folders a user has\naccess to which meet the specified filter criteria.\n\nThis will only return folders on which the caller has the\npermission `resourcemanager.folders.get`.",
"request": {
"$ref": "SearchFoldersRequest"
},
- "description": "Search for folders that match specific filter criteria.\nSearch provides an eventually consistent view of the folders a user has\naccess to which meet the specified filter criteria.\n\nThis will only return folders on which the caller has the\npermission `resourcemanager.folders.get`.",
"httpMethod": "POST",
"parameterOrder": [],
"response": {
"$ref": "SearchFoldersResponse"
},
+ "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
- "parameters": {},
- "flatPath": "v2beta1/folders:search"
+ "flatPath": "v2beta1/folders:search",
+ "path": "v2beta1/folders:search",
+ "id": "cloudresourcemanager.folders.search"
},
- "patch": {
+ "undelete": {
+ "description": "Cancels the deletion request for a Folder. This method may only be\ncalled on a Folder in the [DELETE_REQUESTED] state.\nIn order to succeed, the Folder's parent must be in the [ACTIVE] state.\nIn addition, reintroducing the folder into the tree must not violate\nfolder naming, height and fanout constraints described in the\n[CreateFolder] documentation.\nThe caller must have `resourcemanager.folders.undelete` permission on the\nidentified folder.",
"request": {
+ "$ref": "UndeleteFolderRequest"
+ },
+ "response": {
"$ref": "Folder"
},
- "description": "Updates a Folder, changing its display_name.\nChanges to the folder display_name will be rejected if they violate either\nthe display_name formatting rules or naming constraints described in\nthe [CreateFolder] documentation.\n+ The Folder's display name must start and end with a letter or digit,\nmay contain letters, digits, spaces, hyphens and underscores and can be\nno longer than 30 characters. This is captured by the regular expression:\n[\\p{L}\\p{N}]({\\p{L}\\p{N}_- ]{0,28}[\\p{L}\\p{N}])?.\nThe caller must have `resourcemanager.folders.update` permission on the\nidentified folder.\n\nIf the update fails due to the unique name constraint then a\nPreconditionFailure explaining this violation will be returned\nin the Status.details field.",
- "httpMethod": "PATCH",
"parameterOrder": [
"name"
],
- "response": {
- "$ref": "Folder"
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The resource name of the Folder to undelete.\nMust be of the form `folders/{folder_id}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^folders/[^/]+$"
+ }
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "parameters": {
- "updateMask": {
- "format": "google-fieldmask",
- "description": "Fields to be updated.\nOnly the `display_name` can be updated.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "description": "Output only. The resource name of the Folder.\nIts format is `folders/{folder_id}`, for example: \"folders/1234\".",
- "type": "string",
- "required": true,
- "pattern": "^folders/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2beta1/folders/{foldersId}",
- "path": "v2beta1/{+name}",
- "id": "cloudresourcemanager.folders.patch"
+ "flatPath": "v2beta1/folders/{foldersId}:undelete",
+ "id": "cloudresourcemanager.folders.undelete",
+ "path": "v2beta1/{+name}:undelete"
},
"get": {
+ "description": "Retrieves a Folder identified by the supplied resource name.\nValid Folder resource names have the format `folders/{folder_id}`\n(for example, `folders/1234`).\nThe caller must have `resourcemanager.folders.get` permission on the\nidentified folder.",
"response": {
"$ref": "Folder"
},
@@ -652,11 +624,11 @@
"httpMethod": "GET",
"parameters": {
"name": {
+ "location": "path",
"description": "The resource name of the Folder to retrieve.\nMust be of the form `folders/{folder_id}`.",
"type": "string",
"required": true,
- "pattern": "^folders/[^/]+$",
- "location": "path"
+ "pattern": "^folders/[^/]+$"
}
},
"scopes": [
@@ -665,24 +637,29 @@
],
"flatPath": "v2beta1/folders/{foldersId}",
"id": "cloudresourcemanager.folders.get",
- "path": "v2beta1/{+name}",
- "description": "Retrieves a Folder identified by the supplied resource name.\nValid Folder resource names have the format `folders/{folder_id}`\n(for example, `folders/1234`).\nThe caller must have `resourcemanager.folders.get` permission on the\nidentified folder."
+ "path": "v2beta1/{+name}"
},
- "undelete": {
- "description": "Cancels the deletion request for a Folder. This method may only be\ncalled on a Folder in the [DELETE_REQUESTED] state.\nIn order to succeed, the Folder's parent must be in the [ACTIVE] state.\nIn addition, reintroducing the folder into the tree must not violate\nfolder naming, height and fanout constraints described in the\n[CreateFolder] documentation.\nThe caller must have `resourcemanager.folders.undelete` permission on the\nidentified folder.",
+ "patch": {
+ "description": "Updates a Folder, changing its display_name.\nChanges to the folder display_name will be rejected if they violate either\nthe display_name formatting rules or naming constraints described in\nthe [CreateFolder] documentation.\n+ The Folder's display name must start and end with a letter or digit,\nmay contain letters, digits, spaces, hyphens and underscores and can be\nno longer than 30 characters. This is captured by the regular expression:\n[\\p{L}\\p{N}]({\\p{L}\\p{N}_- ]{0,28}[\\p{L}\\p{N}])?.\nThe caller must have `resourcemanager.folders.update` permission on the\nidentified folder.\n\nIf the update fails due to the unique name constraint then a\nPreconditionFailure explaining this violation will be returned\nin the Status.details field.",
"request": {
- "$ref": "UndeleteFolderRequest"
+ "$ref": "Folder"
},
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "Folder"
},
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
"parameters": {
+ "updateMask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Fields to be updated.\nOnly the `display_name` can be updated.",
+ "type": "string"
+ },
"name": {
- "description": "The resource name of the Folder to undelete.\nMust be of the form `folders/{folder_id}`.",
+ "description": "Output only. The resource name of the Folder.\nIts format is `folders/{folder_id}`, for example: \"folders/1234\".",
"type": "string",
"required": true,
"pattern": "^folders/[^/]+$",
@@ -692,15 +669,15 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v2beta1/folders/{foldersId}:undelete",
- "path": "v2beta1/{+name}:undelete",
- "id": "cloudresourcemanager.folders.undelete"
+ "flatPath": "v2beta1/folders/{foldersId}",
+ "id": "cloudresourcemanager.folders.patch",
+ "path": "v2beta1/{+name}"
},
"move": {
- "description": "Moves a Folder under a new resource parent.\nReturns an Operation which can be used to track the progress of the\nfolder move workflow.\nUpon success the Operation.response field will be populated with the\nmoved Folder.\nUpon failure, a FolderOperationError categorizing the failure cause will\nbe returned - if the failure occurs synchronously then the\nFolderOperationError will be returned via the Status.details field\nand if it occurs asynchronously then the FolderOperation will be returned\nvia the the Operation.error field.\nIn addition, the Operation.metadata field will be populated with a\nFolderOperation message as an aid to stateless clients.\nFolder moves will be rejected if they violate either the naming, height\nor fanout constraints described in the [CreateFolder] documentation.\nThe caller must have `resourcemanager.folders.move` permission on the\nfolder's current and proposed new parent.",
"request": {
"$ref": "MoveFolderRequest"
},
+ "description": "Moves a Folder under a new resource parent.\nReturns an Operation which can be used to track the progress of the\nfolder move workflow.\nUpon success the Operation.response field will be populated with the\nmoved Folder.\nUpon failure, a FolderOperationError categorizing the failure cause will\nbe returned - if the failure occurs synchronously then the\nFolderOperationError will be returned via the Status.details field\nand if it occurs asynchronously then the FolderOperation will be returned\nvia the the Operation.error field.\nIn addition, the Operation.metadata field will be populated with a\nFolderOperation message as an aid to stateless clients.\nFolder moves will be rejected if they violate either the naming, height\nor fanout constraints described in the [CreateFolder] documentation.\nThe caller must have `resourcemanager.folders.move` permission on the\nfolder's current and proposed new parent.",
"response": {
"$ref": "Operation"
},
@@ -708,30 +685,23 @@
"name"
],
"httpMethod": "POST",
- "parameters": {
- "name": {
- "description": "The resource name of the Folder to move.\nMust be of the form folders/{folder_id}",
- "type": "string",
- "required": true,
- "pattern": "^folders/[^/]+$",
- "location": "path"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The resource name of the Folder to move.\nMust be of the form folders/{folder_id}",
+ "type": "string",
+ "required": true,
+ "pattern": "^folders/[^/]+$"
+ }
+ },
"flatPath": "v2beta1/folders/{foldersId}:move",
"id": "cloudresourcemanager.folders.move",
"path": "v2beta1/{+name}:move"
},
"testIamPermissions": {
- "flatPath": "v2beta1/folders/{foldersId}:testIamPermissions",
- "id": "cloudresourcemanager.folders.testIamPermissions",
- "path": "v2beta1/{+resource}:testIamPermissions",
- "description": "Returns permissions that a caller has on the specified Folder.\nThe `resource` field should be the Folder's resource name,\ne.g. \"folders/1234\".\n\nThere are no permissions required for making this API call.",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
"response": {
"$ref": "TestIamPermissionsResponse"
},
@@ -741,71 +711,53 @@
"httpMethod": "POST",
"parameters": {
"resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
"type": "string",
"required": true,
"pattern": "^folders/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field."
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ]
+ ],
+ "flatPath": "v2beta1/folders/{foldersId}:testIamPermissions",
+ "id": "cloudresourcemanager.folders.testIamPermissions",
+ "path": "v2beta1/{+resource}:testIamPermissions",
+ "description": "Returns permissions that a caller has on the specified Folder.\nThe `resource` field should be the Folder's resource name,\ne.g. \"folders/1234\".\n\nThere are no permissions required for making this API call.",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ }
+ },
+ "delete": {
+ "description": "Requests deletion of a Folder. The Folder is moved into the\n[DELETE_REQUESTED] state immediately, and is deleted approximately 30 days\nlater. This method may only be called on an empty Folder in the [ACTIVE]\nstate, where a Folder is empty if it doesn't contain any Folders or\nProjects in the [ACTIVE] state.\nThe caller must have `resourcemanager.folders.delete` permission on the\nidentified folder.",
+ "response": {
+ "$ref": "Folder"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "description": "the resource name of the Folder to be deleted.\nMust be of the form `folders/{folder_id}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^folders/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/folders/{foldersId}",
+ "id": "cloudresourcemanager.folders.delete",
+ "path": "v2beta1/{+name}"
}
}
}
},
"parameters": {
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format."
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "alt": {
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
- },
"key": {
"location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
@@ -817,9 +769,9 @@
"location": "query"
},
"quotaUser": {
- "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pp": {
"location": "query",
@@ -841,8 +793,56 @@
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
"location": "query"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "alt": {
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
}
- },
- "version": "v2beta1",
- "baseUrl": "https://cloudresourcemanager.googleapis.com/"
+ }
}
diff --git a/cloudtasks/v2beta2/cloudtasks-api.json b/cloudtasks/v2beta2/cloudtasks-api.json
index ff5bb9d..b38ca4c 100644
--- a/cloudtasks/v2beta2/cloudtasks-api.json
+++ b/cloudtasks/v2beta2/cloudtasks-api.json
@@ -1,24 +1,1183 @@
{
+ "name": "cloudtasks",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Cloud Tasks API",
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "resources": {
+ "locations": {
+ "methods": {
+ "list": {
+ "description": "Lists information about the supported locations for this service.",
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ },
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The resource that owns the locations collection, if applicable."
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "The standard list page token."
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "description": "The standard list page size.",
+ "format": "int32"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta2/projects/{projectsId}/locations",
+ "path": "v2beta2/{+name}/locations",
+ "id": "cloudtasks.projects.locations.list"
+ },
+ "get": {
+ "description": "Get information about a location.",
+ "response": {
+ "$ref": "Location"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "description": "Resource name for the location.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}",
+ "path": "v2beta2/{+name}",
+ "id": "cloudtasks.projects.locations.get"
+ }
+ },
+ "resources": {
+ "queues": {
+ "methods": {
+ "testIamPermissions": {
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on a Queue.\nIf the resource does not exist, this will return an empty set of\npermissions, not a google.rpc.Code.NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.\n",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameters": {
+ "resource": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:testIamPermissions",
+ "id": "cloudtasks.projects.locations.queues.testIamPermissions",
+ "path": "v2beta2/{+resource}:testIamPermissions"
+ },
+ "pause": {
+ "request": {
+ "$ref": "PauseQueueRequest"
+ },
+ "description": "Pauses the queue.\n\nIf a queue is paused then the system will stop executing the\ntasks in the queue until it is resumed via\nCloudTasks.ResumeQueue. Tasks can still be added when the\nqueue is paused. The state of the queue is stored in\nQueue.queue_state; if paused it will be set to\nQueue.QueueState.PAUSED.\n\nWARNING: This method is only available to whitelisted\nusers. Using this method carries some risk. Read\n[Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)\ncarefully and then sign up for\n[whitelist access to this method](https://goo.gl/Fe5mUy).",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Queue"
+ },
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
+ "location": "path",
+ "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:pause",
+ "id": "cloudtasks.projects.locations.queues.pause",
+ "path": "v2beta2/{+name}:pause"
+ },
+ "delete": {
+ "description": "Deletes a queue.\n\nThis command will delete the queue even if it has tasks in it.\n\nNote: If you delete a queue, a queue with the same name can't be created\nfor 7 days.\n\nWARNING: This method is only available to whitelisted\nusers. Using this method carries some risk. Read\n[Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)\ncarefully and then sign up for\n[whitelist access to this method](https://goo.gl/Fe5mUy).",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "name": {
+ "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}",
+ "id": "cloudtasks.projects.locations.queues.delete",
+ "path": "v2beta2/{+name}"
+ },
+ "list": {
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues",
+ "id": "cloudtasks.projects.locations.queues.list",
+ "path": "v2beta2/{+parent}/queues",
+ "description": "Lists queues.\n\nQueues are returned in lexicographical order.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListQueuesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "description": "Required.\n\nThe location name.\nFor example: `projects/PROJECT_ID/locations/LOCATION_ID`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+$"
+ },
+ "filter": {
+ "description": "`filter` can be used to specify a subset of queues. Any Queue\nfield can be used as a filter and several operators as supported.\nFor example: `\u003c=, \u003c, \u003e=, \u003e, !=, =, :`. The filter syntax is the same as\ndescribed in\n[Stackdriver's Advanced Logs Filters](/logging/docs/view/advanced_filters).\n\nSample filter \"app_engine_http_target: *\".\n\nNote that using filters might cause fewer queues than the\nrequested_page size to be returned.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "description": "A token identifying the page of results to return.\n\nTo request the first page results, page_token must be empty. To\nrequest the next page of results, page_token must be the value of\nListQueuesResponse.next_page_token returned from the previous\ncall to CloudTasks.ListQueues method. It is an error to\nswitch the value of ListQueuesRequest.filter while iterating\nthrough pages.",
+ "format": "byte",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "description": "Requested page size.\n\nThe maximum page size is 9800. If unspecified, the page size will\nbe the maximum. Fewer queues than requested might be returned,\neven if more queues exist; use\nListQueuesResponse.next_page_token to determine if more\nqueues exist.",
+ "format": "int32"
+ }
+ }
+ },
+ "setIamPolicy": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:setIamPolicy",
+ "id": "cloudtasks.projects.locations.queues.setIamPolicy",
+ "path": "v2beta2/{+resource}:setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy for a Queue. Replaces any existing\npolicy.\n\nAuthorization requires the following [Google IAM](/iam) permission on the\nspecified resource parent:\n\n* `cloudtasks.queues.setIamPolicy`\n"
+ },
+ "create": {
+ "parameters": {
+ "parent": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path",
+ "description": "Required.\n\nThe location name in which the queue will be created.\nFor example: `projects/PROJECT_ID/locations/LOCATION_ID`\n\nThe list of allowed locations can be obtained by calling Cloud\nTasks' implementation of\ngoogle.cloud.location.Locations.ListLocations."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues",
+ "path": "v2beta2/{+parent}/queues",
+ "id": "cloudtasks.projects.locations.queues.create",
+ "request": {
+ "$ref": "Queue"
+ },
+ "description": "Creates a queue.\n\nWARNING: This method is only available to whitelisted\nusers. Using this method carries some risk. Read\n[Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)\ncarefully and then sign up for\n[whitelist access to this method](https://goo.gl/Fe5mUy).",
+ "response": {
+ "$ref": "Queue"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST"
+ },
+ "resume": {
+ "response": {
+ "$ref": "Queue"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:resume",
+ "path": "v2beta2/{+name}:resume",
+ "id": "cloudtasks.projects.locations.queues.resume",
+ "description": "Resume a queue.\n\nThis method resumes a queue after it has been\nQueue.QueueState.PAUSED or Queue.QueueState.DISABLED. The state of\na queue is stored in Queue.queue_state; after calling this method it\nwill be set to Queue.QueueState.RUNNING.\n\nWARNING: This method is only available to whitelisted\nusers. Using this method carries some risk. Read\n[Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)\ncarefully and then sign up for\n[whitelist access to this method](https://goo.gl/Fe5mUy).\n\nWARNING: Resuming many high-QPS queues at the same time can\nlead to target overloading. If you are resuming high-QPS\nqueues, follow the 500/50/5 pattern described in\n[Managing Cloud Tasks Scaling Risks](/cloud-tasks/pdfs/managing-cloud-tasks-scaling-risks-2017-06-05.pdf).",
+ "request": {
+ "$ref": "ResumeQueueRequest"
+ }
+ },
+ "getIamPolicy": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:getIamPolicy",
+ "id": "cloudtasks.projects.locations.queues.getIamPolicy",
+ "path": "v2beta2/{+resource}:getIamPolicy",
+ "description": "Gets the access control policy for a Queue.\nReturns an empty policy if the resource exists and does not have a policy\nset.\n\nAuthorization requires the following [Google IAM](/iam) permission on the\nspecified resource parent:\n\n* `cloudtasks.queues.getIamPolicy`\n",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ }
+ },
+ "patch": {
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Queue"
+ },
+ "parameters": {
+ "updateMask": {
+ "description": "A mask used to specify which fields of the queue are being updated.\n\nIf empty, then all fields will be updated.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "location": "path",
+ "description": "The queue name.\n\nThe queue name must have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`\n\n* `PROJECT_ID` can contain uppercase and lowercase letters,\n numbers, hyphens, colons, and periods; that is, it must match\n the regular expression: `[a-zA-Z\\\\d-:\\\\.]+`.\n* `QUEUE_ID` can contain uppercase and lowercase letters,\n numbers, and hyphens; that is, it must match the regular\n expression: `[a-zA-Z\\\\d-]+`. The maximum length is 100\n characters.\n\nCaller-specified and required in CreateQueueRequest, after which\nit becomes output only.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}",
+ "id": "cloudtasks.projects.locations.queues.patch",
+ "path": "v2beta2/{+name}",
+ "request": {
+ "$ref": "Queue"
+ },
+ "description": "Updates a queue.\n\nThis method creates the queue if it does not exist and updates\nthe queue if it does exist.\n\nWARNING: This method is only available to whitelisted\nusers. Using this method carries some risk. Read\n[Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)\ncarefully and then sign up for\n[whitelist access to this method](https://goo.gl/Fe5mUy)."
+ },
+ "get": {
+ "response": {
+ "$ref": "Queue"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "description": "Required.\n\nThe resource name of the queue. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}",
+ "path": "v2beta2/{+name}",
+ "id": "cloudtasks.projects.locations.queues.get",
+ "description": "Gets a queue."
+ },
+ "purge": {
+ "request": {
+ "$ref": "PurgeQueueRequest"
+ },
+ "description": "Purges a queue by deleting all of its tasks.\n\nAll tasks created before this method is called are permanently deleted.\n\nPurge operations can take up to one minute to take effect. Tasks\nmight be dispatched before the purge takes effect. A purge is irreversible.",
+ "response": {
+ "$ref": "Queue"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:purge",
+ "path": "v2beta2/{+name}:purge",
+ "id": "cloudtasks.projects.locations.queues.purge"
+ }
+ },
+ "resources": {
+ "tasks": {
+ "methods": {
+ "pull": {
+ "request": {
+ "$ref": "PullTasksRequest"
+ },
+ "description": "Pulls tasks from a pull queue and acquires a lease on them for a\nspecified PullTasksRequest.lease_duration.\n\nThis method is invoked by the lease holder to obtain the\nlease. The lease holder must acknowledge the task via\nCloudTasks.AcknowledgeTask after they have performed the work\nassociated with the task.\n\nThe payload is intended to store data that the lease holder needs\nto perform the work associated with the task. To return the\npayloads in the PullTasksResponse, set\nPullTasksRequest.response_view to Task.View.FULL.\n\nA maximum of 10 qps of CloudTasks.PullTasks requests are allowed per\nqueue. google.rpc.Code.RESOURCE_EXHAUSTED is returned when this limit\nis exceeded. google.rpc.Code.RESOURCE_EXHAUSTED is also returned when\nRateLimits.max_tasks_dispatched_per_second is exceeded.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "PullTasksResponse"
+ },
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
+ "location": "path",
+ "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks:pull",
+ "id": "cloudtasks.projects.locations.queues.tasks.pull",
+ "path": "v2beta2/{+name}/tasks:pull"
+ },
+ "delete": {
+ "path": "v2beta2/{+name}",
+ "id": "cloudtasks.projects.locations.queues.tasks.delete",
+ "description": "Deletes a task.\n\nA task can be deleted if it is scheduled or dispatched. A task\ncannot be deleted if it has completed successfully or permanently\nfailed.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$",
+ "location": "path",
+ "description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}"
+ },
+ "list": {
+ "description": "Lists the tasks in a queue.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default due to performance\nconsiderations; ListTasksRequest.response_view controls the\nsubset of information which is returned.",
+ "response": {
+ "$ref": "ListTasksResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "responseView": {
+ "location": "query",
+ "enum": [
+ "VIEW_UNSPECIFIED",
+ "BASIC",
+ "FULL"
+ ],
+ "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for Task.View.FULL requires `cloudtasks.tasks.fullView`\n[Google IAM](/iam/) permission on the\nTask.name resource.",
+ "type": "string"
+ },
+ "orderBy": {
+ "type": "string",
+ "location": "query",
+ "description": "\nSort order used for the query. The fields supported for sorting\nare Task.schedule_time and PullMessage.tag. All results will be\nreturned in ascending order. The default ordering is by\nTask.schedule_time."
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "A token identifying the page of results to return.\n\nTo request the first page results, page_token must be empty. To\nrequest the next page of results, page_token must be the value of\nListTasksResponse.next_page_token returned from the previous\ncall to CloudTasks.ListTasks method.\n\nThe page token is valid for only 2 hours.",
+ "format": "byte",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Requested page size. Fewer tasks than requested might be returned.\n\nThe maximum page size is 1000. If unspecified, the page size will\nbe the maximum. Fewer tasks than requested might be returned,\neven if more tasks exist; use\nListTasksResponse.next_page_token to determine if more tasks\nexist.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "parent": {
+ "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks",
+ "path": "v2beta2/{+parent}/tasks",
+ "id": "cloudtasks.projects.locations.queues.tasks.list"
+ },
+ "create": {
+ "description": "Creates a task and adds it to a queue.\n\nTo add multiple tasks at the same time, use\n[HTTP batching](/storage/docs/json_api/v1/how-tos/batch)\nor the batching documentation for your client library, for example\nhttps://developers.google.com/api-client-library/python/guide/batch.\n\nTasks cannot be updated after creation; there is no UpdateTask command.\n\n* For [App Engine queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget),\n the maximum task size is 100KB.\n* For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this\n the maximum task size is 1MB.",
+ "request": {
+ "$ref": "CreateTaskRequest"
+ },
+ "response": {
+ "$ref": "Task"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
+ "location": "path",
+ "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`\n\nThe queue must already exist.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks",
+ "path": "v2beta2/{+parent}/tasks",
+ "id": "cloudtasks.projects.locations.queues.tasks.create"
+ },
+ "run": {
+ "description": "Forces a task to run now.\n\nThis command is meant to be used for manual debugging. For\nexample, CloudTasks.RunTask can be used to retry a failed\ntask after a fix has been made or to manually force a task to be\ndispatched now.\n\nWhen this method is called, Cloud Tasks will dispatch the task to its\ntarget, even if the queue is Queue.QueueState.PAUSED.\n\nThe dispatched task is returned. That is, the task that is returned\ncontains the Task.task_status after the task is dispatched but\nbefore the task is received by its target.\n\nIf Cloud Tasks receives a successful response from the task's\nhandler, then the task will be deleted; otherwise the task's\nTask.schedule_time will be reset to the time that\nCloudTasks.RunTask was called plus the retry delay specified\nin the queue and task's RetryConfig.\n\nCloudTasks.RunTask returns google.rpc.Code.NOT_FOUND when\nit is called on a task that has already succeeded or permanently\nfailed. google.rpc.Code.FAILED_PRECONDITION is returned when\nCloudTasks.RunTask is called on task that is dispatched or\nalready running.",
+ "request": {
+ "$ref": "RunTaskRequest"
+ },
+ "response": {
+ "$ref": "Task"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$"
+ }
+ },
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:run",
+ "path": "v2beta2/{+name}:run",
+ "id": "cloudtasks.projects.locations.queues.tasks.run"
+ },
+ "cancelLease": {
+ "id": "cloudtasks.projects.locations.queues.tasks.cancelLease",
+ "path": "v2beta2/{+name}:cancelLease",
+ "request": {
+ "$ref": "CancelLeaseRequest"
+ },
+ "description": "Cancel a pull task's lease.\n\nThe lease holder can use this method to cancel a task's lease\nby setting Task.schedule_time to now. This will make the task\navailable to be leased to the next caller of CloudTasks.PullTasks.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Task"
+ },
+ "parameters": {
+ "name": {
+ "description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:cancelLease"
+ },
+ "acknowledge": {
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:acknowledge",
+ "path": "v2beta2/{+name}:acknowledge",
+ "id": "cloudtasks.projects.locations.queues.tasks.acknowledge",
+ "request": {
+ "$ref": "AcknowledgeTaskRequest"
+ },
+ "description": "Acknowledges a pull task.\n\nThe lease holder, that is, the entity that received this task in\na PullTasksResponse, must call this method to indicate that\nthe work associated with the task has finished.\n\nThe lease holder must acknowledge a task within the\nPullTasksRequest.lease_duration or the lease will expire and\nthe task will become ready to be returned in a different\nPullTasksResponse. After the task is acknowledged, it will\nnot be returned by a later CloudTasks.PullTasks,\nCloudTasks.GetTask, or CloudTasks.ListTasks.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "renewLease": {
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:renewLease",
+ "path": "v2beta2/{+name}:renewLease",
+ "id": "cloudtasks.projects.locations.queues.tasks.renewLease",
+ "request": {
+ "$ref": "RenewLeaseRequest"
+ },
+ "description": "Renew the current lease of a pull task.\n\nThe lease holder can use this method to extend the lease by a new\nduration, starting from now. The new task lease will be\nreturned in Task.schedule_time.",
+ "response": {
+ "$ref": "Task"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}",
+ "path": "v2beta2/{+name}",
+ "id": "cloudtasks.projects.locations.queues.tasks.get",
+ "description": "Gets a task.",
+ "response": {
+ "$ref": "Task"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$"
+ },
+ "responseView": {
+ "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for Task.View.FULL requires `cloudtasks.tasks.fullView`\n[Google IAM](/iam/) permission on the\nTask.name resource.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "VIEW_UNSPECIFIED",
+ "BASIC",
+ "FULL"
+ ]
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ]
+ },
+ "callback": {
+ "type": "string",
+ "location": "query",
+ "description": "JSONP"
+ },
+ "alt": {
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "type": "string",
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ }
+ },
+ "version": "v2beta2",
+ "baseUrl": "https://cloudtasks.googleapis.com/",
+ "servicePath": "",
+ "description": "Manages the execution of large numbers of distributed requests. Cloud Tasks is in Alpha.",
+ "kind": "discovery#restDescription",
+ "basePath": "",
+ "id": "cloudtasks:v2beta2",
+ "documentationLink": "https://cloud.google.com/cloud-tasks/",
+ "revision": "20171011",
+ "discoveryVersion": "v1",
+ "version_module": true,
"schemas": {
- "PullTarget": {
- "description": "Pull target.",
- "type": "object",
- "properties": {},
- "id": "PullTarget"
- },
- "ResumeQueueRequest": {
- "description": "Request message for CloudTasks.ResumeQueue.",
- "type": "object",
- "properties": {},
- "id": "ResumeQueueRequest"
- },
- "CreateTaskRequest": {
- "description": "Request message for CloudTasks.CreateTask.",
+ "AcknowledgeTaskRequest": {
+ "id": "AcknowledgeTaskRequest",
+ "description": "Request message for acknowledging a task using\nCloudTasks.AcknowledgeTask.",
"type": "object",
"properties": {
- "task": {
- "description": "Required.\n\nThe task to add.\n\nTask names have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.\nThe user can optionally specify a name for the task in\nTask.name. If a name is not specified then the system will\ngenerate a random unique task id, which will be returned in the\nresponse's Task.name.\n\nIf Task.schedule_time is not set or is in the past then Cloud\nTasks will set it to the current time.\n\nTask De-duplication:\n\nExplicitly specifying a task ID enables task de-duplication. If\na task's ID is identical to that of an existing task or a task\nthat was deleted or completed recently then the call will fail\nwith google.rpc.Code.ALREADY_EXISTS. If the task's queue was\ncreated using Cloud Tasks, then another task with the same name\ncan't be created for ~1hour after the original task was deleted\nor completed. If the task's queue was created using queue.yaml or\nqueue.xml, then another task with the same name can't be created\nfor ~9days after the original task was deleted or completed.\n\nBecause there is an extra lookup cost to identify duplicate task\nnames, these CloudTasks.CreateTask calls have significantly\nincreased latency. Using hashed strings for the task id or for\nthe prefix of the task id is recommended. Choosing task ids that\nare sequential or have sequential prefixes, for example using a\ntimestamp, causes an increase in latency and error rates in all\ntask commands. The infrastructure relies on an approximately\nuniform distribution of task ids to store and serve tasks\nefficiently.",
- "$ref": "Task"
+ "scheduleTime": {
+ "description": "Required.\n\nThe task's current schedule time, available in the Task.schedule_time\nreturned in PullTasksResponse.tasks or\nCloudTasks.RenewLease. This restriction is to check that\nthe caller is acknowledging the correct task.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ }
+ },
+ "ListQueuesResponse": {
+ "description": "Response message for CloudTasks.ListQueues.",
+ "type": "object",
+ "properties": {
+ "queues": {
+ "description": "The list of queues.",
+ "type": "array",
+ "items": {
+ "$ref": "Queue"
+ }
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve next page of results.\n\nTo return the next page of results, call\nCloudTasks.ListQueues with this value as the\nListQueuesRequest.page_token.\n\nIf the next_page_token is empty, there are no more results.\n\nThe page token is valid for only 2 hours.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "ListQueuesResponse"
+ },
+ "TestIamPermissionsRequest": {
+ "properties": {
+ "permissions": {
+ "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "TestIamPermissionsRequest",
+ "description": "Request message for `TestIamPermissions` method.",
+ "type": "object"
+ },
+ "Policy": {
+ "type": "object",
+ "properties": {
+ "etag": {
+ "type": "string",
+ "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
+ "format": "byte"
+ },
+ "version": {
+ "type": "integer",
+ "description": "Version of the `Policy`. The default version is 0.",
+ "format": "int32"
+ },
+ "bindings": {
+ "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
+ "type": "array",
+ "items": {
+ "$ref": "Binding"
+ }
+ }
+ },
+ "id": "Policy",
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam)."
+ },
+ "ListLocationsResponse": {
+ "description": "The response message for Locations.ListLocations.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
+ "locations": {
+ "description": "A list of locations that matches the specified filter in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Location"
+ }
+ }
+ },
+ "id": "ListLocationsResponse"
+ },
+ "AppEngineTaskTarget": {
+ "description": "Deprecated. Use AppEngineHttpRequest.",
+ "type": "object",
+ "properties": {
+ "appEngineRouting": {
+ "description": "Deprecated. Use AppEngineHttpRequest.app_engine_routing.",
+ "$ref": "AppEngineRouting"
+ },
+ "httpMethod": {
+ "enum": [
+ "HTTP_METHOD_UNSPECIFIED",
+ "POST",
+ "GET",
+ "HEAD",
+ "PUT",
+ "DELETE"
+ ],
+ "description": "Deprecated. Use AppEngineHttpRequest.http_method.",
+ "type": "string",
+ "enumDescriptions": [
+ "HTTP method unspecified",
+ "HTTP Post",
+ "HTTP Get",
+ "HTTP Head",
+ "HTTP Put",
+ "HTTP Delete"
+ ]
+ },
+ "payload": {
+ "type": "string",
+ "description": "Deprecated. Use AppEngineHttpRequest.payload.",
+ "format": "byte"
+ },
+ "relativeUrl": {
+ "description": "Deprecated. Use AppEngineHttpRequest.relative_url.",
+ "type": "string"
+ },
+ "headers": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Deprecated. Use AppEngineHttpRequest.headers.",
+ "type": "object"
+ }
+ },
+ "id": "AppEngineTaskTarget"
+ },
+ "CancelLeaseRequest": {
+ "description": "Request message for canceling a lease using\nCloudTasks.CancelLease.",
+ "type": "object",
+ "properties": {
+ "scheduleTime": {
+ "type": "string",
+ "description": "Required.\n\nThe task's current schedule time, available in the Task.schedule_time\nreturned in PullTasksResponse.tasks or\nCloudTasks.RenewLease. This restriction is to check that\nthe caller is canceling the correct task.",
+ "format": "google-datetime"
+ },
+ "responseView": {
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified. Defaults to BASIC.",
+ "The basic view omits fields which can be large or can contain\nsensitive data.\n\nThis view does not include the payload.",
+ "All information is returned.\n\nPayloads might be desirable to return only when needed, because\nthey can be large and because of the sensitivity of the data\nthat you choose to store in it.\n\nAuthorization for Task.View.FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue.name resource."
+ ],
+ "enum": [
+ "VIEW_UNSPECIFIED",
+ "BASIC",
+ "FULL"
+ ],
+ "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for Task.View.FULL requires `cloudtasks.tasks.fullView`\n[Google IAM](/iam/) permission on the\nTask.name resource."
+ }
+ },
+ "id": "CancelLeaseRequest"
+ },
+ "AttemptStatus": {
+ "description": "The status of a task attempt.",
+ "type": "object",
+ "properties": {
+ "responseTime": {
+ "type": "string",
+ "description": "Output only.\n\nThe time that this attempt response was received.\n\n`response_time` will be truncated to the nearest microsecond.",
+ "format": "google-datetime"
+ },
+ "responseStatus": {
+ "description": "Output only.\n\nThe response from the target for this attempt.\n\nIf the task has not been attempted or the task is currently running\nthen the response status is google.rpc.Code.UNKNOWN.",
+ "$ref": "Status"
+ },
+ "scheduleTime": {
+ "description": "Output only.\n\nThe time that this attempt was scheduled.\n\n`schedule_time` will be truncated to the nearest microsecond.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "dispatchTime": {
+ "description": "Output only.\n\nThe time that this attempt was dispatched.\n\n`dispatch_time` will be truncated to the nearest microsecond.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "AttemptStatus"
+ },
+ "RateLimits": {
+ "description": "Rate limits.\n\nThis message determines the maximum rate that tasks can be dispatched by a\nqueue, regardless of whether the dispatch is a first task attempt or a retry.",
+ "type": "object",
+ "properties": {
+ "maxBurstSize": {
+ "description": "Output only.\n\nThe max burst size limits how fast the queue is processed when\nmany tasks are in the queue and the rate is high. This field\nallows the queue to have a high rate so processing starts shortly\nafter a task is enqueued, but still limits resource usage when\nmany tasks are enqueued in a short period of time.\n\n* For App Engine queues, if\n RateLimits.max_tasks_dispatched_per_second is 1, this\n field is 10; otherwise this field is\n RateLimits.max_tasks_dispatched_per_second / 5.\n* For pull queues, this field is output only and always 10,000.\n\nNote: For App Engine queues that were created through\n`queue.yaml/xml`, `max_burst_size` might not have the same\nsettings as specified above; CloudTasks.UpdateQueue can be\nused to set `max_burst_size` only to the values specified above.\n\nThis field has the same meaning as\n[bucket_size in queue.yaml](/appengine/docs/standard/python/config/queueref#bucket_size).",
+ "format": "int32",
+ "type": "integer"
+ },
+ "maxConcurrentTasks": {
+ "description": "The maximum number of concurrent tasks that Cloud Tasks allows\nto be dispatched for this queue. After this threshold has been\nreached, Cloud Tasks stops dispatching tasks until the number of\nconcurrent requests decreases.\n\nThe maximum allowed value is 5,000.\n\n* For App Engine queues, this field is 10 by default.\n* For pull queues, this field is output only and always -1, which\n indicates no limit.\n\nThis field has the same meaning as\n[max_concurrent_requests in queue.yaml](/appengine/docs/standard/python/config/queueref#max_concurrent_requests).",
+ "format": "int32",
+ "type": "integer"
+ },
+ "maxTasksDispatchedPerSecond": {
+ "description": "The maximum rate at which tasks are dispatched from this\nqueue.\n\nThe maximum allowed value is 500.\n\n* For App Engine queues, this field is 1 by default.\n* For pull queues, this field is output only and always 10,000.\n\nThis field has the same meaning as\n[rate in queue.yaml](/appengine/docs/standard/python/config/queueref#rate).",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "id": "RateLimits"
+ },
+ "PurgeQueueRequest": {
+ "description": "Request message for CloudTasks.PurgeQueue.",
+ "type": "object",
+ "properties": {},
+ "id": "PurgeQueueRequest"
+ },
+ "PauseQueueRequest": {
+ "type": "object",
+ "properties": {},
+ "id": "PauseQueueRequest",
+ "description": "Request message for CloudTasks.PauseQueue."
+ },
+ "RunTaskRequest": {
+ "id": "RunTaskRequest",
+ "description": "Request message for forcing a task to run now using\nCloudTasks.RunTask.",
+ "type": "object",
+ "properties": {
+ "responseView": {
+ "enum": [
+ "VIEW_UNSPECIFIED",
+ "BASIC",
+ "FULL"
+ ],
+ "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for Task.View.FULL requires `cloudtasks.tasks.fullView`\n[Google IAM](/iam/) permission on the\nTask.name resource.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified. Defaults to BASIC.",
+ "The basic view omits fields which can be large or can contain\nsensitive data.\n\nThis view does not include the payload.",
+ "All information is returned.\n\nPayloads might be desirable to return only when needed, because\nthey can be large and because of the sensitivity of the data\nthat you choose to store in it.\n\nAuthorization for Task.View.FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue.name resource."
+ ]
+ }
+ }
+ },
+ "PullTasksResponse": {
+ "type": "object",
+ "properties": {
+ "tasks": {
+ "description": "The leased tasks.",
+ "type": "array",
+ "items": {
+ "$ref": "Task"
+ }
+ }
+ },
+ "id": "PullTasksResponse",
+ "description": "Response message for pulling tasks using CloudTasks.PullTasks."
+ },
+ "Task": {
+ "id": "Task",
+ "description": "A unit of scheduled work.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The task name.\n\nThe task name must have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`\n\n* `PROJECT_ID` can contain uppercase and lowercase letters,\n numbers, hyphens, colons, and periods; that is, it must match\n the regular expression: `[a-zA-Z\\\\d-:\\\\.]+`.\n* `QUEUE_ID` can contain uppercase and lowercase letters,\n numbers, and hyphens; that is, it must match the regular\n expression: `[a-zA-Z\\\\d-]+`. The maximum length is 100\n characters.\n* `TASK_ID` contain uppercase and lowercase letters, numbers,\n underscores, and hyphens; that is, it must match the regular\n expression: `[a-zA-Z\\\\d_-]+`. The maximum length is 500\n characters.\n\nOptionally caller-specified in CreateTaskRequest.",
+ "type": "string"
+ },
+ "appEngineTaskTarget": {
+ "description": "Deprecated. Use Task.app_engine_http_request.",
+ "$ref": "AppEngineTaskTarget"
+ },
+ "taskStatus": {
+ "$ref": "TaskStatus",
+ "description": "Output only.\n\nTask status."
+ },
+ "pullTaskTarget": {
+ "$ref": "PullTaskTarget",
+ "description": "Deprecated. Use Task.pull_message."
+ },
+ "appEngineHttpRequest": {
+ "description": "App Engine HTTP request that is sent to the task's target. Can be set\nonly if Queue.app_engine_http_target is set.\n\nAn App Engine task is a task that has AppEngineHttpRequest set.",
+ "$ref": "AppEngineHttpRequest"
+ },
+ "view": {
+ "enumDescriptions": [
+ "Unspecified. Defaults to BASIC.",
+ "The basic view omits fields which can be large or can contain\nsensitive data.\n\nThis view does not include the payload.",
+ "All information is returned.\n\nPayloads might be desirable to return only when needed, because\nthey can be large and because of the sensitivity of the data\nthat you choose to store in it.\n\nAuthorization for Task.View.FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue.name resource."
+ ],
+ "enum": [
+ "VIEW_UNSPECIFIED",
+ "BASIC",
+ "FULL"
+ ],
+ "description": "Output only.\n\nThe view specifies which subset of the Task has been\nreturned.",
+ "type": "string"
+ },
+ "createTime": {
+ "description": "Output only.\n\nThe time that the task was created.\n\n`create_time` will be truncated to the nearest second.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "scheduleTime": {
+ "description": "The time when the task is scheduled to be attempted.\n\nFor pull queues, this is the time when the task is available to\nbe leased; if a task is currently leased, this is the time when\nthe current lease expires, that is, the time that the task was\nleased plus the PullTasksRequest.lease_duration.\n\nFor App Engine queues, this is when the task will be attempted or retried.\n\n`schedule_time` will be truncated to the nearest microsecond.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "pullMessage": {
+ "$ref": "PullMessage",
+ "description": "Pull message contains data that should be used by the caller of\nCloudTasks.PullTasks to process the task. Can be set only if\nQueue.pull_target is set.\n\nA pull task is a task that has PullMessage set."
+ }
+ }
+ },
+ "Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
+ "properties": {
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ }
+ },
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "Status"
+ },
+ "PullMessage": {
+ "id": "PullMessage",
+ "description": "The pull message contains data that can be used by the caller of\nCloudTasks.PullTasks to process the task.\n\nThis proto can only be used for tasks in a queue which has\nQueue.pull_target set.",
+ "type": "object",
+ "properties": {
+ "payload": {
+ "description": "A data payload consumed by the task worker to execute the task.",
+ "format": "byte",
+ "type": "string"
+ },
+ "tag": {
+ "type": "string",
+ "description": "A meta-data tag for this task.\n\nThis value is used by CloudTasks.PullTasks calls when\nPullTasksRequest.filter is `tag=\u003ctag\u003e`.\n\nThe tag must be less than 500 bytes.",
+ "format": "byte"
+ }
+ }
+ },
+ "Binding": {
+ "properties": {
+ "members": {
+ "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "role": {
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
+ "type": "string"
+ }
+ },
+ "id": "Binding",
+ "description": "Associates `members` with a `role`.",
+ "type": "object"
+ },
+ "RenewLeaseRequest": {
+ "type": "object",
+ "properties": {
+ "scheduleTime": {
+ "description": "Required.\n\nThe task's current schedule time, available in the Task.schedule_time\nreturned in PullTasksResponse.tasks or\nCloudTasks.RenewLease. This restriction is to check that\nthe caller is renewing the correct task.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "newLeaseDuration": {
+ "description": "Required.\n\nThe desired new lease duration, starting from now.\n\n\nThe maximum lease duration is 1 week.\n`new_lease_duration` will be truncated to the nearest second.",
+ "format": "google-duration",
+ "type": "string"
},
"responseView": {
"enumDescriptions": [
@@ -35,43 +1194,241 @@
"type": "string"
}
},
- "id": "CreateTaskRequest"
+ "id": "RenewLeaseRequest",
+ "description": "Request message for renewing a lease using CloudTasks.RenewLease."
+ },
+ "TaskStatus": {
+ "properties": {
+ "attemptResponseCount": {
+ "description": "Output only.\n\nThe number of attempts which have received a response.\n\nThis field is not calculated for\n[pull tasks](google.cloud.tasks.v2beta2.PullTaskTarget).",
+ "format": "int64",
+ "type": "string"
+ },
+ "lastAttemptStatus": {
+ "$ref": "AttemptStatus",
+ "description": "Output only.\n\nThe status of the task's last attempt.\n\nThis field is not calculated for\n[pull tasks](google.cloud.tasks.v2beta2.PullTaskTarget)."
+ },
+ "attemptDispatchCount": {
+ "description": "Output only.\n\nThe number of attempts dispatched. This count includes tasks which have\nbeen dispatched but haven't received a response.",
+ "format": "int64",
+ "type": "string"
+ },
+ "firstAttemptStatus": {
+ "description": "Output only.\n\nThe status of the task's first attempt.\n\nOnly AttemptStatus.dispatch_time will be set.\nThe other AttemptStatus information is not retained by Cloud Tasks.\n\nThis field is not calculated for\n[pull tasks](google.cloud.tasks.v2beta2.PullTaskTarget).",
+ "$ref": "AttemptStatus"
+ }
+ },
+ "id": "TaskStatus",
+ "description": "Status of the task.",
+ "type": "object"
+ },
+ "AppEngineHttpRequest": {
+ "description": "App Engine HTTP request.\n\nThe message defines the HTTP request that is sent to an App Engine app when\nthe task is dispatched.\n\nThis proto can only be used for tasks in a queue which has\nQueue.app_engine_http_target set.\n\nUsing AppEngineHttpRequest requires\n[`appengine.applications.get`](/appengine/docs/admin-api/access-control)\nGoogle IAM permission for the project\nand the following scope:\n\n`https://www.googleapis.com/auth/cloud-platform`\n\nThe task will be delivered to the App Engine app which belongs to the same\nproject as the queue. For more information, see\n[How Requests are Routed](/appengine/docs/standard/python/how-requests-are-routed)\nand how routing is affected by\n[dispatch files](/appengine/docs/python/config/dispatchref).\n\nThe AppEngineRouting used to construct the URL that the task is\ndelivered to can be set at the queue-level or task-level:\n\n* If set, AppEngineHttpTarget.app_engine_routing_override is used for\n all tasks in the queue, no matter what the setting is for the\n task-level app_engine_routing.\n\n\nThe `url` that the task will be sent to is:\n\n* `url =` AppEngineRouting.host `+` AppEngineHttpRequest.relative_url\n\nThe task will be sent to a task handler by an HTTP\nrequest using the specified AppEngineHttpRequest.http_method (for example\nPOST, HTTP GET, etc). The task attempt has succeeded if the task handler\nreturns an HTTP response code in the range [200 - 299]. Error 503 is\nconsidered an App Engine system error instead of an application error.\nRequests returning error 503 will be retried regardless of retry\nconfiguration and not counted against retry counts.\nAny other response code or a failure to receive a response before the\ndeadline is a failed attempt.",
+ "type": "object",
+ "properties": {
+ "relativeUrl": {
+ "description": "The relative URL.\n\nThe relative URL must begin with \"/\" and must be a valid HTTP relative URL.\nIt can contain a path and query string arguments.\nIf the relative URL is empty, then the root path \"/\" will be used.\nNo spaces are allowed, and the maximum length allowed is 2083 characters.",
+ "type": "string"
+ },
+ "headers": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "HTTP request headers.\n\nThis map contains the header field names and values.\nHeaders can be set when the\n[task is created](google.cloud.tasks.v2beta2.CloudTasks.CreateTask).\nRepeated headers are not supported but a header value can contain commas.\n\nCloud Tasks sets some headers to default values:\n\n* `User-Agent`: By default, this header is\n `\"AppEngine-Google; (+http://code.google.com/appengine)\"`.\n This header can be modified, but Cloud Tasks will append\n `\"AppEngine-Google; (+http://code.google.com/appengine)\"` to the\n modified `User-Agent`.\n\nIf the task has an AppEngineHttpRequest.payload, Cloud Tasks sets the\nfollowing headers:\n\n* `Content-Type`: By default, the `Content-Type` header is set to\n `\"application/octet-stream\"`. The default can be overridden by explictly\n setting `Content-Type` to a particular media type when the\n [task is created](google.cloud.tasks.v2beta2.CloudTasks.CreateTask).\n For example, `Content-Type` can be set to `\"application/json\"`.\n* `Content-Length`: This is computed by Cloud Tasks. This value is\n output only. It cannot be changed.\n\nThe headers below cannot be set or overridden:\n\n* `Host`\n* `X-Google-*`\n* `X-AppEngine-*`\n\nIn addition, some App Engine headers, which contain\ntask-specific information, are also be sent to the task handler; see\n[request headers](/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).",
+ "type": "object"
+ },
+ "appEngineRouting": {
+ "$ref": "AppEngineRouting",
+ "description": "Task-level setting for App Engine routing.\n\nIf set, AppEngineHttpTarget.app_engine_routing_override is used for\nall tasks in the queue, no matter what the setting is for the\ntask-level app_engine_routing."
+ },
+ "httpMethod": {
+ "enum": [
+ "HTTP_METHOD_UNSPECIFIED",
+ "POST",
+ "GET",
+ "HEAD",
+ "PUT",
+ "DELETE"
+ ],
+ "description": "The HTTP method to use for the request. The default is POST.\n\nThe app's request handler for the task's target URL must be able to handle\nHTTP requests with this http_method, otherwise the task attempt will fail\nwith error code 405 (Method Not Allowed). See\nthe Request-Line is not allowed for the resource identified by the\nRequest-URI\". See\n[Writing a push task request handler](/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)\nand the documentation for the request handlers in the language your app is\nwritten in e.g.\n[python RequestHandler](/appengine/docs/python/tools/webapp/requesthandlerclass).",
+ "type": "string",
+ "enumDescriptions": [
+ "HTTP method unspecified",
+ "HTTP Post",
+ "HTTP Get",
+ "HTTP Head",
+ "HTTP Put",
+ "HTTP Delete"
+ ]
+ },
+ "payload": {
+ "type": "string",
+ "description": "Payload.\n\nThe payload will be sent as the HTTP message body. A message\nbody, and thus a payload, is allowed only if the HTTP method is\nPOST or PUT. It is an error to set a data payload on a task with\nan incompatible HttpMethod.",
+ "format": "byte"
+ }
+ },
+ "id": "AppEngineHttpRequest"
+ },
+ "AppEngineQueueConfig": {
+ "type": "object",
+ "properties": {
+ "appEngineRoutingOverride": {
+ "description": "Deprecated. Use AppEngineTarget.app_engine_routing_override.",
+ "$ref": "AppEngineRouting"
+ }
+ },
+ "id": "AppEngineQueueConfig",
+ "description": "Deprecated. Use AppEngineTarget."
+ },
+ "PullTaskTarget": {
+ "id": "PullTaskTarget",
+ "description": "Deprecated. Use PullMessage.",
+ "type": "object",
+ "properties": {
+ "payload": {
+ "description": "Deprecated. Use PullMessage.payload.",
+ "format": "byte",
+ "type": "string"
+ },
+ "tag": {
+ "type": "string",
+ "description": "Deprecated. Use PullMessage.tag.",
+ "format": "byte"
+ }
+ }
+ },
+ "TestIamPermissionsResponse": {
+ "properties": {
+ "permissions": {
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "TestIamPermissionsResponse",
+ "description": "Response message for `TestIamPermissions` method.",
+ "type": "object"
+ },
+ "GetIamPolicyRequest": {
+ "description": "Request message for `GetIamPolicy` method.",
+ "type": "object",
+ "properties": {},
+ "id": "GetIamPolicyRequest"
+ },
+ "RetryConfig": {
+ "description": "Retry config.\n\nThese settings determine how a failed task attempt is retried.",
+ "type": "object",
+ "properties": {
+ "maxRetryDuration": {
+ "type": "string",
+ "description": "If positive, `max_retry_duration` specifies the time limit for retrying a\nfailed task, measured from when the task was first attempted. Once\n`max_retry_duration` time has passed *and* the task has been attempted\nRetryConfig.max_attempts times, no further attempts will be made and\nthe task will be deleted.\n\nIf zero, then the task age is unlimited.\n\n* For [App Engine queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget),\n this field is 0 seconds by default.\n* For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this\n field is output only and always 0.\n\n`max_retry_duration` will be truncated to the nearest second.\n\nThis field has the same meaning as\n[task_age_limit in queue.yaml](/appengine/docs/standard/python/config/queueref#retry_parameters).",
+ "format": "google-duration"
+ },
+ "maxAttempts": {
+ "description": "The maximum number of attempts for a task.\n\nCloud Tasks will attempt the task `max_attempts` times (that\nis, if the first attempt fails, then there will be\n`max_attempts - 1` retries). Must be \u003e 0.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "maxDoublings": {
+ "description": "The time between retries increases exponentially `max_doublings` times.\n`max_doublings` is maximum number of times that the interval between failed\ntask retries will be doubled before the interval increases linearly.\nAfter max_doublings intervals, the retry interval will be\n2^(max_doublings - 1) * RetryConfig.min_backoff.\n\n* For [App Engine queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget),\n this field is 16 by default.\n* For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this field\n is output only and always 0.\n\nThis field has the same meaning as\n[max_doublings in queue.yaml](/appengine/docs/standard/python/config/queueref#retry_parameters).",
+ "format": "int32",
+ "type": "integer"
+ },
+ "unlimitedAttempts": {
+ "description": "If true, then the number of attempts is unlimited.",
+ "type": "boolean"
+ },
+ "minBackoff": {
+ "description": "The minimum amount of time to wait before retrying a task after\nit fails.\n\n* For [App Engine queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget),\n this field is 0.1 seconds by default.\n* For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this\n field is output only and always 0.\n\n`min_backoff` will be truncated to the nearest second.\n\nThis field has the same meaning as\n[min_backoff_seconds in queue.yaml](/appengine/docs/standard/python/config/queueref#retry_parameters).",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "maxBackoff": {
+ "description": "The maximum amount of time to wait before retrying a task after\nit fails. The default is 1 hour.\n\n* For [App Engine queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget),\n this field is 1 hour by default.\n* For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this field\n is output only and always 0.\n\n`max_backoff` will be truncated to the nearest second.\n\nThis field has the same meaning as\n[max_backoff_seconds in queue.yaml](/appengine/docs/standard/python/config/queueref#retry_parameters).",
+ "format": "google-duration",
+ "type": "string"
+ }
+ },
+ "id": "RetryConfig"
+ },
+ "PullTarget": {
+ "description": "Pull target.",
+ "type": "object",
+ "properties": {},
+ "id": "PullTarget"
+ },
+ "ResumeQueueRequest": {
+ "properties": {},
+ "id": "ResumeQueueRequest",
+ "description": "Request message for CloudTasks.ResumeQueue.",
+ "type": "object"
},
"ListTasksResponse": {
"description": "Response message for listing tasks using CloudTasks.ListTasks.",
"type": "object",
"properties": {
- "nextPageToken": {
- "format": "byte",
- "description": "A token to retrieve next page of results.\n\nTo return the next page of results, call\nCloudTasks.ListTasks with this value as the\nListTasksRequest.page_token.\n\nIf the next_page_token is empty, there are no more results.",
- "type": "string"
- },
"tasks": {
"description": "The list of tasks.",
+ "type": "array",
"items": {
"$ref": "Task"
- },
- "type": "array"
+ }
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve next page of results.\n\nTo return the next page of results, call\nCloudTasks.ListTasks with this value as the\nListTasksRequest.page_token.\n\nIf the next_page_token is empty, there are no more results.",
+ "format": "byte",
+ "type": "string"
}
},
"id": "ListTasksResponse"
},
- "PullQueueConfig": {
- "description": "Deprecated. Use PullTarget.",
- "type": "object",
- "properties": {},
- "id": "PullQueueConfig"
+ "CreateTaskRequest": {
+ "properties": {
+ "responseView": {
+ "enumDescriptions": [
+ "Unspecified. Defaults to BASIC.",
+ "The basic view omits fields which can be large or can contain\nsensitive data.\n\nThis view does not include the payload.",
+ "All information is returned.\n\nPayloads might be desirable to return only when needed, because\nthey can be large and because of the sensitivity of the data\nthat you choose to store in it.\n\nAuthorization for Task.View.FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue.name resource."
+ ],
+ "enum": [
+ "VIEW_UNSPECIFIED",
+ "BASIC",
+ "FULL"
+ ],
+ "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for Task.View.FULL requires `cloudtasks.tasks.fullView`\n[Google IAM](/iam/) permission on the\nTask.name resource.",
+ "type": "string"
+ },
+ "task": {
+ "description": "Required.\n\nThe task to add.\n\nTask names have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.\nThe user can optionally specify a name for the task in\nTask.name. If a name is not specified then the system will\ngenerate a random unique task id, which will be returned in the\nresponse's Task.name.\n\nIf Task.schedule_time is not set or is in the past then Cloud\nTasks will set it to the current time.\n\nTask De-duplication:\n\nExplicitly specifying a task ID enables task de-duplication. If\na task's ID is identical to that of an existing task or a task\nthat was deleted or completed recently then the call will fail\nwith google.rpc.Code.ALREADY_EXISTS. If the task's queue was\ncreated using Cloud Tasks, then another task with the same name\ncan't be created for ~1hour after the original task was deleted\nor completed. If the task's queue was created using queue.yaml or\nqueue.xml, then another task with the same name can't be created\nfor ~9days after the original task was deleted or completed.\n\nBecause there is an extra lookup cost to identify duplicate task\nnames, these CloudTasks.CreateTask calls have significantly\nincreased latency. Using hashed strings for the task id or for\nthe prefix of the task id is recommended. Choosing task ids that\nare sequential or have sequential prefixes, for example using a\ntimestamp, causes an increase in latency and error rates in all\ntask commands. The infrastructure relies on an approximately\nuniform distribution of task ids to store and serve tasks\nefficiently.",
+ "$ref": "Task"
+ }
+ },
+ "id": "CreateTaskRequest",
+ "description": "Request message for CloudTasks.CreateTask.",
+ "type": "object"
},
"Queue": {
"description": "A queue is a container of related tasks. Queues are configured to manage\nhow those tasks are dispatched. Configurable properties include rate limits,\nretry options, target types, and others.",
"type": "object",
"properties": {
"purgeTime": {
- "type": "string",
+ "description": "Output only.\n\nThe last time this queue was purged. All tasks that were\ncreated before this time were purged.\n\nA queue can be purged using CloudTasks.PurgeQueue, the\n[App Engine Task Queue SDK, or the Cloud Console](/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).\n\nPurge time will be truncated to the nearest microsecond. Purge\ntime will be zero if the queue has never been purged.",
"format": "google-datetime",
- "description": "Output only.\n\nThe last time this queue was purged. All tasks that were\ncreated before this time were purged.\n\nA queue can be purged using CloudTasks.PurgeQueue, the\n[App Engine Task Queue SDK, or the Cloud Console](/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).\n\nPurge time will be truncated to the nearest microsecond. Purge\ntime will be zero if the queue has never been purged."
+ "type": "string"
+ },
+ "retryConfig": {
+ "$ref": "RetryConfig",
+ "description": "Settings that determine the retry behavior.\n\n* For tasks created using Cloud Tasks: the queue-level retry settings\n apply to all tasks in the queue that were created using Cloud Tasks.\n Retry settings cannot be set on individual tasks.\n* For tasks created using the App Engine SDK: the queue-level retry\n settings apply to all tasks in the queue which do not have retry settings\n explicitly set on the task and were created by the App Engine SDK. See\n [App Engine documentation](/appengine/docs/standard/python/taskqueue/push/retrying-tasks)."
},
"queueState": {
+ "enumDescriptions": [
+ "Unspecified state.",
+ "The queue is running. Tasks can be dispatched.",
+ "Tasks are paused by the user. If the queue is paused then Cloud\nTasks will stop delivering tasks from it, but more tasks can\nstill be added to it by the user. When a pull queue is paused,\nall CloudTasks.PullTasks calls will return a\n`FAILED_PRECONDITION` error.",
+ "The queue is disabled.\n\nA queue becomes `DISABLED` when\n[queue.yaml](/appengine/docs/python/config/queueref) or\n[queue.xml](appengine/docs/standard/java/config/queueref) is uploaded\nwhich does not contain the queue. You cannot directly disable a queue.\n\nWhen a queue is disabled, tasks can still be added to a queue\nbut the tasks are not dispatched and CloudTasks.PullTasks calls\nreturn a `FAILED_PRECONDITION` error.\n\nTo permanently delete this queue and all of its tasks, call\nCloudTasks.DeleteQueue."
+ ],
"enum": [
"QUEUE_STATE_UNSPECIFIED",
"RUNNING",
@@ -79,21 +1436,11 @@
"DISABLED"
],
"description": "Output only.\n\nThe state of the queue.\n\n`queue_state` can only be changed by called\nCloudTasks.PauseQueue, CloudTasks.ResumeQueue, or uploading\n[queue.yaml](/appengine/docs/python/config/queueref).\nCloudTasks.UpdateQueue cannot be used to change `queue_state`.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified state.",
- "The queue is running. Tasks can be dispatched.",
- "Tasks are paused by the user. If the queue is paused then Cloud\nTasks will stop delivering tasks from it, but more tasks can\nstill be added to it by the user. When a pull queue is paused,\nall CloudTasks.PullTasks calls will return a\n`FAILED_PRECONDITION` error.",
- "The queue is disabled.\n\nA queue becomes `DISABLED` when\n[queue.yaml](/appengine/docs/python/config/queueref) or\n[queue.xml](appengine/docs/standard/java/config/queueref) is uploaded\nwhich does not contain the queue. You cannot directly disable a queue.\n\nWhen a queue is disabled, tasks can still be added to a queue\nbut the tasks are not dispatched and CloudTasks.PullTasks calls\nreturn a `FAILED_PRECONDITION` error.\n\nTo permanently delete this queue and all of its tasks, call\nCloudTasks.DeleteQueue."
- ]
- },
- "retryConfig": {
- "$ref": "RetryConfig",
- "description": "Settings that determine the retry behavior.\n\n* For tasks created using Cloud Tasks: the queue-level retry settings\n apply to all tasks in the queue that were created using Cloud Tasks.\n Retry settings cannot be set on individual tasks.\n* For tasks created using the App Engine SDK: the queue-level retry\n settings apply to all tasks in the queue which do not have retry settings\n explicitly set on the task and were created by the App Engine SDK. See\n [App Engine documentation](/appengine/docs/standard/python/taskqueue/push/retrying-tasks)."
+ "type": "string"
},
"name": {
- "description": "The queue name.\n\nThe queue name must have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`\n\n* `PROJECT_ID` can contain uppercase and lowercase letters,\n numbers, hyphens, colons, and periods; that is, it must match\n the regular expression: `[a-zA-Z\\\\d-:\\\\.]+`.\n* `QUEUE_ID` can contain uppercase and lowercase letters,\n numbers, and hyphens; that is, it must match the regular\n expression: `[a-zA-Z\\\\d-]+`. The maximum length is 100\n characters.\n\nCaller-specified and required in CreateQueueRequest, after which\nit becomes output only.",
- "type": "string"
+ "type": "string",
+ "description": "The queue name.\n\nThe queue name must have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`\n\n* `PROJECT_ID` can contain uppercase and lowercase letters,\n numbers, hyphens, colons, and periods; that is, it must match\n the regular expression: `[a-zA-Z\\\\d-:\\\\.]+`.\n* `QUEUE_ID` can contain uppercase and lowercase letters,\n numbers, and hyphens; that is, it must match the regular\n expression: `[a-zA-Z\\\\d-]+`. The maximum length is 100\n characters.\n\nCaller-specified and required in CreateQueueRequest, after which\nit becomes output only."
},
"rateLimits": {
"$ref": "RateLimits",
@@ -118,19 +1465,30 @@
},
"id": "Queue"
},
+ "PullQueueConfig": {
+ "description": "Deprecated. Use PullTarget.",
+ "type": "object",
+ "properties": {},
+ "id": "PullQueueConfig"
+ },
"PullTasksRequest": {
+ "description": "Request message for pulling tasks using CloudTasks.PullTasks.",
"type": "object",
"properties": {
- "leaseDuration": {
- "format": "google-duration",
- "description": "The duration of the lease.\n\nEach task returned in the PullTasksResponse will have its\nTask.schedule_time set to the current time plus the\n`lease_duration`. A task that has been returned in a\nPullTasksResponse is leased -- that task will not be\nreturned in a different PullTasksResponse before the\nTask.schedule_time.\n\nAfter the lease holder has successfully finished the work\nassociated with the task, the lease holder must call\nCloudTasks.AcknowledgeTask. If the task is not acknowledged\nvia CloudTasks.AcknowledgeTask before the\nTask.schedule_time then it will be returned in a later\nPullTasksResponse so that another lease holder can process\nit.\n\nThe maximum lease duration is 1 week.\n`lease_duration` will be truncated to the nearest second.",
+ "filter": {
+ "description": "`filter` can be used to specify a subset of tasks to lease.\n\nWhen `filter` is set to `tag=\u003cmy-tag\u003e` then the\nPullTasksResponse will contain only tasks whose\nPullMessage.tag is equal to `\u003cmy-tag\u003e`. `\u003cmy-tag\u003e` must be less than\n500 bytes.\n\nWhen `filter` is set to `tag_function=oldest_tag()`, only tasks which have\nthe same tag as the task with the oldest schedule_time will be returned.\n\nGrammar Syntax:\n\n* `filter = \"tag=\" tag | \"tag_function=\" function`\n\n* `tag = string | bytes`\n\n* `function = \"oldest_tag()\"`\n\nThe `oldest_tag()` function returns tasks which have the same tag as the\noldest task (ordered by schedule time).",
"type": "string"
},
"maxTasks": {
- "format": "int32",
"description": "The maximum number of tasks to lease. The maximum that can be\nrequested is 1000.",
+ "format": "int32",
"type": "integer"
},
+ "leaseDuration": {
+ "description": "The duration of the lease.\n\nEach task returned in the PullTasksResponse will have its\nTask.schedule_time set to the current time plus the\n`lease_duration`. A task that has been returned in a\nPullTasksResponse is leased -- that task will not be\nreturned in a different PullTasksResponse before the\nTask.schedule_time.\n\nAfter the lease holder has successfully finished the work\nassociated with the task, the lease holder must call\nCloudTasks.AcknowledgeTask. If the task is not acknowledged\nvia CloudTasks.AcknowledgeTask before the\nTask.schedule_time then it will be returned in a later\nPullTasksResponse so that another lease holder can process\nit.\n\nThe maximum lease duration is 1 week.\n`lease_duration` will be truncated to the nearest second.",
+ "format": "google-duration",
+ "type": "string"
+ },
"responseView": {
"enumDescriptions": [
"Unspecified. Defaults to BASIC.",
@@ -144,14 +1502,9 @@
],
"description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for Task.View.FULL requires `cloudtasks.tasks.fullView`\n[Google IAM](/iam/) permission on the\nTask.name resource.",
"type": "string"
- },
- "filter": {
- "description": "`filter` can be used to specify a subset of tasks to lease.\n\nWhen `filter` is set to `tag=\u003cmy-tag\u003e` then the\nPullTasksResponse will contain only tasks whose\nPullMessage.tag is equal to `\u003cmy-tag\u003e`. `\u003cmy-tag\u003e` must be less than\n500 bytes.\n\nWhen `filter` is set to `tag_function=oldest_tag()`, only tasks which have\nthe same tag as the task with the oldest schedule_time will be returned.\n\nGrammar Syntax:\n\n* `filter = \"tag=\" tag | \"tag_function=\" function`\n\n* `tag = string | bytes`\n\n* `function = \"oldest_tag()\"`\n\nThe `oldest_tag()` function returns tasks which have the same tag as the\noldest task (ordered by schedule time).",
- "type": "string"
}
},
- "id": "PullTasksRequest",
- "description": "Request message for pulling tasks using CloudTasks.PullTasks."
+ "id": "PullTasksRequest"
},
"SetIamPolicyRequest": {
"description": "Request message for `SetIamPolicy` method.",
@@ -165,9 +1518,14 @@
"id": "SetIamPolicyRequest"
},
"AppEngineRouting": {
+ "id": "AppEngineRouting",
"description": "App Engine Routing.\n\nFor more information about services, versions, and instances see\n[An Overview of App Engine](/appengine/docs/python/an-overview-of-app-engine),\n[Microservices Architecture on Google App Engine](/appengine/docs/python/microservices-on-app-engine),\n[App Engine Standard request routing](/appengine/docs/standard/python/how-requests-are-routed),\nand [App Engine Flex request routing](/appengine/docs/flexible/python/how-requests-are-routed).",
"type": "object",
"properties": {
+ "service": {
+ "description": "App service.\n\nBy default, the task is sent to the service which is the default\nservice when the task is attempted (\"default\").\n\nFor some queues or tasks which were created using the App Engine Task Queue\nAPI, AppEngineRouting.host is not parsable into\nAppEngineRouting.service, AppEngineRouting.version, and\nAppEngineRouting.instance. For example, some tasks which were created\nusing the App Engine SDK use a custom domain name; custom domains are not\nparsed by Cloud Tasks. If AppEngineRouting.host is not parsable, then\nAppEngineRouting.service, AppEngineRouting.version, and\nAppEngineRouting.instance are the empty string.",
+ "type": "string"
+ },
"instance": {
"description": "App instance.\n\nBy default, the task is sent to an instance which is available when\nthe task is attempted.\n\nRequests can only be sent to a specific instance if\n[manual scaling is used in App Engine Standard](/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).\nApp Engine Flex does not support instances. For more information, see\n[App Engine Standard request routing](/appengine/docs/standard/python/how-requests-are-routed)\nand [App Engine Flex request routing](/appengine/docs/flexible/python/how-requests-are-routed).",
"type": "string"
@@ -179,13 +1537,8 @@
"host": {
"description": "Output only.\n\nThe host that the task is sent to. For more information, see\n[How Requests are Routed](/appengine/docs/standard/python/how-requests-are-routed).\n\nThe host is constructed as:\n\n\n* `host = [application_domain_name]`\u003c/br\u003e\n `| [service] + '.' + [application_domain_name]`\u003c/br\u003e\n `| [version] + '.' + [application_domain_name]`\u003c/br\u003e\n `| [version_dot_service]+ '.' + [application_domain_name]`\u003c/br\u003e\n `| [instance] + '.' + [application_domain_name]`\u003c/br\u003e\n `| [instance_dot_service] + '.' + [application_domain_name]`\u003c/br\u003e\n `| [instance_dot_version] + '.' + [application_domain_name]`\u003c/br\u003e\n `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`\n\n* `application_domain_name` = The domain name of the app, for\n example \u003capp-id\u003e.appspot.com, which is associated with the\n queue's project ID. Some tasks which were created using the App Engine\n SDK use a custom domain name.\n\n* `service =` AppEngineRouting.service\n\n* `version =` AppEngineRouting.version\n\n* `version_dot_service =`\n AppEngineRouting.version `+ '.' +` AppEngineRouting.service\n\n* `instance =` AppEngineRouting.instance\n\n* `instance_dot_service =`\n AppEngineRouting.instance `+ '.' +` AppEngineRouting.service\n\n* `instance_dot_version =`\n AppEngineRouting.instance `+ '.' +` AppEngineRouting.version\n\n* `instance_dot_version_dot_service =`\n AppEngineRouting.instance `+ '.' +`\n AppEngineRouting.version `+ '.' +` AppEngineRouting.service\n\nIf AppEngineRouting.service is empty, then the task will be sent\nto the service which is the default service when the task is attempted.\n\nIf AppEngineRouting.version is empty, then the task will be sent\nto the version which is the default version when the task is attempted.\n\nIf AppEngineRouting.instance is empty, then the task will be sent\nto an instance which is available when the task is attempted.\n\nWhen AppEngineRouting.service is \"default\",\nAppEngineRouting.version is \"default\", and\nAppEngineRouting.instance is empty, AppEngineRouting.host is\nshortened to just the `application_domain_name`.\n\nIf AppEngineRouting.service, AppEngineRouting.version, or\nAppEngineRouting.instance is invalid, then the task will be sent\nto the default version of the default service when the task is attempted.",
"type": "string"
- },
- "service": {
- "type": "string",
- "description": "App service.\n\nBy default, the task is sent to the service which is the default\nservice when the task is attempted (\"default\").\n\nFor some queues or tasks which were created using the App Engine Task Queue\nAPI, AppEngineRouting.host is not parsable into\nAppEngineRouting.service, AppEngineRouting.version, and\nAppEngineRouting.instance. For example, some tasks which were created\nusing the App Engine SDK use a custom domain name; custom domains are not\nparsed by Cloud Tasks. If AppEngineRouting.host is not parsable, then\nAppEngineRouting.service, AppEngineRouting.version, and\nAppEngineRouting.instance are the empty string."
}
- },
- "id": "AppEngineRouting"
+ }
},
"Empty": {
"properties": {},
@@ -194,19 +1547,17 @@
"type": "object"
},
"AppEngineHttpTarget": {
- "id": "AppEngineHttpTarget",
- "description": "App Engine HTTP target.\n\nThe task will be delivered to the App Engine application hostname\nspecified by its AppEngineHttpTarget and AppEngineHttpRequest.\nThe documentation for AppEngineHttpRequest explains how the\ntask's host URL is constructed.\n\nUsing AppEngineHttpTarget requires\n[`appengine.applications.get`](/appengine/docs/admin-api/access-control)\nGoogle IAM permission for the project\nand the following scope:\n\n`https://www.googleapis.com/auth/cloud-platform`",
"type": "object",
"properties": {
"appEngineRoutingOverride": {
"$ref": "AppEngineRouting",
"description": "Overrides for the\ntask-level app_engine_routing.\n\nIf set, AppEngineHttpTarget.app_engine_routing_override is used for\nall tasks in the queue, no matter what the setting is for the\ntask-level app_engine_routing."
}
- }
+ },
+ "id": "AppEngineHttpTarget",
+ "description": "App Engine HTTP target.\n\nThe task will be delivered to the App Engine application hostname\nspecified by its AppEngineHttpTarget and AppEngineHttpRequest.\nThe documentation for AppEngineHttpRequest explains how the\ntask's host URL is constructed.\n\nUsing AppEngineHttpTarget requires\n[`appengine.applications.get`](/appengine/docs/admin-api/access-control)\nGoogle IAM permission for the project\nand the following scope:\n\n`https://www.googleapis.com/auth/cloud-platform`"
},
"Location": {
- "description": "A resource that represents Google Cloud Platform location.",
- "type": "object",
"properties": {
"name": {
"description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
@@ -217,588 +1568,31 @@
"type": "string"
},
"metadata": {
- "description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
"type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- }
+ },
+ "description": "Service-specific metadata. For example the available capacity at the given\nlocation."
},
"labels": {
- "additionalProperties": {
- "type": "string"
- },
"description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
- "type": "object"
- }
- },
- "id": "Location"
- },
- "AcknowledgeTaskRequest": {
- "type": "object",
- "properties": {
- "scheduleTime": {
- "format": "google-datetime",
- "description": "Required.\n\nThe task's current schedule time, available in the Task.schedule_time\nreturned in PullTasksResponse.tasks or\nCloudTasks.RenewLease. This restriction is to check that\nthe caller is acknowledging the correct task.",
- "type": "string"
- }
- },
- "id": "AcknowledgeTaskRequest",
- "description": "Request message for acknowledging a task using\nCloudTasks.AcknowledgeTask."
- },
- "ListQueuesResponse": {
- "description": "Response message for CloudTasks.ListQueues.",
- "type": "object",
- "properties": {
- "queues": {
- "description": "The list of queues.",
- "items": {
- "$ref": "Queue"
- },
- "type": "array"
- },
- "nextPageToken": {
- "format": "byte",
- "description": "A token to retrieve next page of results.\n\nTo return the next page of results, call\nCloudTasks.ListQueues with this value as the\nListQueuesRequest.page_token.\n\nIf the next_page_token is empty, there are no more results.\n\nThe page token is valid for only 2 hours.",
- "type": "string"
- }
- },
- "id": "ListQueuesResponse"
- },
- "TestIamPermissionsRequest": {
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "TestIamPermissionsRequest"
- },
- "Policy": {
- "properties": {
- "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": {
- "format": "byte",
- "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.",
- "type": "string"
- },
- "version": {
- "format": "int32",
- "description": "Version of the `Policy`. The default version is 0.",
- "type": "integer"
- }
- },
- "id": "Policy",
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
- "type": "object"
- },
- "ListLocationsResponse": {
- "description": "The response message for Locations.ListLocations.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
- "locations": {
- "description": "A list of locations that matches the specified filter in the request.",
- "items": {
- "$ref": "Location"
- },
- "type": "array"
- }
- },
- "id": "ListLocationsResponse"
- },
- "AppEngineTaskTarget": {
- "properties": {
- "appEngineRouting": {
- "$ref": "AppEngineRouting",
- "description": "Deprecated. Use AppEngineHttpRequest.app_engine_routing."
- },
- "httpMethod": {
- "description": "Deprecated. Use AppEngineHttpRequest.http_method.",
- "type": "string",
- "enumDescriptions": [
- "HTTP method unspecified",
- "HTTP Post",
- "HTTP Get",
- "HTTP Head",
- "HTTP Put",
- "HTTP Delete"
- ],
- "enum": [
- "HTTP_METHOD_UNSPECIFIED",
- "POST",
- "GET",
- "HEAD",
- "PUT",
- "DELETE"
- ]
- },
- "payload": {
- "format": "byte",
- "description": "Deprecated. Use AppEngineHttpRequest.payload.",
- "type": "string"
- },
- "relativeUrl": {
- "description": "Deprecated. Use AppEngineHttpRequest.relative_url.",
- "type": "string"
- },
- "headers": {
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "Deprecated. Use AppEngineHttpRequest.headers.",
- "type": "object"
+ }
}
},
- "id": "AppEngineTaskTarget",
- "description": "Deprecated. Use AppEngineHttpRequest.",
+ "id": "Location",
+ "description": "A resource that represents Google Cloud Platform location.",
"type": "object"
- },
- "CancelLeaseRequest": {
- "description": "Request message for canceling a lease using\nCloudTasks.CancelLease.",
- "type": "object",
- "properties": {
- "scheduleTime": {
- "format": "google-datetime",
- "description": "Required.\n\nThe task's current schedule time, available in the Task.schedule_time\nreturned in PullTasksResponse.tasks or\nCloudTasks.RenewLease. This restriction is to check that\nthe caller is canceling the correct task.",
- "type": "string"
- },
- "responseView": {
- "enum": [
- "VIEW_UNSPECIFIED",
- "BASIC",
- "FULL"
- ],
- "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for Task.View.FULL requires `cloudtasks.tasks.fullView`\n[Google IAM](/iam/) permission on the\nTask.name resource.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified. Defaults to BASIC.",
- "The basic view omits fields which can be large or can contain\nsensitive data.\n\nThis view does not include the payload.",
- "All information is returned.\n\nPayloads might be desirable to return only when needed, because\nthey can be large and because of the sensitivity of the data\nthat you choose to store in it.\n\nAuthorization for Task.View.FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue.name resource."
- ]
- }
- },
- "id": "CancelLeaseRequest"
- },
- "AttemptStatus": {
- "description": "The status of a task attempt.",
- "type": "object",
- "properties": {
- "dispatchTime": {
- "format": "google-datetime",
- "description": "Output only.\n\nThe time that this attempt was dispatched.\n\n`dispatch_time` will be truncated to the nearest microsecond.",
- "type": "string"
- },
- "responseStatus": {
- "$ref": "Status",
- "description": "Output only.\n\nThe response from the target for this attempt.\n\nIf the task has not been attempted or the task is currently running\nthen the response status is google.rpc.Code.UNKNOWN."
- },
- "responseTime": {
- "type": "string",
- "format": "google-datetime",
- "description": "Output only.\n\nThe time that this attempt response was received.\n\n`response_time` will be truncated to the nearest microsecond."
- },
- "scheduleTime": {
- "format": "google-datetime",
- "description": "Output only.\n\nThe time that this attempt was scheduled.\n\n`schedule_time` will be truncated to the nearest microsecond.",
- "type": "string"
- }
- },
- "id": "AttemptStatus"
- },
- "RateLimits": {
- "type": "object",
- "properties": {
- "maxConcurrentTasks": {
- "format": "int32",
- "description": "The maximum number of concurrent tasks that Cloud Tasks allows\nto be dispatched for this queue. After this threshold has been\nreached, Cloud Tasks stops dispatching tasks until the number of\nconcurrent requests decreases.\n\nThe maximum allowed value is 5,000.\n\n* For App Engine queues, this field is 10 by default.\n* For pull queues, this field is output only and always -1, which\n indicates no limit.\n\nThis field has the same meaning as\n[max_concurrent_requests in queue.yaml](/appengine/docs/standard/python/config/queueref#max_concurrent_requests).",
- "type": "integer"
- },
- "maxTasksDispatchedPerSecond": {
- "format": "double",
- "description": "The maximum rate at which tasks are dispatched from this\nqueue.\n\nThe maximum allowed value is 500.\n\n* For App Engine queues, this field is 1 by default.\n* For pull queues, this field is output only and always 10,000.\n\nThis field has the same meaning as\n[rate in queue.yaml](/appengine/docs/standard/python/config/queueref#rate).",
- "type": "number"
- },
- "maxBurstSize": {
- "format": "int32",
- "description": "Output only.\n\nThe max burst size limits how fast the queue is processed when\nmany tasks are in the queue and the rate is high. This field\nallows the queue to have a high rate so processing starts shortly\nafter a task is enqueued, but still limits resource usage when\nmany tasks are enqueued in a short period of time.\n\n* For App Engine queues, if\n RateLimits.max_tasks_dispatched_per_second is 1, this\n field is 10; otherwise this field is\n RateLimits.max_tasks_dispatched_per_second / 5.\n* For pull queues, this field is output only and always 10,000.\n\nNote: For App Engine queues that were created through\n`queue.yaml/xml`, `max_burst_size` might not have the same\nsettings as specified above; CloudTasks.UpdateQueue can be\nused to set `max_burst_size` only to the values specified above.\n\nThis field has the same meaning as\n[bucket_size in queue.yaml](/appengine/docs/standard/python/config/queueref#bucket_size).",
- "type": "integer"
- }
- },
- "id": "RateLimits",
- "description": "Rate limits.\n\nThis message determines the maximum rate that tasks can be dispatched by a\nqueue, regardless of whether the dispatch is a first task attempt or a retry."
- },
- "PauseQueueRequest": {
- "description": "Request message for CloudTasks.PauseQueue.",
- "type": "object",
- "properties": {},
- "id": "PauseQueueRequest"
- },
- "PurgeQueueRequest": {
- "type": "object",
- "properties": {},
- "id": "PurgeQueueRequest",
- "description": "Request message for CloudTasks.PurgeQueue."
- },
- "PullTasksResponse": {
- "properties": {
- "tasks": {
- "description": "The leased tasks.",
- "items": {
- "$ref": "Task"
- },
- "type": "array"
- }
- },
- "id": "PullTasksResponse",
- "description": "Response message for pulling tasks using CloudTasks.PullTasks.",
- "type": "object"
- },
- "RunTaskRequest": {
- "description": "Request message for forcing a task to run now using\nCloudTasks.RunTask.",
- "type": "object",
- "properties": {
- "responseView": {
- "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for Task.View.FULL requires `cloudtasks.tasks.fullView`\n[Google IAM](/iam/) permission on the\nTask.name resource.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified. Defaults to BASIC.",
- "The basic view omits fields which can be large or can contain\nsensitive data.\n\nThis view does not include the payload.",
- "All information is returned.\n\nPayloads might be desirable to return only when needed, because\nthey can be large and because of the sensitivity of the data\nthat you choose to store in it.\n\nAuthorization for Task.View.FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue.name resource."
- ],
- "enum": [
- "VIEW_UNSPECIFIED",
- "BASIC",
- "FULL"
- ]
- }
- },
- "id": "RunTaskRequest"
- },
- "Task": {
- "description": "A unit of scheduled work.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The task name.\n\nThe task name must have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`\n\n* `PROJECT_ID` can contain uppercase and lowercase letters,\n numbers, hyphens, colons, and periods; that is, it must match\n the regular expression: `[a-zA-Z\\\\d-:\\\\.]+`.\n* `QUEUE_ID` can contain uppercase and lowercase letters,\n numbers, and hyphens; that is, it must match the regular\n expression: `[a-zA-Z\\\\d-]+`. The maximum length is 100\n characters.\n* `TASK_ID` contain uppercase and lowercase letters, numbers,\n underscores, and hyphens; that is, it must match the regular\n expression: `[a-zA-Z\\\\d_-]+`. The maximum length is 500\n characters.\n\nOptionally caller-specified in CreateTaskRequest.",
- "type": "string"
- },
- "appEngineTaskTarget": {
- "description": "Deprecated. Use Task.app_engine_http_request.",
- "$ref": "AppEngineTaskTarget"
- },
- "taskStatus": {
- "description": "Output only.\n\nTask status.",
- "$ref": "TaskStatus"
- },
- "appEngineHttpRequest": {
- "$ref": "AppEngineHttpRequest",
- "description": "App Engine HTTP request that is sent to the task's target. Can be set\nonly if Queue.app_engine_http_target is set.\n\nAn App Engine task is a task that has AppEngineHttpRequest set."
- },
- "pullTaskTarget": {
- "description": "Deprecated. Use Task.pull_message.",
- "$ref": "PullTaskTarget"
- },
- "view": {
- "description": "Output only.\n\nThe view specifies which subset of the Task has been\nreturned.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified. Defaults to BASIC.",
- "The basic view omits fields which can be large or can contain\nsensitive data.\n\nThis view does not include the payload.",
- "All information is returned.\n\nPayloads might be desirable to return only when needed, because\nthey can be large and because of the sensitivity of the data\nthat you choose to store in it.\n\nAuthorization for Task.View.FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue.name resource."
- ],
- "enum": [
- "VIEW_UNSPECIFIED",
- "BASIC",
- "FULL"
- ]
- },
- "scheduleTime": {
- "format": "google-datetime",
- "description": "The time when the task is scheduled to be attempted.\n\nFor pull queues, this is the time when the task is available to\nbe leased; if a task is currently leased, this is the time when\nthe current lease expires, that is, the time that the task was\nleased plus the PullTasksRequest.lease_duration.\n\nFor App Engine queues, this is when the task will be attempted or retried.\n\n`schedule_time` will be truncated to the nearest microsecond.",
- "type": "string"
- },
- "pullMessage": {
- "$ref": "PullMessage",
- "description": "Pull message contains data that should be used by the caller of\nCloudTasks.PullTasks to process the task. Can be set only if\nQueue.pull_target is set.\n\nA pull task is a task that has PullMessage set."
- },
- "createTime": {
- "format": "google-datetime",
- "description": "Output only.\n\nThe time that the task was created.\n\n`create_time` will be truncated to the nearest second.",
- "type": "string"
- }
- },
- "id": "Task"
- },
- "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.",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- },
- "type": "array"
- },
- "code": {
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "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"
- },
- "PullMessage": {
- "description": "The pull message contains data that can be used by the caller of\nCloudTasks.PullTasks to process the task.\n\nThis proto can only be used for tasks in a queue which has\nQueue.pull_target set.",
- "type": "object",
- "properties": {
- "payload": {
- "format": "byte",
- "description": "A data payload consumed by the task worker to execute the task.",
- "type": "string"
- },
- "tag": {
- "format": "byte",
- "description": "A meta-data tag for this task.\n\nThis value is used by CloudTasks.PullTasks calls when\nPullTasksRequest.filter is `tag=\u003ctag\u003e`.\n\nThe tag must be less than 500 bytes.",
- "type": "string"
- }
- },
- "id": "PullMessage"
- },
- "Binding": {
- "description": "Associates `members` with a `role`.",
- "type": "object",
- "properties": {
- "members": {
- "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "role": {
- "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
- "type": "string"
- }
- },
- "id": "Binding"
- },
- "RenewLeaseRequest": {
- "properties": {
- "responseView": {
- "enum": [
- "VIEW_UNSPECIFIED",
- "BASIC",
- "FULL"
- ],
- "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for Task.View.FULL requires `cloudtasks.tasks.fullView`\n[Google IAM](/iam/) permission on the\nTask.name resource.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified. Defaults to BASIC.",
- "The basic view omits fields which can be large or can contain\nsensitive data.\n\nThis view does not include the payload.",
- "All information is returned.\n\nPayloads might be desirable to return only when needed, because\nthey can be large and because of the sensitivity of the data\nthat you choose to store in it.\n\nAuthorization for Task.View.FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue.name resource."
- ]
- },
- "scheduleTime": {
- "format": "google-datetime",
- "description": "Required.\n\nThe task's current schedule time, available in the Task.schedule_time\nreturned in PullTasksResponse.tasks or\nCloudTasks.RenewLease. This restriction is to check that\nthe caller is renewing the correct task.",
- "type": "string"
- },
- "newLeaseDuration": {
- "format": "google-duration",
- "description": "Required.\n\nThe desired new lease duration, starting from now.\n\n\nThe maximum lease duration is 1 week.\n`new_lease_duration` will be truncated to the nearest second.",
- "type": "string"
- }
- },
- "id": "RenewLeaseRequest",
- "description": "Request message for renewing a lease using CloudTasks.RenewLease.",
- "type": "object"
- },
- "TaskStatus": {
- "description": "Status of the task.",
- "type": "object",
- "properties": {
- "lastAttemptStatus": {
- "description": "Output only.\n\nThe status of the task's last attempt.\n\nThis field is not calculated for\n[pull tasks](google.cloud.tasks.v2beta2.PullTaskTarget).",
- "$ref": "AttemptStatus"
- },
- "attemptDispatchCount": {
- "format": "int64",
- "description": "Output only.\n\nThe number of attempts dispatched. This count includes tasks which have\nbeen dispatched but haven't received a response.",
- "type": "string"
- },
- "firstAttemptStatus": {
- "description": "Output only.\n\nThe status of the task's first attempt.\n\nOnly AttemptStatus.dispatch_time will be set.\nThe other AttemptStatus information is not retained by Cloud Tasks.\n\nThis field is not calculated for\n[pull tasks](google.cloud.tasks.v2beta2.PullTaskTarget).",
- "$ref": "AttemptStatus"
- },
- "attemptResponseCount": {
- "format": "int64",
- "description": "Output only.\n\nThe number of attempts which have received a response.\n\nThis field is not calculated for\n[pull tasks](google.cloud.tasks.v2beta2.PullTaskTarget).",
- "type": "string"
- }
- },
- "id": "TaskStatus"
- },
- "AppEngineHttpRequest": {
- "description": "App Engine HTTP request.\n\nThe message defines the HTTP request that is sent to an App Engine app when\nthe task is dispatched.\n\nThis proto can only be used for tasks in a queue which has\nQueue.app_engine_http_target set.\n\nUsing AppEngineHttpRequest requires\n[`appengine.applications.get`](/appengine/docs/admin-api/access-control)\nGoogle IAM permission for the project\nand the following scope:\n\n`https://www.googleapis.com/auth/cloud-platform`\n\nThe task will be delivered to the App Engine app which belongs to the same\nproject as the queue. For more information, see\n[How Requests are Routed](/appengine/docs/standard/python/how-requests-are-routed)\nand how routing is affected by\n[dispatch files](/appengine/docs/python/config/dispatchref).\n\nThe AppEngineRouting used to construct the URL that the task is\ndelivered to can be set at the queue-level or task-level:\n\n* If set, AppEngineHttpTarget.app_engine_routing_override is used for\n all tasks in the queue, no matter what the setting is for the\n task-level app_engine_routing.\n\n\nThe `url` that the task will be sent to is:\n\n* `url =` AppEngineRouting.host `+` AppEngineHttpRequest.relative_url\n\nThe task will be sent to a task handler by an HTTP\nrequest using the specified AppEngineHttpRequest.http_method (for example\nPOST, HTTP GET, etc). The task attempt has succeeded if the task handler\nreturns an HTTP response code in the range [200 - 299]. Error 503 is\nconsidered an App Engine system error instead of an application error.\nRequests returning error 503 will be retried regardless of retry\nconfiguration and not counted against retry counts.\nAny other response code or a failure to receive a response before the\ndeadline is a failed attempt.",
- "type": "object",
- "properties": {
- "relativeUrl": {
- "description": "The relative URL.\n\nThe relative URL must begin with \"/\" and must be a valid HTTP relative URL.\nIt can contain a path and query string arguments.\nIf the relative URL is empty, then the root path \"/\" will be used.\nNo spaces are allowed, and the maximum length allowed is 2083 characters.",
- "type": "string"
- },
- "headers": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "HTTP request headers.\n\nThis map contains the header field names and values.\nHeaders can be set when the\n[task is created](google.cloud.tasks.v2beta2.CloudTasks.CreateTask).\nRepeated headers are not supported but a header value can contain commas.\n\nCloud Tasks sets some headers to default values:\n\n* `User-Agent`: By default, this header is\n `\"AppEngine-Google; (+http://code.google.com/appengine)\"`.\n This header can be modified, but Cloud Tasks will append\n `\"AppEngine-Google; (+http://code.google.com/appengine)\"` to the\n modified `User-Agent`.\n\nIf the task has an AppEngineHttpRequest.payload, Cloud Tasks sets the\nfollowing headers:\n\n* `Content-Type`: By default, the `Content-Type` header is set to\n `\"application/octet-stream\"`. The default can be overridden by explictly\n setting `Content-Type` to a particular media type when the\n [task is created](google.cloud.tasks.v2beta2.CloudTasks.CreateTask).\n For example, `Content-Type` can be set to `\"application/json\"`.\n* `Content-Length`: This is computed by Cloud Tasks. This value is\n output only. It cannot be changed.\n\nThe headers below cannot be set or overridden:\n\n* `Host`\n* `X-Google-*`\n* `X-AppEngine-*`\n\nIn addition, some App Engine headers, which contain\ntask-specific information, are also be sent to the task handler; see\n[request headers](/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).",
- "type": "object"
- },
- "appEngineRouting": {
- "$ref": "AppEngineRouting",
- "description": "Task-level setting for App Engine routing.\n\nIf set, AppEngineHttpTarget.app_engine_routing_override is used for\nall tasks in the queue, no matter what the setting is for the\ntask-level app_engine_routing."
- },
- "httpMethod": {
- "enumDescriptions": [
- "HTTP method unspecified",
- "HTTP Post",
- "HTTP Get",
- "HTTP Head",
- "HTTP Put",
- "HTTP Delete"
- ],
- "enum": [
- "HTTP_METHOD_UNSPECIFIED",
- "POST",
- "GET",
- "HEAD",
- "PUT",
- "DELETE"
- ],
- "description": "The HTTP method to use for the request. The default is POST.\n\nThe app's request handler for the task's target URL must be able to handle\nHTTP requests with this http_method, otherwise the task attempt will fail\nwith error code 405 (Method Not Allowed). See\nthe Request-Line is not allowed for the resource identified by the\nRequest-URI\". See\n[Writing a push task request handler](/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)\nand the documentation for the request handlers in the language your app is\nwritten in e.g.\n[python RequestHandler](/appengine/docs/python/tools/webapp/requesthandlerclass).",
- "type": "string"
- },
- "payload": {
- "type": "string",
- "format": "byte",
- "description": "Payload.\n\nThe payload will be sent as the HTTP message body. A message\nbody, and thus a payload, is allowed only if the HTTP method is\nPOST or PUT. It is an error to set a data payload on a task with\nan incompatible HttpMethod."
- }
- },
- "id": "AppEngineHttpRequest"
- },
- "AppEngineQueueConfig": {
- "description": "Deprecated. Use AppEngineTarget.",
- "type": "object",
- "properties": {
- "appEngineRoutingOverride": {
- "$ref": "AppEngineRouting",
- "description": "Deprecated. Use AppEngineTarget.app_engine_routing_override."
- }
- },
- "id": "AppEngineQueueConfig"
- },
- "PullTaskTarget": {
- "description": "Deprecated. Use PullMessage.",
- "type": "object",
- "properties": {
- "payload": {
- "format": "byte",
- "description": "Deprecated. Use PullMessage.payload.",
- "type": "string"
- },
- "tag": {
- "format": "byte",
- "description": "Deprecated. Use PullMessage.tag.",
- "type": "string"
- }
- },
- "id": "PullTaskTarget"
- },
- "TestIamPermissionsResponse": {
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed."
- }
- },
- "id": "TestIamPermissionsResponse"
- },
- "GetIamPolicyRequest": {
- "description": "Request message for `GetIamPolicy` method.",
- "type": "object",
- "properties": {},
- "id": "GetIamPolicyRequest"
- },
- "RetryConfig": {
- "id": "RetryConfig",
- "description": "Retry config.\n\nThese settings determine how a failed task attempt is retried.",
- "type": "object",
- "properties": {
- "maxDoublings": {
- "format": "int32",
- "description": "The time between retries increases exponentially `max_doublings` times.\n`max_doublings` is maximum number of times that the interval between failed\ntask retries will be doubled before the interval increases linearly.\nAfter max_doublings intervals, the retry interval will be\n2^(max_doublings - 1) * RetryConfig.min_backoff.\n\n* For [App Engine queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget),\n this field is 16 by default.\n* For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this field\n is output only and always 0.\n\nThis field has the same meaning as\n[max_doublings in queue.yaml](/appengine/docs/standard/python/config/queueref#retry_parameters).",
- "type": "integer"
- },
- "maxAttempts": {
- "format": "int32",
- "description": "The maximum number of attempts for a task.\n\nCloud Tasks will attempt the task `max_attempts` times (that\nis, if the first attempt fails, then there will be\n`max_attempts - 1` retries). Must be \u003e 0.",
- "type": "integer"
- },
- "unlimitedAttempts": {
- "description": "If true, then the number of attempts is unlimited.",
- "type": "boolean"
- },
- "minBackoff": {
- "format": "google-duration",
- "description": "The minimum amount of time to wait before retrying a task after\nit fails.\n\n* For [App Engine queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget),\n this field is 0.1 seconds by default.\n* For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this\n field is output only and always 0.\n\n`min_backoff` will be truncated to the nearest second.\n\nThis field has the same meaning as\n[min_backoff_seconds in queue.yaml](/appengine/docs/standard/python/config/queueref#retry_parameters).",
- "type": "string"
- },
- "maxBackoff": {
- "format": "google-duration",
- "description": "The maximum amount of time to wait before retrying a task after\nit fails. The default is 1 hour.\n\n* For [App Engine queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget),\n this field is 1 hour by default.\n* For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this field\n is output only and always 0.\n\n`max_backoff` will be truncated to the nearest second.\n\nThis field has the same meaning as\n[max_backoff_seconds in queue.yaml](/appengine/docs/standard/python/config/queueref#retry_parameters).",
- "type": "string"
- },
- "maxRetryDuration": {
- "format": "google-duration",
- "description": "If positive, `max_retry_duration` specifies the time limit for retrying a\nfailed task, measured from when the task was first attempted. Once\n`max_retry_duration` time has passed *and* the task has been attempted\nRetryConfig.max_attempts times, no further attempts will be made and\nthe task will be deleted.\n\nIf zero, then the task age is unlimited.\n\n* For [App Engine queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget),\n this field is 0 seconds by default.\n* For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this\n field is output only and always 0.\n\n`max_retry_duration` will be truncated to the nearest second.\n\nThis field has the same meaning as\n[task_age_limit in queue.yaml](/appengine/docs/standard/python/config/queueref#retry_parameters).",
- "type": "string"
- }
- }
}
},
- "protocol": "rest",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
+ "protocol": "rest",
"canonicalName": "Cloud Tasks",
"auth": {
"oauth2": {
@@ -810,799 +1604,5 @@
}
},
"rootUrl": "https://cloudtasks.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "cloudtasks",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Cloud Tasks API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "locations": {
- "methods": {
- "get": {
- "response": {
- "$ref": "Location"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "Resource name for the location.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}",
- "id": "cloudtasks.projects.locations.get",
- "path": "v2beta2/{+name}",
- "description": "Get information about a location."
- },
- "list": {
- "flatPath": "v2beta2/projects/{projectsId}/locations",
- "id": "cloudtasks.projects.locations.list",
- "path": "v2beta2/{+name}/locations",
- "description": "Lists information about the supported locations for this service.",
- "response": {
- "$ref": "ListLocationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "name": {
- "description": "The resource that owns the locations collection, if applicable.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer"
- },
- "filter": {
- "type": "string",
- "location": "query",
- "description": "The standard list filter."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- },
- "resources": {
- "queues": {
- "methods": {
- "setIamPolicy": {
- "id": "cloudtasks.projects.locations.queues.setIamPolicy",
- "path": "v2beta2/{+resource}:setIamPolicy",
- "description": "Sets the access control policy for a Queue. Replaces any existing\npolicy.\n\nAuthorization requires the following [Google IAM](/iam) permission on the\nspecified resource parent:\n\n* `cloudtasks.queues.setIamPolicy`\n",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:setIamPolicy"
- },
- "create": {
- "description": "Creates a queue.\n\nWARNING: This method is only available to whitelisted\nusers. Using this method carries some risk. Read\n[Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)\ncarefully and then sign up for\n[whitelist access to this method](https://goo.gl/Fe5mUy).",
- "request": {
- "$ref": "Queue"
- },
- "response": {
- "$ref": "Queue"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "location": "path",
- "description": "Required.\n\nThe location name in which the queue will be created.\nFor example: `projects/PROJECT_ID/locations/LOCATION_ID`\n\nThe list of allowed locations can be obtained by calling Cloud\nTasks' implementation of\ngoogle.cloud.location.Locations.ListLocations.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues",
- "id": "cloudtasks.projects.locations.queues.create",
- "path": "v2beta2/{+parent}/queues"
- },
- "resume": {
- "response": {
- "$ref": "Queue"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
- "location": "path",
- "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:resume",
- "id": "cloudtasks.projects.locations.queues.resume",
- "path": "v2beta2/{+name}:resume",
- "description": "Resume a queue.\n\nThis method resumes a queue after it has been\nQueue.QueueState.PAUSED or Queue.QueueState.DISABLED. The state of\na queue is stored in Queue.queue_state; after calling this method it\nwill be set to Queue.QueueState.RUNNING.\n\nWARNING: This method is only available to whitelisted\nusers. Using this method carries some risk. Read\n[Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)\ncarefully and then sign up for\n[whitelist access to this method](https://goo.gl/Fe5mUy).\n\nWARNING: Resuming many high-QPS queues at the same time can\nlead to target overloading. If you are resuming high-QPS\nqueues, follow the 500/50/5 pattern described in\n[Managing Cloud Tasks Scaling Risks](/cloud-tasks/pdfs/managing-cloud-tasks-scaling-risks-2017-06-05.pdf).",
- "request": {
- "$ref": "ResumeQueueRequest"
- }
- },
- "getIamPolicy": {
- "id": "cloudtasks.projects.locations.queues.getIamPolicy",
- "path": "v2beta2/{+resource}:getIamPolicy",
- "description": "Gets the access control policy for a Queue.\nReturns an empty policy if the resource exists and does not have a policy\nset.\n\nAuthorization requires the following [Google IAM](/iam) permission on the\nspecified resource parent:\n\n* `cloudtasks.queues.getIamPolicy`\n",
- "request": {
- "$ref": "GetIamPolicyRequest"
- },
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:getIamPolicy"
- },
- "patch": {
- "response": {
- "$ref": "Queue"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "name": {
- "description": "The queue name.\n\nThe queue name must have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`\n\n* `PROJECT_ID` can contain uppercase and lowercase letters,\n numbers, hyphens, colons, and periods; that is, it must match\n the regular expression: `[a-zA-Z\\\\d-:\\\\.]+`.\n* `QUEUE_ID` can contain uppercase and lowercase letters,\n numbers, and hyphens; that is, it must match the regular\n expression: `[a-zA-Z\\\\d-]+`. The maximum length is 100\n characters.\n\nCaller-specified and required in CreateQueueRequest, after which\nit becomes output only.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
- "location": "path"
- },
- "updateMask": {
- "format": "google-fieldmask",
- "description": "A mask used to specify which fields of the queue are being updated.\n\nIf empty, then all fields will be updated.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}",
- "id": "cloudtasks.projects.locations.queues.patch",
- "path": "v2beta2/{+name}",
- "description": "Updates a queue.\n\nThis method creates the queue if it does not exist and updates\nthe queue if it does exist.\n\nWARNING: This method is only available to whitelisted\nusers. Using this method carries some risk. Read\n[Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)\ncarefully and then sign up for\n[whitelist access to this method](https://goo.gl/Fe5mUy).",
- "request": {
- "$ref": "Queue"
- }
- },
- "get": {
- "response": {
- "$ref": "Queue"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "location": "path",
- "description": "Required.\n\nThe resource name of the queue. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}",
- "id": "cloudtasks.projects.locations.queues.get",
- "path": "v2beta2/{+name}",
- "description": "Gets a queue."
- },
- "purge": {
- "id": "cloudtasks.projects.locations.queues.purge",
- "path": "v2beta2/{+name}:purge",
- "request": {
- "$ref": "PurgeQueueRequest"
- },
- "description": "Purges a queue by deleting all of its tasks.\n\nAll tasks created before this method is called are permanently deleted.\n\nPurge operations can take up to one minute to take effect. Tasks\nmight be dispatched before the purge takes effect. A purge is irreversible.",
- "response": {
- "$ref": "Queue"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:purge"
- },
- "testIamPermissions": {
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:testIamPermissions",
- "id": "cloudtasks.projects.locations.queues.testIamPermissions",
- "path": "v2beta2/{+resource}:testIamPermissions",
- "description": "Returns permissions that a caller has on a Queue.\nIf the resource does not exist, this will return an empty set of\npermissions, not a google.rpc.Code.NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.\n",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- }
- },
- "pause": {
- "description": "Pauses the queue.\n\nIf a queue is paused then the system will stop executing the\ntasks in the queue until it is resumed via\nCloudTasks.ResumeQueue. Tasks can still be added when the\nqueue is paused. The state of the queue is stored in\nQueue.queue_state; if paused it will be set to\nQueue.QueueState.PAUSED.\n\nWARNING: This method is only available to whitelisted\nusers. Using this method carries some risk. Read\n[Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)\ncarefully and then sign up for\n[whitelist access to this method](https://goo.gl/Fe5mUy).",
- "request": {
- "$ref": "PauseQueueRequest"
- },
- "response": {
- "$ref": "Queue"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:pause",
- "id": "cloudtasks.projects.locations.queues.pause",
- "path": "v2beta2/{+name}:pause"
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$"
- }
- },
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}",
- "id": "cloudtasks.projects.locations.queues.delete",
- "path": "v2beta2/{+name}",
- "description": "Deletes a queue.\n\nThis command will delete the queue even if it has tasks in it.\n\nNote: If you delete a queue, a queue with the same name can't be created\nfor 7 days.\n\nWARNING: This method is only available to whitelisted\nusers. Using this method carries some risk. Read\n[Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)\ncarefully and then sign up for\n[whitelist access to this method](https://goo.gl/Fe5mUy)."
- },
- "list": {
- "description": "Lists queues.\n\nQueues are returned in lexicographical order.",
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "ListQueuesResponse"
- },
- "parameters": {
- "filter": {
- "location": "query",
- "description": "`filter` can be used to specify a subset of queues. Any Queue\nfield can be used as a filter and several operators as supported.\nFor example: `\u003c=, \u003c, \u003e=, \u003e, !=, =, :`. The filter syntax is the same as\ndescribed in\n[Stackdriver's Advanced Logs Filters](/logging/docs/view/advanced_filters).\n\nSample filter \"app_engine_http_target: *\".\n\nNote that using filters might cause fewer queues than the\nrequested_page size to be returned.",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "format": "byte",
- "description": "A token identifying the page of results to return.\n\nTo request the first page results, page_token must be empty. To\nrequest the next page of results, page_token must be the value of\nListQueuesResponse.next_page_token returned from the previous\ncall to CloudTasks.ListQueues method. It is an error to\nswitch the value of ListQueuesRequest.filter while iterating\nthrough pages.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Requested page size.\n\nThe maximum page size is 9800. If unspecified, the page size will\nbe the maximum. Fewer queues than requested might be returned,\neven if more queues exist; use\nListQueuesResponse.next_page_token to determine if more\nqueues exist.",
- "type": "integer"
- },
- "parent": {
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path",
- "description": "Required.\n\nThe location name.\nFor example: `projects/PROJECT_ID/locations/LOCATION_ID`"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues",
- "path": "v2beta2/{+parent}/queues",
- "id": "cloudtasks.projects.locations.queues.list"
- }
- },
- "resources": {
- "tasks": {
- "methods": {
- "delete": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}",
- "path": "v2beta2/{+name}",
- "id": "cloudtasks.projects.locations.queues.tasks.delete",
- "description": "Deletes a task.\n\nA task can be deleted if it is scheduled or dispatched. A task\ncannot be deleted if it has completed successfully or permanently\nfailed.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ]
- },
- "pull": {
- "description": "Pulls tasks from a pull queue and acquires a lease on them for a\nspecified PullTasksRequest.lease_duration.\n\nThis method is invoked by the lease holder to obtain the\nlease. The lease holder must acknowledge the task via\nCloudTasks.AcknowledgeTask after they have performed the work\nassociated with the task.\n\nThe payload is intended to store data that the lease holder needs\nto perform the work associated with the task. To return the\npayloads in the PullTasksResponse, set\nPullTasksRequest.response_view to Task.View.FULL.\n\nA maximum of 10 qps of CloudTasks.PullTasks requests are allowed per\nqueue. google.rpc.Code.RESOURCE_EXHAUSTED is returned when this limit\nis exceeded. google.rpc.Code.RESOURCE_EXHAUSTED is also returned when\nRateLimits.max_tasks_dispatched_per_second is exceeded.",
- "request": {
- "$ref": "PullTasksRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "PullTasksResponse"
- },
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
- "location": "path",
- "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks:pull",
- "path": "v2beta2/{+name}/tasks:pull",
- "id": "cloudtasks.projects.locations.queues.tasks.pull"
- },
- "list": {
- "response": {
- "$ref": "ListTasksResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
- "location": "path",
- "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
- "type": "string",
- "required": true
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "format": "byte",
- "description": "A token identifying the page of results to return.\n\nTo request the first page results, page_token must be empty. To\nrequest the next page of results, page_token must be the value of\nListTasksResponse.next_page_token returned from the previous\ncall to CloudTasks.ListTasks method.\n\nThe page token is valid for only 2 hours."
- },
- "orderBy": {
- "location": "query",
- "description": "\nSort order used for the query. The fields supported for sorting\nare Task.schedule_time and PullMessage.tag. All results will be\nreturned in ascending order. The default ordering is by\nTask.schedule_time.",
- "type": "string"
- },
- "responseView": {
- "location": "query",
- "enum": [
- "VIEW_UNSPECIFIED",
- "BASIC",
- "FULL"
- ],
- "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for Task.View.FULL requires `cloudtasks.tasks.fullView`\n[Google IAM](/iam/) permission on the\nTask.name resource.",
- "type": "string"
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "format": "int32",
- "description": "Requested page size. Fewer tasks than requested might be returned.\n\nThe maximum page size is 1000. If unspecified, the page size will\nbe the maximum. Fewer tasks than requested might be returned,\neven if more tasks exist; use\nListTasksResponse.next_page_token to determine if more tasks\nexist."
- }
- },
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks",
- "id": "cloudtasks.projects.locations.queues.tasks.list",
- "path": "v2beta2/{+parent}/tasks",
- "description": "Lists the tasks in a queue.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default due to performance\nconsiderations; ListTasksRequest.response_view controls the\nsubset of information which is returned."
- },
- "create": {
- "request": {
- "$ref": "CreateTaskRequest"
- },
- "description": "Creates a task and adds it to a queue.\n\nTo add multiple tasks at the same time, use\n[HTTP batching](/storage/docs/json_api/v1/how-tos/batch)\nor the batching documentation for your client library, for example\nhttps://developers.google.com/api-client-library/python/guide/batch.\n\nTasks cannot be updated after creation; there is no UpdateTask command.\n\n* For [App Engine queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget),\n the maximum task size is 100KB.\n* For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this\n the maximum task size is 1MB.",
- "response": {
- "$ref": "Task"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
- "location": "path",
- "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`\n\nThe queue must already exist.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks",
- "id": "cloudtasks.projects.locations.queues.tasks.create",
- "path": "v2beta2/{+parent}/tasks"
- },
- "run": {
- "response": {
- "$ref": "Task"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$"
- }
- },
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:run",
- "id": "cloudtasks.projects.locations.queues.tasks.run",
- "path": "v2beta2/{+name}:run",
- "request": {
- "$ref": "RunTaskRequest"
- },
- "description": "Forces a task to run now.\n\nThis command is meant to be used for manual debugging. For\nexample, CloudTasks.RunTask can be used to retry a failed\ntask after a fix has been made or to manually force a task to be\ndispatched now.\n\nWhen this method is called, Cloud Tasks will dispatch the task to its\ntarget, even if the queue is Queue.QueueState.PAUSED.\n\nThe dispatched task is returned. That is, the task that is returned\ncontains the Task.task_status after the task is dispatched but\nbefore the task is received by its target.\n\nIf Cloud Tasks receives a successful response from the task's\nhandler, then the task will be deleted; otherwise the task's\nTask.schedule_time will be reset to the time that\nCloudTasks.RunTask was called plus the retry delay specified\nin the queue and task's RetryConfig.\n\nCloudTasks.RunTask returns google.rpc.Code.NOT_FOUND when\nit is called on a task that has already succeeded or permanently\nfailed. google.rpc.Code.FAILED_PRECONDITION is returned when\nCloudTasks.RunTask is called on task that is dispatched or\nalready running."
- },
- "cancelLease": {
- "request": {
- "$ref": "CancelLeaseRequest"
- },
- "description": "Cancel a pull task's lease.\n\nThe lease holder can use this method to cancel a task's lease\nby setting Task.schedule_time to now. This will make the task\navailable to be leased to the next caller of CloudTasks.PullTasks.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Task"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$"
- }
- },
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:cancelLease",
- "path": "v2beta2/{+name}:cancelLease",
- "id": "cloudtasks.projects.locations.queues.tasks.cancelLease"
- },
- "acknowledge": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:acknowledge",
- "path": "v2beta2/{+name}:acknowledge",
- "id": "cloudtasks.projects.locations.queues.tasks.acknowledge",
- "request": {
- "$ref": "AcknowledgeTaskRequest"
- },
- "description": "Acknowledges a pull task.\n\nThe lease holder, that is, the entity that received this task in\na PullTasksResponse, must call this method to indicate that\nthe work associated with the task has finished.\n\nThe lease holder must acknowledge a task within the\nPullTasksRequest.lease_duration or the lease will expire and\nthe task will become ready to be returned in a different\nPullTasksResponse. After the task is acknowledged, it will\nnot be returned by a later CloudTasks.PullTasks,\nCloudTasks.GetTask, or CloudTasks.ListTasks."
- },
- "renewLease": {
- "request": {
- "$ref": "RenewLeaseRequest"
- },
- "description": "Renew the current lease of a pull task.\n\nThe lease holder can use this method to extend the lease by a new\nduration, starting from now. The new task lease will be\nreturned in Task.schedule_time.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Task"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:renewLease",
- "path": "v2beta2/{+name}:renewLease",
- "id": "cloudtasks.projects.locations.queues.tasks.renewLease"
- },
- "get": {
- "description": "Gets a task.",
- "response": {
- "$ref": "Task"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "responseView": {
- "location": "query",
- "enum": [
- "VIEW_UNSPECIFIED",
- "BASIC",
- "FULL"
- ],
- "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for Task.View.FULL requires `cloudtasks.tasks.fullView`\n[Google IAM](/iam/) permission on the\nTask.name resource.",
- "type": "string"
- },
- "name": {
- "description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}",
- "id": "cloudtasks.projects.locations.queues.tasks.get",
- "path": "v2beta2/{+name}"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "parameters": {
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ]
- },
- "alt": {
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response."
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
- },
- "oauth_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- }
- },
- "version": "v2beta2",
- "baseUrl": "https://cloudtasks.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Manages the execution of large numbers of distributed requests. Cloud Tasks is in Alpha.",
- "servicePath": "",
- "basePath": "",
- "revision": "20171005",
- "documentationLink": "https://cloud.google.com/cloud-tasks/",
- "id": "cloudtasks:v2beta2",
- "discoveryVersion": "v1",
- "version_module": true
+ "ownerDomain": "google.com"
}
diff --git a/cloudtrace/v1/cloudtrace-api.json b/cloudtrace/v1/cloudtrace-api.json
index 89e0a83..2b51e31 100644
--- a/cloudtrace/v1/cloudtrace-api.json
+++ b/cloudtrace/v1/cloudtrace-api.json
@@ -1,4 +1,9 @@
{
+ "version": "v1",
+ "baseUrl": "https://cloudtrace.googleapis.com/",
+ "description": "Send and retrieve trace data from Stackdriver Trace. Data is generated and available by default for all App Engine applications. Data from other applications can be written to Stackdriver Trace for display, reporting, and analysis.\n",
+ "servicePath": "",
+ "kind": "discovery#restDescription",
"basePath": "",
"revision": "20171003",
"documentationLink": "https://cloud.google.com/trace",
@@ -7,22 +12,18 @@
"version_module": true,
"schemas": {
"TraceSpan": {
+ "description": "A span represents a single timed event within a trace. Spans can be nested\nand form a trace tree. Often, a trace contains a root span that describes the\nend-to-end latency of an operation and, optionally, one or more subspans for\nits suboperations. Spans do not need to be contiguous. There may be gaps\nbetween spans in a trace.",
"type": "object",
"properties": {
- "spanId": {
- "type": "string",
- "format": "uint64",
- "description": "Identifier for the span. Must be a 64-bit integer other than 0 and\nunique within a trace."
- },
"parentSpanId": {
- "type": "string",
"format": "uint64",
- "description": "ID of the parent span, if any. Optional."
+ "description": "ID of the parent span, if any. Optional.",
+ "type": "string"
},
"endTime": {
- "type": "string",
"format": "google-datetime",
- "description": "End time of the span in nanoseconds from the UNIX epoch."
+ "description": "End time of the span in nanoseconds from the UNIX epoch.",
+ "type": "string"
},
"startTime": {
"format": "google-datetime",
@@ -30,41 +31,46 @@
"type": "string"
},
"kind": {
+ "enumDescriptions": [
+ "Unspecified.",
+ "Indicates that the span covers server-side handling of an RPC or other\nremote network request.",
+ "Indicates that the span covers the client-side wrapper around an RPC or\nother remote request."
+ ],
"enum": [
"SPAN_KIND_UNSPECIFIED",
"RPC_SERVER",
"RPC_CLIENT"
],
"description": "Distinguishes between spans generated in a particular context. For example,\ntwo spans with the same name may be distinguished using `RPC_CLIENT`\nand `RPC_SERVER` to identify queueing latency associated with the span.",
- "type": "string",
- "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": {
- "type": "object",
"additionalProperties": {
"type": "string"
},
- "description": "Collection of labels associated with the span. Label keys must be less than\n128 bytes. Label values must be less than 16 kilobytes (10MB for\n`/stacktrace` values).\n\nSome predefined label keys exist, or you may create your own. When creating\nyour own, we recommend the following formats:\n\n* `/category/product/key` for agents of well-known products (e.g.\n `/db/mongodb/read_size`).\n* `short_host/path/key` for domain-specific keys (e.g.\n `foo.com/myproduct/bar`)\n\nPredefined labels include:\n\n* `/agent`\n* `/component`\n* `/error/message`\n* `/error/name`\n* `/http/client_city`\n* `/http/client_country`\n* `/http/client_protocol`\n* `/http/client_region`\n* `/http/host`\n* `/http/method`\n* `/http/redirected_url`\n* `/http/request/size`\n* `/http/response/size`\n* `/http/status_code`\n* `/http/url`\n* `/http/user_agent`\n* `/pid`\n* `/stacktrace`\n* `/tid`"
+ "description": "Collection of labels associated with the span. Label keys must be less than\n128 bytes. Label values must be less than 16 kilobytes (10MB for\n`/stacktrace` values).\n\nSome predefined label keys exist, or you may create your own. When creating\nyour own, we recommend the following formats:\n\n* `/category/product/key` for agents of well-known products (e.g.\n `/db/mongodb/read_size`).\n* `short_host/path/key` for domain-specific keys (e.g.\n `foo.com/myproduct/bar`)\n\nPredefined labels include:\n\n* `/agent`\n* `/component`\n* `/error/message`\n* `/error/name`\n* `/http/client_city`\n* `/http/client_country`\n* `/http/client_protocol`\n* `/http/client_region`\n* `/http/host`\n* `/http/method`\n* `/http/redirected_url`\n* `/http/request/size`\n* `/http/response/size`\n* `/http/status_code`\n* `/http/url`\n* `/http/user_agent`\n* `/pid`\n* `/stacktrace`\n* `/tid`",
+ "type": "object"
},
"name": {
"description": "Name of the span. Must be less than 128 bytes. The span name is sanitized\nand displayed in the Stackdriver Trace tool in the\n{% dynamic print site_values.console_name %}.\nThe name may be a method name or some other per-call site name.\nFor the same executable and the same call point, a best practice is\nto use a consistent name, which makes it easier to correlate\ncross-trace spans.",
"type": "string"
+ },
+ "spanId": {
+ "format": "uint64",
+ "description": "Identifier for the span. Must be a 64-bit integer other than 0 and\nunique within a trace.",
+ "type": "string"
}
},
- "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."
+ "id": "TraceSpan"
},
"Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
"properties": {},
- "id": "Empty"
+ "id": "Empty",
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object"
},
"ListTracesResponse": {
+ "id": "ListTracesResponse",
"description": "The response message for the `ListTraces` method.",
"type": "object",
"properties": {
@@ -79,23 +85,22 @@
},
"type": "array"
}
- },
- "id": "ListTracesResponse"
+ }
},
"Trace": {
"description": "A trace describes how long it takes for an application to perform an\noperation. It consists of a set of spans, each of which represent a single\ntimed event within the operation.",
"type": "object",
"properties": {
"spans": {
- "description": "Collection of spans in the trace.",
"items": {
"$ref": "TraceSpan"
},
- "type": "array"
+ "type": "array",
+ "description": "Collection of spans in the trace."
},
"projectId": {
- "type": "string",
- "description": "Project ID of the Cloud project where the trace data is stored."
+ "description": "Project ID of the Cloud project where the trace data is stored.",
+ "type": "string"
},
"traceId": {
"type": "string",
@@ -105,6 +110,7 @@
"id": "Trace"
},
"Traces": {
+ "id": "Traces",
"description": "List of new or updated traces.",
"type": "object",
"properties": {
@@ -115,27 +121,26 @@
},
"type": "array"
}
- },
- "id": "Traces"
+ }
}
},
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"protocol": "rest",
"canonicalName": "Cloud Trace",
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/trace.append": {
- "description": "Write Trace data for a project or application"
- },
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
},
"https://www.googleapis.com/auth/trace.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"
}
}
}
@@ -151,6 +156,12 @@
"projects": {
"methods": {
"patchTraces": {
+ "path": "v1/projects/{projectId}/traces",
+ "id": "cloudtrace.projects.patchTraces",
+ "description": "Sends new traces to Stackdriver Trace or updates existing traces. If the ID\nof a trace that you send matches that of an existing trace, any fields\nin the existing trace and its spans are overwritten by the provided values,\nand any new fields provided are merged with the existing trace data. If the\nID does not match, a new trace is created.",
+ "request": {
+ "$ref": "Traces"
+ },
"httpMethod": "PATCH",
"parameterOrder": [
"projectId"
@@ -160,37 +171,31 @@
},
"parameters": {
"projectId": {
+ "description": "ID of the Cloud project where the trace data is stored.",
"type": "string",
"required": true,
- "location": "path",
- "description": "ID of the Cloud project where the trace data is stored."
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/trace.append"
],
- "flatPath": "v1/projects/{projectId}/traces",
- "path": "v1/projects/{projectId}/traces",
- "id": "cloudtrace.projects.patchTraces",
- "description": "Sends new traces to Stackdriver Trace or updates existing traces. If the ID\nof a trace that you send matches that of an existing trace, any fields\nin the existing trace and its spans are overwritten by the provided values,\nand any new fields provided are merged with the existing trace data. If the\nID does not match, a new trace is created.",
- "request": {
- "$ref": "Traces"
- }
+ "flatPath": "v1/projects/{projectId}/traces"
}
},
"resources": {
"traces": {
"methods": {
"get": {
+ "response": {
+ "$ref": "Trace"
+ },
"httpMethod": "GET",
"parameterOrder": [
"projectId",
"traceId"
],
- "response": {
- "$ref": "Trace"
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/trace.readonly"
@@ -203,51 +208,29 @@
"description": "ID of the Cloud project where the trace data is stored."
},
"traceId": {
+ "description": "ID of the trace to return.",
"type": "string",
"required": true,
- "location": "path",
- "description": "ID of the trace to return."
+ "location": "path"
}
},
"flatPath": "v1/projects/{projectId}/traces/{traceId}",
- "path": "v1/projects/{projectId}/traces/{traceId}",
"id": "cloudtrace.projects.traces.get",
+ "path": "v1/projects/{projectId}/traces/{traceId}",
"description": "Gets a single trace by its ID."
},
"list": {
"description": "Returns of a list of traces that match the specified filter conditions.",
- "httpMethod": "GET",
- "parameterOrder": [
- "projectId"
- ],
"response": {
"$ref": "ListTracesResponse"
},
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "GET",
"parameters": {
- "endTime": {
- "type": "string",
- "location": "query",
- "format": "google-datetime",
- "description": "End of the time interval (inclusive) during which the trace data was\ncollected from the application."
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "Token identifying the page of results to return. If provided, use the\nvalue of the `next_page_token` field from a previous request. Optional."
- },
- "startTime": {
- "type": "string",
- "location": "query",
- "format": "google-datetime",
- "description": "Start of the time interval (inclusive) during which the trace data was\ncollected from the application."
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "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.",
- "type": "integer"
- },
"view": {
+ "description": "Type of data returned for traces in the list. Optional. Default is\n`MINIMAL`.",
"type": "string",
"location": "query",
"enum": [
@@ -255,13 +238,12 @@
"MINIMAL",
"ROOTSPAN",
"COMPLETE"
- ],
- "description": "Type of data returned for traces in the list. Optional. Default is\n`MINIMAL`."
+ ]
},
"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"
+ "type": "string",
+ "location": "query"
},
"projectId": {
"location": "path",
@@ -270,9 +252,32 @@
"required": true
},
"filter": {
- "location": "query",
"description": "An optional filter against labels for the request.\n\nBy default, searches use prefix matching. To specify exact match, prepend\na plus symbol (`+`) to the search term.\nMultiple terms are ANDed. Syntax:\n\n* `root:NAME_PREFIX` or `NAME_PREFIX`: Return traces where any root\n span starts with `NAME_PREFIX`.\n* `+root:NAME` or `+NAME`: Return traces where any root span's name is\n exactly `NAME`.\n* `span:NAME_PREFIX`: Return traces where any span starts with\n `NAME_PREFIX`.\n* `+span:NAME`: Return traces where any span's name is exactly\n `NAME`.\n* `latency:DURATION`: Return traces whose overall latency is\n greater or equal to than `DURATION`. Accepted units are nanoseconds\n (`ns`), milliseconds (`ms`), and seconds (`s`). Default is `ms`. For\n example, `latency:24ms` returns traces whose overall latency\n is greater than or equal to 24 milliseconds.\n* `label:LABEL_KEY`: Return all traces containing the specified\n label key (exact match, case-sensitive) regardless of the key:value\n pair's value (including empty values).\n* `LABEL_KEY:VALUE_PREFIX`: Return all traces containing the specified\n label key (exact match, case-sensitive) whose value starts with\n `VALUE_PREFIX`. Both a key and a value must be specified.\n* `+LABEL_KEY:VALUE`: Return all traces containing a key:value pair\n exactly matching the specified text. Both a key and a value must be\n specified.\n* `method:VALUE`: Equivalent to `/http/method:VALUE`.\n* `url:VALUE`: Equivalent to `/http/url:VALUE`.",
- "type": "string"
+ "type": "string",
+ "location": "query"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "End of the time interval (inclusive) during which the trace data was\ncollected from the application.",
+ "type": "string",
+ "location": "query"
+ },
+ "startTime": {
+ "format": "google-datetime",
+ "description": "Start of the time interval (inclusive) during which the trace data was\ncollected from the application.",
+ "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"
+ },
+ "pageSize": {
+ "format": "int32",
+ "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.",
+ "type": "integer",
+ "location": "query"
}
},
"scopes": [
@@ -280,8 +285,8 @@
"https://www.googleapis.com/auth/trace.readonly"
],
"flatPath": "v1/projects/{projectId}/traces",
- "path": "v1/projects/{projectId}/traces",
- "id": "cloudtrace.projects.traces.list"
+ "id": "cloudtrace.projects.traces.list",
+ "path": "v1/projects/{projectId}/traces"
}
}
}
@@ -289,20 +294,26 @@
}
},
"parameters": {
- "uploadType": {
+ "upload_protocol": {
+ "type": "string",
"location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
+ },
+ "prettyPrint": {
+ "default": "true",
+ "type": "boolean",
+ "location": "query",
+ "description": "Returns response with indentations and line breaks."
},
"fields": {
- "type": "string",
"location": "query",
- "description": "Selector specifying which fields to include in a partial response."
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
},
- "callback": {
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
- "location": "query",
- "description": "JSONP"
+ "location": "query"
},
"$.xgafv": {
"location": "query",
@@ -317,7 +328,14 @@
"v2 error format"
]
},
+ "callback": {
+ "type": "string",
+ "location": "query",
+ "description": "JSONP"
+ },
"alt": {
+ "description": "Data format for response.",
+ "default": "json",
"enum": [
"json",
"media",
@@ -329,56 +347,38 @@
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "access_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth access token."
+ "location": "query"
},
"key": {
"location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string"
},
- "quotaUser": {
+ "access_token": {
"type": "string",
"location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
+ "description": "OAuth access token."
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
},
"pp": {
+ "description": "Pretty-print response.",
"default": "true",
"type": "boolean",
- "location": "query",
- "description": "Pretty-print response."
- },
- "oauth_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
+ "location": "query"
},
"bearer_token": {
- "type": "string",
"location": "query",
- "description": "OAuth bearer token."
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "description": "OAuth bearer token.",
"type": "string"
},
- "prettyPrint": {
- "default": "true",
- "type": "boolean",
- "location": "query",
- "description": "Returns response with indentations and line breaks."
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
}
- },
- "version": "v1",
- "baseUrl": "https://cloudtrace.googleapis.com/",
- "servicePath": "",
- "kind": "discovery#restDescription",
- "description": "Send and retrieve trace data from Stackdriver Trace. Data is generated and available by default for all App Engine applications. Data from other applications can be written to Stackdriver Trace for display, reporting, and analysis.\n"
+ }
}
diff --git a/cloudtrace/v2/cloudtrace-api.json b/cloudtrace/v2/cloudtrace-api.json
index 607ebb4..d976e27 100644
--- a/cloudtrace/v2/cloudtrace-api.json
+++ b/cloudtrace/v2/cloudtrace-api.json
@@ -1,4 +1,10 @@
{
+ "rootUrl": "https://cloudtrace.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "cloudtrace",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Stackdriver Trace API",
"ownerName": "Google",
"resources": {
"projects": {
@@ -39,10 +45,10 @@
"spans": {
"methods": {
"create": {
- "description": "Creates a new Span.",
"request": {
"$ref": "Span"
},
+ "description": "Creates a new Span.",
"response": {
"$ref": "Span"
},
@@ -50,19 +56,19 @@
"name"
],
"httpMethod": "PUT",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/traces/[^/]+/spans/[^/]+$",
- "location": "path",
- "description": "The resource name of the span in the following format:\n\n projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project.\n[SPAN_ID] is a unique identifier for a span within a trace,\nassigned when the span is created.",
- "type": "string",
- "required": true
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/trace.append"
],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The resource name of the span in the following format:\n\n projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project.\n[SPAN_ID] is a unique identifier for a span within a trace,\nassigned when the span is created.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/traces/[^/]+/spans/[^/]+$"
+ }
+ },
"flatPath": "v2/projects/{projectsId}/traces/{tracesId}/spans/{spansId}",
"id": "cloudtrace.projects.traces.spans.create",
"path": "v2/{+name}"
@@ -75,32 +81,6 @@
}
},
"parameters": {
- "alt": {
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string",
@@ -113,9 +93,9 @@
"location": "query"
},
"oauth_token": {
+ "location": "query",
"description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"bearer_token": {
"location": "query",
@@ -123,20 +103,20 @@
"type": "string"
},
"upload_protocol": {
- "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean",
+ "type": "string",
"location": "query"
},
- "fields": {
+ "prettyPrint": {
"location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "fields": {
"description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"uploadType": {
"location": "query",
@@ -144,37 +124,121 @@
"type": "string"
},
"callback": {
+ "location": "query",
"description": "JSONP",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
}
},
"version": "v2",
"baseUrl": "https://cloudtrace.googleapis.com/",
"servicePath": "",
- "kind": "discovery#restDescription",
"description": "Send and retrieve trace data from Stackdriver Trace. Data is generated and available by default for all App Engine applications. Data from other applications can be written to Stackdriver Trace for display, reporting, and analysis.\n",
+ "kind": "discovery#restDescription",
"basePath": "",
- "id": "cloudtrace:v2",
"documentationLink": "https://cloud.google.com/trace",
+ "id": "cloudtrace:v2",
"revision": "20171003",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "TimeEvent": {
+ "description": "A time-stamped annotation or message event in the Span.",
+ "type": "object",
+ "properties": {
+ "annotation": {
+ "$ref": "Annotation",
+ "description": "Text annotation with a set of attributes."
+ },
+ "messageEvent": {
+ "description": "An event describing a message sent/received between Spans.",
+ "$ref": "MessageEvent"
+ },
+ "time": {
+ "format": "google-datetime",
+ "description": "The timestamp indicating the time the event occurred.",
+ "type": "string"
+ }
+ },
+ "id": "TimeEvent"
+ },
+ "MessageEvent": {
+ "properties": {
+ "uncompressedSize": {
+ "format": "uint64",
+ "description": "The number of uncompressed bytes sent or received.",
+ "type": "string"
+ },
+ "type": {
+ "enumDescriptions": [
+ "Unknown event type.",
+ "Indicates a sent message.",
+ "Indicates a received message."
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "SENT",
+ "RECEIVED"
+ ],
+ "description": "Type of MessageEvent. Indicates whether the message was sent or\nreceived.",
+ "type": "string"
+ },
+ "compressedSize": {
+ "format": "uint64",
+ "description": "The number of compressed bytes sent or received. If missing assumed to\nbe the same size as uncompressed.",
+ "type": "string"
+ },
+ "id": {
+ "format": "uint64",
+ "description": "An identifier for the message, which must be unique in this span.",
+ "type": "string"
+ }
+ },
+ "id": "MessageEvent",
+ "description": "An event describing a message sent/received between Spans.",
+ "type": "object"
+ },
"StackFrame": {
+ "description": "Represents a single stack frame in a stack trace.",
+ "type": "object",
"properties": {
"columnNumber": {
"format": "int64",
@@ -190,8 +254,8 @@
"description": "The version of the deployed source code (up to 128 bytes)."
},
"originalFunctionName": {
- "$ref": "TruncatableString",
- "description": "An un-mangled function name, if `function_name` is\n[mangled](http://www.avabodh.com/cxxin/namemangling.html). The name can\nbe fully-qualified (up to 1024 bytes)."
+ "description": "An un-mangled function name, if `function_name` is\n[mangled](http://www.avabodh.com/cxxin/namemangling.html). The name can\nbe fully-qualified (up to 1024 bytes).",
+ "$ref": "TruncatableString"
},
"functionName": {
"description": "The fully-qualified name that uniquely identifies the function or\nmethod that is active in this frame (up to 1024 bytes).",
@@ -207,13 +271,9 @@
"description": "The binary module from where the code was loaded."
}
},
- "id": "StackFrame",
- "description": "Represents a single stack frame in a stack trace.",
- "type": "object"
+ "id": "StackFrame"
},
"Link": {
- "description": "A pointer from the current span to another span in the same trace or in a\ndifferent trace. For example, this can be used in batching operations,\nwhere a single batch handler processes multiple requests from different\ntraces or when the handler receives a request from a different project.",
- "type": "object",
"properties": {
"type": {
"enumDescriptions": [
@@ -230,8 +290,8 @@
"type": "string"
},
"attributes": {
- "$ref": "Attributes",
- "description": "A set of attributes on the link. There is a limit of 32 attributes per\nlink."
+ "description": "A set of attributes on the link. There is a limit of 32 attributes per\nlink.",
+ "$ref": "Attributes"
},
"traceId": {
"description": "`TRACE_ID` identifies a trace within a project.",
@@ -242,24 +302,28 @@
"type": "string"
}
},
- "id": "Link"
+ "id": "Link",
+ "description": "A pointer from the current span to another span in the same trace or in a\ndifferent trace. For example, this can be used in batching operations,\nwhere a single batch handler processes multiple requests from different\ntraces or when the handler receives a request from a different project.",
+ "type": "object"
},
"Annotation": {
"description": "Text annotation with a set of attributes.",
"type": "object",
"properties": {
"description": {
- "$ref": "TruncatableString",
- "description": "A user-supplied message describing the event. The maximum length for\nthe description is 256 bytes."
+ "description": "A user-supplied message describing the event. The maximum length for\nthe description is 256 bytes.",
+ "$ref": "TruncatableString"
},
"attributes": {
- "$ref": "Attributes",
- "description": "A set of attributes on the annotation. There is a limit of 4 attributes\nper Annotation."
+ "description": "A set of attributes on the annotation. There is a limit of 4 attributes\nper Annotation.",
+ "$ref": "Attributes"
}
},
"id": "Annotation"
},
"StackFrames": {
+ "description": "A collection of stack frames, which can be truncated.",
+ "type": "object",
"properties": {
"droppedFramesCount": {
"format": "int32",
@@ -274,9 +338,7 @@
"type": "array"
}
},
- "id": "StackFrames",
- "description": "A collection of stack frames, which can be truncated.",
- "type": "object"
+ "id": "StackFrames"
},
"TimeEvents": {
"description": "A collection of `TimeEvent`s. A `TimeEvent` is a time-stamped annotation\non the span, consisting of either user-supplied key:value pairs, or\ndetails of a message sent/received between Spans.",
@@ -303,26 +365,24 @@
"id": "TimeEvents"
},
"Module": {
- "description": "Binary module.",
- "type": "object",
"properties": {
"module": {
- "$ref": "TruncatableString",
- "description": "For example: main binary, kernel modules, and dynamic libraries\nsuch as libc.so, sharedlib.so (up to 256 bytes)."
+ "description": "For example: main binary, kernel modules, and dynamic libraries\nsuch as libc.so, sharedlib.so (up to 256 bytes).",
+ "$ref": "TruncatableString"
},
"buildId": {
"$ref": "TruncatableString",
"description": "A unique identifier for the module, usually a hash of its\ncontents (up to 128 bytes)."
}
},
- "id": "Module"
+ "id": "Module",
+ "description": "Binary module.",
+ "type": "object"
},
"Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
"properties": {
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
@@ -338,15 +398,15 @@
"format": "int32",
"description": "The status code, which should be an enum value of google.rpc.Code.",
"type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
}
},
- "id": "Status",
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object"
+ "id": "Status"
},
"BatchWriteSpansRequest": {
- "description": "The request message for the `BatchWriteSpans` method.",
- "type": "object",
"properties": {
"spans": {
"description": "A collection of spans.",
@@ -356,43 +416,14 @@
"type": "array"
}
},
- "id": "BatchWriteSpansRequest"
- },
- "Empty": {
- "properties": {},
- "id": "Empty",
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "id": "BatchWriteSpansRequest",
+ "description": "The request message for the `BatchWriteSpans` method.",
"type": "object"
},
"Span": {
"description": "A span represents a single operation within a trace. Spans can be\nnested to form a trace tree. Often, a trace contains a root span\nthat describes the end-to-end latency, and one or more subspans for\nits sub-operations. A trace can also contain multiple root spans,\nor none at all. Spans do not need to be contiguous—there may be\ngaps or overlaps between spans in a trace.",
"type": "object",
"properties": {
- "startTime": {
- "format": "google-datetime",
- "description": "The start time of the span. On the client side, this is the time kept by\nthe local machine where the span execution starts. On the server side, this\nis the time when the server's application handler starts running.",
- "type": "string"
- },
- "displayName": {
- "$ref": "TruncatableString",
- "description": "A description of the span's operation (up to 128 bytes).\nStackdriver Trace displays the description in the\n{% dynamic print site_values.console_name %}.\nFor example, the display name can be a qualified method name or a file name\nand a line number where the operation is called. A best practice is to use\nthe same display name within an application and at the same call point.\nThis makes it easier to correlate spans in different traces."
- },
- "timeEvents": {
- "$ref": "TimeEvents",
- "description": "The included time events. There can be up to 32 annotations and 128 message\nevents per span."
- },
- "links": {
- "description": "A maximum of 128 links are allowed per Span.",
- "$ref": "Links"
- },
- "attributes": {
- "$ref": "Attributes",
- "description": "A set of attributes on the span. There is a limit of 32 attributes per\nspan."
- },
- "spanId": {
- "description": "The [SPAN_ID] portion of the span's resource name.",
- "type": "string"
- },
"childSpanCount": {
"format": "uint32",
"description": "An optional number of child spans that were generated while this span\nwas active. If set, allows implementation to detect missing child spans.",
@@ -411,8 +442,8 @@
"type": "string"
},
"stackTrace": {
- "description": "Stack trace captured at the start of the span.",
- "$ref": "StackTrace"
+ "$ref": "StackTrace",
+ "description": "Stack trace captured at the start of the span."
},
"parentSpanId": {
"description": "The [SPAN_ID] of this span's parent span. If this is a root span,\nthen this field must be empty.",
@@ -422,11 +453,44 @@
"format": "google-datetime",
"description": "The end time of the span. On the client side, this is the time kept by\nthe local machine where the span execution ends. On the server side, this\nis the time when the server application handler stops running.",
"type": "string"
+ },
+ "startTime": {
+ "format": "google-datetime",
+ "description": "The start time of the span. On the client side, this is the time kept by\nthe local machine where the span execution starts. On the server side, this\nis the time when the server's application handler starts running.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "A description of the span's operation (up to 128 bytes).\nStackdriver Trace displays the description in the\n{% dynamic print site_values.console_name %}.\nFor example, the display name can be a qualified method name or a file name\nand a line number where the operation is called. A best practice is to use\nthe same display name within an application and at the same call point.\nThis makes it easier to correlate spans in different traces.",
+ "$ref": "TruncatableString"
+ },
+ "timeEvents": {
+ "description": "The included time events. There can be up to 32 annotations and 128 message\nevents per span.",
+ "$ref": "TimeEvents"
+ },
+ "links": {
+ "description": "A maximum of 128 links are allowed per Span.",
+ "$ref": "Links"
+ },
+ "attributes": {
+ "$ref": "Attributes",
+ "description": "A set of attributes on the span. There is a limit of 32 attributes per\nspan."
+ },
+ "spanId": {
+ "description": "The [SPAN_ID] portion of the span's resource name.",
+ "type": "string"
}
},
"id": "Span"
},
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
+ },
"AttributeValue": {
+ "description": "The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute.",
+ "type": "object",
"properties": {
"intValue": {
"format": "int64",
@@ -438,13 +502,11 @@
"type": "boolean"
},
"stringValue": {
- "$ref": "TruncatableString",
- "description": "A string up to 256 bytes long."
+ "description": "A string up to 256 bytes long.",
+ "$ref": "TruncatableString"
}
},
- "id": "AttributeValue",
- "description": "The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute.",
- "type": "object"
+ "id": "AttributeValue"
},
"Attributes": {
"description": "A set of attributes, each in the format `[KEY]:[VALUE]`.",
@@ -469,115 +531,59 @@
"description": "A collection of links, which are references from this span to a span\nin the same or different trace.",
"type": "object",
"properties": {
+ "droppedLinksCount": {
+ "format": "int32",
+ "description": "The number of dropped links after the maximum size was enforced. If\nthis value is 0, then no links were dropped.",
+ "type": "integer"
+ },
"link": {
"description": "A collection of links.",
"items": {
"$ref": "Link"
},
"type": "array"
- },
- "droppedLinksCount": {
- "format": "int32",
- "description": "The number of dropped links after the maximum size was enforced. If\nthis value is 0, then no links were dropped.",
- "type": "integer"
}
},
"id": "Links"
},
- "TruncatableString": {
- "properties": {
- "value": {
- "description": "The shortened string. For example, if the original string was 500\nbytes long and the limit of the string was 128 bytes, then this\nvalue contains the first 128 bytes of the 500-byte string. Note that\ntruncation always happens on the character boundary, to ensure that\ntruncated string is still valid UTF8. In case of multi-byte characters,\nsize of truncated string can be less than truncation limit.",
- "type": "string"
- },
- "truncatedByteCount": {
- "format": "int32",
- "description": "The number of bytes removed from the original string. If this\nvalue is 0, then the string was not shortened.",
- "type": "integer"
- }
- },
- "id": "TruncatableString",
- "description": "Represents a string that might be shortened to a specified length.",
- "type": "object"
- },
"StackTrace": {
"properties": {
- "stackFrames": {
- "description": "Stack frames in this stack trace. A maximum of 128 frames are allowed.",
- "$ref": "StackFrames"
- },
"stackTraceHashId": {
"format": "uint64",
"description": "The hash ID is used to conserve network bandwidth for duplicate\nstack traces within a single trace.\n\nOften multiple spans will have identical stack traces.\nThe first occurrence of a stack trace should contain both the\n`stackFrame` content and a value in `stackTraceHashId`.\n\nSubsequent spans within the same request can refer\nto that stack trace by only setting `stackTraceHashId`.",
"type": "string"
+ },
+ "stackFrames": {
+ "$ref": "StackFrames",
+ "description": "Stack frames in this stack trace. A maximum of 128 frames are allowed."
}
},
"id": "StackTrace",
"description": "A call stack appearing in a trace.",
"type": "object"
},
- "TimeEvent": {
+ "TruncatableString": {
+ "description": "Represents a string that might be shortened to a specified length.",
+ "type": "object",
"properties": {
- "messageEvent": {
- "description": "An event describing a message sent/received between Spans.",
- "$ref": "MessageEvent"
+ "truncatedByteCount": {
+ "format": "int32",
+ "description": "The number of bytes removed from the original string. If this\nvalue is 0, then the string was not shortened.",
+ "type": "integer"
},
- "time": {
- "format": "google-datetime",
- "description": "The timestamp indicating the time the event occurred.",
+ "value": {
+ "description": "The shortened string. For example, if the original string was 500\nbytes long and the limit of the string was 128 bytes, then this\nvalue contains the first 128 bytes of the 500-byte string. Note that\ntruncation always happens on the character boundary, to ensure that\ntruncated string is still valid UTF8. In case of multi-byte characters,\nsize of truncated string can be less than truncation limit.",
"type": "string"
- },
- "annotation": {
- "description": "Text annotation with a set of attributes.",
- "$ref": "Annotation"
}
},
- "id": "TimeEvent",
- "description": "A time-stamped annotation or message event in the Span.",
- "type": "object"
- },
- "MessageEvent": {
- "properties": {
- "compressedSize": {
- "format": "uint64",
- "description": "The number of compressed bytes sent or received. If missing assumed to\nbe the same size as uncompressed.",
- "type": "string"
- },
- "id": {
- "format": "uint64",
- "description": "An identifier for the message, which must be unique in this span.",
- "type": "string"
- },
- "uncompressedSize": {
- "format": "uint64",
- "description": "The number of uncompressed bytes sent or received.",
- "type": "string"
- },
- "type": {
- "enum": [
- "TYPE_UNSPECIFIED",
- "SENT",
- "RECEIVED"
- ],
- "description": "Type of MessageEvent. Indicates whether the message was sent or\nreceived.",
- "type": "string",
- "enumDescriptions": [
- "Unknown event type.",
- "Indicates a sent message.",
- "Indicates a received message."
- ]
- }
- },
- "id": "MessageEvent",
- "description": "An event describing a message sent/received between Spans.",
- "type": "object"
+ "id": "TruncatableString"
}
},
+ "protocol": "rest",
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
- "protocol": "rest",
"canonicalName": "Cloud Trace",
"auth": {
"oauth2": {
@@ -590,11 +596,5 @@
}
}
}
- },
- "rootUrl": "https://cloudtrace.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "cloudtrace",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Stackdriver Trace API"
+ }
}
diff --git a/container/v1/container-api.json b/container/v1/container-api.json
index 0f8360a..48816ce 100644
--- a/container/v1/container-api.json
+++ b/container/v1/container-api.json
@@ -1,6 +1,6 @@
{
- "discoveryVersion": "v1",
"ownerName": "Google",
+ "discoveryVersion": "v1",
"resources": {
"projects": {
"resources": {
@@ -8,6 +8,7 @@
"methods": {
"getServerconfig": {
"description": "Returns configuration info about the Container Engine service.",
+ "httpMethod": "GET",
"response": {
"$ref": "ServerConfig"
},
@@ -15,235 +16,114 @@
"projectId",
"zone"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
- "zone": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for."
- },
"projectId": {
"description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
"type": "string",
"required": true,
"location": "path"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for.",
+ "type": "string",
+ "required": true,
+ "location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1/projects/{projectId}/zones/{zone}/serverconfig",
- "id": "container.projects.zones.getServerconfig",
- "path": "v1/projects/{projectId}/zones/{zone}/serverconfig"
+ "path": "v1/projects/{projectId}/zones/{zone}/serverconfig",
+ "id": "container.projects.zones.getServerconfig"
}
},
"resources": {
- "operations": {
- "methods": {
- "get": {
- "description": "Gets the specified operation.",
- "parameterOrder": [
- "projectId",
- "zone",
- "operationId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "operationId": {
- "location": "path",
- "description": "The server-assigned `name` of the operation.",
- "type": "string",
- "required": true
- },
- "projectId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840)."
- }
- },
- "flatPath": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}",
- "id": "container.projects.zones.operations.get",
- "path": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}"
- },
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "projectId",
- "zone"
- ],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "type": "string",
- "required": true
- },
- "zone": {
- "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for, or `-` for all zones.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/operations",
- "path": "v1/projects/{projectId}/zones/{zone}/operations",
- "id": "container.projects.zones.operations.list",
- "description": "Lists all operations in a project in a specific zone or all zones."
- },
- "cancel": {
- "description": "Cancels the specified operation.",
- "request": {
- "$ref": "CancelOperationRequest"
- },
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "operationId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation resides.",
- "type": "string",
- "required": true
- },
- "operationId": {
- "description": "The server-assigned `name` of the operation.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel",
- "id": "container.projects.zones.operations.cancel",
- "path": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel"
- }
- }
- },
"clusters": {
"methods": {
"update": {
+ "id": "container.projects.zones.clusters.update",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
"request": {
"$ref": "UpdateClusterRequest"
},
"description": "Updates the settings of a specific cluster.",
- "httpMethod": "PUT",
+ "response": {
+ "$ref": "Operation"
+ },
"parameterOrder": [
"projectId",
"zone",
"clusterId"
],
- "response": {
- "$ref": "Operation"
- },
+ "httpMethod": "PUT",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "clusterId": {
- "description": "The name of the cluster to upgrade.",
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
"type": "string",
"required": true,
"location": "path"
},
- "projectId": {
+ "clusterId": {
"location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "description": "The name of the cluster to upgrade.",
"type": "string",
"required": true
},
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
}
},
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "id": "container.projects.zones.clusters.update"
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}"
},
"monitoring": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "type": "string",
- "required": true
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "clusterId": {
- "description": "The name of the cluster to upgrade.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring",
- "id": "container.projects.zones.clusters.monitoring",
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring",
+ "id": "container.projects.zones.clusters.monitoring",
"description": "Sets the monitoring service of a specific cluster.",
"request": {
"$ref": "SetMonitoringServiceRequest"
- }
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to upgrade.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring"
},
"master": {
- "id": "container.projects.zones.clusters.master",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master",
- "description": "Updates the master of a specific cluster.",
- "request": {
- "$ref": "UpdateMasterRequest"
- },
"response": {
"$ref": "Operation"
},
@@ -253,12 +133,15 @@
"clusterId"
],
"httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"projectId": {
+ "location": "path",
"description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
},
"zone": {
"location": "path",
@@ -273,18 +156,61 @@
"required": true
}
},
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master",
+ "id": "container.projects.zones.clusters.master",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master",
+ "request": {
+ "$ref": "UpdateMasterRequest"
+ },
+ "description": "Updates the master of a specific cluster."
+ },
+ "setMasterAuth": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "type": "string",
+ "required": true
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to upgrade.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master"
- },
- "setMasterAuth": {
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth",
"id": "container.projects.zones.clusters.setMasterAuth",
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth",
"description": "Used to set master auth materials. Currently supports :-\nChanging the admin password of a specific cluster.\nThis can be either via password generation or explicitly set the password.",
"request": {
"$ref": "SetMasterAuthRequest"
+ }
+ },
+ "logging": {
+ "id": "container.projects.zones.clusters.logging",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging",
+ "description": "Sets the logging service of a specific cluster.",
+ "request": {
+ "$ref": "SetLoggingServiceRequest"
},
"response": {
"$ref": "Operation"
@@ -303,48 +229,10 @@
"location": "path"
},
"zone": {
- "location": "path",
"description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
"type": "string",
- "required": true
- },
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster to upgrade.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "logging": {
- "description": "Sets the logging service of a specific cluster.",
- "request": {
- "$ref": "SetLoggingServiceRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "type": "string",
- "required": true
- },
- "zone": {
- "type": "string",
"required": true,
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides."
+ "location": "path"
},
"clusterId": {
"location": "path",
@@ -356,9 +244,7 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging",
- "id": "container.projects.zones.clusters.logging"
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging"
},
"list": {
"response": {
@@ -369,69 +255,28 @@
"zone"
],
"httpMethod": "GET",
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides, or \"-\" for all zones.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "type": "string",
- "required": true
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides, or \"-\" for all zones.",
- "type": "string",
- "required": true
- }
- },
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters",
"id": "container.projects.zones.clusters.list",
"path": "v1/projects/{projectId}/zones/{zone}/clusters",
"description": "Lists all clusters owned by a project in either the specified zone or all\nzones."
},
- "resourceLabels": {
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
- "type": "string",
- "required": true
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "type": "string",
- "required": true
- },
- "clusterId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The name of the cluster."
- }
- },
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels",
- "id": "container.projects.zones.clusters.resourceLabels",
- "request": {
- "$ref": "SetLabelsRequest"
- },
- "description": "Sets labels on a cluster."
- },
"create": {
"description": "Creates a cluster, consisting of the specified number and type of Google\nCompute Engine instances.\n\nBy default, the cluster is created in the project's\n[default network](/compute/docs/networks-and-firewalls#networks).\n\nOne firewall is added for the cluster. After cluster creation,\nthe cluster creates routes for each node to allow the containers\non that node to communicate with all other instances in the\ncluster.\n\nFinally, an entry is added to the project's global metadata indicating\nwhich CIDR range is being used by the cluster.",
"request": {
@@ -446,17 +291,17 @@
"$ref": "Operation"
},
"parameters": {
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
"projectId": {
"location": "path",
"description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
"type": "string",
"required": true
- },
- "zone": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides."
}
},
"scopes": [
@@ -466,27 +311,62 @@
"path": "v1/projects/{projectId}/zones/{zone}/clusters",
"id": "container.projects.zones.clusters.create"
},
- "completeIpRotation": {
- "description": "Completes master IP rotation.",
+ "resourceLabels": {
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels",
+ "id": "container.projects.zones.clusters.resourceLabels",
+ "description": "Sets labels on a cluster.",
"request": {
- "$ref": "CompleteIPRotationRequest"
+ "$ref": "SetLabelsRequest"
},
- "response": {
- "$ref": "Operation"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"projectId",
"zone",
"clusterId"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
+ },
"parameters": {
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clusterId": {
+ "description": "The name of the cluster.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
"projectId": {
- "location": "path",
"description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
"type": "string",
- "required": true
- },
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels"
+ },
+ "completeIpRotation": {
+ "description": "Completes master IP rotation.",
+ "request": {
+ "$ref": "CompleteIPRotationRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
"zone": {
"location": "path",
"description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
@@ -498,14 +378,20 @@
"description": "The name of the cluster.",
"type": "string",
"required": true
+ },
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
+ "type": "string",
+ "required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation",
- "id": "container.projects.zones.clusters.completeIpRotation",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation"
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation",
+ "id": "container.projects.zones.clusters.completeIpRotation"
},
"get": {
"description": "Gets the details of a specific cluster.",
@@ -518,13 +404,10 @@
"clusterId"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "type": "string",
- "required": true
- },
"zone": {
"location": "path",
"description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
@@ -536,66 +419,34 @@
"type": "string",
"required": true,
"location": "path"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "type": "string",
+ "required": true,
+ "location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
"id": "container.projects.zones.clusters.get",
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}"
},
- "setNetworkPolicy": {
- "request": {
- "$ref": "SetNetworkPolicyRequest"
- },
- "description": "Enables/Disables Network Policy for a cluster.",
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "clusterId": {
- "description": "The name of the cluster.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy",
- "id": "container.projects.zones.clusters.setNetworkPolicy"
- },
"legacyAbac": {
- "response": {
- "$ref": "Operation"
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac",
+ "id": "container.projects.zones.clusters.legacyAbac",
+ "request": {
+ "$ref": "SetLegacyAbacRequest"
},
+ "description": "Enables or disables the ABAC authorization mechanism on a cluster.",
+ "httpMethod": "POST",
"parameterOrder": [
"projectId",
"zone",
"clusterId"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
@@ -607,10 +458,10 @@
"location": "path"
},
"zone": {
+ "location": "path",
"description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
},
"clusterId": {
"location": "path",
@@ -619,44 +470,75 @@
"required": true
}
},
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac",
- "id": "container.projects.zones.clusters.legacyAbac",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac",
- "request": {
- "$ref": "SetLegacyAbacRequest"
- },
- "description": "Enables or disables the ABAC authorization mechanism on a cluster."
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac"
},
- "startIpRotation": {
+ "setNetworkPolicy": {
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy",
+ "id": "container.projects.zones.clusters.setNetworkPolicy",
+ "description": "Enables/Disables Network Policy for a cluster.",
"request": {
- "$ref": "StartIPRotationRequest"
+ "$ref": "SetNetworkPolicyRequest"
},
- "description": "Start master IP rotation.",
- "response": {
- "$ref": "Operation"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"projectId",
"zone",
"clusterId"
],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
+ "type": "string",
+ "required": true
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy"
+ },
+ "startIpRotation": {
"httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"projectId": {
+ "location": "path",
"description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
"type": "string",
+ "required": true
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "type": "string",
"required": true,
"location": "path"
},
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "type": "string",
- "required": true
- },
"clusterId": {
"description": "The name of the cluster.",
"type": "string",
@@ -665,61 +547,34 @@
}
},
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation",
"id": "container.projects.zones.clusters.startIpRotation",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation"
- },
- "setMaintenancePolicy": {
- "description": "Sets the maintenance policy for a cluster.",
"request": {
- "$ref": "SetMaintenancePolicyRequest"
+ "$ref": "StartIPRotationRequest"
},
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "type": "string",
- "required": true
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "type": "string",
- "required": true
- },
- "clusterId": {
- "description": "The name of the cluster to update.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy",
- "id": "container.projects.zones.clusters.setMaintenancePolicy"
+ "description": "Start master IP rotation."
},
"addons": {
- "httpMethod": "POST",
+ "description": "Sets the addons of a specific cluster.",
+ "request": {
+ "$ref": "SetAddonsConfigRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
"parameterOrder": [
"projectId",
"zone",
"clusterId"
],
- "response": {
- "$ref": "Operation"
- },
+ "httpMethod": "POST",
"parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
"zone": {
"description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
"type": "string",
@@ -727,14 +582,8 @@
"location": "path"
},
"clusterId": {
- "description": "The name of the cluster to upgrade.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "projectId": {
"location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "description": "The name of the cluster to upgrade.",
"type": "string",
"required": true
}
@@ -743,16 +592,11 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons",
"id": "container.projects.zones.clusters.addons",
- "description": "Sets the addons of a specific cluster.",
- "request": {
- "$ref": "SetAddonsConfigRequest"
- }
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons"
},
- "delete": {
- "description": "Deletes the cluster, including the Kubernetes endpoint and all worker\nnodes.\n\nFirewalls and routes that were configured during cluster creation\nare also deleted.\n\nOther Google Compute Engine resources that might be in use by the cluster\n(e.g. load balancer resources) will not be deleted if they weren't present\nat the initial create time.",
- "httpMethod": "DELETE",
+ "setMaintenancePolicy": {
+ "httpMethod": "POST",
"parameterOrder": [
"projectId",
"zone",
@@ -761,38 +605,80 @@
"response": {
"$ref": "Operation"
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster to update.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy",
+ "id": "container.projects.zones.clusters.setMaintenancePolicy",
+ "request": {
+ "$ref": "SetMaintenancePolicyRequest"
+ },
+ "description": "Sets the maintenance policy for a cluster."
+ },
+ "delete": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster to delete.",
+ "type": "string",
+ "required": true
+ },
+ "projectId": {
"location": "path",
"description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
"type": "string",
"required": true
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "type": "string",
- "required": true
- },
- "clusterId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The name of the cluster to delete."
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ "id": "container.projects.zones.clusters.delete",
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "id": "container.projects.zones.clusters.delete"
+ "description": "Deletes the cluster, including the Kubernetes endpoint and all worker\nnodes.\n\nFirewalls and routes that were configured during cluster creation\nare also deleted.\n\nOther Google Compute Engine resources that might be in use by the cluster\n(e.g. load balancer resources) will not be deleted if they weren't present\nat the initial create time."
},
"locations": {
+ "description": "Sets the locations of a specific cluster.",
"request": {
"$ref": "SetLocationsRequest"
},
- "description": "Sets the locations of a specific cluster.",
"response": {
"$ref": "Operation"
},
@@ -802,29 +688,29 @@
"clusterId"
],
"httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
- "projectId": {
+ "zone": {
"location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
"type": "string",
"required": true
},
- "zone": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides."
- },
"clusterId": {
"description": "The name of the cluster to upgrade.",
"type": "string",
"required": true,
"location": "path"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "type": "string",
+ "required": true
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations",
"id": "container.projects.zones.clusters.locations",
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations"
@@ -833,7 +719,102 @@
"resources": {
"nodePools": {
"methods": {
+ "delete": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId",
+ "nodePoolId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clusterId": {
+ "description": "The name of the cluster.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "nodePoolId": {
+ "description": "The name of the node pool to delete.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
+ "id": "container.projects.zones.clusters.nodePools.delete",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
+ "description": "Deletes a node pool from a cluster."
+ },
+ "setManagement": {
+ "id": "container.projects.zones.clusters.nodePools.setManagement",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement",
+ "description": "Sets the NodeManagement options for a node pool.",
+ "request": {
+ "$ref": "SetNodePoolManagementRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId",
+ "nodePoolId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to update.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "nodePoolId": {
+ "description": "The name of the node pool to update.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement"
+ },
"setSize": {
+ "id": "container.projects.zones.clusters.nodePools.setSize",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setSize",
"request": {
"$ref": "SetNodePoolSizeRequest"
},
@@ -852,53 +833,6 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "type": "string",
- "required": true
- },
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster to update.",
- "type": "string",
- "required": true
- },
- "nodePoolId": {
- "location": "path",
- "description": "The name of the node pool to update.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setSize",
- "id": "container.projects.zones.clusters.nodePools.setSize",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setSize"
- },
- "setManagement": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId",
- "nodePoolId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "type": "string",
- "required": true
- },
"zone": {
"description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
"type": "string",
@@ -916,77 +850,29 @@
"type": "string",
"required": true,
"location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement",
- "id": "container.projects.zones.clusters.nodePools.setManagement",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement",
- "description": "Sets the NodeManagement options for a node pool.",
- "request": {
- "$ref": "SetNodePoolManagementRequest"
- }
- },
- "delete": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId",
- "nodePoolId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "clusterId": {
- "description": "The name of the cluster.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "nodePoolId": {
- "location": "path",
- "description": "The name of the node pool to delete.",
- "type": "string",
- "required": true
},
"projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
"type": "string",
"required": true,
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
- "id": "container.projects.zones.clusters.nodePools.delete",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
- "description": "Deletes a node pool from a cluster."
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setSize"
},
"list": {
- "httpMethod": "GET",
+ "id": "container.projects.zones.clusters.nodePools.list",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
+ "description": "Lists the node pools for a cluster.",
+ "response": {
+ "$ref": "ListNodePoolsResponse"
+ },
"parameterOrder": [
"projectId",
"zone",
"clusterId"
],
- "response": {
- "$ref": "ListNodePoolsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
+ "httpMethod": "GET",
"parameters": {
"projectId": {
"location": "path",
@@ -1007,16 +893,12 @@
"location": "path"
}
},
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
- "id": "container.projects.zones.clusters.nodePools.list",
- "description": "Lists the node pools for a cluster."
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools"
},
"rollback": {
- "request": {
- "$ref": "RollbackNodePoolUpgradeRequest"
- },
- "description": "Roll back the previously Aborted or Failed NodePool upgrade.\nThis will be an no-op if the last upgrade successfully completed.",
"httpMethod": "POST",
"parameterOrder": [
"projectId",
@@ -1027,9 +909,6 @@
"response": {
"$ref": "Operation"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"zone": {
"location": "path",
@@ -1050,21 +929,24 @@
"required": true
},
"projectId": {
- "type": "string",
- "required": true,
"location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840)."
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "type": "string",
+ "required": true
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback",
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback",
- "id": "container.projects.zones.clusters.nodePools.rollback"
+ "id": "container.projects.zones.clusters.nodePools.rollback",
+ "description": "Roll back the previously Aborted or Failed NodePool upgrade.\nThis will be an no-op if the last upgrade successfully completed.",
+ "request": {
+ "$ref": "RollbackNodePoolUpgradeRequest"
+ }
},
"create": {
- "request": {
- "$ref": "CreateNodePoolRequest"
- },
- "description": "Creates a node pool for a cluster.",
"response": {
"$ref": "Operation"
},
@@ -1078,28 +960,32 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "projectId": {
+ "zone": {
"location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
"type": "string",
"required": true
},
- "zone": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides."
- },
"clusterId": {
- "location": "path",
"description": "The name of the cluster.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
+ "type": "string",
+ "required": true,
+ "location": "path"
}
},
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
"id": "container.projects.zones.clusters.nodePools.create",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools"
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
+ "request": {
+ "$ref": "CreateNodePoolRequest"
+ },
+ "description": "Creates a node pool for a cluster."
},
"autoscaling": {
"id": "container.projects.zones.clusters.nodePools.autoscaling",
@@ -1129,16 +1015,16 @@
"required": true
},
"clusterId": {
- "location": "path",
"description": "The name of the cluster to upgrade.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
},
"nodePoolId": {
- "location": "path",
"description": "The name of the node pool to upgrade.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
},
"projectId": {
"description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
@@ -1150,6 +1036,9 @@
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling"
},
"get": {
+ "id": "container.projects.zones.clusters.nodePools.get",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
+ "description": "Retrieves the node pool requested.",
"response": {
"$ref": "NodePool"
},
@@ -1160,7 +1049,16 @@
"nodePoolId"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
"clusterId": {
"description": "The name of the cluster.",
"type": "string",
@@ -1168,31 +1066,19 @@
"location": "path"
},
"nodePoolId": {
- "location": "path",
"description": "The name of the node pool.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
},
"projectId": {
- "location": "path",
"description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
"type": "string",
- "required": true
- },
- "zone": {
- "type": "string",
"required": true,
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides."
+ "location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
- "id": "container.projects.zones.clusters.nodePools.get",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
- "description": "Retrieves the node pool requested."
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}"
},
"update": {
"response": {
@@ -1216,10 +1102,10 @@
"required": true
},
"zone": {
- "type": "string",
- "required": true,
"location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides."
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "type": "string",
+ "required": true
},
"clusterId": {
"description": "The name of the cluster to upgrade.",
@@ -1228,10 +1114,10 @@
"location": "path"
},
"nodePoolId": {
+ "description": "The name of the node pool to upgrade.",
"type": "string",
"required": true,
- "location": "path",
- "description": "The name of the node pool to upgrade."
+ "location": "path"
}
},
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update",
@@ -1245,6 +1131,120 @@
}
}
}
+ },
+ "operations": {
+ "methods": {
+ "cancel": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "operationId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "operationId": {
+ "description": "The server-assigned `name` of the operation.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation resides.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel",
+ "id": "container.projects.zones.operations.cancel",
+ "path": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel",
+ "request": {
+ "$ref": "CancelOperationRequest"
+ },
+ "description": "Cancels the specified operation."
+ },
+ "get": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "operationId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "operationId": {
+ "description": "The server-assigned `name` of the operation.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}",
+ "id": "container.projects.zones.operations.get",
+ "path": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}",
+ "description": "Gets the specified operation."
+ },
+ "list": {
+ "parameterOrder": [
+ "projectId",
+ "zone"
+ ],
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for, or `-` for all zones.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/operations",
+ "id": "container.projects.zones.operations.list",
+ "path": "v1/projects/{projectId}/zones/{zone}/operations",
+ "description": "Lists all operations in a project in a specific zone or all zones."
+ }
+ }
}
}
}
@@ -1252,53 +1252,37 @@
}
},
"parameters": {
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
"key": {
"location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string"
},
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
"quotaUser": {
"location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string"
},
"pp": {
+ "description": "Pretty-print response.",
"default": "true",
"type": "boolean",
- "location": "query",
- "description": "Pretty-print response."
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
+ "location": "query"
},
"bearer_token": {
"location": "query",
"description": "OAuth bearer token.",
"type": "string"
},
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
@@ -1311,17 +1295,12 @@
"type": "boolean"
},
"uploadType": {
- "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
- "callback": {
- "description": "JSONP",
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
@@ -1337,503 +1316,30 @@
],
"description": "V1 error format.",
"type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "alt": {
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query"
}
},
"schemas": {
- "AddonsConfig": {
- "description": "Configuration for the addons that can be automatically spun up in the\ncluster, enabling additional functionality.",
- "type": "object",
- "properties": {
- "horizontalPodAutoscaling": {
- "$ref": "HorizontalPodAutoscaling",
- "description": "Configuration for the horizontal pod autoscaling feature, which\nincreases or decreases the number of replica pods a replication controller\nhas based on the resource usage of the existing pods."
- },
- "httpLoadBalancing": {
- "description": "Configuration for the HTTP (L7) load balancing controller addon, which\nmakes it easy to set up HTTP load balancers for services in a cluster.",
- "$ref": "HttpLoadBalancing"
- },
- "kubernetesDashboard": {
- "$ref": "KubernetesDashboard",
- "description": "Configuration for the Kubernetes Dashboard."
- },
- "networkPolicyConfig": {
- "$ref": "NetworkPolicyConfig",
- "description": "Configuration for NetworkPolicy. This only tracks whether the addon\nis enabled or not on the Master, it does not track whether network policy\nis enabled for the nodes."
- }
- },
- "id": "AddonsConfig"
- },
- "SetLocationsRequest": {
- "description": "SetLocationsRequest sets the locations of the cluster.",
- "type": "object",
- "properties": {
- "locations": {
- "description": "The desired list of Google Compute Engine\n[locations](/compute/docs/zones#available) in which the cluster's nodes\nshould be located. Changing the locations a cluster is in will result\nin nodes being either created or removed from the cluster, depending on\nwhether locations are being added or removed.\n\nThis list must always include the cluster's primary zone.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "SetLocationsRequest"
- },
- "SetNodePoolSizeRequest": {
- "type": "object",
- "properties": {
- "nodeCount": {
- "format": "int32",
- "description": "The desired node count for the pool.",
- "type": "integer"
- }
- },
- "id": "SetNodePoolSizeRequest",
- "description": "SetNodePoolSizeRequest sets the size a node\npool."
- },
- "NetworkPolicyConfig": {
- "type": "object",
- "properties": {
- "disabled": {
- "description": "Whether NetworkPolicy is enabled for this cluster.",
- "type": "boolean"
- }
- },
- "id": "NetworkPolicyConfig",
- "description": "Configuration for NetworkPolicy. This only tracks whether the addon\nis enabled or not on the Master, it does not track whether network policy\nis enabled for the nodes."
- },
- "UpdateClusterRequest": {
- "id": "UpdateClusterRequest",
- "description": "UpdateClusterRequest updates the settings of a cluster.",
- "type": "object",
- "properties": {
- "update": {
- "description": "A description of the update.",
- "$ref": "ClusterUpdate"
- }
- }
- },
- "Cluster": {
- "description": "A Google Container Engine cluster.",
- "type": "object",
- "properties": {
- "currentMasterVersion": {
- "description": "[Output only] The current software version of the master endpoint.",
- "type": "string"
- },
- "nodeConfig": {
- "$ref": "NodeConfig",
- "description": "Parameters used in creating the cluster's nodes.\nSee `nodeConfig` for the description of its properties.\nFor requests, this field should only be used in lieu of a\n\"node_pool\" object, since this configuration (along with the\n\"initial_node_count\") will be used to create a \"NodePool\" object with an\nauto-generated name. Do not use this and a node_pool at the same time.\nFor responses, this field will be populated with the node configuration of\nthe first node pool.\n\nIf unspecified, the defaults are used."
- },
- "addonsConfig": {
- "description": "Configurations for the various addons available to run in the cluster.",
- "$ref": "AddonsConfig"
- },
- "status": {
- "description": "[Output only] The current status of this cluster.",
- "type": "string",
- "enumDescriptions": [
- "Not set.",
- "The PROVISIONING state indicates the cluster is being created.",
- "The RUNNING state indicates the cluster has been created and is fully\nusable.",
- "The RECONCILING state indicates that some work is actively being done on\nthe cluster, such as upgrading the master or node software. Details can\nbe found in the `statusMessage` field.",
- "The STOPPING state indicates the cluster is being deleted.",
- "The ERROR state indicates the cluster may be unusable. Details\ncan be found in the `statusMessage` field."
- ],
- "enum": [
- "STATUS_UNSPECIFIED",
- "PROVISIONING",
- "RUNNING",
- "RECONCILING",
- "STOPPING",
- "ERROR"
- ]
- },
- "subnetwork": {
- "description": "The name of the Google Compute Engine\n[subnetwork](/compute/docs/subnetworks) to which the\ncluster is connected.",
- "type": "string"
- },
- "currentNodeVersion": {
- "description": "[Output only] The current version of the node software components.\nIf they are currently at multiple versions because they're in the process\nof being upgraded, this reflects the minimum version of all nodes.",
- "type": "string"
- },
- "maintenancePolicy": {
- "$ref": "MaintenancePolicy",
- "description": "Configure the maintenance policy for this cluster."
- },
- "resourceLabels": {
- "description": "The resource labels for the cluster to use to annotate any related\nGoogle Compute Engine resources.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "name": {
- "description": "The name of this cluster. The name must be unique within this project\nand zone, and can be up to 40 characters with the following restrictions:\n\n* Lowercase letters, numbers, and hyphens only.\n* Must start with a letter.\n* Must end with a number or a letter.",
- "type": "string"
- },
- "initialClusterVersion": {
- "description": "The initial Kubernetes version for this cluster. Valid versions are those\nfound in validMasterVersions returned by getServerConfig. The version can\nbe upgraded over time; such upgrades are reflected in\ncurrentMasterVersion and currentNodeVersion.",
- "type": "string"
- },
- "ipAllocationPolicy": {
- "$ref": "IPAllocationPolicy",
- "description": "Configuration for cluster IP allocation."
- },
- "legacyAbac": {
- "description": "Configuration for the legacy ABAC authorization mode.",
- "$ref": "LegacyAbac"
- },
- "endpoint": {
- "type": "string",
- "description": "[Output only] The IP address of this cluster's master endpoint.\nThe endpoint can be accessed from the internet at\n`https://username:password@endpoint/`.\n\nSee the `masterAuth` property of this resource for username and\npassword information."
- },
- "createTime": {
- "description": "[Output only] The time the cluster was created, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
- "type": "string"
- },
- "clusterIpv4Cidr": {
- "description": "The IP address range of the container pods in this cluster, in\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`). Leave blank to have\none automatically chosen or specify a `/14` block in `10.0.0.0/8`.",
- "type": "string"
- },
- "initialNodeCount": {
- "format": "int32",
- "description": "The number of nodes to create in this cluster. You must ensure that your\nCompute Engine \u003ca href=\"/compute/docs/resource-quotas\"\u003eresource quota\u003c/a\u003e\nis sufficient for this number of instances. You must also have available\nfirewall and routes quota.\nFor requests, this field should only be used in lieu of a\n\"node_pool\" object, since this configuration (along with the\n\"node_config\") will be used to create a \"NodePool\" object with an\nauto-generated name. Do not use this and a node_pool at the same time.",
- "type": "integer"
- },
- "locations": {
- "description": "The list of Google Compute Engine\n[locations](/compute/docs/zones#available) in which the cluster's nodes\nshould be located.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "nodePools": {
- "description": "The node pools associated with this cluster.\nThis field should not be set if \"node_config\" or \"initial_node_count\" are\nspecified.",
- "items": {
- "$ref": "NodePool"
- },
- "type": "array"
- },
- "selfLink": {
- "description": "[Output only] Server-defined URL for the resource.",
- "type": "string"
- },
- "instanceGroupUrls": {
- "description": "[Output only] The resource URLs of [instance\ngroups](/compute/docs/instance-groups/) associated with this\ncluster.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "servicesIpv4Cidr": {
- "description": "[Output only] The IP address range of the Kubernetes services in\nthis cluster, in\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `1.2.3.4/29`). Service addresses are\ntypically put in the last `/16` from the container CIDR.",
- "type": "string"
- },
- "networkPolicy": {
- "description": "Configuration options for the NetworkPolicy feature.",
- "$ref": "NetworkPolicy"
- },
- "enableKubernetesAlpha": {
- "description": "Kubernetes alpha features are enabled on this cluster. This includes alpha\nAPI groups (e.g. v1alpha1) and features that may not be production ready in\nthe kubernetes version of the master and nodes.\nThe cluster has no SLA for uptime and master/node upgrades are disabled.\nAlpha enabled clusters are automatically deleted thirty days after\ncreation.",
- "type": "boolean"
- },
- "description": {
- "description": "An optional description of this cluster.",
- "type": "string"
- },
- "currentNodeCount": {
- "format": "int32",
- "description": "[Output only] The number of nodes currently in the cluster.",
- "type": "integer"
- },
- "monitoringService": {
- "description": "The monitoring service the cluster should use to write metrics.\nCurrently available options:\n\n* `monitoring.googleapis.com` - the Google Cloud Monitoring service.\n* `none` - no metrics will be exported from the cluster.\n* if left as an empty string, `monitoring.googleapis.com` will be used.",
- "type": "string"
- },
- "network": {
- "description": "The name of the Google Compute Engine\n[network](/compute/docs/networks-and-firewalls#networks) to which the\ncluster is connected. If left unspecified, the `default` network\nwill be used.",
- "type": "string"
- },
- "labelFingerprint": {
- "description": "The fingerprint of the set of labels for this cluster.",
- "type": "string"
- },
- "zone": {
- "description": "[Output only] The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "type": "string"
- },
- "loggingService": {
- "description": "The logging service the cluster should use to write logs.\nCurrently available options:\n\n* `logging.googleapis.com` - the Google Cloud Logging service.\n* `none` - no logs will be exported from the cluster.\n* if left as an empty string,`logging.googleapis.com` will be used.",
- "type": "string"
- },
- "expireTime": {
- "type": "string",
- "description": "[Output only] The time the cluster will be automatically\ndeleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format."
- },
- "nodeIpv4CidrSize": {
- "format": "int32",
- "description": "[Output only] The size of the address space on each node for hosting\ncontainers. This is provisioned from within the `container_ipv4_cidr`\nrange.",
- "type": "integer"
- },
- "masterAuthorizedNetworksConfig": {
- "description": "Master authorized networks is a Beta feature.\nThe configuration options for master authorized networks feature.",
- "$ref": "MasterAuthorizedNetworksConfig"
- },
- "statusMessage": {
- "type": "string",
- "description": "[Output only] Additional information about the current status of this\ncluster, if available."
- },
- "masterAuth": {
- "$ref": "MasterAuth",
- "description": "The authentication information for accessing the master endpoint."
- }
- },
- "id": "Cluster"
- },
- "CreateNodePoolRequest": {
- "description": "CreateNodePoolRequest creates a node pool for a cluster.",
- "type": "object",
- "properties": {
- "nodePool": {
- "$ref": "NodePool",
- "description": "The node pool to create."
- }
- },
- "id": "CreateNodePoolRequest"
- },
- "MasterAuth": {
- "id": "MasterAuth",
- "description": "The authentication information for accessing the master endpoint.\nAuthentication can be done using HTTP basic auth or using client\ncertificates.",
- "type": "object",
- "properties": {
- "clientCertificate": {
- "description": "[Output only] Base64-encoded public certificate used by clients to\nauthenticate to the cluster endpoint.",
- "type": "string"
- },
- "username": {
- "description": "The username to use for HTTP basic authentication to the master endpoint.\nFor clusters v1.6.0 and later, you can disable basic authentication by\nproviding an empty username.",
- "type": "string"
- },
- "password": {
- "description": "The password to use for HTTP basic authentication to the master endpoint.\nBecause the master endpoint is open to the Internet, you should create a\nstrong password. If a password is provided for cluster creation, username\nmust be non-empty.",
- "type": "string"
- },
- "clientCertificateConfig": {
- "$ref": "ClientCertificateConfig",
- "description": "Configuration for client certificate authentication on the cluster. If no\nconfiguration is specified, a client certificate is issued."
- },
- "clientKey": {
- "description": "[Output only] Base64-encoded private key used by clients to authenticate\nto the cluster endpoint.",
- "type": "string"
- },
- "clusterCaCertificate": {
- "description": "[Output only] Base64-encoded public certificate that is the root of\ntrust for the cluster.",
- "type": "string"
- }
- }
- },
- "DailyMaintenanceWindow": {
- "type": "object",
- "properties": {
- "duration": {
- "description": "[Output only] Duration of the time window, automatically chosen to be\nsmallest possible in the given scenario.\nDuration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)\nformat \"PTnHnMnS\".",
- "type": "string"
- },
- "startTime": {
- "description": "Time within the maintenance window to start the maintenance operations.\nTime format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)\nformat \"HH:MM”, where HH : [00-23] and MM : [00-59] GMT.",
- "type": "string"
- }
- },
- "id": "DailyMaintenanceWindow",
- "description": "Time window specified for daily maintenance operations."
- },
- "MaintenancePolicy": {
- "description": "MaintenancePolicy defines the maintenance policy to be used for the cluster.",
- "type": "object",
- "properties": {
- "window": {
- "$ref": "MaintenanceWindow",
- "description": "Specifies the maintenance window in which maintenance may be performed."
- }
- },
- "id": "MaintenancePolicy"
- },
- "ClientCertificateConfig": {
- "description": "Configuration for client certificates on the cluster.",
- "type": "object",
- "properties": {
- "issueClientCertificate": {
- "description": "Issue a client certificate.",
- "type": "boolean"
- }
- },
- "id": "ClientCertificateConfig"
- },
- "SetLoggingServiceRequest": {
- "type": "object",
- "properties": {
- "loggingService": {
- "description": "The logging service the cluster should use to write metrics.\nCurrently available options:\n\n* \"logging.googleapis.com\" - the Google Cloud Logging service\n* \"none\" - no metrics will be exported from the cluster",
- "type": "string"
- }
- },
- "id": "SetLoggingServiceRequest",
- "description": "SetLoggingServiceRequest sets the logging service of a cluster."
- },
- "SetMaintenancePolicyRequest": {
- "description": "SetMaintenancePolicyRequest sets the maintenance policy for a cluster.",
- "type": "object",
- "properties": {
- "maintenancePolicy": {
- "description": "The maintenance policy to be set for the cluster. An empty field\nclears the existing maintenance policy.",
- "$ref": "MaintenancePolicy"
- }
- },
- "id": "SetMaintenancePolicyRequest"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "ListNodePoolsResponse": {
- "properties": {
- "nodePools": {
- "description": "A list of node pools for a cluster.",
- "items": {
- "$ref": "NodePool"
- },
- "type": "array"
- }
- },
- "id": "ListNodePoolsResponse",
- "description": "ListNodePoolsResponse is the result of ListNodePoolsRequest.",
- "type": "object"
- },
- "CompleteIPRotationRequest": {
- "description": "CompleteIPRotationRequest moves the cluster master back into single-IP mode.",
- "type": "object",
- "properties": {},
- "id": "CompleteIPRotationRequest"
- },
- "StartIPRotationRequest": {
- "description": "StartIPRotationRequest creates a new IP for the cluster and then performs\na node upgrade on each node pool to point to the new IP.",
- "type": "object",
- "properties": {},
- "id": "StartIPRotationRequest"
- },
- "NodePool": {
- "id": "NodePool",
- "description": "NodePool contains the name and configuration for a cluster's node pool.\nNode pools are a set of nodes (i.e. VM's), with a common configuration and\nspecification, under the control of the cluster master. They may have a set\nof Kubernetes labels applied to them, which may be used to reference them\nduring pod scheduling. They may also be resized up or down, to accommodate\nthe workload.",
- "type": "object",
- "properties": {
- "config": {
- "$ref": "NodeConfig",
- "description": "The node configuration of the pool."
- },
- "statusMessage": {
- "type": "string",
- "description": "[Output only] Additional information about the current status of this\nnode pool instance, if available."
- },
- "name": {
- "description": "The name of the node pool.",
- "type": "string"
- },
- "autoscaling": {
- "description": "Autoscaler configuration for this NodePool. Autoscaler is enabled\nonly if a valid configuration is present.",
- "$ref": "NodePoolAutoscaling"
- },
- "management": {
- "$ref": "NodeManagement",
- "description": "NodeManagement configuration for this NodePool."
- },
- "initialNodeCount": {
- "format": "int32",
- "description": "The initial node count for the pool. You must ensure that your\nCompute Engine \u003ca href=\"/compute/docs/resource-quotas\"\u003eresource quota\u003c/a\u003e\nis sufficient for this number of instances. You must also have available\nfirewall and routes quota.",
- "type": "integer"
- },
- "selfLink": {
- "description": "[Output only] Server-defined URL for the resource.",
- "type": "string"
- },
- "instanceGroupUrls": {
- "description": "[Output only] The resource URLs of [instance\ngroups](/compute/docs/instance-groups/) associated with this\nnode pool.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "version": {
- "description": "[Output only] The version of the Kubernetes of this node.",
- "type": "string"
- },
- "status": {
- "description": "[Output only] The status of the nodes in this pool instance.",
- "type": "string",
- "enumDescriptions": [
- "Not set.",
- "The PROVISIONING state indicates the node pool is being created.",
- "The RUNNING state indicates the node pool has been created\nand is fully usable.",
- "The RUNNING_WITH_ERROR state indicates the node pool has been created\nand is partially usable. Some error state has occurred and some\nfunctionality may be impaired. Customer may need to reissue a request\nor trigger a new update.",
- "The RECONCILING state indicates that some work is actively being done on\nthe node pool, such as upgrading node software. Details can\nbe found in the `statusMessage` field.",
- "The STOPPING state indicates the node pool is being deleted.",
- "The ERROR state indicates the node pool may be unusable. Details\ncan be found in the `statusMessage` field."
- ],
- "enum": [
- "STATUS_UNSPECIFIED",
- "PROVISIONING",
- "RUNNING",
- "RUNNING_WITH_ERROR",
- "RECONCILING",
- "STOPPING",
- "ERROR"
- ]
- }
- }
- },
- "SetLabelsRequest": {
- "description": "SetLabelsRequest sets the Google Cloud Platform labels on a Google Container\nEngine cluster, which will in turn set them for Google Compute Engine\nresources used by that cluster",
- "type": "object",
- "properties": {
- "resourceLabels": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "description": "The labels to set for that cluster."
- },
- "labelFingerprint": {
- "description": "The fingerprint of the previous set of labels for this resource,\nused to detect conflicts. The fingerprint is initially generated by\nContainer Engine and changes after every request to modify or update\nlabels. You must always provide an up-to-date fingerprint hash when\nupdating or changing labels. Make a \u003ccode\u003eget()\u003c/code\u003e request to the\nresource to get the latest fingerprint.",
- "type": "string"
- }
- },
- "id": "SetLabelsRequest"
- },
- "NodeManagement": {
- "id": "NodeManagement",
- "description": "NodeManagement defines the set of node management services turned on for the\nnode pool.",
- "type": "object",
- "properties": {
- "upgradeOptions": {
- "$ref": "AutoUpgradeOptions",
- "description": "Specifies the Auto Upgrade knobs for the node pool."
- },
- "autoRepair": {
- "type": "boolean",
- "description": "A flag that specifies whether the node auto-repair is enabled for the node\npool. If enabled, the nodes in this node pool will be monitored and, if\nthey fail health checks too many times, an automatic repair action will be\ntriggered."
- },
- "autoUpgrade": {
- "description": "A flag that specifies whether node auto-upgrade is enabled for the node\npool. If enabled, node auto-upgrade helps keep the nodes in your node pool\nup to date with the latest release version of Kubernetes.",
- "type": "boolean"
- }
- }
- },
- "CancelOperationRequest": {
- "description": "CancelOperationRequest cancels a single operation.",
- "type": "object",
- "properties": {},
- "id": "CancelOperationRequest"
- },
"KubernetesDashboard": {
"properties": {
"disabled": {
@@ -1846,35 +1352,29 @@
"type": "object"
},
"Operation": {
- "id": "Operation",
"description": "This operation resource represents operations that may have happened or are\nhappening on the cluster. All fields are output only.",
"type": "object",
"properties": {
- "name": {
- "description": "The server-assigned ID for the operation.",
- "type": "string"
- },
- "statusMessage": {
- "description": "If an error has occurred, a textual description of the error.",
- "type": "string"
- },
- "selfLink": {
- "description": "Server-defined URL for the resource.",
- "type": "string"
- },
- "detail": {
- "description": "Detailed operation progress, if available.",
- "type": "string"
- },
- "targetLink": {
- "description": "Server-defined URL for the target of the operation.",
- "type": "string"
- },
- "endTime": {
- "description": "[Output only] The time the operation completed, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
- "type": "string"
- },
"operationType": {
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "CREATE_CLUSTER",
+ "DELETE_CLUSTER",
+ "UPGRADE_MASTER",
+ "UPGRADE_NODES",
+ "REPAIR_CLUSTER",
+ "UPDATE_CLUSTER",
+ "CREATE_NODE_POOL",
+ "DELETE_NODE_POOL",
+ "SET_NODE_POOL_MANAGEMENT",
+ "AUTO_REPAIR_NODES",
+ "AUTO_UPGRADE_NODES",
+ "SET_LABELS",
+ "SET_MASTER_AUTH",
+ "SET_NODE_POOL_SIZE",
+ "SET_NETWORK_POLICY",
+ "SET_MAINTENANCE_POLICY"
+ ],
"description": "The operation type.",
"type": "string",
"enumDescriptions": [
@@ -1895,43 +1395,17 @@
"Set node pool size.",
"Updates network policy for a cluster.",
"Set the maintenance policy."
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "CREATE_CLUSTER",
- "DELETE_CLUSTER",
- "UPGRADE_MASTER",
- "UPGRADE_NODES",
- "REPAIR_CLUSTER",
- "UPDATE_CLUSTER",
- "CREATE_NODE_POOL",
- "DELETE_NODE_POOL",
- "SET_NODE_POOL_MANAGEMENT",
- "AUTO_REPAIR_NODES",
- "AUTO_UPGRADE_NODES",
- "SET_LABELS",
- "SET_MASTER_AUTH",
- "SET_NODE_POOL_SIZE",
- "SET_NETWORK_POLICY",
- "SET_MAINTENANCE_POLICY"
]
},
"startTime": {
- "type": "string",
- "description": "[Output only] The time the operation started, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format."
+ "description": "[Output only] The time the operation started, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
+ "type": "string"
},
"zone": {
"description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation\nis taking place.",
"type": "string"
},
"status": {
- "enumDescriptions": [
- "Not set.",
- "The operation has been created.",
- "The operation is currently running.",
- "The operation is done, either cancelled or completed.",
- "The operation is aborting."
- ],
"enum": [
"STATUS_UNSPECIFIED",
"PENDING",
@@ -1940,30 +1414,60 @@
"ABORTING"
],
"description": "The current status of the operation.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not set.",
+ "The operation has been created.",
+ "The operation is currently running.",
+ "The operation is done, either cancelled or completed.",
+ "The operation is aborting."
+ ]
+ },
+ "statusMessage": {
+ "description": "If an error has occurred, a textual description of the error.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The server-assigned ID for the operation.",
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "Server-defined URL for the resource.",
+ "type": "string"
+ },
+ "targetLink": {
+ "description": "Server-defined URL for the target of the operation.",
+ "type": "string"
+ },
+ "detail": {
+ "description": "Detailed operation progress, if available.",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "[Output only] The time the operation completed, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
"type": "string"
}
- }
+ },
+ "id": "Operation"
},
"MaintenanceWindow": {
+ "description": "MaintenanceWindow defines the maintenance window to be used for the cluster.",
+ "type": "object",
"properties": {
"dailyMaintenanceWindow": {
- "$ref": "DailyMaintenanceWindow",
- "description": "DailyMaintenanceWindow specifies a daily maintenance operation window."
+ "description": "DailyMaintenanceWindow specifies a daily maintenance operation window.",
+ "$ref": "DailyMaintenanceWindow"
}
},
- "id": "MaintenanceWindow",
- "description": "MaintenanceWindow defines the maintenance window to be used for the cluster.",
- "type": "object"
+ "id": "MaintenanceWindow"
},
"RollbackNodePoolUpgradeRequest": {
- "description": "RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed\nNodePool upgrade. This will be an no-op if the last upgrade successfully\ncompleted.",
- "type": "object",
"properties": {},
- "id": "RollbackNodePoolUpgradeRequest"
+ "id": "RollbackNodePoolUpgradeRequest",
+ "description": "RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed\nNodePool upgrade. This will be an no-op if the last upgrade successfully\ncompleted.",
+ "type": "object"
},
"NetworkPolicy": {
- "description": "Configuration options for the NetworkPolicy feature.\nhttps://kubernetes.io/docs/concepts/services-networking/networkpolicies/",
- "type": "object",
"properties": {
"enabled": {
"description": "Whether network policy is enabled on the cluster.",
@@ -1982,23 +1486,22 @@
]
}
},
- "id": "NetworkPolicy"
+ "id": "NetworkPolicy",
+ "description": "Configuration options for the NetworkPolicy feature.\nhttps://kubernetes.io/docs/concepts/services-networking/networkpolicies/",
+ "type": "object"
},
"UpdateMasterRequest": {
- "description": "UpdateMasterRequest updates the master of the cluster.",
- "type": "object",
"properties": {
"masterVersion": {
"description": "The Kubernetes version to change the master to. The only valid value is the\nlatest supported version. Use \"-\" to have the server automatically select\nthe latest version.",
"type": "string"
}
},
- "id": "UpdateMasterRequest"
+ "id": "UpdateMasterRequest",
+ "description": "UpdateMasterRequest updates the master of the cluster.",
+ "type": "object"
},
"ListOperationsResponse": {
- "id": "ListOperationsResponse",
- "description": "ListOperationsResponse is the result of ListOperationsRequest.",
- "type": "object",
"properties": {
"operations": {
"description": "A list of operations in the project in the specified zone.",
@@ -2014,45 +1517,41 @@
},
"type": "array"
}
- }
+ },
+ "id": "ListOperationsResponse",
+ "description": "ListOperationsResponse is the result of ListOperationsRequest.",
+ "type": "object"
},
"CidrBlock": {
- "description": "CidrBlock contains an optional name and one CIDR block.",
- "type": "object",
"properties": {
- "cidrBlock": {
- "description": "cidr_block must be specified in CIDR notation.",
- "type": "string"
- },
"displayName": {
"description": "display_name is an optional field for users to identify CIDR blocks.",
"type": "string"
+ },
+ "cidrBlock": {
+ "description": "cidr_block must be specified in CIDR notation.",
+ "type": "string"
}
},
- "id": "CidrBlock"
+ "id": "CidrBlock",
+ "description": "CidrBlock contains an optional name and one CIDR block.",
+ "type": "object"
},
"SetMonitoringServiceRequest": {
- "id": "SetMonitoringServiceRequest",
"description": "SetMonitoringServiceRequest sets the monitoring service of a cluster.",
"type": "object",
"properties": {
"monitoringService": {
- "type": "string",
- "description": "The monitoring service the cluster should use to write metrics.\nCurrently available options:\n\n* \"monitoring.googleapis.com\" - the Google Cloud Monitoring service\n* \"none\" - no metrics will be exported from the cluster"
+ "description": "The monitoring service the cluster should use to write metrics.\nCurrently available options:\n\n* \"monitoring.googleapis.com\" - the Google Cloud Monitoring service\n* \"none\" - no metrics will be exported from the cluster",
+ "type": "string"
}
- }
+ },
+ "id": "SetMonitoringServiceRequest"
},
"ServerConfig": {
"description": "Container Engine service configuration.",
"type": "object",
"properties": {
- "validMasterVersions": {
- "description": "List of valid master versions.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
"defaultImageType": {
"description": "Default image type.",
"type": "string"
@@ -2074,54 +1573,25 @@
"type": "string"
},
"type": "array"
+ },
+ "validMasterVersions": {
+ "description": "List of valid master versions.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
},
"id": "ServerConfig"
},
"NodeConfig": {
- "description": "Parameters that describe the nodes in a cluster.",
- "type": "object",
"properties": {
- "localSsdCount": {
- "format": "int32",
- "description": "The number of local SSD disks to be attached to the node.\n\nThe limit for this value is dependant upon the maximum number of\ndisks available on a machine per zone. See:\nhttps://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits\nfor more information.",
- "type": "integer"
- },
- "metadata": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "The metadata key/value pairs assigned to instances in the cluster.\n\nKeys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes\nin length. These are reflected as part of a URL in the metadata server.\nAdditionally, to avoid ambiguity, keys must not conflict with any other\nmetadata keys for the project or be one of the four reserved keys:\n\"instance-template\", \"kube-env\", \"startup-script\", and \"user-data\"\n\nValues are free-form strings, and only have meaning as interpreted by\nthe image running in the instance. The only restriction placed on them is\nthat each value's size must be less than or equal to 32 KB.\n\nThe total size of all keys and values must be less than 512 KB.",
- "type": "object"
- },
- "tags": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "The list of instance tags applied to all nodes. Tags are used to identify\nvalid sources or targets for network firewalls and are specified by\nthe client during cluster or node pool creation. Each tag within the list\nmust comply with RFC1035."
- },
- "serviceAccount": {
- "description": "The Google Cloud Platform Service Account to be used by the node VMs. If\nno Service Account is specified, the \"default\" service account is used.",
- "type": "string"
- },
- "imageType": {
- "description": "The image type to use for this node. Note that for a given image type,\nthe latest version of it will be used.",
- "type": "string"
- },
- "oauthScopes": {
- "description": "The set of Google API scopes to be made available on all of the\nnode VMs under the \"default\" service account.\n\nThe following scopes are recommended, but not required, and by default are\nnot included:\n\n* `https://www.googleapis.com/auth/compute` is required for mounting\npersistent storage on your nodes.\n* `https://www.googleapis.com/auth/devstorage.read_only` is required for\ncommunicating with **gcr.io**\n(the [Google Container Registry](/container-registry/)).\n\nIf unspecified, no scopes are added, unless Cloud Logging or Cloud\nMonitoring are enabled, in which case their required scopes will be added.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
"labels": {
- "description": "The map of Kubernetes labels (key/value pairs) to be applied to each node.\nThese will added in addition to any default label(s) that\nKubernetes may apply to the node.\nIn case of conflict in label keys, the applied set may differ depending on\nthe Kubernetes version -- it's best to assume the behavior is undefined\nand conflicts should be avoided.\nFor more information, including usage and the valid values, see:\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels/",
- "type": "object",
"additionalProperties": {
"type": "string"
- }
+ },
+ "description": "The map of Kubernetes labels (key/value pairs) to be applied to each node.\nThese will added in addition to any default label(s) that\nKubernetes may apply to the node.\nIn case of conflict in label keys, the applied set may differ depending on\nthe Kubernetes version -- it's best to assume the behavior is undefined\nand conflicts should be avoided.\nFor more information, including usage and the valid values, see:\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels/",
+ "type": "object"
},
"diskSizeGb": {
"format": "int32",
@@ -2146,13 +1616,47 @@
"preemptible": {
"description": "Whether the nodes are created as preemptible VM instances. See:\nhttps://cloud.google.com/compute/docs/instances/preemptible for more\ninformation about preemptible VM instances.",
"type": "boolean"
+ },
+ "localSsdCount": {
+ "format": "int32",
+ "description": "The number of local SSD disks to be attached to the node.\n\nThe limit for this value is dependant upon the maximum number of\ndisks available on a machine per zone. See:\nhttps://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits\nfor more information.",
+ "type": "integer"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The metadata key/value pairs assigned to instances in the cluster.\n\nKeys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes\nin length. These are reflected as part of a URL in the metadata server.\nAdditionally, to avoid ambiguity, keys must not conflict with any other\nmetadata keys for the project or be one of the four reserved keys:\n\"instance-template\", \"kube-env\", \"startup-script\", and \"user-data\"\n\nValues are free-form strings, and only have meaning as interpreted by\nthe image running in the instance. The only restriction placed on them is\nthat each value's size must be less than or equal to 32 KB.\n\nThe total size of all keys and values must be less than 512 KB.",
+ "type": "object"
+ },
+ "tags": {
+ "description": "The list of instance tags applied to all nodes. Tags are used to identify\nvalid sources or targets for network firewalls and are specified by\nthe client during cluster or node pool creation. Each tag within the list\nmust comply with RFC1035.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "serviceAccount": {
+ "description": "The Google Cloud Platform Service Account to be used by the node VMs. If\nno Service Account is specified, the \"default\" service account is used.",
+ "type": "string"
+ },
+ "imageType": {
+ "description": "The image type to use for this node. Note that for a given image type,\nthe latest version of it will be used.",
+ "type": "string"
+ },
+ "oauthScopes": {
+ "description": "The set of Google API scopes to be made available on all of the\nnode VMs under the \"default\" service account.\n\nThe following scopes are recommended, but not required, and by default are\nnot included:\n\n* `https://www.googleapis.com/auth/compute` is required for mounting\npersistent storage on your nodes.\n* `https://www.googleapis.com/auth/devstorage.read_only` is required for\ncommunicating with **gcr.io**\n(the [Google Container Registry](/container-registry/)).\n\nIf unspecified, no scopes are added, unless Cloud Logging or Cloud\nMonitoring are enabled, in which case their required scopes will be added.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
},
- "id": "NodeConfig"
+ "id": "NodeConfig",
+ "description": "Parameters that describe the nodes in a cluster.",
+ "type": "object"
},
"AutoUpgradeOptions": {
- "description": "AutoUpgradeOptions defines the set of options for the user to control how\nthe Auto Upgrades will proceed.",
- "type": "object",
"properties": {
"description": {
"description": "[Output only] This field is set when upgrades are about to commence\nwith the description of the upgrade.",
@@ -2163,28 +1667,30 @@
"type": "string"
}
},
- "id": "AutoUpgradeOptions"
+ "id": "AutoUpgradeOptions",
+ "description": "AutoUpgradeOptions defines the set of options for the user to control how\nthe Auto Upgrades will proceed.",
+ "type": "object"
},
"ListClustersResponse": {
- "type": "object",
"properties": {
+ "clusters": {
+ "description": "A list of clusters in the project in the specified zone, or\nacross all ones.",
+ "items": {
+ "$ref": "Cluster"
+ },
+ "type": "array"
+ },
"missingZones": {
"description": "If any zones are listed here, the list of clusters returned\nmay be missing those zones.",
"items": {
"type": "string"
},
"type": "array"
- },
- "clusters": {
- "items": {
- "$ref": "Cluster"
- },
- "type": "array",
- "description": "A list of clusters in the project in the specified zone, or\nacross all ones."
}
},
"id": "ListClustersResponse",
- "description": "ListClustersResponse is the result of ListClustersRequest."
+ "description": "ListClustersResponse is the result of ListClustersRequest.",
+ "type": "object"
},
"HttpLoadBalancing": {
"description": "Configuration options for the HTTP (L7) load balancing controller addon,\nwhich makes it easy to set up HTTP load balancers for services in a cluster.",
@@ -2197,26 +1703,37 @@
},
"id": "HttpLoadBalancing"
},
- "SetNetworkPolicyRequest": {
- "type": "object",
+ "SetMasterAuthRequest": {
"properties": {
- "networkPolicy": {
- "$ref": "NetworkPolicy",
- "description": "Configuration options for the NetworkPolicy feature."
+ "update": {
+ "$ref": "MasterAuth",
+ "description": "A description of the update."
+ },
+ "action": {
+ "enum": [
+ "UNKNOWN",
+ "SET_PASSWORD",
+ "GENERATE_PASSWORD",
+ "SET_USERNAME"
+ ],
+ "description": "The exact form of action to be taken on the master auth.",
+ "type": "string",
+ "enumDescriptions": [
+ "Operation is unknown and will error out.",
+ "Set the password to a user generated value.",
+ "Generate a new password and set it to that.",
+ "Set the username. If an empty username is provided, basic authentication\nis disabled for the cluster. If a non-empty username is provided, basic\nauthentication is enabled, with either a provided password or a generated\none."
+ ]
}
},
- "id": "SetNetworkPolicyRequest",
- "description": "SetNetworkPolicyRequest enables/disables network policy for a cluster."
+ "id": "SetMasterAuthRequest",
+ "description": "SetMasterAuthRequest updates the admin password of a cluster.",
+ "type": "object"
},
"NodePoolAutoscaling": {
"description": "NodePoolAutoscaling contains information required by cluster autoscaler to\nadjust the size of the node pool to the current cluster usage.",
"type": "object",
"properties": {
- "minNodeCount": {
- "format": "int32",
- "description": "Minimum number of nodes in the NodePool. Must be \u003e= 1 and \u003c=\nmax_node_count.",
- "type": "integer"
- },
"enabled": {
"description": "Is autoscaling enabled for this node pool.",
"type": "boolean"
@@ -2225,40 +1742,73 @@
"format": "int32",
"description": "Maximum number of nodes in the NodePool. Must be \u003e= min_node_count. There\nhas to enough quota to scale up the cluster.",
"type": "integer"
+ },
+ "minNodeCount": {
+ "format": "int32",
+ "description": "Minimum number of nodes in the NodePool. Must be \u003e= 1 and \u003c=\nmax_node_count.",
+ "type": "integer"
}
},
"id": "NodePoolAutoscaling"
},
- "SetMasterAuthRequest": {
- "id": "SetMasterAuthRequest",
- "description": "SetMasterAuthRequest updates the admin password of a cluster.",
+ "SetNetworkPolicyRequest": {
+ "properties": {
+ "networkPolicy": {
+ "$ref": "NetworkPolicy",
+ "description": "Configuration options for the NetworkPolicy feature."
+ }
+ },
+ "id": "SetNetworkPolicyRequest",
+ "description": "SetNetworkPolicyRequest enables/disables network policy for a cluster.",
+ "type": "object"
+ },
+ "ClusterUpdate": {
+ "description": "ClusterUpdate describes an update to the cluster. Exactly one update can\nbe applied to a cluster with each request, so at most one field can be\nprovided.",
"type": "object",
"properties": {
- "action": {
- "description": "The exact form of action to be taken on the master auth.",
- "type": "string",
- "enumDescriptions": [
- "Operation is unknown and will error out.",
- "Set the password to a user generated value.",
- "Generate a new password and set it to that.",
- "Set the username. If an empty username is provided, basic authentication\nis disabled for the cluster. If a non-empty username is provided, basic\nauthentication is enabled, with either a provided password or a generated\none."
- ],
- "enum": [
- "UNKNOWN",
- "SET_PASSWORD",
- "GENERATE_PASSWORD",
- "SET_USERNAME"
- ]
+ "desiredNodeVersion": {
+ "description": "The Kubernetes version to change the nodes to (typically an\nupgrade). Use `-` to upgrade to the latest version supported by\nthe server.",
+ "type": "string"
},
- "update": {
- "$ref": "MasterAuth",
- "description": "A description of the update."
+ "desiredMasterVersion": {
+ "description": "The Kubernetes version to change the master to. The only valid value is the\nlatest supported version. Use \"-\" to have the server automatically select\nthe latest version.",
+ "type": "string"
+ },
+ "desiredMasterAuthorizedNetworksConfig": {
+ "description": "Master authorized networks is a Beta feature.\nThe desired configuration options for master authorized networks feature.",
+ "$ref": "MasterAuthorizedNetworksConfig"
+ },
+ "desiredLocations": {
+ "description": "The desired list of Google Compute Engine\n[locations](/compute/docs/zones#available) in which the cluster's nodes\nshould be located. Changing the locations a cluster is in will result\nin nodes being either created or removed from the cluster, depending on\nwhether locations are being added or removed.\n\nThis list must always include the cluster's primary zone.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "desiredNodePoolAutoscaling": {
+ "$ref": "NodePoolAutoscaling",
+ "description": "Autoscaler configuration for the node pool specified in\ndesired_node_pool_id. If there is only one pool in the\ncluster and desired_node_pool_id is not provided then\nthe change applies to that single node pool."
+ },
+ "desiredMonitoringService": {
+ "description": "The monitoring service the cluster should use to write metrics.\nCurrently available options:\n\n* \"monitoring.googleapis.com\" - the Google Cloud Monitoring service\n* \"none\" - no metrics will be exported from the cluster",
+ "type": "string"
+ },
+ "desiredImageType": {
+ "description": "The desired image type for the node pool.\nNOTE: Set the \"desired_node_pool\" field as well.",
+ "type": "string"
+ },
+ "desiredAddonsConfig": {
+ "$ref": "AddonsConfig",
+ "description": "Configurations for the various addons available to run in the cluster."
+ },
+ "desiredNodePoolId": {
+ "description": "The node pool to be upgraded. This field is mandatory if\n\"desired_node_version\", \"desired_image_family\" or\n\"desired_node_pool_autoscaling\" is specified and there is more than one\nnode pool on the cluster.",
+ "type": "string"
}
- }
+ },
+ "id": "ClusterUpdate"
},
"IPAllocationPolicy": {
- "description": "Configuration for controlling how IPs are allocated in the cluster.",
- "type": "object",
"properties": {
"servicesIpv4CidrBlock": {
"description": "The IP address range of the services IPs in this cluster. If blank, a range\nwill be automatically chosen with the default size.\n\nThis field is only applicable when `use_ip_aliases` is true.\n\nSet to blank to have a range chosen with the default size.\n\nSet to /netmask (e.g. `/14`) to have a range chosen with a specific\nnetmask.\n\nSet to a\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use.",
@@ -2305,126 +1855,86 @@
"type": "boolean"
}
},
- "id": "IPAllocationPolicy"
- },
- "ClusterUpdate": {
- "description": "ClusterUpdate describes an update to the cluster. Exactly one update can\nbe applied to a cluster with each request, so at most one field can be\nprovided.",
- "type": "object",
- "properties": {
- "desiredMasterAuthorizedNetworksConfig": {
- "description": "Master authorized networks is a Beta feature.\nThe desired configuration options for master authorized networks feature.",
- "$ref": "MasterAuthorizedNetworksConfig"
- },
- "desiredNodePoolAutoscaling": {
- "$ref": "NodePoolAutoscaling",
- "description": "Autoscaler configuration for the node pool specified in\ndesired_node_pool_id. If there is only one pool in the\ncluster and desired_node_pool_id is not provided then\nthe change applies to that single node pool."
- },
- "desiredLocations": {
- "description": "The desired list of Google Compute Engine\n[locations](/compute/docs/zones#available) in which the cluster's nodes\nshould be located. Changing the locations a cluster is in will result\nin nodes being either created or removed from the cluster, depending on\nwhether locations are being added or removed.\n\nThis list must always include the cluster's primary zone.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "desiredMonitoringService": {
- "description": "The monitoring service the cluster should use to write metrics.\nCurrently available options:\n\n* \"monitoring.googleapis.com\" - the Google Cloud Monitoring service\n* \"none\" - no metrics will be exported from the cluster",
- "type": "string"
- },
- "desiredImageType": {
- "description": "The desired image type for the node pool.\nNOTE: Set the \"desired_node_pool\" field as well.",
- "type": "string"
- },
- "desiredAddonsConfig": {
- "$ref": "AddonsConfig",
- "description": "Configurations for the various addons available to run in the cluster."
- },
- "desiredNodePoolId": {
- "description": "The node pool to be upgraded. This field is mandatory if\n\"desired_node_version\", \"desired_image_family\" or\n\"desired_node_pool_autoscaling\" is specified and there is more than one\nnode pool on the cluster.",
- "type": "string"
- },
- "desiredNodeVersion": {
- "description": "The Kubernetes version to change the nodes to (typically an\nupgrade). Use `-` to upgrade to the latest version supported by\nthe server.",
- "type": "string"
- },
- "desiredMasterVersion": {
- "description": "The Kubernetes version to change the master to. The only valid value is the\nlatest supported version. Use \"-\" to have the server automatically select\nthe latest version.",
- "type": "string"
- }
- },
- "id": "ClusterUpdate"
+ "id": "IPAllocationPolicy",
+ "description": "Configuration for controlling how IPs are allocated in the cluster.",
+ "type": "object"
},
"HorizontalPodAutoscaling": {
- "description": "Configuration options for the horizontal pod autoscaling feature, which\nincreases or decreases the number of replica pods a replication controller\nhas based on the resource usage of the existing pods.",
- "type": "object",
"properties": {
"disabled": {
"description": "Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.\nWhen enabled, it ensures that a Heapster pod is running in the cluster,\nwhich is also used by the Cloud Monitoring service.",
"type": "boolean"
}
},
- "id": "HorizontalPodAutoscaling"
+ "id": "HorizontalPodAutoscaling",
+ "description": "Configuration options for the horizontal pod autoscaling feature, which\nincreases or decreases the number of replica pods a replication controller\nhas based on the resource usage of the existing pods.",
+ "type": "object"
+ },
+ "SetNodePoolManagementRequest": {
+ "properties": {
+ "management": {
+ "description": "NodeManagement configuration for the node pool.",
+ "$ref": "NodeManagement"
+ }
+ },
+ "id": "SetNodePoolManagementRequest",
+ "description": "SetNodePoolManagementRequest sets the node management properties of a node\npool.",
+ "type": "object"
},
"MasterAuthorizedNetworksConfig": {
- "description": "Master authorized networks is a Beta feature.\nConfiguration options for the master authorized networks feature. Enabled\nmaster authorized networks will disallow all external traffic to access\nKubernetes master through HTTPS except traffic from the given CIDR blocks,\nGoogle Compute Engine Public IPs and Google Prod IPs.",
- "type": "object",
"properties": {
- "enabled": {
- "description": "Whether or not master authorized networks is enabled.",
- "type": "boolean"
- },
"cidrBlocks": {
+ "description": "cidr_blocks define up to 10 external networks that could access\nKubernetes master through HTTPS.",
"items": {
"$ref": "CidrBlock"
},
- "type": "array",
- "description": "cidr_blocks define up to 10 external networks that could access\nKubernetes master through HTTPS."
+ "type": "array"
+ },
+ "enabled": {
+ "description": "Whether or not master authorized networks is enabled.",
+ "type": "boolean"
}
},
- "id": "MasterAuthorizedNetworksConfig"
- },
- "SetNodePoolManagementRequest": {
- "description": "SetNodePoolManagementRequest sets the node management properties of a node\npool.",
- "type": "object",
- "properties": {
- "management": {
- "$ref": "NodeManagement",
- "description": "NodeManagement configuration for the node pool."
- }
- },
- "id": "SetNodePoolManagementRequest"
+ "id": "MasterAuthorizedNetworksConfig",
+ "description": "Master authorized networks is a Beta feature.\nConfiguration options for the master authorized networks feature. Enabled\nmaster authorized networks will disallow all external traffic to access\nKubernetes master through HTTPS except traffic from the given CIDR blocks,\nGoogle Compute Engine Public IPs and Google Prod IPs.",
+ "type": "object"
},
"SetNodePoolAutoscalingRequest": {
+ "description": "SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.",
"type": "object",
"properties": {
"autoscaling": {
- "$ref": "NodePoolAutoscaling",
- "description": "Autoscaling configuration for the node pool."
+ "description": "Autoscaling configuration for the node pool.",
+ "$ref": "NodePoolAutoscaling"
}
},
- "id": "SetNodePoolAutoscalingRequest",
- "description": "SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool."
+ "id": "SetNodePoolAutoscalingRequest"
},
"CreateClusterRequest": {
+ "description": "CreateClusterRequest creates a cluster.",
"type": "object",
"properties": {
"cluster": {
- "description": "A [cluster\nresource](/container-engine/reference/rest/v1/projects.zones.clusters)",
- "$ref": "Cluster"
+ "$ref": "Cluster",
+ "description": "A [cluster\nresource](/container-engine/reference/rest/v1/projects.zones.clusters)"
}
},
- "id": "CreateClusterRequest",
- "description": "CreateClusterRequest creates a cluster."
+ "id": "CreateClusterRequest"
},
- "LegacyAbac": {
- "id": "LegacyAbac",
- "description": "Configuration for the legacy Attribute Based Access Control authorization\nmode.",
- "type": "object",
+ "UpdateNodePoolRequest": {
"properties": {
- "enabled": {
- "description": "Whether the ABAC authorizer is enabled for this cluster. When enabled,\nidentities in the system, including service accounts, nodes, and\ncontrollers, will have statically granted permissions beyond those\nprovided by the RBAC configuration or IAM.",
- "type": "boolean"
+ "imageType": {
+ "description": "The desired image type for the node pool.",
+ "type": "string"
+ },
+ "nodeVersion": {
+ "description": "The Kubernetes version to change the nodes to (typically an\nupgrade). Use `-` to upgrade to the latest version supported by\nthe server.",
+ "type": "string"
}
- }
+ },
+ "id": "UpdateNodePoolRequest",
+ "description": "UpdateNodePoolRequests update a node pool's image and/or version.",
+ "type": "object"
},
"AcceleratorConfig": {
"description": "AcceleratorConfig represents a Hardware Accelerator request.",
@@ -2442,34 +1952,29 @@
},
"id": "AcceleratorConfig"
},
- "UpdateNodePoolRequest": {
- "description": "UpdateNodePoolRequests update a node pool's image and/or version.",
+ "LegacyAbac": {
+ "description": "Configuration for the legacy Attribute Based Access Control authorization\nmode.",
"type": "object",
"properties": {
- "imageType": {
- "description": "The desired image type for the node pool.",
- "type": "string"
- },
- "nodeVersion": {
- "description": "The Kubernetes version to change the nodes to (typically an\nupgrade). Use `-` to upgrade to the latest version supported by\nthe server.",
- "type": "string"
+ "enabled": {
+ "description": "Whether the ABAC authorizer is enabled for this cluster. When enabled,\nidentities in the system, including service accounts, nodes, and\ncontrollers, will have statically granted permissions beyond those\nprovided by the RBAC configuration or IAM.",
+ "type": "boolean"
}
},
- "id": "UpdateNodePoolRequest"
+ "id": "LegacyAbac"
},
"SetAddonsConfigRequest": {
- "description": "SetAddonsConfigRequest sets the addons associated with the cluster.",
- "type": "object",
"properties": {
"addonsConfig": {
"description": "The desired configurations for the various addons available to run in the\ncluster.",
"$ref": "AddonsConfig"
}
},
- "id": "SetAddonsConfigRequest"
+ "id": "SetAddonsConfigRequest",
+ "description": "SetAddonsConfigRequest sets the addons associated with the cluster.",
+ "type": "object"
},
"SetLegacyAbacRequest": {
- "type": "object",
"properties": {
"enabled": {
"description": "Whether ABAC authorization will be enabled in the cluster.",
@@ -2477,13 +1982,508 @@
}
},
"id": "SetLegacyAbacRequest",
- "description": "SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for\na cluster."
+ "description": "SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for\na cluster.",
+ "type": "object"
+ },
+ "AddonsConfig": {
+ "properties": {
+ "horizontalPodAutoscaling": {
+ "$ref": "HorizontalPodAutoscaling",
+ "description": "Configuration for the horizontal pod autoscaling feature, which\nincreases or decreases the number of replica pods a replication controller\nhas based on the resource usage of the existing pods."
+ },
+ "httpLoadBalancing": {
+ "description": "Configuration for the HTTP (L7) load balancing controller addon, which\nmakes it easy to set up HTTP load balancers for services in a cluster.",
+ "$ref": "HttpLoadBalancing"
+ },
+ "kubernetesDashboard": {
+ "$ref": "KubernetesDashboard",
+ "description": "Configuration for the Kubernetes Dashboard."
+ },
+ "networkPolicyConfig": {
+ "description": "Configuration for NetworkPolicy. This only tracks whether the addon\nis enabled or not on the Master, it does not track whether network policy\nis enabled for the nodes.",
+ "$ref": "NetworkPolicyConfig"
+ }
+ },
+ "id": "AddonsConfig",
+ "description": "Configuration for the addons that can be automatically spun up in the\ncluster, enabling additional functionality.",
+ "type": "object"
+ },
+ "SetLocationsRequest": {
+ "description": "SetLocationsRequest sets the locations of the cluster.",
+ "type": "object",
+ "properties": {
+ "locations": {
+ "description": "The desired list of Google Compute Engine\n[locations](/compute/docs/zones#available) in which the cluster's nodes\nshould be located. Changing the locations a cluster is in will result\nin nodes being either created or removed from the cluster, depending on\nwhether locations are being added or removed.\n\nThis list must always include the cluster's primary zone.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "SetLocationsRequest"
+ },
+ "SetNodePoolSizeRequest": {
+ "description": "SetNodePoolSizeRequest sets the size a node\npool.",
+ "type": "object",
+ "properties": {
+ "nodeCount": {
+ "format": "int32",
+ "description": "The desired node count for the pool.",
+ "type": "integer"
+ }
+ },
+ "id": "SetNodePoolSizeRequest"
+ },
+ "NetworkPolicyConfig": {
+ "properties": {
+ "disabled": {
+ "description": "Whether NetworkPolicy is enabled for this cluster.",
+ "type": "boolean"
+ }
+ },
+ "id": "NetworkPolicyConfig",
+ "description": "Configuration for NetworkPolicy. This only tracks whether the addon\nis enabled or not on the Master, it does not track whether network policy\nis enabled for the nodes.",
+ "type": "object"
+ },
+ "UpdateClusterRequest": {
+ "description": "UpdateClusterRequest updates the settings of a cluster.",
+ "type": "object",
+ "properties": {
+ "update": {
+ "$ref": "ClusterUpdate",
+ "description": "A description of the update."
+ }
+ },
+ "id": "UpdateClusterRequest"
+ },
+ "Cluster": {
+ "properties": {
+ "zone": {
+ "description": "[Output only] The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "type": "string"
+ },
+ "expireTime": {
+ "description": "[Output only] The time the cluster will be automatically\ndeleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
+ "type": "string"
+ },
+ "nodeIpv4CidrSize": {
+ "format": "int32",
+ "description": "[Output only] The size of the address space on each node for hosting\ncontainers. This is provisioned from within the `container_ipv4_cidr`\nrange.",
+ "type": "integer"
+ },
+ "loggingService": {
+ "description": "The logging service the cluster should use to write logs.\nCurrently available options:\n\n* `logging.googleapis.com` - the Google Cloud Logging service.\n* `none` - no logs will be exported from the cluster.\n* if left as an empty string,`logging.googleapis.com` will be used.",
+ "type": "string"
+ },
+ "masterAuthorizedNetworksConfig": {
+ "$ref": "MasterAuthorizedNetworksConfig",
+ "description": "Master authorized networks is a Beta feature.\nThe configuration options for master authorized networks feature."
+ },
+ "statusMessage": {
+ "description": "[Output only] Additional information about the current status of this\ncluster, if available.",
+ "type": "string"
+ },
+ "masterAuth": {
+ "description": "The authentication information for accessing the master endpoint.",
+ "$ref": "MasterAuth"
+ },
+ "currentMasterVersion": {
+ "description": "[Output only] The current software version of the master endpoint.",
+ "type": "string"
+ },
+ "nodeConfig": {
+ "description": "Parameters used in creating the cluster's nodes.\nSee `nodeConfig` for the description of its properties.\nFor requests, this field should only be used in lieu of a\n\"node_pool\" object, since this configuration (along with the\n\"initial_node_count\") will be used to create a \"NodePool\" object with an\nauto-generated name. Do not use this and a node_pool at the same time.\nFor responses, this field will be populated with the node configuration of\nthe first node pool.\n\nIf unspecified, the defaults are used.",
+ "$ref": "NodeConfig"
+ },
+ "addonsConfig": {
+ "description": "Configurations for the various addons available to run in the cluster.",
+ "$ref": "AddonsConfig"
+ },
+ "status": {
+ "enumDescriptions": [
+ "Not set.",
+ "The PROVISIONING state indicates the cluster is being created.",
+ "The RUNNING state indicates the cluster has been created and is fully\nusable.",
+ "The RECONCILING state indicates that some work is actively being done on\nthe cluster, such as upgrading the master or node software. Details can\nbe found in the `statusMessage` field.",
+ "The STOPPING state indicates the cluster is being deleted.",
+ "The ERROR state indicates the cluster may be unusable. Details\ncan be found in the `statusMessage` field."
+ ],
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "PROVISIONING",
+ "RUNNING",
+ "RECONCILING",
+ "STOPPING",
+ "ERROR"
+ ],
+ "description": "[Output only] The current status of this cluster.",
+ "type": "string"
+ },
+ "subnetwork": {
+ "description": "The name of the Google Compute Engine\n[subnetwork](/compute/docs/subnetworks) to which the\ncluster is connected.",
+ "type": "string"
+ },
+ "currentNodeVersion": {
+ "description": "[Output only] The current version of the node software components.\nIf they are currently at multiple versions because they're in the process\nof being upgraded, this reflects the minimum version of all nodes.",
+ "type": "string"
+ },
+ "resourceLabels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The resource labels for the cluster to use to annotate any related\nGoogle Compute Engine resources.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The name of this cluster. The name must be unique within this project\nand zone, and can be up to 40 characters with the following restrictions:\n\n* Lowercase letters, numbers, and hyphens only.\n* Must start with a letter.\n* Must end with a number or a letter.",
+ "type": "string"
+ },
+ "maintenancePolicy": {
+ "description": "Configure the maintenance policy for this cluster.",
+ "$ref": "MaintenancePolicy"
+ },
+ "initialClusterVersion": {
+ "description": "The initial Kubernetes version for this cluster. Valid versions are those\nfound in validMasterVersions returned by getServerConfig. The version can\nbe upgraded over time; such upgrades are reflected in\ncurrentMasterVersion and currentNodeVersion.",
+ "type": "string"
+ },
+ "ipAllocationPolicy": {
+ "description": "Configuration for cluster IP allocation.",
+ "$ref": "IPAllocationPolicy"
+ },
+ "endpoint": {
+ "description": "[Output only] The IP address of this cluster's master endpoint.\nThe endpoint can be accessed from the internet at\n`https://username:password@endpoint/`.\n\nSee the `masterAuth` property of this resource for username and\npassword information.",
+ "type": "string"
+ },
+ "legacyAbac": {
+ "$ref": "LegacyAbac",
+ "description": "Configuration for the legacy ABAC authorization mode."
+ },
+ "createTime": {
+ "description": "[Output only] The time the cluster was created, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
+ "type": "string"
+ },
+ "clusterIpv4Cidr": {
+ "description": "The IP address range of the container pods in this cluster, in\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`). Leave blank to have\none automatically chosen or specify a `/14` block in `10.0.0.0/8`.",
+ "type": "string"
+ },
+ "initialNodeCount": {
+ "format": "int32",
+ "description": "The number of nodes to create in this cluster. You must ensure that your\nCompute Engine \u003ca href=\"/compute/docs/resource-quotas\"\u003eresource quota\u003c/a\u003e\nis sufficient for this number of instances. You must also have available\nfirewall and routes quota.\nFor requests, this field should only be used in lieu of a\n\"node_pool\" object, since this configuration (along with the\n\"node_config\") will be used to create a \"NodePool\" object with an\nauto-generated name. Do not use this and a node_pool at the same time.",
+ "type": "integer"
+ },
+ "selfLink": {
+ "description": "[Output only] Server-defined URL for the resource.",
+ "type": "string"
+ },
+ "locations": {
+ "description": "The list of Google Compute Engine\n[locations](/compute/docs/zones#available) in which the cluster's nodes\nshould be located.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "nodePools": {
+ "description": "The node pools associated with this cluster.\nThis field should not be set if \"node_config\" or \"initial_node_count\" are\nspecified.",
+ "items": {
+ "$ref": "NodePool"
+ },
+ "type": "array"
+ },
+ "instanceGroupUrls": {
+ "description": "[Output only] The resource URLs of [instance\ngroups](/compute/docs/instance-groups/) associated with this\ncluster.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "servicesIpv4Cidr": {
+ "description": "[Output only] The IP address range of the Kubernetes services in\nthis cluster, in\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `1.2.3.4/29`). Service addresses are\ntypically put in the last `/16` from the container CIDR.",
+ "type": "string"
+ },
+ "networkPolicy": {
+ "$ref": "NetworkPolicy",
+ "description": "Configuration options for the NetworkPolicy feature."
+ },
+ "enableKubernetesAlpha": {
+ "description": "Kubernetes alpha features are enabled on this cluster. This includes alpha\nAPI groups (e.g. v1alpha1) and features that may not be production ready in\nthe kubernetes version of the master and nodes.\nThe cluster has no SLA for uptime and master/node upgrades are disabled.\nAlpha enabled clusters are automatically deleted thirty days after\ncreation.",
+ "type": "boolean"
+ },
+ "description": {
+ "description": "An optional description of this cluster.",
+ "type": "string"
+ },
+ "currentNodeCount": {
+ "format": "int32",
+ "description": "[Output only] The number of nodes currently in the cluster.",
+ "type": "integer"
+ },
+ "monitoringService": {
+ "description": "The monitoring service the cluster should use to write metrics.\nCurrently available options:\n\n* `monitoring.googleapis.com` - the Google Cloud Monitoring service.\n* `none` - no metrics will be exported from the cluster.\n* if left as an empty string, `monitoring.googleapis.com` will be used.",
+ "type": "string"
+ },
+ "network": {
+ "description": "The name of the Google Compute Engine\n[network](/compute/docs/networks-and-firewalls#networks) to which the\ncluster is connected. If left unspecified, the `default` network\nwill be used.",
+ "type": "string"
+ },
+ "labelFingerprint": {
+ "description": "The fingerprint of the set of labels for this cluster.",
+ "type": "string"
+ }
+ },
+ "id": "Cluster",
+ "description": "A Google Container Engine cluster.",
+ "type": "object"
+ },
+ "CreateNodePoolRequest": {
+ "properties": {
+ "nodePool": {
+ "$ref": "NodePool",
+ "description": "The node pool to create."
+ }
+ },
+ "id": "CreateNodePoolRequest",
+ "description": "CreateNodePoolRequest creates a node pool for a cluster.",
+ "type": "object"
+ },
+ "MasterAuth": {
+ "properties": {
+ "clusterCaCertificate": {
+ "description": "[Output only] Base64-encoded public certificate that is the root of\ntrust for the cluster.",
+ "type": "string"
+ },
+ "clientCertificate": {
+ "description": "[Output only] Base64-encoded public certificate used by clients to\nauthenticate to the cluster endpoint.",
+ "type": "string"
+ },
+ "username": {
+ "description": "The username to use for HTTP basic authentication to the master endpoint.\nFor clusters v1.6.0 and later, you can disable basic authentication by\nproviding an empty username.",
+ "type": "string"
+ },
+ "password": {
+ "description": "The password to use for HTTP basic authentication to the master endpoint.\nBecause the master endpoint is open to the Internet, you should create a\nstrong password. If a password is provided for cluster creation, username\nmust be non-empty.",
+ "type": "string"
+ },
+ "clientCertificateConfig": {
+ "description": "Configuration for client certificate authentication on the cluster. If no\nconfiguration is specified, a client certificate is issued.",
+ "$ref": "ClientCertificateConfig"
+ },
+ "clientKey": {
+ "description": "[Output only] Base64-encoded private key used by clients to authenticate\nto the cluster endpoint.",
+ "type": "string"
+ }
+ },
+ "id": "MasterAuth",
+ "description": "The authentication information for accessing the master endpoint.\nAuthentication can be done using HTTP basic auth or using client\ncertificates.",
+ "type": "object"
+ },
+ "DailyMaintenanceWindow": {
+ "properties": {
+ "startTime": {
+ "description": "Time within the maintenance window to start the maintenance operations.\nTime format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)\nformat \"HH:MM”, where HH : [00-23] and MM : [00-59] GMT.",
+ "type": "string"
+ },
+ "duration": {
+ "description": "[Output only] Duration of the time window, automatically chosen to be\nsmallest possible in the given scenario.\nDuration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)\nformat \"PTnHnMnS\".",
+ "type": "string"
+ }
+ },
+ "id": "DailyMaintenanceWindow",
+ "description": "Time window specified for daily maintenance operations.",
+ "type": "object"
+ },
+ "ClientCertificateConfig": {
+ "properties": {
+ "issueClientCertificate": {
+ "description": "Issue a client certificate.",
+ "type": "boolean"
+ }
+ },
+ "id": "ClientCertificateConfig",
+ "description": "Configuration for client certificates on the cluster.",
+ "type": "object"
+ },
+ "MaintenancePolicy": {
+ "description": "MaintenancePolicy defines the maintenance policy to be used for the cluster.",
+ "type": "object",
+ "properties": {
+ "window": {
+ "description": "Specifies the maintenance window in which maintenance may be performed.",
+ "$ref": "MaintenanceWindow"
+ }
+ },
+ "id": "MaintenancePolicy"
+ },
+ "SetLoggingServiceRequest": {
+ "description": "SetLoggingServiceRequest sets the logging service of a cluster.",
+ "type": "object",
+ "properties": {
+ "loggingService": {
+ "description": "The logging service the cluster should use to write metrics.\nCurrently available options:\n\n* \"logging.googleapis.com\" - the Google Cloud Logging service\n* \"none\" - no metrics will be exported from the cluster",
+ "type": "string"
+ }
+ },
+ "id": "SetLoggingServiceRequest"
+ },
+ "SetMaintenancePolicyRequest": {
+ "description": "SetMaintenancePolicyRequest sets the maintenance policy for a cluster.",
+ "type": "object",
+ "properties": {
+ "maintenancePolicy": {
+ "description": "The maintenance policy to be set for the cluster. An empty field\nclears the existing maintenance policy.",
+ "$ref": "MaintenancePolicy"
+ }
+ },
+ "id": "SetMaintenancePolicyRequest"
+ },
+ "Empty": {
+ "properties": {},
+ "id": "Empty",
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object"
+ },
+ "ListNodePoolsResponse": {
+ "properties": {
+ "nodePools": {
+ "description": "A list of node pools for a cluster.",
+ "items": {
+ "$ref": "NodePool"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListNodePoolsResponse",
+ "description": "ListNodePoolsResponse is the result of ListNodePoolsRequest.",
+ "type": "object"
+ },
+ "CompleteIPRotationRequest": {
+ "description": "CompleteIPRotationRequest moves the cluster master back into single-IP mode.",
+ "type": "object",
+ "properties": {},
+ "id": "CompleteIPRotationRequest"
+ },
+ "StartIPRotationRequest": {
+ "properties": {},
+ "id": "StartIPRotationRequest",
+ "description": "StartIPRotationRequest creates a new IP for the cluster and then performs\na node upgrade on each node pool to point to the new IP.",
+ "type": "object"
+ },
+ "NodePool": {
+ "description": "NodePool contains the name and configuration for a cluster's node pool.\nNode pools are a set of nodes (i.e. VM's), with a common configuration and\nspecification, under the control of the cluster master. They may have a set\nof Kubernetes labels applied to them, which may be used to reference them\nduring pod scheduling. They may also be resized up or down, to accommodate\nthe workload.",
+ "type": "object",
+ "properties": {
+ "selfLink": {
+ "description": "[Output only] Server-defined URL for the resource.",
+ "type": "string"
+ },
+ "version": {
+ "description": "[Output only] The version of the Kubernetes of this node.",
+ "type": "string"
+ },
+ "instanceGroupUrls": {
+ "description": "[Output only] The resource URLs of [instance\ngroups](/compute/docs/instance-groups/) associated with this\nnode pool.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "status": {
+ "enumDescriptions": [
+ "Not set.",
+ "The PROVISIONING state indicates the node pool is being created.",
+ "The RUNNING state indicates the node pool has been created\nand is fully usable.",
+ "The RUNNING_WITH_ERROR state indicates the node pool has been created\nand is partially usable. Some error state has occurred and some\nfunctionality may be impaired. Customer may need to reissue a request\nor trigger a new update.",
+ "The RECONCILING state indicates that some work is actively being done on\nthe node pool, such as upgrading node software. Details can\nbe found in the `statusMessage` field.",
+ "The STOPPING state indicates the node pool is being deleted.",
+ "The ERROR state indicates the node pool may be unusable. Details\ncan be found in the `statusMessage` field."
+ ],
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "PROVISIONING",
+ "RUNNING",
+ "RUNNING_WITH_ERROR",
+ "RECONCILING",
+ "STOPPING",
+ "ERROR"
+ ],
+ "description": "[Output only] The status of the nodes in this pool instance.",
+ "type": "string"
+ },
+ "config": {
+ "description": "The node configuration of the pool.",
+ "$ref": "NodeConfig"
+ },
+ "name": {
+ "description": "The name of the node pool.",
+ "type": "string"
+ },
+ "statusMessage": {
+ "description": "[Output only] Additional information about the current status of this\nnode pool instance, if available.",
+ "type": "string"
+ },
+ "autoscaling": {
+ "description": "Autoscaler configuration for this NodePool. Autoscaler is enabled\nonly if a valid configuration is present.",
+ "$ref": "NodePoolAutoscaling"
+ },
+ "management": {
+ "$ref": "NodeManagement",
+ "description": "NodeManagement configuration for this NodePool."
+ },
+ "initialNodeCount": {
+ "format": "int32",
+ "description": "The initial node count for the pool. You must ensure that your\nCompute Engine \u003ca href=\"/compute/docs/resource-quotas\"\u003eresource quota\u003c/a\u003e\nis sufficient for this number of instances. You must also have available\nfirewall and routes quota.",
+ "type": "integer"
+ }
+ },
+ "id": "NodePool"
+ },
+ "SetLabelsRequest": {
+ "description": "SetLabelsRequest sets the Google Cloud Platform labels on a Google Container\nEngine cluster, which will in turn set them for Google Compute Engine\nresources used by that cluster",
+ "type": "object",
+ "properties": {
+ "resourceLabels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The labels to set for that cluster.",
+ "type": "object"
+ },
+ "labelFingerprint": {
+ "description": "The fingerprint of the previous set of labels for this resource,\nused to detect conflicts. The fingerprint is initially generated by\nContainer Engine and changes after every request to modify or update\nlabels. You must always provide an up-to-date fingerprint hash when\nupdating or changing labels. Make a \u003ccode\u003eget()\u003c/code\u003e request to the\nresource to get the latest fingerprint.",
+ "type": "string"
+ }
+ },
+ "id": "SetLabelsRequest"
+ },
+ "NodeManagement": {
+ "description": "NodeManagement defines the set of node management services turned on for the\nnode pool.",
+ "type": "object",
+ "properties": {
+ "autoRepair": {
+ "description": "A flag that specifies whether the node auto-repair is enabled for the node\npool. If enabled, the nodes in this node pool will be monitored and, if\nthey fail health checks too many times, an automatic repair action will be\ntriggered.",
+ "type": "boolean"
+ },
+ "autoUpgrade": {
+ "description": "A flag that specifies whether node auto-upgrade is enabled for the node\npool. If enabled, node auto-upgrade helps keep the nodes in your node pool\nup to date with the latest release version of Kubernetes.",
+ "type": "boolean"
+ },
+ "upgradeOptions": {
+ "description": "Specifies the Auto Upgrade knobs for the node pool.",
+ "$ref": "AutoUpgradeOptions"
+ }
+ },
+ "id": "NodeManagement"
+ },
+ "CancelOperationRequest": {
+ "description": "CancelOperationRequest cancels a single operation.",
+ "type": "object",
+ "properties": {},
+ "id": "CancelOperationRequest"
}
},
"protocol": "rest",
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"version": "v1",
"baseUrl": "https://container.googleapis.com/",
@@ -2505,8 +2505,8 @@
"ownerDomain": "google.com",
"name": "container",
"batchPath": "batch",
- "revision": "20170922",
"id": "container:v1",
"documentationLink": "https://cloud.google.com/container-engine/",
+ "revision": "20170922",
"title": "Google Container Engine API"
}
diff --git a/container/v1beta1/container-api.json b/container/v1beta1/container-api.json
index afb962d..347ca68 100644
--- a/container/v1beta1/container-api.json
+++ b/container/v1beta1/container-api.json
@@ -1,50 +1,1795 @@
{
+ "ownerDomain": "google.com",
+ "name": "container",
+ "batchPath": "batch",
+ "title": "Google Container Engine API",
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "resources": {
+ "locations": {
+ "methods": {
+ "getServerConfig": {
+ "description": "Returns configuration info about the Container Engine service.",
+ "response": {
+ "$ref": "ServerConfig"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "projectId": {
+ "location": "query",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "zone": {
+ "location": "query",
+ "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name (project and location) of the server config to get\nSpecified in the format 'projects/*/locations/*'.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serverConfig",
+ "id": "container.projects.locations.getServerConfig",
+ "path": "v1beta1/{+name}/serverConfig"
+ }
+ },
+ "resources": {
+ "operations": {
+ "methods": {
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "name": {
+ "description": "The name (project, location, operation id) of the operation to get.\nSpecified in the format 'projects/*/locations/*/operations/*'.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
+ "location": "path"
+ },
+ "operationId": {
+ "description": "The server-assigned `name` of the operation.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "location": "query"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "location": "query"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
+ "path": "v1beta1/{+name}",
+ "id": "container.projects.locations.operations.get",
+ "description": "Gets the specified operation."
+ },
+ "list": {
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations",
+ "id": "container.projects.locations.operations.list",
+ "path": "v1beta1/{+parent}/operations",
+ "description": "Lists all operations in a project in a specific zone or all zones.",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "projectId": {
+ "location": "query",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.",
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for, or `-` for all zones.\nThis field is deprecated, use parent instead.",
+ "type": "string",
+ "location": "query"
+ },
+ "parent": {
+ "description": "The parent (project and location) where the operations will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "cancel": {
+ "request": {
+ "$ref": "CancelOperationRequest"
+ },
+ "description": "Cancels the specified operation.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name (project, location, operation id) of the operation to cancel.\nSpecified in the format 'projects/*/locations/*/operations/*'.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
+ "id": "container.projects.locations.operations.cancel",
+ "path": "v1beta1/{+name}:cancel"
+ }
+ }
+ },
+ "clusters": {
+ "methods": {
+ "setNetworkPolicy": {
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setNetworkPolicy",
+ "path": "v1beta1/{+name}:setNetworkPolicy",
+ "id": "container.projects.locations.clusters.setNetworkPolicy",
+ "description": "Enables/Disables Network Policy for a cluster.",
+ "request": {
+ "$ref": "SetNetworkPolicyRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "name": {
+ "description": "The name (project, location, cluster id) of the cluster to set networking policy.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Gets the details of a specific cluster.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Cluster"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name (project, location, cluster) of the cluster to retrieve.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "location": "query"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "location": "query"
+ },
+ "clusterId": {
+ "location": "query",
+ "description": "The name of the cluster to retrieve.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}",
+ "path": "v1beta1/{+name}",
+ "id": "container.projects.locations.clusters.get"
+ },
+ "startIpRotation": {
+ "description": "Start master IP rotation.",
+ "request": {
+ "$ref": "StartIPRotationRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "description": "The name (project, location, cluster id) of the cluster to start IP rotation.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:startIpRotation",
+ "id": "container.projects.locations.clusters.startIpRotation",
+ "path": "v1beta1/{+name}:startIpRotation"
+ },
+ "setMaintenancePolicy": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name (project, location, cluster id) of the cluster to set maintenance\npolicy.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMaintenancePolicy",
+ "id": "container.projects.locations.clusters.setMaintenancePolicy",
+ "path": "v1beta1/{+name}:setMaintenancePolicy",
+ "request": {
+ "$ref": "SetMaintenancePolicyRequest"
+ },
+ "description": "Sets the maintenance policy for a cluster."
+ },
+ "delete": {
+ "description": "Deletes the cluster, including the Kubernetes endpoint and all worker\nnodes.\n\nFirewalls and routes that were configured during cluster creation\nare also deleted.\n\nOther Google Compute Engine resources that might be in use by the cluster\n(e.g. load balancer resources) will not be deleted if they weren't present\nat the initial create time.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "location": "query"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "location": "query"
+ },
+ "clusterId": {
+ "location": "query",
+ "description": "The name of the cluster to delete.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "name": {
+ "location": "path",
+ "description": "The name (project, location, cluster) of the cluster to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}",
+ "id": "container.projects.locations.clusters.delete",
+ "path": "v1beta1/{+name}"
+ },
+ "setLegacyAbac": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name (project, location, cluster id) of the cluster to set legacy abac.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLegacyAbac",
+ "id": "container.projects.locations.clusters.setLegacyAbac",
+ "path": "v1beta1/{+name}:setLegacyAbac",
+ "request": {
+ "$ref": "SetLegacyAbacRequest"
+ },
+ "description": "Enables or disables the ABAC authorization mechanism on a cluster."
+ },
+ "setResourceLabels": {
+ "request": {
+ "$ref": "SetLabelsRequest"
+ },
+ "description": "Sets labels on a cluster.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name (project, location, cluster id) of the cluster to set labels.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setResourceLabels",
+ "id": "container.projects.locations.clusters.setResourceLabels",
+ "path": "v1beta1/{+name}:setResourceLabels"
+ },
+ "update": {
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}",
+ "path": "v1beta1/{+name}",
+ "id": "container.projects.locations.clusters.update",
+ "request": {
+ "$ref": "UpdateClusterRequest"
+ },
+ "description": "Updates the settings of a specific cluster."
+ },
+ "setMasterAuth": {
+ "description": "Used to set master auth materials. Currently supports :-\nChanging the admin password of a specific cluster.\nThis can be either via password generation or explicitly set.\nModify basic_auth.csv and reset the K8S API server.",
+ "request": {
+ "$ref": "SetMasterAuthRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "name": {
+ "description": "The name (project, location, cluster) of the cluster to set auth.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMasterAuth",
+ "path": "v1beta1/{+name}:setMasterAuth",
+ "id": "container.projects.locations.clusters.setMasterAuth"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListClustersResponse"
+ },
+ "parameters": {
+ "projectId": {
+ "location": "query",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.",
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides, or \"-\" for all zones.\nThis field is deprecated, use parent instead.",
+ "type": "string",
+ "location": "query"
+ },
+ "parent": {
+ "location": "path",
+ "description": "The parent (project and location) where the clusters will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters",
+ "path": "v1beta1/{+parent}/clusters",
+ "id": "container.projects.locations.clusters.list",
+ "description": "Lists all clusters owned by a project in either the specified zone or all\nzones."
+ },
+ "create": {
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters",
+ "path": "v1beta1/{+parent}/clusters",
+ "id": "container.projects.locations.clusters.create",
+ "request": {
+ "$ref": "CreateClusterRequest"
+ },
+ "description": "Creates a cluster, consisting of the specified number and type of Google\nCompute Engine instances.\n\nBy default, the cluster is created in the project's\n[default network](/compute/docs/networks-and-firewalls#networks).\n\nOne firewall is added for the cluster. After cluster creation,\nthe cluster creates routes for each node to allow the containers\non that node to communicate with all other instances in the\ncluster.\n\nFinally, an entry is added to the project's global metadata indicating\nwhich CIDR range is being used by the cluster.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "description": "The parent (project and location) where the cluster will be created.\nSpecified in the format 'projects/*/locations/*'.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+$"
+ }
+ }
+ },
+ "completeIpRotation": {
+ "request": {
+ "$ref": "CompleteIPRotationRequest"
+ },
+ "description": "Completes master IP rotation.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name (project, location, cluster id) of the cluster to complete IP rotation.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:completeIpRotation",
+ "id": "container.projects.locations.clusters.completeIpRotation",
+ "path": "v1beta1/{+name}:completeIpRotation"
+ }
+ },
+ "resources": {
+ "nodePools": {
+ "methods": {
+ "get": {
+ "response": {
+ "$ref": "NodePool"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "nodePoolId": {
+ "description": "The name of the node pool.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "location": "path",
+ "description": "The name (project, location, cluster, node pool id) of the node pool to get.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "location": "query"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "location": "query"
+ },
+ "clusterId": {
+ "location": "query",
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}",
+ "id": "container.projects.locations.clusters.nodePools.get",
+ "path": "v1beta1/{+name}",
+ "description": "Retrieves the node pool requested."
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "nodePoolId": {
+ "description": "The name of the node pool to delete.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "description": "The name (project, location, cluster, node pool id) of the node pool to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$",
+ "location": "path"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "location": "query"
+ },
+ "zone": {
+ "location": "query",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "clusterId": {
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}",
+ "path": "v1beta1/{+name}",
+ "id": "container.projects.locations.clusters.nodePools.delete",
+ "description": "Deletes a node pool from a cluster."
+ },
+ "setManagement": {
+ "description": "Sets the NodeManagement options for a node pool.",
+ "request": {
+ "$ref": "SetNodePoolManagementRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name (project, location, cluster, node pool id) of the node pool to set\nmanagement properties. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:setManagement",
+ "path": "v1beta1/{+name}:setManagement",
+ "id": "container.projects.locations.clusters.nodePools.setManagement"
+ },
+ "list": {
+ "description": "Lists the node pools for a cluster.",
+ "response": {
+ "$ref": "ListNodePoolsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use parent instead.",
+ "type": "string",
+ "location": "query"
+ },
+ "zone": {
+ "location": "query",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead.",
+ "type": "string"
+ },
+ "clusterId": {
+ "description": "The name of the cluster.\nThis field is deprecated, use parent instead.",
+ "type": "string",
+ "location": "query"
+ },
+ "parent": {
+ "description": "The parent (project, location, cluster id) where the node pools will be listed.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools",
+ "id": "container.projects.locations.clusters.nodePools.list",
+ "path": "v1beta1/{+parent}/nodePools"
+ },
+ "rollback": {
+ "request": {
+ "$ref": "RollbackNodePoolUpgradeRequest"
+ },
+ "description": "Roll back the previously Aborted or Failed NodePool upgrade.\nThis will be an no-op if the last upgrade successfully completed.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name (project, location, cluster, node pool id) of the node poll to\nrollback upgrade.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:rollback",
+ "id": "container.projects.locations.clusters.nodePools.rollback",
+ "path": "v1beta1/{+name}:rollback"
+ },
+ "create": {
+ "request": {
+ "$ref": "CreateNodePoolRequest"
+ },
+ "description": "Creates a node pool for a cluster.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "The parent (project, location, cluster id) where the node pool will be created.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools",
+ "id": "container.projects.locations.clusters.nodePools.create",
+ "path": "v1beta1/{+parent}/nodePools"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "zones": {
+ "methods": {
+ "getServerconfig": {
+ "description": "Returns configuration info about the Container Engine service.",
+ "response": {
+ "$ref": "ServerConfig"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name (project and location) of the server config to get\nSpecified in the format 'projects/*/locations/*'.",
+ "type": "string",
+ "location": "query"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/serverconfig",
+ "id": "container.projects.zones.getServerconfig",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/serverconfig"
+ }
+ },
+ "resources": {
+ "clusters": {
+ "methods": {
+ "startIpRotation": {
+ "description": "Start master IP rotation.",
+ "request": {
+ "$ref": "StartIPRotationRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation",
+ "id": "container.projects.zones.clusters.startIpRotation"
+ },
+ "setMaintenancePolicy": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "type": "string",
+ "required": true
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "type": "string",
+ "required": true
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster to update.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy",
+ "id": "container.projects.zones.clusters.setMaintenancePolicy",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy",
+ "description": "Sets the maintenance policy for a cluster.",
+ "request": {
+ "$ref": "SetMaintenancePolicyRequest"
+ }
+ },
+ "delete": {
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ "id": "container.projects.zones.clusters.delete",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ "description": "Deletes the cluster, including the Kubernetes endpoint and all worker\nnodes.\n\nFirewalls and routes that were configured during cluster creation\nare also deleted.\n\nOther Google Compute Engine resources that might be in use by the cluster\n(e.g. load balancer resources) will not be deleted if they weren't present\nat the initial create time.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to delete.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "name": {
+ "location": "query",
+ "description": "The name (project, location, cluster) of the cluster to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "update": {
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ "id": "container.projects.zones.clusters.update",
+ "description": "Updates the settings of a specific cluster.",
+ "request": {
+ "$ref": "UpdateClusterRequest"
+ },
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "setMasterAuth": {
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth",
+ "id": "container.projects.zones.clusters.setMasterAuth",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth",
+ "request": {
+ "$ref": "SetMasterAuthRequest"
+ },
+ "description": "Used to set master auth materials. Currently supports :-\nChanging the admin password of a specific cluster.\nThis can be either via password generation or explicitly set.\nModify basic_auth.csv and reset the K8S API server.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "clusterId": {
+ "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ }
+ },
+ "list": {
+ "description": "Lists all clusters owned by a project in either the specified zone or all\nzones.",
+ "response": {
+ "$ref": "ListClustersResponse"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides, or \"-\" for all zones.\nThis field is deprecated, use parent instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "parent": {
+ "description": "The parent (project and location) where the clusters will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters",
+ "id": "container.projects.zones.clusters.list",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters"
+ },
+ "resourceLabels": {
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels",
+ "id": "container.projects.zones.clusters.resourceLabels",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels",
+ "description": "Sets labels on a cluster.",
+ "request": {
+ "$ref": "SetLabelsRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "create": {
+ "description": "Creates a cluster, consisting of the specified number and type of Google\nCompute Engine instances.\n\nBy default, the cluster is created in the project's\n[default network](/compute/docs/networks-and-firewalls#networks).\n\nOne firewall is added for the cluster. After cluster creation,\nthe cluster creates routes for each node to allow the containers\non that node to communicate with all other instances in the\ncluster.\n\nFinally, an entry is added to the project's global metadata indicating\nwhich CIDR range is being used by the cluster.",
+ "request": {
+ "$ref": "CreateClusterRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters",
+ "id": "container.projects.zones.clusters.create"
+ },
+ "completeIpRotation": {
+ "description": "Completes master IP rotation.",
+ "request": {
+ "$ref": "CompleteIPRotationRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "clusterId": {
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation",
+ "id": "container.projects.zones.clusters.completeIpRotation",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation"
+ },
+ "setNetworkPolicy": {
+ "request": {
+ "$ref": "SetNetworkPolicyRequest"
+ },
+ "description": "Enables/Disables Network Policy for a cluster.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clusterId": {
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy",
+ "id": "container.projects.zones.clusters.setNetworkPolicy",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy"
+ },
+ "get": {
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ "id": "container.projects.zones.clusters.get",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ "description": "Gets the details of a specific cluster.",
+ "response": {
+ "$ref": "Cluster"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "clusterId": {
+ "description": "The name of the cluster to retrieve.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "name": {
+ "location": "query",
+ "description": "The name (project, location, cluster) of the cluster to retrieve.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "legacyAbac": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "clusterId": {
+ "description": "The name of the cluster to update.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac",
+ "id": "container.projects.zones.clusters.legacyAbac",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac",
+ "description": "Enables or disables the ABAC authorization mechanism on a cluster.",
+ "request": {
+ "$ref": "SetLegacyAbacRequest"
+ }
+ }
+ },
+ "resources": {
+ "nodePools": {
+ "methods": {
+ "get": {
+ "response": {
+ "$ref": "NodePool"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId",
+ "nodePoolId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "nodePoolId": {
+ "description": "The name of the node pool.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "name": {
+ "description": "The name (project, location, cluster, node pool id) of the node pool to get.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
+ "id": "container.projects.zones.clusters.nodePools.get",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
+ "description": "Retrieves the node pool requested."
+ },
+ "delete": {
+ "description": "Deletes a node pool from a cluster.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId",
+ "nodePoolId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "nodePoolId": {
+ "location": "path",
+ "description": "The name of the node pool to delete.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "name": {
+ "location": "query",
+ "description": "The name (project, location, cluster, node pool id) of the node pool to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
+ "type": "string"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "clusterId": {
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
+ "id": "container.projects.zones.clusters.nodePools.delete"
+ },
+ "setManagement": {
+ "description": "Sets the NodeManagement options for a node pool.",
+ "request": {
+ "$ref": "SetNodePoolManagementRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId",
+ "nodePoolId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to update.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "nodePoolId": {
+ "location": "path",
+ "description": "The name of the node pool to update.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement",
+ "id": "container.projects.zones.clusters.nodePools.setManagement",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement"
+ },
+ "list": {
+ "description": "Lists the node pools for a cluster.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "ListNodePoolsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use parent instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "parent": {
+ "location": "query",
+ "description": "The parent (project, location, cluster id) where the node pools will be listed.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string"
+ },
+ "clusterId": {
+ "description": "The name of the cluster.\nThis field is deprecated, use parent instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
+ "id": "container.projects.zones.clusters.nodePools.list"
+ },
+ "rollback": {
+ "description": "Roll back the previously Aborted or Failed NodePool upgrade.\nThis will be an no-op if the last upgrade successfully completed.",
+ "request": {
+ "$ref": "RollbackNodePoolUpgradeRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId",
+ "nodePoolId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "nodePoolId": {
+ "description": "The name of the node pool to rollback.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to rollback.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback",
+ "id": "container.projects.zones.clusters.nodePools.rollback",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback"
+ },
+ "create": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use parent instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead.",
+ "type": "string",
+ "required": true
+ },
+ "clusterId": {
+ "description": "The name of the cluster.\nThis field is deprecated, use parent instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
+ "id": "container.projects.zones.clusters.nodePools.create",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
+ "request": {
+ "$ref": "CreateNodePoolRequest"
+ },
+ "description": "Creates a node pool for a cluster."
+ }
+ }
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "get": {
+ "description": "Gets the specified operation.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "operationId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "name": {
+ "description": "The name (project, location, operation id) of the operation to get.\nSpecified in the format 'projects/*/locations/*/operations/*'.",
+ "type": "string",
+ "location": "query"
+ },
+ "operationId": {
+ "description": "The server-assigned `name` of the operation.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}",
+ "id": "container.projects.zones.operations.get"
+ },
+ "list": {
+ "description": "Lists all operations in a project in a specific zone or all zones.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId",
+ "zone"
+ ],
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.",
+ "type": "string",
+ "required": true
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for, or `-` for all zones.\nThis field is deprecated, use parent instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "parent": {
+ "description": "The parent (project and location) where the operations will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/operations",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/operations",
+ "id": "container.projects.zones.operations.list"
+ },
+ "cancel": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "operationId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "operationId": {
+ "location": "path",
+ "description": "The server-assigned `name` of the operation.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation resides.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel",
+ "id": "container.projects.zones.operations.cancel",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel",
+ "request": {
+ "$ref": "CancelOperationRequest"
+ },
+ "description": "Cancels the specified operation."
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "version": "v1beta1",
+ "baseUrl": "https://container.googleapis.com/",
+ "description": "The Google Container Engine API is used for building and managing container based applications, powered by the open source Kubernetes technology.",
+ "kind": "discovery#restDescription",
+ "servicePath": "",
"basePath": "",
"documentationLink": "https://cloud.google.com/container-engine/",
- "revision": "20170922",
+ "revision": "20170929",
"id": "container:v1beta1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "ListNodePoolsResponse": {
- "description": "ListNodePoolsResponse is the result of ListNodePoolsRequest.",
- "type": "object",
- "properties": {
- "nodePools": {
- "description": "A list of node pools for a cluster.",
- "items": {
- "$ref": "NodePool"
- },
- "type": "array"
- }
- },
- "id": "ListNodePoolsResponse"
- },
- "CompleteIPRotationRequest": {
- "description": "CompleteIPRotationRequest moves the cluster master back into single-IP mode.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The name (project, location, cluster id) of the cluster to complete IP rotation.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "type": "string"
- },
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "clusterId": {
- "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
- "type": "string"
- }
- },
- "id": "CompleteIPRotationRequest"
- },
"StartIPRotationRequest": {
- "id": "StartIPRotationRequest",
"description": "StartIPRotationRequest creates a new IP for the cluster and then performs\na node upgrade on each node pool to point to the new IP.",
"type": "object",
"properties": {
@@ -64,7 +1809,8 @@
"description": "The name (project, location, cluster id) of the cluster to start IP rotation.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
"type": "string"
}
- }
+ },
+ "id": "StartIPRotationRequest"
},
"AcceleratorConfig": {
"description": "AcceleratorConfig represents a Hardware Accelerator request.",
@@ -82,47 +1828,13 @@
},
"id": "AcceleratorConfig"
},
- "SetLabelsRequest": {
- "properties": {
- "name": {
- "description": "The name (project, location, cluster id) of the cluster to set labels.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "type": "string"
- },
- "resourceLabels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "The labels to set for that cluster.",
- "type": "object"
- },
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "clusterId": {
- "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "labelFingerprint": {
- "description": "The fingerprint of the previous set of labels for this resource,\nused to detect conflicts. The fingerprint is initially generated by\nContainer Engine and changes after every request to modify or update\nlabels. You must always provide an up-to-date fingerprint hash when\nupdating or changing labels. Make a \u003ccode\u003eget()\u003c/code\u003e request to the\nresource to get the latest fingerprint.",
- "type": "string"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "type": "string"
- }
- },
- "id": "SetLabelsRequest",
- "description": "SetLabelsRequest sets the Google Cloud Platform labels on a Google Container\nEngine cluster, which will in turn set them for Google Compute Engine\nresources used by that cluster",
- "type": "object"
- },
"NodePool": {
"description": "NodePool contains the name and configuration for a cluster's node pool.\nNode pools are a set of nodes (i.e. VM's), with a common configuration and\nspecification, under the control of the cluster master. They may have a set\nof Kubernetes labels applied to them, which may be used to reference them\nduring pod scheduling. They may also be resized up or down, to accommodate\nthe workload.",
"type": "object",
"properties": {
"autoscaling": {
- "$ref": "NodePoolAutoscaling",
- "description": "Autoscaler configuration for this NodePool. Autoscaler is enabled\nonly if a valid configuration is present."
+ "description": "Autoscaler configuration for this NodePool. Autoscaler is enabled\nonly if a valid configuration is present.",
+ "$ref": "NodePoolAutoscaling"
},
"management": {
"$ref": "NodeManagement",
@@ -137,10 +1849,6 @@
"description": "[Output only] Server-defined URL for the resource.",
"type": "string"
},
- "version": {
- "description": "[Output only] The version of the Kubernetes of this node.",
- "type": "string"
- },
"instanceGroupUrls": {
"description": "[Output only] The resource URLs of [instance\ngroups](/compute/docs/instance-groups/) associated with this\nnode pool.",
"items": {
@@ -148,8 +1856,11 @@
},
"type": "array"
},
+ "version": {
+ "description": "[Output only] The version of the Kubernetes of this node.",
+ "type": "string"
+ },
"status": {
- "type": "string",
"enumDescriptions": [
"Not set.",
"The PROVISIONING state indicates the node pool is being created.",
@@ -168,24 +1879,61 @@
"STOPPING",
"ERROR"
],
- "description": "[Output only] The status of the nodes in this pool instance."
+ "description": "[Output only] The status of the nodes in this pool instance.",
+ "type": "string"
},
"config": {
"$ref": "NodeConfig",
"description": "The node configuration of the pool."
},
- "name": {
- "description": "The name of the node pool.",
- "type": "string"
- },
"statusMessage": {
"description": "[Output only] Additional information about the current status of this\nnode pool instance, if available.",
"type": "string"
+ },
+ "name": {
+ "description": "The name of the node pool.",
+ "type": "string"
}
},
"id": "NodePool"
},
+ "SetLabelsRequest": {
+ "description": "SetLabelsRequest sets the Google Cloud Platform labels on a Google Container\nEngine cluster, which will in turn set them for Google Compute Engine\nresources used by that cluster",
+ "type": "object",
+ "properties": {
+ "labelFingerprint": {
+ "description": "The fingerprint of the previous set of labels for this resource,\nused to detect conflicts. The fingerprint is initially generated by\nContainer Engine and changes after every request to modify or update\nlabels. You must always provide an up-to-date fingerprint hash when\nupdating or changing labels. Make a \u003ccode\u003eget()\u003c/code\u003e request to the\nresource to get the latest fingerprint.",
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "resourceLabels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The labels to set for that cluster.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The name (project, location, cluster id) of the cluster to set labels.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "clusterId": {
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ }
+ },
+ "id": "SetLabelsRequest"
+ },
"NodeManagement": {
+ "description": "NodeManagement defines the set of node management services turned on for the\nnode pool.",
+ "type": "object",
"properties": {
"autoRepair": {
"description": "Whether the nodes will be automatically repaired.",
@@ -196,51 +1944,47 @@
"type": "boolean"
},
"upgradeOptions": {
- "description": "Specifies the Auto Upgrade knobs for the node pool.",
- "$ref": "AutoUpgradeOptions"
+ "$ref": "AutoUpgradeOptions",
+ "description": "Specifies the Auto Upgrade knobs for the node pool."
}
},
- "id": "NodeManagement",
- "description": "NodeManagement defines the set of node management services turned on for the\nnode pool.",
- "type": "object"
+ "id": "NodeManagement"
},
"NodeTaint": {
+ "description": "Kubernetes taint is comprised of three fields: key, value, and effect. Effect\ncan only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.\n\nFor more information, including usage and the valid values, see:\nhttps://kubernetes.io/docs/concepts/configuration/taint-and-toleration/",
"type": "object",
"properties": {
- "key": {
- "description": "Key for taint.",
- "type": "string"
- },
"effect": {
- "description": "Effect for taint.",
- "type": "string",
"enumDescriptions": [
+ "Not set",
"NoSchedule",
"PreferNoSchedule",
"NoExecute"
],
"enum": [
+ "EFFECT_UNSPECIFIED",
"NO_SCHEDULE",
"PREFER_NO_SCHEDULE",
"NO_EXECUTE"
- ]
+ ],
+ "description": "Effect for taint.",
+ "type": "string"
},
"value": {
"description": "Value for taint.",
"type": "string"
+ },
+ "key": {
+ "description": "Key for taint.",
+ "type": "string"
}
},
- "id": "NodeTaint",
- "description": "Kubernetes taint is comprised of three fields: key, value, and effect. Effect\ncan only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.\n\nFor more information, including usage and the valid values, see:\nhttps://kubernetes.io/docs/concepts/configuration/taint-and-toleration/"
+ "id": "NodeTaint"
},
"CancelOperationRequest": {
"description": "CancelOperationRequest cancels a single operation.",
"type": "object",
"properties": {
- "name": {
- "description": "The name (project, location, operation id) of the operation to cancel.\nSpecified in the format 'projects/*/locations/*/operations/*'.",
- "type": "string"
- },
"operationId": {
"description": "The server-assigned `name` of the operation.\nThis field is deprecated, use name instead.",
"type": "string"
@@ -252,29 +1996,18 @@
"zone": {
"description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation resides.\nThis field is deprecated, use name instead.",
"type": "string"
+ },
+ "name": {
+ "description": "The name (project, location, operation id) of the operation to cancel.\nSpecified in the format 'projects/*/locations/*/operations/*'.",
+ "type": "string"
}
},
"id": "CancelOperationRequest"
},
- "KubernetesDashboard": {
- "description": "Configuration for the Kubernetes Dashboard.",
- "type": "object",
- "properties": {
- "disabled": {
- "description": "Whether the Kubernetes Dashboard is enabled for this cluster.",
- "type": "boolean"
- }
- },
- "id": "KubernetesDashboard"
- },
"SetLegacyAbacRequest": {
"description": "SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for\na cluster.",
"type": "object",
"properties": {
- "name": {
- "description": "The name (project, location, cluster id) of the cluster to set legacy abac.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "type": "string"
- },
"enabled": {
"description": "Whether ABAC authorization will be enabled in the cluster.",
"type": "boolean"
@@ -290,33 +2023,76 @@
"clusterId": {
"description": "The name of the cluster to update.\nThis field is deprecated, use name instead.",
"type": "string"
+ },
+ "name": {
+ "description": "The name (project, location, cluster id) of the cluster to set legacy abac.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string"
}
},
"id": "SetLegacyAbacRequest"
},
+ "KubernetesDashboard": {
+ "description": "Configuration for the Kubernetes Dashboard.",
+ "type": "object",
+ "properties": {
+ "disabled": {
+ "description": "Whether the Kubernetes Dashboard is enabled for this cluster.",
+ "type": "boolean"
+ }
+ },
+ "id": "KubernetesDashboard"
+ },
"Operation": {
"description": "This operation resource represents operations that may have happened or are\nhappening on the cluster. All fields are output only.",
"type": "object",
"properties": {
- "endTime": {
- "description": "[Output only] The time the operation completed, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
+ "status": {
+ "description": "The current status of the operation.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not set.",
+ "The operation has been created.",
+ "The operation is currently running.",
+ "The operation is done, either cancelled or completed.",
+ "The operation is aborting."
+ ],
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "PENDING",
+ "RUNNING",
+ "DONE",
+ "ABORTING"
+ ]
+ },
+ "name": {
+ "description": "The server-assigned ID for the operation.",
"type": "string"
},
- "location": {
- "description": "[Output only] The name of the Google Compute Engine\n[zone](/compute/docs/regions-zones/regions-zones#available) or\n[region](/compute/docs/regions-zones/regions-zones#available) in which\nthe cluster resides.",
+ "statusMessage": {
+ "description": "If an error has occurred, a textual description of the error.",
"type": "string"
},
- "targetLink": {
- "description": "Server-defined URL for the target of the operation.",
+ "selfLink": {
+ "description": "Server-defined URL for the resource.",
"type": "string"
},
"detail": {
"description": "Detailed operation progress, if available.",
"type": "string"
},
+ "targetLink": {
+ "description": "Server-defined URL for the target of the operation.",
+ "type": "string"
+ },
+ "location": {
+ "description": "[Output only] The name of the Google Compute Engine\n[zone](/compute/docs/regions-zones/regions-zones#available) or\n[region](/compute/docs/regions-zones/regions-zones#available) in which\nthe cluster resides.",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "[Output only] The time the operation completed, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
+ "type": "string"
+ },
"operationType": {
- "description": "The operation type.",
- "type": "string",
"enumDescriptions": [
"Not set.",
"Cluster create.",
@@ -354,44 +2130,16 @@
"SET_NODE_POOL_SIZE",
"SET_NETWORK_POLICY",
"SET_MAINTENANCE_POLICY"
- ]
+ ],
+ "description": "The operation type.",
+ "type": "string"
},
"startTime": {
"description": "[Output only] The time the operation started, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
"type": "string"
},
"zone": {
- "type": "string",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation\nis taking place.\nThis field is deprecated, use location instead."
- },
- "status": {
- "description": "The current status of the operation.",
- "type": "string",
- "enumDescriptions": [
- "Not set.",
- "The operation has been created.",
- "The operation is currently running.",
- "The operation is done, either cancelled or completed.",
- "The operation is aborting."
- ],
- "enum": [
- "STATUS_UNSPECIFIED",
- "PENDING",
- "RUNNING",
- "DONE",
- "ABORTING"
- ]
- },
- "statusMessage": {
- "description": "If an error has occurred, a textual description of the error.",
- "type": "string"
- },
- "name": {
- "description": "The server-assigned ID for the operation.",
- "type": "string"
- },
- "selfLink": {
- "description": "Server-defined URL for the resource.",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation\nis taking place.\nThis field is deprecated, use location instead.",
"type": "string"
}
},
@@ -401,21 +2149,21 @@
"description": "Configuration for the addons that can be automatically spun up in the\ncluster, enabling additional functionality.",
"type": "object",
"properties": {
+ "horizontalPodAutoscaling": {
+ "description": "Configuration for the horizontal pod autoscaling feature, which\nincreases or decreases the number of replica pods a replication controller\nhas based on the resource usage of the existing pods.",
+ "$ref": "HorizontalPodAutoscaling"
+ },
"httpLoadBalancing": {
"description": "Configuration for the HTTP (L7) load balancing controller addon, which\nmakes it easy to set up HTTP load balancers for services in a cluster.",
"$ref": "HttpLoadBalancing"
},
"kubernetesDashboard": {
- "description": "Configuration for the Kubernetes Dashboard.",
- "$ref": "KubernetesDashboard"
+ "$ref": "KubernetesDashboard",
+ "description": "Configuration for the Kubernetes Dashboard."
},
"networkPolicyConfig": {
- "$ref": "NetworkPolicyConfig",
- "description": "Configuration for NetworkPolicy. This only tracks whether the addon\nis enabled or not on the Master, it does not track whether network policy\nis enabled for the nodes."
- },
- "horizontalPodAutoscaling": {
- "description": "Configuration for the horizontal pod autoscaling feature, which\nincreases or decreases the number of replica pods a replication controller\nhas based on the resource usage of the existing pods.",
- "$ref": "HorizontalPodAutoscaling"
+ "description": "Configuration for NetworkPolicy. This only tracks whether the addon\nis enabled or not on the Master, it does not track whether network policy\nis enabled for the nodes.",
+ "$ref": "NetworkPolicyConfig"
}
},
"id": "AddonsConfig"
@@ -435,6 +2183,10 @@
"description": "RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed\nNodePool upgrade. This will be an no-op if the last upgrade successfully\ncompleted.",
"type": "object",
"properties": {
+ "nodePoolId": {
+ "description": "The name of the node pool to rollback.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
"name": {
"description": "The name (project, location, cluster, node pool id) of the node poll to\nrollback upgrade.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
"type": "string"
@@ -450,10 +2202,6 @@
"clusterId": {
"description": "The name of the cluster to rollback.\nThis field is deprecated, use name instead.",
"type": "string"
- },
- "nodePoolId": {
- "description": "The name of the node pool to rollback.\nThis field is deprecated, use name instead.",
- "type": "string"
}
},
"id": "RollbackNodePoolUpgradeRequest"
@@ -474,8 +2222,8 @@
"type": "object",
"properties": {
"update": {
- "$ref": "ClusterUpdate",
- "description": "A description of the update."
+ "description": "A description of the update.",
+ "$ref": "ClusterUpdate"
},
"name": {
"description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
@@ -486,8 +2234,8 @@
"type": "string"
},
"zone": {
- "type": "string",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead."
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string"
},
"clusterId": {
"description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
@@ -500,7 +2248,13 @@
"description": "Configuration options for the NetworkPolicy feature.\nhttps://kubernetes.io/docs/concepts/services-networking/networkpolicies/",
"type": "object",
"properties": {
+ "enabled": {
+ "description": "Whether network policy is enabled on the cluster.",
+ "type": "boolean"
+ },
"provider": {
+ "description": "The selected network policy provider.",
+ "type": "string",
"enumDescriptions": [
"Not set",
"Tigera (Calico Felix)."
@@ -508,13 +2262,7 @@
"enum": [
"PROVIDER_UNSPECIFIED",
"CALICO"
- ],
- "description": "The selected network policy provider.",
- "type": "string"
- },
- "enabled": {
- "description": "Whether network policy is enabled on the cluster.",
- "type": "boolean"
+ ]
}
},
"id": "NetworkPolicy"
@@ -523,50 +2271,17 @@
"description": "A Google Container Engine cluster.",
"type": "object",
"properties": {
- "network": {
- "description": "The name of the Google Compute Engine\n[network](/compute/docs/networks-and-firewalls#networks) to which the\ncluster is connected. If left unspecified, the `default` network\nwill be used.",
- "type": "string"
- },
- "zone": {
- "description": "[Output only] The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use location instead.",
- "type": "string"
- },
- "loggingService": {
- "description": "The logging service the cluster should use to write logs.\nCurrently available options:\n\n* `logging.googleapis.com` - the Google Cloud Logging service.\n* `none` - no logs will be exported from the cluster.\n* if left as an empty string,`logging.googleapis.com` will be used.",
- "type": "string"
- },
- "nodeIpv4CidrSize": {
- "format": "int32",
- "description": "[Output only] The size of the address space on each node for hosting\ncontainers. This is provisioned from within the `container_ipv4_cidr`\nrange.",
- "type": "integer"
- },
- "expireTime": {
- "description": "[Output only] The time the cluster will be automatically\ndeleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
- "type": "string"
- },
- "masterAuthorizedNetworksConfig": {
- "description": "The configuration options for master authorized networks feature.",
- "$ref": "MasterAuthorizedNetworksConfig"
- },
- "statusMessage": {
- "description": "[Output only] Additional information about the current status of this\ncluster, if available.",
- "type": "string"
- },
- "masterAuth": {
- "$ref": "MasterAuth",
- "description": "The authentication information for accessing the master endpoint."
- },
"currentMasterVersion": {
"description": "[Output only] The current software version of the master endpoint.",
"type": "string"
},
"nodeConfig": {
- "$ref": "NodeConfig",
- "description": "Parameters used in creating the cluster's nodes.\nSee `nodeConfig` for the description of its properties.\nFor requests, this field should only be used in lieu of a\n\"node_pool\" object, since this configuration (along with the\n\"initial_node_count\") will be used to create a \"NodePool\" object with an\nauto-generated name. Do not use this and a node_pool at the same time.\nFor responses, this field will be populated with the node configuration of\nthe first node pool.\n\nIf unspecified, the defaults are used."
+ "description": "Parameters used in creating the cluster's nodes.\nSee `nodeConfig` for the description of its properties.\nFor requests, this field should only be used in lieu of a\n\"node_pool\" object, since this configuration (along with the\n\"initial_node_count\") will be used to create a \"NodePool\" object with an\nauto-generated name. Do not use this and a node_pool at the same time.\nFor responses, this field will be populated with the node configuration of\nthe first node pool.\n\nIf unspecified, the defaults are used.",
+ "$ref": "NodeConfig"
},
"podSecurityPolicyConfig": {
- "$ref": "PodSecurityPolicyConfig",
- "description": "Configuration for the PodSecurityPolicy feature."
+ "description": "Configuration for the PodSecurityPolicy feature.",
+ "$ref": "PodSecurityPolicyConfig"
},
"addonsConfig": {
"$ref": "AddonsConfig",
@@ -597,8 +2312,8 @@
"type": "string"
},
"subnetwork": {
- "type": "string",
- "description": "The name of the Google Compute Engine\n[subnetwork](/compute/docs/subnetworks) to which the\ncluster is connected."
+ "description": "The name of the Google Compute Engine\n[subnetwork](/compute/docs/subnetworks) to which the\ncluster is connected.",
+ "type": "string"
},
"name": {
"description": "The name of this cluster. The name must be unique within this project\nand zone, and can be up to 40 characters with the following restrictions:\n\n* Lowercase letters, numbers, and hyphens only.\n* Must start with a letter.\n* Must end with a number or a letter.",
@@ -609,21 +2324,21 @@
"description": "Configure the maintenance policy for this cluster."
},
"initialClusterVersion": {
- "type": "string",
- "description": "The initial Kubernetes version for this cluster. Valid versions are those\nfound in validMasterVersions returned by getServerConfig. The version can\nbe upgraded over time; such upgrades are reflected in\ncurrentMasterVersion and currentNodeVersion."
+ "description": "The initial Kubernetes version for this cluster. Valid versions are those\nfound in validMasterVersions returned by getServerConfig. The version can\nbe upgraded over time; such upgrades are reflected in\ncurrentMasterVersion and currentNodeVersion.",
+ "type": "string"
},
"ipAllocationPolicy": {
- "description": "Configuration for cluster IP allocation.",
- "$ref": "IPAllocationPolicy"
- },
- "endpoint": {
- "description": "[Output only] The IP address of this cluster's master endpoint.\nThe endpoint can be accessed from the internet at\n`https://username:password@endpoint/`.\n\nSee the `masterAuth` property of this resource for username and\npassword information.",
- "type": "string"
+ "$ref": "IPAllocationPolicy",
+ "description": "Configuration for cluster IP allocation."
},
"location": {
"description": "[Output only] The name of the Google Compute Engine\n[zone](/compute/docs/regions-zones/regions-zones#available) or\n[region](/compute/docs/regions-zones/regions-zones#available) in which\nthe cluster resides.",
"type": "string"
},
+ "endpoint": {
+ "description": "[Output only] The IP address of this cluster's master endpoint.\nThe endpoint can be accessed from the internet at\n`https://username:password@endpoint/`.\n\nSee the `masterAuth` property of this resource for username and\npassword information.",
+ "type": "string"
+ },
"createTime": {
"description": "[Output only] The time the cluster was created, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
"type": "string"
@@ -641,13 +2356,6 @@
"description": "[Output only] Server-defined URL for the resource.",
"type": "string"
},
- "nodePools": {
- "items": {
- "$ref": "NodePool"
- },
- "type": "array",
- "description": "The node pools associated with this cluster.\nThis field should not be set if \"node_config\" or \"initial_node_count\" are\nspecified."
- },
"locations": {
"description": "The list of Google Compute Engine\n[locations](/compute/docs/zones#available) in which the cluster's nodes\nshould be located.",
"items": {
@@ -655,21 +2363,28 @@
},
"type": "array"
},
+ "nodePools": {
+ "description": "The node pools associated with this cluster.\nThis field should not be set if \"node_config\" or \"initial_node_count\" are\nspecified.",
+ "items": {
+ "$ref": "NodePool"
+ },
+ "type": "array"
+ },
"instanceGroupUrls": {
+ "description": "[Output only] The resource URLs of [instance\ngroups](/compute/docs/instance-groups/) associated with this\ncluster.",
"items": {
"type": "string"
},
- "type": "array",
- "description": "[Output only] The resource URLs of [instance\ngroups](/compute/docs/instance-groups/) associated with this\ncluster."
- },
- "networkPolicy": {
- "$ref": "NetworkPolicy",
- "description": "Configuration options for the NetworkPolicy feature."
+ "type": "array"
},
"servicesIpv4Cidr": {
"description": "[Output only] The IP address range of the Kubernetes services in\nthis cluster, in\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `1.2.3.4/29`). Service addresses are\ntypically put in the last `/16` from the container CIDR.",
"type": "string"
},
+ "networkPolicy": {
+ "description": "Configuration options for the NetworkPolicy feature.",
+ "$ref": "NetworkPolicy"
+ },
"enableKubernetesAlpha": {
"description": "Kubernetes alpha features are enabled on this cluster. This includes alpha\nAPI groups (e.g. v1beta1) and features that may not be production ready in\nthe kubernetes version of the master and nodes.\nThe cluster has no SLA for uptime and master/node upgrades are disabled.\nAlpha enabled clusters are automatically deleted thirty days after\ncreation.",
"type": "boolean"
@@ -686,10 +2401,70 @@
"monitoringService": {
"description": "The monitoring service the cluster should use to write metrics.\nCurrently available options:\n\n* `monitoring.googleapis.com` - the Google Cloud Monitoring service.\n* `none` - no metrics will be exported from the cluster.\n* if left as an empty string, `monitoring.googleapis.com` will be used.",
"type": "string"
+ },
+ "network": {
+ "description": "The name of the Google Compute Engine\n[network](/compute/docs/networks-and-firewalls#networks) to which the\ncluster is connected. If left unspecified, the `default` network\nwill be used.",
+ "type": "string"
+ },
+ "zone": {
+ "description": "[Output only] The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use location instead.",
+ "type": "string"
+ },
+ "loggingService": {
+ "description": "The logging service the cluster should use to write logs.\nCurrently available options:\n\n* `logging.googleapis.com` - the Google Cloud Logging service.\n* `none` - no logs will be exported from the cluster.\n* if left as an empty string,`logging.googleapis.com` will be used.",
+ "type": "string"
+ },
+ "nodeIpv4CidrSize": {
+ "format": "int32",
+ "description": "[Output only] The size of the address space on each node for hosting\ncontainers. This is provisioned from within the `container_ipv4_cidr`\nrange.",
+ "type": "integer"
+ },
+ "expireTime": {
+ "description": "[Output only] The time the cluster will be automatically\ndeleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
+ "type": "string"
+ },
+ "masterAuthorizedNetworksConfig": {
+ "$ref": "MasterAuthorizedNetworksConfig",
+ "description": "The configuration options for master authorized networks feature."
+ },
+ "statusMessage": {
+ "description": "[Output only] Additional information about the current status of this\ncluster, if available.",
+ "type": "string"
+ },
+ "masterAuth": {
+ "description": "The authentication information for accessing the master endpoint.",
+ "$ref": "MasterAuth"
}
},
"id": "Cluster"
},
+ "CreateNodePoolRequest": {
+ "description": "CreateNodePoolRequest creates a node pool for a cluster.",
+ "type": "object",
+ "properties": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use parent instead.",
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead.",
+ "type": "string"
+ },
+ "parent": {
+ "description": "The parent (project, location, cluster id) where the node pool will be created.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
+ "type": "string"
+ },
+ "nodePool": {
+ "$ref": "NodePool",
+ "description": "The node pool to create."
+ },
+ "clusterId": {
+ "description": "The name of the cluster.\nThis field is deprecated, use parent instead.",
+ "type": "string"
+ }
+ },
+ "id": "CreateNodePoolRequest"
+ },
"ListOperationsResponse": {
"description": "ListOperationsResponse is the result of ListOperationsRequest.",
"type": "object",
@@ -711,44 +2486,17 @@
},
"id": "ListOperationsResponse"
},
- "CreateNodePoolRequest": {
- "description": "CreateNodePoolRequest creates a node pool for a cluster.",
- "type": "object",
- "properties": {
- "projectId": {
- "type": "string",
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use parent instead."
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead.",
- "type": "string"
- },
- "parent": {
- "description": "The parent (project, location, cluster id) where the node pool will be created.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
- "type": "string"
- },
- "nodePool": {
- "$ref": "NodePool",
- "description": "The node pool to create."
- },
- "clusterId": {
- "description": "The name of the cluster.\nThis field is deprecated, use parent instead.",
- "type": "string"
- }
- },
- "id": "CreateNodePoolRequest"
- },
"CidrBlock": {
"description": "CidrBlock contains an optional name and one CIDR block.",
"type": "object",
"properties": {
+ "displayName": {
+ "description": "display_name is an optional field for users to identify CIDR blocks.",
+ "type": "string"
+ },
"cidrBlock": {
"description": "cidr_block must be specified in CIDR notation.",
"type": "string"
- },
- "displayName": {
- "type": "string",
- "description": "display_name is an optional field for users to identify CIDR blocks."
}
},
"id": "CidrBlock"
@@ -757,20 +2505,6 @@
"description": "Container Engine service configuration.",
"type": "object",
"properties": {
- "validImageTypes": {
- "description": "List of valid image types.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "validNodeVersions": {
- "description": "List of valid node upgrade target versions.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
"validMasterVersions": {
"description": "List of valid master versions.",
"items": {
@@ -785,44 +2519,28 @@
"defaultClusterVersion": {
"description": "Version of Kubernetes the service deploys by default.",
"type": "string"
- }
- },
- "id": "ServerConfig"
- },
- "NodeConfig": {
- "type": "object",
- "properties": {
- "minCpuPlatform": {
- "description": "Minimum CPU platform to be used by this instance. The instance may be\nscheduled on the specified or newer CPU platform. Applicable values are the\nfriendly names of CPU platforms, such as\n\u003ccode\u003eminCpuPlatform: "Intel Haswell"\u003c/code\u003e or\n\u003ccode\u003eminCpuPlatform: "Intel Sandy Bridge"\u003c/code\u003e. For more\ninformation, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)",
- "type": "string"
},
- "preemptible": {
- "description": "Whether the nodes are created as preemptible VM instances. See:\nhttps://cloud.google.com/compute/docs/instances/preemptible for more\ninforamtion about preemptible VM instances.",
- "type": "boolean"
- },
- "localSsdCount": {
- "format": "int32",
- "description": "The number of local SSD disks to be attached to the node.\n\nThe limit for this value is dependant upon the maximum number of\ndisks available on a machine per zone. See:\nhttps://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits\nfor more information.",
- "type": "integer"
- },
- "metadata": {
- "description": "The metadata key/value pairs assigned to instances in the cluster.\n\nKeys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes\nin length. These are reflected as part of a URL in the metadata server.\nAdditionally, to avoid ambiguity, keys must not conflict with any other\nmetadata keys for the project or be one of the four reserved keys:\n\"instance-template\", \"kube-env\", \"startup-script\", and \"user-data\"\n\nValues are free-form strings, and only have meaning as interpreted by\nthe image running in the instance. The only restriction placed on them is\nthat each value's size must be less than or equal to 32 KB.\n\nThe total size of all keys and values must be less than 512 KB.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "tags": {
- "description": "The list of instance tags applied to all nodes. Tags are used to identify\nvalid sources or targets for network firewalls and are specified by\nthe client during cluster or node pool creation. Each tag within the list\nmust comply with RFC1035.",
+ "validImageTypes": {
+ "description": "List of valid image types.",
"items": {
"type": "string"
},
"type": "array"
},
- "serviceAccount": {
- "description": "The Google Cloud Platform Service Account to be used by the node VMs. If\nno Service Account is specified, the \"default\" service account is used.",
- "type": "string"
- },
+ "validNodeVersions": {
+ "description": "List of valid node upgrade target versions.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ServerConfig"
+ },
+ "NodeConfig": {
+ "description": "Parameters that describe the nodes in a cluster.",
+ "type": "object",
+ "properties": {
"imageType": {
"description": "The image type to use for this node. Note that for a given image type,\nthe latest version of it will be used.",
"type": "string"
@@ -835,11 +2553,11 @@
"type": "array"
},
"taints": {
+ "description": "List of kubernetes taints to be applied to each node.\n\nFor more information, including usage and the valid values, see:\nhttps://kubernetes.io/docs/concepts/configuration/taint-and-toleration/",
"items": {
"$ref": "NodeTaint"
},
- "type": "array",
- "description": "List of kubernetes taints to be applied to each node.\n\nFor more information, including usage and the valid values, see:\nhttps://kubernetes.io/docs/concepts/configuration/taint-and-toleration/"
+ "type": "array"
},
"labels": {
"additionalProperties": {
@@ -863,19 +2581,45 @@
"machineType": {
"description": "The name of a Google Compute Engine [machine\ntype](/compute/docs/machine-types) (e.g.\n`n1-standard-1`).\n\nIf unspecified, the default machine type is\n`n1-standard-1`.",
"type": "string"
+ },
+ "minCpuPlatform": {
+ "description": "Minimum CPU platform to be used by this instance. The instance may be\nscheduled on the specified or newer CPU platform. Applicable values are the\nfriendly names of CPU platforms, such as\n\u003ccode\u003eminCpuPlatform: "Intel Haswell"\u003c/code\u003e or\n\u003ccode\u003eminCpuPlatform: "Intel Sandy Bridge"\u003c/code\u003e. For more\ninformation, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)",
+ "type": "string"
+ },
+ "preemptible": {
+ "description": "Whether the nodes are created as preemptible VM instances. See:\nhttps://cloud.google.com/compute/docs/instances/preemptible for more\ninforamtion about preemptible VM instances.",
+ "type": "boolean"
+ },
+ "localSsdCount": {
+ "format": "int32",
+ "description": "The number of local SSD disks to be attached to the node.\n\nThe limit for this value is dependant upon the maximum number of\ndisks available on a machine per zone. See:\nhttps://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits\nfor more information.",
+ "type": "integer"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The metadata key/value pairs assigned to instances in the cluster.\n\nKeys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes\nin length. These are reflected as part of a URL in the metadata server.\nAdditionally, to avoid ambiguity, keys must not conflict with any other\nmetadata keys for the project or be one of the four reserved keys:\n\"instance-template\", \"kube-env\", \"startup-script\", and \"user-data\"\n\nValues are free-form strings, and only have meaning as interpreted by\nthe image running in the instance. The only restriction placed on them is\nthat each value's size must be less than or equal to 32 KB.\n\nThe total size of all keys and values must be less than 512 KB.",
+ "type": "object"
+ },
+ "tags": {
+ "description": "The list of instance tags applied to all nodes. Tags are used to identify\nvalid sources or targets for network firewalls and are specified by\nthe client during cluster or node pool creation. Each tag within the list\nmust comply with RFC1035.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "serviceAccount": {
+ "description": "The Google Cloud Platform Service Account to be used by the node VMs. If\nno Service Account is specified, the \"default\" service account is used.",
+ "type": "string"
}
},
- "id": "NodeConfig",
- "description": "Parameters that describe the nodes in a cluster."
+ "id": "NodeConfig"
},
"MasterAuth": {
"description": "The authentication information for accessing the master endpoint.\nAuthentication can be done using HTTP basic auth or using client\ncertificates.",
"type": "object",
"properties": {
- "clientKey": {
- "description": "[Output only] Base64-encoded private key used by clients to authenticate\nto the cluster endpoint.",
- "type": "string"
- },
"clusterCaCertificate": {
"description": "[Output only] Base64-encoded public certificate that is the root of\ntrust for the cluster.",
"type": "string"
@@ -888,12 +2632,16 @@
"description": "The username to use for HTTP basic authentication to the master endpoint.\nFor clusters v1.6.0 and later, you can disable basic authentication by\nproviding an empty username.",
"type": "string"
},
+ "password": {
+ "description": "The password to use for HTTP basic authentication to the master endpoint.\nBecause the master endpoint is open to the Internet, you should create a\nstrong password. If a password is provided for cluster creation, username\nmust be non-empty.",
+ "type": "string"
+ },
"clientCertificateConfig": {
"description": "Configuration for client certificate authentication on the cluster. If no\nconfiguration is specified, a client certificate is issued.",
"$ref": "ClientCertificateConfig"
},
- "password": {
- "description": "The password to use for HTTP basic authentication to the master endpoint.\nBecause the master endpoint is open to the Internet, you should create a\nstrong password. If a password is provided for cluster creation, username\nmust be non-empty.",
+ "clientKey": {
+ "description": "[Output only] Base64-encoded private key used by clients to authenticate\nto the cluster endpoint.",
"type": "string"
}
},
@@ -915,64 +2663,152 @@
"id": "DailyMaintenanceWindow"
},
"AutoUpgradeOptions": {
+ "description": "AutoUpgradeOptions defines the set of options for the user to control how\nthe Auto Upgrades will proceed.",
"type": "object",
"properties": {
- "autoUpgradeStartTime": {
- "description": "[Output only] This field is set when upgrades are about to commence\nwith the approximate start time for the upgrades, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
- "type": "string"
- },
"description": {
"description": "[Output only] This field is set when upgrades are about to commence\nwith the description of the upgrade.",
"type": "string"
+ },
+ "autoUpgradeStartTime": {
+ "description": "[Output only] This field is set when upgrades are about to commence\nwith the approximate start time for the upgrades, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
+ "type": "string"
}
},
- "id": "AutoUpgradeOptions",
- "description": "AutoUpgradeOptions defines the set of options for the user to control how\nthe Auto Upgrades will proceed."
+ "id": "AutoUpgradeOptions"
},
"ListClustersResponse": {
- "id": "ListClustersResponse",
"description": "ListClustersResponse is the result of ListClustersRequest.",
"type": "object",
"properties": {
- "missingZones": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "If any zones are listed here, the list of clusters returned\nmay be missing those zones."
- },
"clusters": {
"description": "A list of clusters in the project in the specified zone, or\nacross all ones.",
"items": {
"$ref": "Cluster"
},
"type": "array"
+ },
+ "missingZones": {
+ "description": "If any zones are listed here, the list of clusters returned\nmay be missing those zones.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
- }
+ },
+ "id": "ListClustersResponse"
},
"PodSecurityPolicyConfig": {
+ "description": "Configuration for the PodSecurityPolicy feature.",
+ "type": "object",
"properties": {
"enabled": {
"description": "Enable the PodSecurityPolicy controller for this cluster. If enabled, pods\nmust be valid under a PodSecurityPolicy to be created.",
"type": "boolean"
}
},
- "id": "PodSecurityPolicyConfig",
- "description": "Configuration for the PodSecurityPolicy feature.",
- "type": "object"
+ "id": "PodSecurityPolicyConfig"
},
"HttpLoadBalancing": {
+ "description": "Configuration options for the HTTP (L7) load balancing controller addon,\nwhich makes it easy to set up HTTP load balancers for services in a cluster.",
+ "type": "object",
"properties": {
"disabled": {
"description": "Whether the HTTP Load Balancing controller is enabled in the cluster.\nWhen enabled, it runs a small pod in the cluster that manages the load\nbalancers.",
"type": "boolean"
}
},
- "id": "HttpLoadBalancing",
- "description": "Configuration options for the HTTP (L7) load balancing controller addon,\nwhich makes it easy to set up HTTP load balancers for services in a cluster.",
- "type": "object"
+ "id": "HttpLoadBalancing"
+ },
+ "MaintenancePolicy": {
+ "description": "MaintenancePolicy defines the maintenance policy to be used for the cluster.",
+ "type": "object",
+ "properties": {
+ "window": {
+ "$ref": "MaintenanceWindow",
+ "description": "Specifies the maintenance window in which maintenance may be performed."
+ }
+ },
+ "id": "MaintenancePolicy"
+ },
+ "NodePoolAutoscaling": {
+ "description": "NodePoolAutoscaling contains information required by cluster autoscaler to\nadjust the size of the node pool to the current cluster usage.",
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "description": "Is autoscaling enabled for this node pool.",
+ "type": "boolean"
+ },
+ "maxNodeCount": {
+ "format": "int32",
+ "description": "Maximum number of nodes in the NodePool. Must be \u003e= min_node_count. There\nhas to enough quota to scale up the cluster.",
+ "type": "integer"
+ },
+ "minNodeCount": {
+ "format": "int32",
+ "description": "Minimum number of nodes in the NodePool. Must be \u003e= 1 and \u003c=\nmax_node_count.",
+ "type": "integer"
+ }
+ },
+ "id": "NodePoolAutoscaling"
+ },
+ "ClientCertificateConfig": {
+ "description": "Configuration for client certificates on the cluster.",
+ "type": "object",
+ "properties": {
+ "issueClientCertificate": {
+ "description": "Issue a client certificate.",
+ "type": "boolean"
+ }
+ },
+ "id": "ClientCertificateConfig"
+ },
+ "SetMasterAuthRequest": {
+ "description": "SetMasterAuthRequest updates the admin password of a cluster.",
+ "type": "object",
+ "properties": {
+ "update": {
+ "description": "A description of the update.",
+ "$ref": "MasterAuth"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name (project, location, cluster) of the cluster to set auth.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string"
+ },
+ "action": {
+ "description": "The exact form of action to be taken on the master auth.",
+ "type": "string",
+ "enumDescriptions": [
+ "Operation is unknown and will error out.",
+ "Set the password to a user generated value.",
+ "Generate a new password and set it to that.",
+ "Set the username. If an empty username is provided, basic authentication\nis disabled for the cluster. If a non-empty username is provided, basic\nauthentication is enabled, with either a provided password or a generated\none."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "SET_PASSWORD",
+ "GENERATE_PASSWORD",
+ "SET_USERNAME"
+ ]
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ }
+ },
+ "id": "SetMasterAuthRequest"
},
"SetNetworkPolicyRequest": {
+ "description": "SetNetworkPolicyRequest enables/disables network policy for a cluster.",
+ "type": "object",
"properties": {
"projectId": {
"description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
@@ -987,120 +2823,20 @@
"type": "string"
},
"networkPolicy": {
- "description": "Configuration options for the NetworkPolicy feature.",
- "$ref": "NetworkPolicy"
+ "$ref": "NetworkPolicy",
+ "description": "Configuration options for the NetworkPolicy feature."
},
"name": {
"description": "The name (project, location, cluster id) of the cluster to set networking policy.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
"type": "string"
}
},
- "id": "SetNetworkPolicyRequest",
- "description": "SetNetworkPolicyRequest enables/disables network policy for a cluster.",
- "type": "object"
- },
- "SetMasterAuthRequest": {
- "id": "SetMasterAuthRequest",
- "description": "SetMasterAuthRequest updates the admin password of a cluster.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The name (project, location, cluster) of the cluster to set auth.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "type": "string"
- },
- "action": {
- "enum": [
- "UNKNOWN",
- "SET_PASSWORD",
- "GENERATE_PASSWORD",
- "SET_USERNAME"
- ],
- "description": "The exact form of action to be taken on the master auth.",
- "type": "string",
- "enumDescriptions": [
- "Operation is unknown and will error out.",
- "Set the password to a user generated value.",
- "Generate a new password and set it to that.",
- "Set the username. If an empty username is provided, basic authentication\nis disabled for the cluster. If a non-empty username is provided, basic\nauthentication is enabled, with either a provided password or a generated\none."
- ]
- },
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "clusterId": {
- "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "update": {
- "$ref": "MasterAuth",
- "description": "A description of the update."
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "type": "string"
- }
- }
- },
- "ClientCertificateConfig": {
- "properties": {
- "issueClientCertificate": {
- "description": "Issue a client certificate.",
- "type": "boolean"
- }
- },
- "id": "ClientCertificateConfig",
- "description": "Configuration for client certificates on the cluster.",
- "type": "object"
- },
- "NodePoolAutoscaling": {
- "type": "object",
- "properties": {
- "enabled": {
- "description": "Is autoscaling enabled for this node pool.",
- "type": "boolean"
- },
- "maxNodeCount": {
- "format": "int32",
- "description": "Maximum number of nodes in the NodePool. Must be \u003e= min_node_count. There\nhas to enough quota to scale up the cluster.",
- "type": "integer"
- },
- "minNodeCount": {
- "type": "integer",
- "format": "int32",
- "description": "Minimum number of nodes in the NodePool. Must be \u003e= 1 and \u003c=\nmax_node_count."
- }
- },
- "id": "NodePoolAutoscaling",
- "description": "NodePoolAutoscaling contains information required by cluster autoscaler to\nadjust the size of the node pool to the current cluster usage."
- },
- "MaintenancePolicy": {
- "type": "object",
- "properties": {
- "window": {
- "$ref": "MaintenanceWindow",
- "description": "Specifies the maintenance window in which maintenance may be performed."
- }
- },
- "id": "MaintenancePolicy",
- "description": "MaintenancePolicy defines the maintenance policy to be used for the cluster."
+ "id": "SetNetworkPolicyRequest"
},
"IPAllocationPolicy": {
"description": "Configuration for controlling how IPs are allocated in the cluster.",
"type": "object",
"properties": {
- "createSubnetwork": {
- "description": "Whether a new subnetwork will be created automatically for the cluster.\n\nThis field is only applicable when `use_ip_aliases` is true.",
- "type": "boolean"
- },
- "useIpAliases": {
- "type": "boolean",
- "description": "Whether alias IPs will be used for pod IPs in the cluster."
- },
- "servicesSecondaryRangeName": {
- "description": "The name of the secondary range to be used as for the services\nCIDR block. The secondary range will be used for service\nClusterIPs. This must be an existing secondary range associated\nwith the cluster subnetwork.\n\nThis field is only applicable with use_ip_aliases and\ncreate_subnetwork is false.",
- "type": "string"
- },
"subnetworkName": {
"description": "A custom subnetwork name to be used if `create_subnetwork` is true. If\nthis field is empty, then an automatic name will be chosen for the new\nsubnetwork.",
"type": "string"
@@ -1126,12 +2862,24 @@
"type": "string"
},
"nodeIpv4CidrBlock": {
- "type": "string",
- "description": "The IP address range of the instance IPs in this cluster.\n\nThis is applicable only if `create_subnetwork` is true.\n\nSet to blank to have a range chosen with the default size.\n\nSet to /netmask (e.g. `/14`) to have a range chosen with a specific\nnetmask.\n\nSet to a\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use."
+ "description": "The IP address range of the instance IPs in this cluster.\n\nThis is applicable only if `create_subnetwork` is true.\n\nSet to blank to have a range chosen with the default size.\n\nSet to /netmask (e.g. `/14`) to have a range chosen with a specific\nnetmask.\n\nSet to a\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use.",
+ "type": "string"
},
"servicesIpv4Cidr": {
"description": "This field is deprecated, use services_ipv4_cidr_block.",
"type": "string"
+ },
+ "servicesSecondaryRangeName": {
+ "description": "The name of the secondary range to be used as for the services\nCIDR block. The secondary range will be used for service\nClusterIPs. This must be an existing secondary range associated\nwith the cluster subnetwork.\n\nThis field is only applicable with use_ip_aliases and\ncreate_subnetwork is false.",
+ "type": "string"
+ },
+ "useIpAliases": {
+ "description": "Whether alias IPs will be used for pod IPs in the cluster.",
+ "type": "boolean"
+ },
+ "createSubnetwork": {
+ "description": "Whether a new subnetwork will be created automatically for the cluster.\n\nThis field is only applicable when `use_ip_aliases` is true.",
+ "type": "boolean"
}
},
"id": "IPAllocationPolicy"
@@ -1140,10 +2888,6 @@
"description": "ClusterUpdate describes an update to the cluster. Exactly one update can\nbe applied to a cluster with each request, so at most one field can be\nprovided.",
"type": "object",
"properties": {
- "desiredAddonsConfig": {
- "$ref": "AddonsConfig",
- "description": "Configurations for the various addons available to run in the cluster."
- },
"desiredNodePoolId": {
"description": "The node pool to be upgraded. This field is mandatory if\n\"desired_node_version\", \"desired_image_family\" or\n\"desired_node_pool_autoscaling\" is specified and there is more than one\nnode pool on the cluster.",
"type": "string"
@@ -1182,64 +2926,62 @@
"desiredImageType": {
"description": "The desired image type for the node pool.\nNOTE: Set the \"desired_node_pool\" field as well.",
"type": "string"
+ },
+ "desiredAddonsConfig": {
+ "description": "Configurations for the various addons available to run in the cluster.",
+ "$ref": "AddonsConfig"
}
},
"id": "ClusterUpdate"
},
"HorizontalPodAutoscaling": {
+ "description": "Configuration options for the horizontal pod autoscaling feature, which\nincreases or decreases the number of replica pods a replication controller\nhas based on the resource usage of the existing pods.",
+ "type": "object",
"properties": {
"disabled": {
- "type": "boolean",
- "description": "Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.\nWhen enabled, it ensures that a Heapster pod is running in the cluster,\nwhich is also used by the Cloud Monitoring service."
+ "description": "Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.\nWhen enabled, it ensures that a Heapster pod is running in the cluster,\nwhich is also used by the Cloud Monitoring service.",
+ "type": "boolean"
}
},
- "id": "HorizontalPodAutoscaling",
- "description": "Configuration options for the horizontal pod autoscaling feature, which\nincreases or decreases the number of replica pods a replication controller\nhas based on the resource usage of the existing pods.",
- "type": "object"
+ "id": "HorizontalPodAutoscaling"
},
"SetMaintenancePolicyRequest": {
- "id": "SetMaintenancePolicyRequest",
"description": "SetMaintenancePolicyRequest sets the maintenance policy for a cluster.",
"type": "object",
"properties": {
- "name": {
- "description": "The name (project, location, cluster id) of the cluster to set maintenance\npolicy.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "type": "string"
- },
- "maintenancePolicy": {
- "description": "The maintenance policy to be set for the cluster. An empty field\nclears the existing maintenance policy.",
- "$ref": "MaintenancePolicy"
- },
"projectId": {
- "type": "string",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840)."
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "type": "string"
},
"zone": {
"description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
"type": "string"
},
"clusterId": {
- "type": "string",
- "description": "The name of the cluster to update."
+ "description": "The name of the cluster to update.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name (project, location, cluster id) of the cluster to set maintenance\npolicy.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string"
+ },
+ "maintenancePolicy": {
+ "$ref": "MaintenancePolicy",
+ "description": "The maintenance policy to be set for the cluster. An empty field\nclears the existing maintenance policy."
}
- }
+ },
+ "id": "SetMaintenancePolicyRequest"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
},
"SetNodePoolManagementRequest": {
"description": "SetNodePoolManagementRequest sets the node management properties of a node\npool.",
"type": "object",
"properties": {
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "management": {
- "$ref": "NodeManagement",
- "description": "NodeManagement configuration for the node pool."
- },
- "clusterId": {
- "type": "string",
- "description": "The name of the cluster to update.\nThis field is deprecated, use name instead."
- },
"nodePoolId": {
"description": "The name of the node pool to update.\nThis field is deprecated, use name instead.",
"type": "string"
@@ -1251,35 +2993,43 @@
"name": {
"description": "The name (project, location, cluster, node pool id) of the node pool to set\nmanagement properties. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.",
"type": "string"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "management": {
+ "description": "NodeManagement configuration for the node pool.",
+ "$ref": "NodeManagement"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to update.\nThis field is deprecated, use name instead.",
+ "type": "string"
}
},
"id": "SetNodePoolManagementRequest"
},
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\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"
- },
"MasterAuthorizedNetworksConfig": {
"description": "Configuration options for the master authorized networks feature. Enabled\nmaster authorized networks will disallow all external traffic to access\nKubernetes master through HTTPS except traffic from the given CIDR blocks,\nGoogle Compute Engine Public IPs and Google Prod IPs.",
"type": "object",
"properties": {
+ "enabled": {
+ "description": "Whether or not master authorized networks is enabled.",
+ "type": "boolean"
+ },
"cidrBlocks": {
"description": "cidr_blocks define up to 10 external networks that could access\nKubernetes master through HTTPS.",
"items": {
"$ref": "CidrBlock"
},
"type": "array"
- },
- "enabled": {
- "description": "Whether or not master authorized networks is enabled.",
- "type": "boolean"
}
},
"id": "MasterAuthorizedNetworksConfig"
},
"CreateClusterRequest": {
+ "description": "CreateClusterRequest creates a cluster.",
+ "type": "object",
"properties": {
"cluster": {
"description": "A [cluster\nresource](/container-engine/reference/rest/v1beta1/projects.zones.clusters)",
@@ -1290,24 +3040,59 @@
"type": "string"
},
"zone": {
- "type": "string",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead."
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead.",
+ "type": "string"
},
"parent": {
- "type": "string",
- "description": "The parent (project and location) where the cluster will be created.\nSpecified in the format 'projects/*/locations/*'."
+ "description": "The parent (project and location) where the cluster will be created.\nSpecified in the format 'projects/*/locations/*'.",
+ "type": "string"
}
},
- "id": "CreateClusterRequest",
- "description": "CreateClusterRequest creates a cluster.",
- "type": "object"
+ "id": "CreateClusterRequest"
+ },
+ "ListNodePoolsResponse": {
+ "description": "ListNodePoolsResponse is the result of ListNodePoolsRequest.",
+ "type": "object",
+ "properties": {
+ "nodePools": {
+ "description": "A list of node pools for a cluster.",
+ "items": {
+ "$ref": "NodePool"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListNodePoolsResponse"
+ },
+ "CompleteIPRotationRequest": {
+ "description": "CompleteIPRotationRequest moves the cluster master back into single-IP mode.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name (project, location, cluster id) of the cluster to complete IP rotation.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "clusterId": {
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ }
+ },
+ "id": "CompleteIPRotationRequest"
}
},
- "icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
"protocol": "rest",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
"canonicalName": "Container",
"auth": {
"oauth2": {
@@ -1318,1788 +3103,5 @@
}
}
},
- "rootUrl": "https://container.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "container",
- "batchPath": "batch",
- "title": "Google Container Engine API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "locations": {
- "methods": {
- "getServerConfig": {
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serverConfig",
- "id": "container.projects.locations.getServerConfig",
- "path": "v1beta1/{+name}/serverConfig",
- "description": "Returns configuration info about the Container Engine service.",
- "response": {
- "$ref": "ServerConfig"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "The name (project and location) of the server config to get\nSpecified in the format 'projects/*/locations/*'.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- },
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
- "type": "string",
- "location": "query"
- },
- "zone": {
- "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for.\nThis field is deprecated, use name instead.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- },
- "resources": {
- "clusters": {
- "methods": {
- "completeIpRotation": {
- "parameters": {
- "name": {
- "description": "The name (project, location, cluster id) of the cluster to complete IP rotation.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:completeIpRotation",
- "id": "container.projects.locations.clusters.completeIpRotation",
- "path": "v1beta1/{+name}:completeIpRotation",
- "description": "Completes master IP rotation.",
- "request": {
- "$ref": "CompleteIPRotationRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST"
- },
- "setNetworkPolicy": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
- "location": "path",
- "description": "The name (project, location, cluster id) of the cluster to set networking policy.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setNetworkPolicy",
- "id": "container.projects.locations.clusters.setNetworkPolicy",
- "path": "v1beta1/{+name}:setNetworkPolicy",
- "description": "Enables/Disables Network Policy for a cluster.",
- "request": {
- "$ref": "SetNetworkPolicyRequest"
- }
- },
- "get": {
- "description": "Gets the details of a specific cluster.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Cluster"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "zone": {
- "location": "query",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "clusterId": {
- "location": "query",
- "description": "The name of the cluster to retrieve.\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
- "location": "path",
- "description": "The name (project, location, cluster) of the cluster to retrieve.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "type": "string",
- "required": true
- },
- "projectId": {
- "location": "query",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}",
- "path": "v1beta1/{+name}",
- "id": "container.projects.locations.clusters.get"
- },
- "startIpRotation": {
- "parameters": {
- "name": {
- "description": "The name (project, location, cluster id) of the cluster to start IP rotation.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:startIpRotation",
- "id": "container.projects.locations.clusters.startIpRotation",
- "path": "v1beta1/{+name}:startIpRotation",
- "description": "Start master IP rotation.",
- "request": {
- "$ref": "StartIPRotationRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST"
- },
- "setMaintenancePolicy": {
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMaintenancePolicy",
- "id": "container.projects.locations.clusters.setMaintenancePolicy",
- "path": "v1beta1/{+name}:setMaintenancePolicy",
- "description": "Sets the maintenance policy for a cluster.",
- "request": {
- "$ref": "SetMaintenancePolicyRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "description": "The name (project, location, cluster id) of the cluster to set maintenance\npolicy.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "delete": {
- "description": "Deletes the cluster, including the Kubernetes endpoint and all worker\nnodes.\n\nFirewalls and routes that were configured during cluster creation\nare also deleted.\n\nOther Google Compute Engine resources that might be in use by the cluster\n(e.g. load balancer resources) will not be deleted if they weren't present\nat the initial create time.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name (project, location, cluster) of the cluster to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$"
- },
- "projectId": {
- "type": "string",
- "location": "query",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead."
- },
- "zone": {
- "location": "query",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "clusterId": {
- "location": "query",
- "description": "The name of the cluster to delete.\nThis field is deprecated, use name instead.",
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}",
- "id": "container.projects.locations.clusters.delete",
- "path": "v1beta1/{+name}"
- },
- "setLegacyAbac": {
- "description": "Enables or disables the ABAC authorization mechanism on a cluster.",
- "request": {
- "$ref": "SetLegacyAbacRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "name": {
- "description": "The name (project, location, cluster id) of the cluster to set legacy abac.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLegacyAbac",
- "path": "v1beta1/{+name}:setLegacyAbac",
- "id": "container.projects.locations.clusters.setLegacyAbac"
- },
- "setResourceLabels": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "description": "The name (project, location, cluster id) of the cluster to set labels.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setResourceLabels",
- "id": "container.projects.locations.clusters.setResourceLabels",
- "path": "v1beta1/{+name}:setResourceLabels",
- "description": "Sets labels on a cluster.",
- "request": {
- "$ref": "SetLabelsRequest"
- }
- },
- "update": {
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}",
- "path": "v1beta1/{+name}",
- "id": "container.projects.locations.clusters.update",
- "description": "Updates the settings of a specific cluster.",
- "request": {
- "$ref": "UpdateClusterRequest"
- },
- "httpMethod": "PUT",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "name": {
- "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "setMasterAuth": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
- "location": "path",
- "description": "The name (project, location, cluster) of the cluster to set auth.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMasterAuth",
- "id": "container.projects.locations.clusters.setMasterAuth",
- "path": "v1beta1/{+name}:setMasterAuth",
- "request": {
- "$ref": "SetMasterAuthRequest"
- },
- "description": "Used to set master auth materials. Currently supports :-\nChanging the admin password of a specific cluster.\nThis can be either via password generation or explicitly set.\nModify basic_auth.csv and reset the K8S API server."
- },
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListClustersResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "location": "query",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.",
- "type": "string"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides, or \"-\" for all zones.\nThis field is deprecated, use parent instead.",
- "type": "string",
- "location": "query"
- },
- "parent": {
- "description": "The parent (project and location) where the clusters will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters",
- "path": "v1beta1/{+parent}/clusters",
- "id": "container.projects.locations.clusters.list",
- "description": "Lists all clusters owned by a project in either the specified zone or all\nzones."
- },
- "create": {
- "description": "Creates a cluster, consisting of the specified number and type of Google\nCompute Engine instances.\n\nBy default, the cluster is created in the project's\n[default network](/compute/docs/networks-and-firewalls#networks).\n\nOne firewall is added for the cluster. After cluster creation,\nthe cluster creates routes for each node to allow the containers\non that node to communicate with all other instances in the\ncluster.\n\nFinally, an entry is added to the project's global metadata indicating\nwhich CIDR range is being used by the cluster.",
- "request": {
- "$ref": "CreateClusterRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "location": "path",
- "description": "The parent (project and location) where the cluster will be created.\nSpecified in the format 'projects/*/locations/*'.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters",
- "id": "container.projects.locations.clusters.create",
- "path": "v1beta1/{+parent}/clusters"
- }
- },
- "resources": {
- "nodePools": {
- "methods": {
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "NodePool"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$",
- "location": "path",
- "description": "The name (project, location, cluster, node pool id) of the node pool to get.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
- "type": "string",
- "required": true
- },
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
- "type": "string",
- "location": "query"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "type": "string",
- "location": "query"
- },
- "clusterId": {
- "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
- "type": "string",
- "location": "query"
- },
- "nodePoolId": {
- "description": "The name of the node pool.\nThis field is deprecated, use name instead.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}",
- "path": "v1beta1/{+name}",
- "id": "container.projects.locations.clusters.nodePools.get",
- "description": "Retrieves the node pool requested."
- },
- "setManagement": {
- "path": "v1beta1/{+name}:setManagement",
- "id": "container.projects.locations.clusters.nodePools.setManagement",
- "description": "Sets the NodeManagement options for a node pool.",
- "request": {
- "$ref": "SetNodePoolManagementRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "name": {
- "description": "The name (project, location, cluster, node pool id) of the node pool to set\nmanagement properties. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:setManagement"
- },
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$",
- "location": "path",
- "description": "The name (project, location, cluster, node pool id) of the node pool to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
- "type": "string",
- "required": true
- },
- "projectId": {
- "location": "query",
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "type": "string",
- "location": "query"
- },
- "clusterId": {
- "location": "query",
- "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "nodePoolId": {
- "location": "query",
- "description": "The name of the node pool to delete.\nThis field is deprecated, use name instead.",
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}",
- "path": "v1beta1/{+name}",
- "id": "container.projects.locations.clusters.nodePools.delete",
- "description": "Deletes a node pool from a cluster."
- },
- "list": {
- "description": "Lists the node pools for a cluster.",
- "response": {
- "$ref": "ListNodePoolsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "type": "string",
- "location": "query",
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use parent instead."
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead.",
- "type": "string",
- "location": "query"
- },
- "clusterId": {
- "location": "query",
- "description": "The name of the cluster.\nThis field is deprecated, use parent instead.",
- "type": "string"
- },
- "parent": {
- "location": "path",
- "description": "The parent (project, location, cluster id) where the node pools will be listed.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools",
- "id": "container.projects.locations.clusters.nodePools.list",
- "path": "v1beta1/{+parent}/nodePools"
- },
- "rollback": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$",
- "location": "path",
- "description": "The name (project, location, cluster, node pool id) of the node poll to\nrollback upgrade.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:rollback",
- "path": "v1beta1/{+name}:rollback",
- "id": "container.projects.locations.clusters.nodePools.rollback",
- "description": "Roll back the previously Aborted or Failed NodePool upgrade.\nThis will be an no-op if the last upgrade successfully completed.",
- "request": {
- "$ref": "RollbackNodePoolUpgradeRequest"
- }
- },
- "create": {
- "description": "Creates a node pool for a cluster.",
- "request": {
- "$ref": "CreateNodePoolRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "description": "The parent (project, location, cluster id) where the node pool will be created.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools",
- "id": "container.projects.locations.clusters.nodePools.create",
- "path": "v1beta1/{+parent}/nodePools"
- }
- }
- }
- }
- },
- "operations": {
- "methods": {
- "cancel": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
- "location": "path",
- "description": "The name (project, location, operation id) of the operation to cancel.\nSpecified in the format 'projects/*/locations/*/operations/*'."
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
- "id": "container.projects.locations.operations.cancel",
- "path": "v1beta1/{+name}:cancel",
- "request": {
- "$ref": "CancelOperationRequest"
- },
- "description": "Cancels the specified operation."
- },
- "get": {
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
- "id": "container.projects.locations.operations.get",
- "path": "v1beta1/{+name}",
- "description": "Gets the specified operation.",
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
- "location": "path",
- "description": "The name (project, location, operation id) of the operation to get.\nSpecified in the format 'projects/*/locations/*/operations/*'.",
- "type": "string",
- "required": true
- },
- "operationId": {
- "location": "query",
- "description": "The server-assigned `name` of the operation.\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "projectId": {
- "type": "string",
- "location": "query",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead."
- },
- "zone": {
- "location": "query",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "type": "string"
- }
- }
- },
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path",
- "description": "The parent (project and location) where the operations will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.",
- "type": "string",
- "required": true
- },
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.",
- "type": "string",
- "location": "query"
- },
- "zone": {
- "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for, or `-` for all zones.\nThis field is deprecated, use parent instead.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations",
- "path": "v1beta1/{+parent}/operations",
- "id": "container.projects.locations.operations.list",
- "description": "Lists all operations in a project in a specific zone or all zones."
- }
- }
- }
- }
- },
- "zones": {
- "methods": {
- "getServerconfig": {
- "path": "v1beta1/projects/{projectId}/zones/{zone}/serverconfig",
- "id": "container.projects.zones.getServerconfig",
- "description": "Returns configuration info about the Container Engine service.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ServerConfig"
- },
- "parameterOrder": [
- "projectId",
- "zone"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "location": "query",
- "description": "The name (project and location) of the server config to get\nSpecified in the format 'projects/*/locations/*'.",
- "type": "string"
- },
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for.\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/serverconfig"
- }
- },
- "resources": {
- "operations": {
- "methods": {
- "cancel": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "operationId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "operationId": {
- "location": "path",
- "description": "The server-assigned `name` of the operation.\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true
- },
- "projectId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead."
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation resides.\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel",
- "id": "container.projects.zones.operations.cancel",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel",
- "request": {
- "$ref": "CancelOperationRequest"
- },
- "description": "Cancels the specified operation."
- },
- "get": {
- "path": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}",
- "id": "container.projects.zones.operations.get",
- "description": "Gets the specified operation.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "operationId"
- ],
- "parameters": {
- "name": {
- "location": "query",
- "description": "The name (project, location, operation id) of the operation to get.\nSpecified in the format 'projects/*/locations/*/operations/*'.",
- "type": "string"
- },
- "operationId": {
- "location": "path",
- "description": "The server-assigned `name` of the operation.\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true
- },
- "projectId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead."
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}"
- },
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "projectId",
- "zone"
- ],
- "parameters": {
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "zone": {
- "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for, or `-` for all zones.\nThis field is deprecated, use parent instead.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "parent": {
- "description": "The parent (project and location) where the operations will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/operations",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/operations",
- "id": "container.projects.zones.operations.list",
- "description": "Lists all operations in a project in a specific zone or all zones."
- }
- }
- },
- "clusters": {
- "methods": {
- "resourceLabels": {
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels",
- "id": "container.projects.zones.clusters.resourceLabels",
- "description": "Sets labels on a cluster.",
- "request": {
- "$ref": "SetLabelsRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true
- },
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels"
- },
- "create": {
- "request": {
- "$ref": "CreateClusterRequest"
- },
- "description": "Creates a cluster, consisting of the specified number and type of Google\nCompute Engine instances.\n\nBy default, the cluster is created in the project's\n[default network](/compute/docs/networks-and-firewalls#networks).\n\nOne firewall is added for the cluster. After cluster creation,\nthe cluster creates routes for each node to allow the containers\non that node to communicate with all other instances in the\ncluster.\n\nFinally, an entry is added to the project's global metadata indicating\nwhich CIDR range is being used by the cluster.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters",
- "id": "container.projects.zones.clusters.create",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters"
- },
- "completeIpRotation": {
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation",
- "id": "container.projects.zones.clusters.completeIpRotation",
- "request": {
- "$ref": "CompleteIPRotationRequest"
- },
- "description": "Completes master IP rotation.",
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead."
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation"
- },
- "get": {
- "description": "Gets the details of a specific cluster.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Cluster"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "location": "query",
- "description": "The name (project, location, cluster) of the cluster to retrieve.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "type": "string"
- },
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true
- },
- "zone": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead."
- },
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster to retrieve.\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "id": "container.projects.zones.clusters.get"
- },
- "setNetworkPolicy": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "clusterId": {
- "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy",
- "id": "container.projects.zones.clusters.setNetworkPolicy",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy",
- "request": {
- "$ref": "SetNetworkPolicyRequest"
- },
- "description": "Enables/Disables Network Policy for a cluster."
- },
- "legacyAbac": {
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac",
- "id": "container.projects.zones.clusters.legacyAbac",
- "request": {
- "$ref": "SetLegacyAbacRequest"
- },
- "description": "Enables or disables the ABAC authorization mechanism on a cluster.",
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true
- },
- "clusterId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The name of the cluster to update.\nThis field is deprecated, use name instead."
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac"
- },
- "startIpRotation": {
- "request": {
- "$ref": "StartIPRotationRequest"
- },
- "description": "Start master IP rotation.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true
- },
- "clusterId": {
- "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation",
- "id": "container.projects.zones.clusters.startIpRotation",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation"
- },
- "setMaintenancePolicy": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "clusterId": {
- "description": "The name of the cluster to update.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy",
- "id": "container.projects.zones.clusters.setMaintenancePolicy",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy",
- "request": {
- "$ref": "SetMaintenancePolicyRequest"
- },
- "description": "Sets the maintenance policy for a cluster."
- },
- "delete": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "type": "string",
- "location": "query",
- "description": "The name (project, location, cluster) of the cluster to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*'."
- },
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true
- },
- "clusterId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The name of the cluster to delete.\nThis field is deprecated, use name instead."
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "id": "container.projects.zones.clusters.delete",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "description": "Deletes the cluster, including the Kubernetes endpoint and all worker\nnodes.\n\nFirewalls and routes that were configured during cluster creation\nare also deleted.\n\nOther Google Compute Engine resources that might be in use by the cluster\n(e.g. load balancer resources) will not be deleted if they weren't present\nat the initial create time."
- },
- "update": {
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "id": "container.projects.zones.clusters.update",
- "description": "Updates the settings of a specific cluster.",
- "request": {
- "$ref": "UpdateClusterRequest"
- },
- "httpMethod": "PUT",
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true
- },
- "zone": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead."
- },
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "setMasterAuth": {
- "request": {
- "$ref": "SetMasterAuthRequest"
- },
- "description": "Used to set master auth materials. Currently supports :-\nChanging the admin password of a specific cluster.\nThis can be either via password generation or explicitly set.\nModify basic_auth.csv and reset the K8S API server.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true
- },
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth",
- "id": "container.projects.zones.clusters.setMasterAuth",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth"
- },
- "list": {
- "description": "Lists all clusters owned by a project in either the specified zone or all\nzones.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListClustersResponse"
- },
- "parameterOrder": [
- "projectId",
- "zone"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.",
- "type": "string",
- "required": true
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides, or \"-\" for all zones.\nThis field is deprecated, use parent instead.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "parent": {
- "description": "The parent (project and location) where the clusters will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters",
- "id": "container.projects.zones.clusters.list"
- }
- },
- "resources": {
- "nodePools": {
- "methods": {
- "setManagement": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId",
- "nodePoolId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead."
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true
- },
- "clusterId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The name of the cluster to update.\nThis field is deprecated, use name instead."
- },
- "nodePoolId": {
- "location": "path",
- "description": "The name of the node pool to update.\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement",
- "id": "container.projects.zones.clusters.nodePools.setManagement",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement",
- "request": {
- "$ref": "SetNodePoolManagementRequest"
- },
- "description": "Sets the NodeManagement options for a node pool."
- },
- "delete": {
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId",
- "nodePoolId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "nodePoolId": {
- "location": "path",
- "description": "The name of the node pool to delete.\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true
- },
- "name": {
- "location": "query",
- "description": "The name (project, location, cluster, node pool id) of the node pool to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
- "type": "string"
- },
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
- "id": "container.projects.zones.clusters.nodePools.delete",
- "description": "Deletes a node pool from a cluster."
- },
- "list": {
- "response": {
- "$ref": "ListNodePoolsResponse"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use parent instead."
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "parent": {
- "location": "query",
- "description": "The parent (project, location, cluster id) where the node pools will be listed.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "type": "string"
- },
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster.\nThis field is deprecated, use parent instead.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
- "id": "container.projects.zones.clusters.nodePools.list",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
- "description": "Lists the node pools for a cluster."
- },
- "rollback": {
- "parameters": {
- "projectId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead."
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true
- },
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster to rollback.\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true
- },
- "nodePoolId": {
- "location": "path",
- "description": "The name of the node pool to rollback.\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback",
- "id": "container.projects.zones.clusters.nodePools.rollback",
- "description": "Roll back the previously Aborted or Failed NodePool upgrade.\nThis will be an no-op if the last upgrade successfully completed.",
- "request": {
- "$ref": "RollbackNodePoolUpgradeRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId",
- "nodePoolId"
- ],
- "response": {
- "$ref": "Operation"
- }
- },
- "create": {
- "description": "Creates a node pool for a cluster.",
- "request": {
- "$ref": "CreateNodePoolRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "clusterId": {
- "description": "The name of the cluster.\nThis field is deprecated, use parent instead.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use parent instead.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
- "id": "container.projects.zones.clusters.nodePools.create"
- },
- "get": {
- "description": "Retrieves the node pool requested.",
- "httpMethod": "GET",
- "response": {
- "$ref": "NodePool"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId",
- "nodePoolId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "clusterId": {
- "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "nodePoolId": {
- "location": "path",
- "description": "The name of the node pool.\nThis field is deprecated, use name instead.",
- "type": "string",
- "required": true
- },
- "name": {
- "description": "The name (project, location, cluster, node pool id) of the node pool to get.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
- "id": "container.projects.zones.clusters.nodePools.get"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "parameters": {
- "alt": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "type": "string",
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- }
- },
- "version": "v1beta1",
- "baseUrl": "https://container.googleapis.com/",
- "servicePath": "",
- "kind": "discovery#restDescription",
- "description": "The Google Container Engine API is used for building and managing container based applications, powered by the open source Kubernetes technology."
+ "rootUrl": "https://container.googleapis.com/"
}
diff --git a/container/v1beta1/container-gen.go b/container/v1beta1/container-gen.go
index 66c14bf..70e08e8 100644
--- a/container/v1beta1/container-gen.go
+++ b/container/v1beta1/container-gen.go
@@ -1968,6 +1968,7 @@
// Effect: Effect for taint.
//
// Possible values:
+ // "EFFECT_UNSPECIFIED" - Not set
// "NO_SCHEDULE" - NoSchedule
// "PREFER_NO_SCHEDULE" - PreferNoSchedule
// "NO_EXECUTE" - NoExecute
diff --git a/content/v2/content-api.json b/content/v2/content-api.json
index da6c8d9..4a191f6 100644
--- a/content/v2/content-api.json
+++ b/content/v2/content-api.json
@@ -1,12 +1,12 @@
{
"kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/dPMCZ2Ey4YVlnyiRa2uPlyOUPp4\"",
+ "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/60Bew0gKwQtbGWAHt8nvE8JEE5I\"",
"discoveryVersion": "v1",
"id": "content:v2",
"name": "content",
"canonicalName": "Shopping Content",
"version": "v2",
- "revision": "20170928",
+ "revision": "20171010",
"title": "Content API for Shopping",
"description": "Manages product items, inventory, and Merchant Center accounts for Google Shopping.",
"ownerDomain": "google.com",
@@ -825,7 +825,7 @@
},
"contentLanguage": {
"type": "string",
- "description": "[DEPRECATED] Please use target.language instead. The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry."
+ "description": "[DEPRECATED] Please use targets[].language instead. The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry."
},
"contentType": {
"type": "string",
@@ -867,7 +867,7 @@
},
"intendedDestinations": {
"type": "array",
- "description": "[DEPRECATED] Please use target.includedDestination instead. The list of intended destinations (corresponds to checked check boxes in Merchant Center).",
+ "description": "[DEPRECATED] Please use targets[].includedDestinations instead. The list of intended destinations (corresponds to checked check boxes in Merchant Center).",
"items": {
"type": "string"
}
@@ -888,7 +888,7 @@
},
"targetCountry": {
"type": "string",
- "description": "[DEPRECATED] Please use target.country instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code."
+ "description": "[DEPRECATED] Please use targets[].country instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code."
},
"targets": {
"type": "array",
@@ -1387,14 +1387,14 @@
},
"prices": {
"type": "array",
- "description": "be \"infinity\". For example [{\"value\": \"10\", \"currency\": \"USD\"}, {\"value\": \"500\", \"currency\": \"USD\"}, {\"value\": \"infinity\", \"currency\": \"USD\"}] represents the headers \"\u003c= $10\", \" $500\". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.",
+ "description": "A list of inclusive order price upper bounds. The last price's value can be \"infinity\". For example [{\"value\": \"10\", \"currency\": \"USD\"}, {\"value\": \"500\", \"currency\": \"USD\"}, {\"value\": \"infinity\", \"currency\": \"USD\"}] represents the headers \"\u003c= $10\", \" $500\". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.",
"items": {
"$ref": "Price"
}
},
"weights": {
"type": "array",
- "description": "be \"infinity\". For example [{\"value\": \"10\", \"unit\": \"kg\"}, {\"value\": \"50\", \"unit\": \"kg\"}, {\"value\": \"infinity\", \"unit\": \"kg\"}] represents the headers \"\u003c= 10kg\", \" 50kg\". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.",
+ "description": "A list of inclusive order weight upper bounds. The last weight's value can be \"infinity\". For example [{\"value\": \"10\", \"unit\": \"kg\"}, {\"value\": \"50\", \"unit\": \"kg\"}, {\"value\": \"infinity\", \"unit\": \"kg\"}] represents the headers \"\u003c= 10kg\", \" 50kg\". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.",
"items": {
"$ref": "Weight"
}
diff --git a/content/v2/content-gen.go b/content/v2/content-gen.go
index 0fc142f..07844e4 100644
--- a/content/v2/content-gen.go
+++ b/content/v2/content-gen.go
@@ -1386,8 +1386,8 @@
// attributes are defined in the data feed.
AttributeLanguage string `json:"attributeLanguage,omitempty"`
- // ContentLanguage: [DEPRECATED] Please use target.language instead. The
- // two-letter ISO 639-1 language of the items in the feed. Must be a
+ // ContentLanguage: [DEPRECATED] Please use targets[].language instead.
+ // The two-letter ISO 639-1 language of the items in the feed. Must be a
// valid language for targetCountry.
ContentLanguage string `json:"contentLanguage,omitempty"`
@@ -1409,8 +1409,8 @@
Id int64 `json:"id,omitempty,string"`
// IntendedDestinations: [DEPRECATED] Please use
- // target.includedDestination instead. The list of intended destinations
- // (corresponds to checked check boxes in Merchant Center).
+ // targets[].includedDestinations instead. The list of intended
+ // destinations (corresponds to checked check boxes in Merchant Center).
IntendedDestinations []string `json:"intendedDestinations,omitempty"`
// Kind: Identifies what kind of resource this is. Value: the fixed
@@ -1420,7 +1420,7 @@
// Name: A descriptive name of the data feed.
Name string `json:"name,omitempty"`
- // TargetCountry: [DEPRECATED] Please use target.country instead. The
+ // TargetCountry: [DEPRECATED] Please use targets[].country instead. The
// country where the items in the feed will be included in the search
// index, represented as a CLDR territory code.
TargetCountry string `json:"targetCountry,omitempty"`
@@ -2220,18 +2220,20 @@
// if all other fields are not set.
PostalCodeGroupNames []string `json:"postalCodeGroupNames,omitempty"`
- // Prices: be "infinity". For example [{"value": "10", "currency":
- // "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity",
- // "currency": "USD"}] represents the headers "<= $10", " $500". All
- // prices within a service must have the same currency. Must be
- // non-empty. Can only be set if all other fields are not set.
+ // Prices: A list of inclusive order price upper bounds. The last
+ // price's value can be "infinity". For example [{"value": "10",
+ // "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value":
+ // "infinity", "currency": "USD"}] represents the headers "<= $10", "
+ // $500". All prices within a service must have the same currency. Must
+ // be non-empty. Can only be set if all other fields are not set.
Prices []*Price `json:"prices,omitempty"`
- // Weights: be "infinity". For example [{"value": "10", "unit": "kg"},
- // {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}]
- // represents the headers "<= 10kg", " 50kg". All weights within a
- // service must have the same unit. Must be non-empty. Can only be set
- // if all other fields are not set.
+ // Weights: A list of inclusive order weight upper bounds. The last
+ // weight's value can be "infinity". For example [{"value": "10",
+ // "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity",
+ // "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights
+ // within a service must have the same unit. Must be non-empty. Can only
+ // be set if all other fields are not set.
Weights []*Weight `json:"weights,omitempty"`
// ForceSendFields is a list of field names (e.g. "Locations") to
diff --git a/dataflow/v1b3/dataflow-api.json b/dataflow/v1b3/dataflow-api.json
index 1272550..15838b2 100644
--- a/dataflow/v1b3/dataflow-api.json
+++ b/dataflow/v1b3/dataflow-api.json
@@ -1,24 +1,53 @@
{
+ "rootUrl": "https://dataflow.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
"name": "dataflow",
"batchPath": "batch",
- "id": "dataflow:v1b3",
"documentationLink": "https://cloud.google.com/dataflow",
+ "id": "dataflow:v1b3",
"revision": "20171003",
"title": "Google Dataflow API",
"ownerName": "Google",
"discoveryVersion": "v1",
"resources": {
"projects": {
+ "methods": {
+ "workerMessages": {
+ "response": {
+ "$ref": "SendWorkerMessagesResponse"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The project to send the WorkerMessages to.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1b3/projects/{projectId}/WorkerMessages",
+ "id": "dataflow.projects.workerMessages",
+ "path": "v1b3/projects/{projectId}/WorkerMessages",
+ "request": {
+ "$ref": "SendWorkerMessagesRequest"
+ },
+ "description": "Send a worker_message to the service."
+ }
+ },
"resources": {
"locations": {
"methods": {
"workerMessages": {
- "path": "v1b3/projects/{projectId}/locations/{location}/WorkerMessages",
- "id": "dataflow.projects.locations.workerMessages",
- "description": "Send a worker_message to the service.",
- "request": {
- "$ref": "SendWorkerMessagesRequest"
- },
"httpMethod": "POST",
"parameterOrder": [
"projectId",
@@ -27,27 +56,33 @@
"response": {
"$ref": "SendWorkerMessagesResponse"
},
- "parameters": {
- "location": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The location which contains the job"
- },
- "projectId": {
- "description": "The project to send the WorkerMessages to.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly",
"https://www.googleapis.com/auth/userinfo.email"
],
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/WorkerMessages"
+ "parameters": {
+ "location": {
+ "location": "path",
+ "description": "The location which contains the job",
+ "type": "string",
+ "required": true
+ },
+ "projectId": {
+ "location": "path",
+ "description": "The project to send the WorkerMessages to.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/WorkerMessages",
+ "path": "v1b3/projects/{projectId}/locations/{location}/WorkerMessages",
+ "id": "dataflow.projects.locations.workerMessages",
+ "request": {
+ "$ref": "SendWorkerMessagesRequest"
+ },
+ "description": "Send a worker_message to the service."
}
},
"resources": {
@@ -73,11 +108,6 @@
"https://www.googleapis.com/auth/userinfo.email"
],
"parameters": {
- "gcsPath": {
- "location": "query",
- "description": "Required. A Cloud Storage path to the template from which to\ncreate the job.\nMust be a valid Cloud Storage URL, beginning with `gs://`.",
- "type": "string"
- },
"location": {
"type": "string",
"required": true,
@@ -93,10 +123,15 @@
"description": "The view to retrieve. Defaults to METADATA_ONLY."
},
"projectId": {
- "description": "Required. The ID of the Cloud Platform project that the job belongs to.",
"type": "string",
"required": true,
- "location": "path"
+ "location": "path",
+ "description": "Required. The ID of the Cloud Platform project that the job belongs to."
+ },
+ "gcsPath": {
+ "type": "string",
+ "location": "query",
+ "description": "Required. A Cloud Storage path to the template from which to\ncreate the job.\nMust be a valid Cloud Storage URL, beginning with `gs://`."
}
}
},
@@ -116,17 +151,17 @@
"https://www.googleapis.com/auth/userinfo.email"
],
"parameters": {
- "location": {
- "description": "The location to which to direct the request.",
- "type": "string",
- "required": true,
- "location": "path"
- },
"projectId": {
+ "location": "path",
"description": "Required. The ID of the Cloud Platform project that the job belongs to.",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
+ },
+ "location": {
+ "location": "path",
+ "description": "The location to which to direct the request.",
+ "type": "string",
+ "required": true
}
},
"flatPath": "v1b3/projects/{projectId}/locations/{location}/templates",
@@ -138,10 +173,13 @@
"description": "Creates a Cloud Dataflow job from a template."
},
"launch": {
- "description": "Launch a template.",
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/templates:launch",
+ "path": "v1b3/projects/{projectId}/locations/{location}/templates:launch",
+ "id": "dataflow.projects.locations.templates.launch",
"request": {
"$ref": "LaunchTemplateParameters"
},
+ "description": "Launch a template.",
"httpMethod": "POST",
"parameterOrder": [
"projectId",
@@ -150,18 +188,13 @@
"response": {
"$ref": "LaunchTemplateResponse"
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
"parameters": {
- "location": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The location to which to direct the request."
- },
- "validateOnly": {
- "description": "If true, the request is validated but not actually executed.\nDefaults to false.",
- "type": "boolean",
- "location": "query"
- },
"projectId": {
"location": "path",
"description": "Required. The ID of the Cloud Platform project that the job belongs to.",
@@ -172,6 +205,58 @@
"location": "query",
"description": "Required. A Cloud Storage path to the template from which to create\nthe job.\nMust be valid Cloud Storage URL, beginning with 'gs://'.",
"type": "string"
+ },
+ "location": {
+ "location": "path",
+ "description": "The location to which to direct the request.",
+ "type": "string",
+ "required": true
+ },
+ "validateOnly": {
+ "location": "query",
+ "description": "If true, the request is validated but not actually executed.\nDefaults to false.",
+ "type": "boolean"
+ }
+ }
+ }
+ }
+ },
+ "jobs": {
+ "methods": {
+ "getMetrics": {
+ "response": {
+ "$ref": "JobMetrics"
+ },
+ "parameterOrder": [
+ "projectId",
+ "location",
+ "jobId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "location": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The location which contains the job specified by job_id."
+ },
+ "startTime": {
+ "type": "string",
+ "location": "query",
+ "format": "google-datetime",
+ "description": "Return only metric data that has changed since this time.\nDefault is to return all information about all metrics for the job."
+ },
+ "jobId": {
+ "location": "path",
+ "description": "The job to get messages for.",
+ "type": "string",
+ "required": true
+ },
+ "projectId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "A project id."
}
},
"scopes": [
@@ -180,14 +265,130 @@
"https://www.googleapis.com/auth/compute.readonly",
"https://www.googleapis.com/auth/userinfo.email"
],
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/templates:launch",
- "path": "v1b3/projects/{projectId}/locations/{location}/templates:launch",
- "id": "dataflow.projects.locations.templates.launch"
- }
- }
- },
- "jobs": {
- "methods": {
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics",
+ "id": "dataflow.projects.locations.jobs.getMetrics",
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics",
+ "description": "Request the job status."
+ },
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId",
+ "location"
+ ],
+ "response": {
+ "$ref": "ListJobsResponse"
+ },
+ "parameters": {
+ "location": {
+ "location": "path",
+ "description": "The location that contains this job.",
+ "type": "string",
+ "required": true
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Set this to the 'next_page_token' field of a previous response\nto request additional results in a long list."
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "format": "int32",
+ "description": "If there are many jobs, limit response to at most this many.\nThe actual number of jobs returned will be the lesser of max_responses\nand an unspecified server-defined limit."
+ },
+ "view": {
+ "location": "query",
+ "enum": [
+ "JOB_VIEW_UNKNOWN",
+ "JOB_VIEW_SUMMARY",
+ "JOB_VIEW_ALL",
+ "JOB_VIEW_DESCRIPTION"
+ ],
+ "description": "Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.",
+ "type": "string"
+ },
+ "projectId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The project which owns the jobs."
+ },
+ "filter": {
+ "location": "query",
+ "enum": [
+ "UNKNOWN",
+ "ALL",
+ "TERMINATED",
+ "ACTIVE"
+ ],
+ "description": "The kind of filter to use.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs",
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs",
+ "id": "dataflow.projects.locations.jobs.list",
+ "description": "List the jobs of a project in a given region."
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId",
+ "location",
+ "jobId"
+ ],
+ "response": {
+ "$ref": "Job"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "parameters": {
+ "view": {
+ "location": "query",
+ "enum": [
+ "JOB_VIEW_UNKNOWN",
+ "JOB_VIEW_SUMMARY",
+ "JOB_VIEW_ALL",
+ "JOB_VIEW_DESCRIPTION"
+ ],
+ "description": "The level of information requested in response.",
+ "type": "string"
+ },
+ "jobId": {
+ "location": "path",
+ "description": "The job ID.",
+ "type": "string",
+ "required": true
+ },
+ "projectId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The ID of the Cloud Platform project that the job belongs to."
+ },
+ "location": {
+ "location": "path",
+ "description": "The location that contains this job.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}",
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}",
+ "id": "dataflow.projects.locations.jobs.get",
+ "description": "Gets the state of the specified Cloud Dataflow job."
+ },
"update": {
"response": {
"$ref": "Job"
@@ -198,44 +399,41 @@
"jobId"
],
"httpMethod": "PUT",
+ "parameters": {
+ "jobId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The job ID."
+ },
+ "projectId": {
+ "location": "path",
+ "description": "The ID of the Cloud Platform project that the job belongs to.",
+ "type": "string",
+ "required": true
+ },
+ "location": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The location that contains this job."
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly",
"https://www.googleapis.com/auth/userinfo.email"
],
- "parameters": {
- "location": {
- "description": "The location that contains this job.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "jobId": {
- "description": "The job ID.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "description": "The ID of the Cloud Platform project that the job belongs to.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
"flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}",
"id": "dataflow.projects.locations.jobs.update",
"path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}",
+ "description": "Updates the state of an existing Cloud Dataflow job.",
"request": {
"$ref": "Job"
- },
- "description": "Updates the state of an existing Cloud Dataflow job."
+ }
},
"create": {
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs",
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs",
- "id": "dataflow.projects.locations.jobs.create",
"request": {
"$ref": "Job"
},
@@ -256,6 +454,7 @@
],
"parameters": {
"view": {
+ "type": "string",
"location": "query",
"enum": [
"JOB_VIEW_UNKNOWN",
@@ -263,249 +462,42 @@
"JOB_VIEW_ALL",
"JOB_VIEW_DESCRIPTION"
],
- "description": "The level of information requested in response.",
- "type": "string"
+ "description": "The level of information requested in response."
},
"projectId": {
- "description": "The ID of the Cloud Platform project that the job belongs to.",
"type": "string",
"required": true,
- "location": "path"
+ "location": "path",
+ "description": "The ID of the Cloud Platform project that the job belongs to."
},
"location": {
+ "location": "path",
"description": "The location that contains this job.",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
},
"replaceJobId": {
+ "location": "query",
"description": "Deprecated. This field is now in the Job message.",
- "type": "string",
- "location": "query"
- }
- }
- },
- "getMetrics": {
- "description": "Request the job status.",
- "httpMethod": "GET",
- "parameterOrder": [
- "projectId",
- "location",
- "jobId"
- ],
- "response": {
- "$ref": "JobMetrics"
- },
- "parameters": {
- "location": {
- "description": "The location which contains the job specified by job_id.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "startTime": {
- "type": "string",
- "location": "query",
- "format": "google-datetime",
- "description": "Return only metric data that has changed since this time.\nDefault is to return all information about all metrics for the job."
- },
- "jobId": {
- "location": "path",
- "description": "The job to get messages for.",
- "type": "string",
- "required": true
- },
- "projectId": {
- "location": "path",
- "description": "A project id.",
- "type": "string",
- "required": true
+ "type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics",
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics",
- "id": "dataflow.projects.locations.jobs.getMetrics"
- },
- "list": {
"flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs",
- "id": "dataflow.projects.locations.jobs.list",
"path": "v1b3/projects/{projectId}/locations/{location}/jobs",
- "description": "List the jobs of a project in a given region.",
- "response": {
- "$ref": "ListJobsResponse"
- },
- "parameterOrder": [
- "projectId",
- "location"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "parameters": {
- "projectId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The project which owns the jobs."
- },
- "filter": {
- "location": "query",
- "enum": [
- "UNKNOWN",
- "ALL",
- "TERMINATED",
- "ACTIVE"
- ],
- "description": "The kind of filter to use.",
- "type": "string"
- },
- "location": {
- "description": "The location that contains this job.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "pageToken": {
- "description": "Set this to the 'next_page_token' field of a previous response\nto request additional results in a long list.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "If there are many jobs, limit response to at most this many.\nThe actual number of jobs returned will be the lesser of max_responses\nand an unspecified server-defined limit.",
- "type": "integer"
- },
- "view": {
- "location": "query",
- "enum": [
- "JOB_VIEW_UNKNOWN",
- "JOB_VIEW_SUMMARY",
- "JOB_VIEW_ALL",
- "JOB_VIEW_DESCRIPTION"
- ],
- "description": "Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.",
- "type": "string"
- }
- }
- },
- "get": {
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId",
- "location",
- "jobId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "parameters": {
- "location": {
- "description": "The location that contains this job.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "view": {
- "location": "query",
- "enum": [
- "JOB_VIEW_UNKNOWN",
- "JOB_VIEW_SUMMARY",
- "JOB_VIEW_ALL",
- "JOB_VIEW_DESCRIPTION"
- ],
- "description": "The level of information requested in response.",
- "type": "string"
- },
- "jobId": {
- "description": "The job ID.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "location": "path",
- "description": "The ID of the Cloud Platform project that the job belongs to.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}",
- "id": "dataflow.projects.locations.jobs.get",
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}",
- "description": "Gets the state of the specified Cloud Dataflow job."
+ "id": "dataflow.projects.locations.jobs.create"
}
},
"resources": {
"workItems": {
"methods": {
- "lease": {
- "request": {
- "$ref": "LeaseWorkItemRequest"
- },
- "description": "Leases a dataflow WorkItem to run.",
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "location",
- "jobId"
- ],
- "response": {
- "$ref": "LeaseWorkItemResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "parameters": {
- "jobId": {
- "description": "Identifies the workflow job this worker belongs to.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "description": "Identifies the project this worker belongs to.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "location": {
- "location": "path",
- "description": "The location which contains the WorkItem's job.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:lease",
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:lease",
- "id": "dataflow.projects.locations.jobs.workItems.lease"
- },
"reportStatus": {
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:reportStatus",
"id": "dataflow.projects.locations.jobs.workItems.reportStatus",
"path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:reportStatus",
- "description": "Reports the status of dataflow WorkItems leased by a worker.",
"request": {
"$ref": "ReportWorkItemStatusRequest"
},
+ "description": "Reports the status of dataflow WorkItems leased by a worker.",
"response": {
"$ref": "ReportWorkItemStatusResponse"
},
@@ -515,6 +507,12 @@
"jobId"
],
"httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
"parameters": {
"location": {
"location": "path",
@@ -529,31 +527,18 @@
"required": true
},
"projectId": {
- "location": "path",
- "description": "The project which owns the WorkItem's job.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path",
+ "description": "The project which owns the WorkItem's job."
}
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:reportStatus"
- }
- }
- },
- "debug": {
- "methods": {
- "sendCapture": {
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/sendCapture",
- "id": "dataflow.projects.locations.jobs.debug.sendCapture",
+ }
+ },
+ "lease": {
+ "description": "Leases a dataflow WorkItem to run.",
"request": {
- "$ref": "SendDebugCaptureRequest"
+ "$ref": "LeaseWorkItemRequest"
},
- "description": "Send encoded debug capture data for component.",
"httpMethod": "POST",
"parameterOrder": [
"projectId",
@@ -561,7 +546,27 @@
"jobId"
],
"response": {
- "$ref": "SendDebugCaptureResponse"
+ "$ref": "LeaseWorkItemResponse"
+ },
+ "parameters": {
+ "jobId": {
+ "location": "path",
+ "description": "Identifies the workflow job this worker belongs to.",
+ "type": "string",
+ "required": true
+ },
+ "projectId": {
+ "location": "path",
+ "description": "Identifies the project this worker belongs to.",
+ "type": "string",
+ "required": true
+ },
+ "location": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The location which contains the WorkItem's job."
+ }
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
@@ -569,33 +574,59 @@
"https://www.googleapis.com/auth/compute.readonly",
"https://www.googleapis.com/auth/userinfo.email"
],
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:lease",
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:lease",
+ "id": "dataflow.projects.locations.jobs.workItems.lease"
+ }
+ }
+ },
+ "debug": {
+ "methods": {
+ "sendCapture": {
+ "response": {
+ "$ref": "SendDebugCaptureResponse"
+ },
+ "parameterOrder": [
+ "projectId",
+ "location",
+ "jobId"
+ ],
+ "httpMethod": "POST",
"parameters": {
- "location": {
- "location": "path",
- "description": "The location which contains the job specified by job_id.",
- "type": "string",
- "required": true
- },
"jobId": {
- "description": "The job id.",
"type": "string",
"required": true,
- "location": "path"
+ "location": "path",
+ "description": "The job id."
},
"projectId": {
- "description": "The project id.",
"type": "string",
"required": true,
- "location": "path"
+ "location": "path",
+ "description": "The project id."
+ },
+ "location": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The location which contains the job specified by job_id."
}
},
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/sendCapture"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/sendCapture",
+ "id": "dataflow.projects.locations.jobs.debug.sendCapture",
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/sendCapture",
+ "description": "Send encoded debug capture data for component.",
+ "request": {
+ "$ref": "SendDebugCaptureRequest"
+ }
},
"getConfig": {
- "request": {
- "$ref": "GetDebugConfigRequest"
- },
- "description": "Get encoded debug configuration for component. Not cacheable.",
"httpMethod": "POST",
"parameterOrder": [
"projectId",
@@ -612,12 +643,6 @@
"https://www.googleapis.com/auth/userinfo.email"
],
"parameters": {
- "location": {
- "description": "The location which contains the job specified by job_id.",
- "type": "string",
- "required": true,
- "location": "path"
- },
"jobId": {
"type": "string",
"required": true,
@@ -625,23 +650,31 @@
"description": "The job id."
},
"projectId": {
- "description": "The project id.",
"type": "string",
"required": true,
- "location": "path"
+ "location": "path",
+ "description": "The project id."
+ },
+ "location": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The location which contains the job specified by job_id."
}
},
"flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/getConfig",
"path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/getConfig",
- "id": "dataflow.projects.locations.jobs.debug.getConfig"
+ "id": "dataflow.projects.locations.jobs.debug.getConfig",
+ "request": {
+ "$ref": "GetDebugConfigRequest"
+ },
+ "description": "Get encoded debug configuration for component. Not cacheable."
}
}
},
"messages": {
"methods": {
"list": {
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages",
- "id": "dataflow.projects.locations.jobs.messages.list",
"description": "Request the job status.",
"httpMethod": "GET",
"response": {
@@ -652,12 +685,30 @@
"location",
"jobId"
],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
"parameters": {
- "endTime": {
+ "projectId": {
"type": "string",
+ "required": true,
+ "location": "path",
+ "description": "A project id."
+ },
+ "jobId": {
+ "location": "path",
+ "description": "The job to get messages about.",
+ "type": "string",
+ "required": true
+ },
+ "endTime": {
"location": "query",
"format": "google-datetime",
- "description": "Return only messages with timestamps \u003c end_time. The default is now\n(i.e. return up to the latest messages available)."
+ "description": "Return only messages with timestamps \u003c end_time. The default is now\n(i.e. return up to the latest messages available).",
+ "type": "string"
},
"location": {
"location": "path",
@@ -666,15 +717,15 @@
"required": true
},
"startTime": {
+ "type": "string",
"location": "query",
"format": "google-datetime",
- "description": "If specified, return only messages with timestamps \u003e= start_time.\nThe default is the job creation time (i.e. beginning of messages).",
- "type": "string"
+ "description": "If specified, return only messages with timestamps \u003e= start_time.\nThe default is the job creation time (i.e. beginning of messages)."
},
"pageToken": {
+ "location": "query",
"description": "If supplied, this should be the value of next_page_token returned\nby an earlier call. This will cause the next page of results to\nbe returned.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pageSize": {
"location": "query",
@@ -683,7 +734,6 @@
"type": "integer"
},
"minimumImportance": {
- "description": "Filter to only get messages with importance \u003e= level",
"type": "string",
"location": "query",
"enum": [
@@ -693,28 +743,13 @@
"JOB_MESSAGE_BASIC",
"JOB_MESSAGE_WARNING",
"JOB_MESSAGE_ERROR"
- ]
- },
- "projectId": {
- "description": "A project id.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "jobId": {
- "description": "The job to get messages about.",
- "type": "string",
- "required": true,
- "location": "path"
+ ],
+ "description": "Filter to only get messages with importance \u003e= level"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages"
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages",
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages",
+ "id": "dataflow.projects.locations.jobs.messages.list"
}
}
}
@@ -743,26 +778,26 @@
"https://www.googleapis.com/auth/userinfo.email"
],
"parameters": {
- "projectId": {
- "description": "Required. The ID of the Cloud Platform project that the job belongs to.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "gcsPath": {
- "location": "query",
- "description": "Required. A Cloud Storage path to the template from which to create\nthe job.\nMust be valid Cloud Storage URL, beginning with 'gs://'.",
- "type": "string"
- },
"location": {
+ "type": "string",
"location": "query",
- "description": "The location to which to direct the request.",
- "type": "string"
+ "description": "The location to which to direct the request."
},
"validateOnly": {
+ "location": "query",
"description": "If true, the request is validated but not actually executed.\nDefaults to false.",
- "type": "boolean",
- "location": "query"
+ "type": "boolean"
+ },
+ "projectId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Required. The ID of the Cloud Platform project that the job belongs to."
+ },
+ "gcsPath": {
+ "type": "string",
+ "location": "query",
+ "description": "Required. A Cloud Storage path to the template from which to create\nthe job.\nMust be valid Cloud Storage URL, beginning with 'gs://'."
}
},
"flatPath": "v1b3/projects/{projectId}/templates:launch",
@@ -785,12 +820,12 @@
],
"parameters": {
"view": {
+ "location": "query",
"enum": [
"METADATA_ONLY"
],
"description": "The view to retrieve. Defaults to METADATA_ONLY.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"projectId": {
"location": "path",
@@ -815,23 +850,26 @@
"description": "Get the template associated with a template."
},
"create": {
+ "flatPath": "v1b3/projects/{projectId}/templates",
+ "path": "v1b3/projects/{projectId}/templates",
+ "id": "dataflow.projects.templates.create",
"description": "Creates a Cloud Dataflow job from a template.",
"request": {
"$ref": "CreateJobFromTemplateRequest"
},
- "response": {
- "$ref": "Job"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"projectId"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "Job"
+ },
"parameters": {
"projectId": {
- "location": "path",
- "description": "Required. The ID of the Cloud Platform project that the job belongs to.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path",
+ "description": "Required. The ID of the Cloud Platform project that the job belongs to."
}
},
"scopes": [
@@ -839,306 +877,21 @@
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly",
"https://www.googleapis.com/auth/userinfo.email"
- ],
- "flatPath": "v1b3/projects/{projectId}/templates",
- "id": "dataflow.projects.templates.create",
- "path": "v1b3/projects/{projectId}/templates"
+ ]
}
}
},
"jobs": {
- "resources": {
- "workItems": {
- "methods": {
- "reportStatus": {
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "jobId"
- ],
- "response": {
- "$ref": "ReportWorkItemStatusResponse"
- },
- "parameters": {
- "jobId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The job which the WorkItem is part of."
- },
- "projectId": {
- "location": "path",
- "description": "The project which owns the WorkItem's job.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:reportStatus",
- "path": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:reportStatus",
- "id": "dataflow.projects.jobs.workItems.reportStatus",
- "description": "Reports the status of dataflow WorkItems leased by a worker.",
- "request": {
- "$ref": "ReportWorkItemStatusRequest"
- }
- },
- "lease": {
- "response": {
- "$ref": "LeaseWorkItemResponse"
- },
- "parameterOrder": [
- "projectId",
- "jobId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "jobId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Identifies the workflow job this worker belongs to."
- },
- "projectId": {
- "location": "path",
- "description": "Identifies the project this worker belongs to.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:lease",
- "id": "dataflow.projects.jobs.workItems.lease",
- "path": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:lease",
- "description": "Leases a dataflow WorkItem to run.",
- "request": {
- "$ref": "LeaseWorkItemRequest"
- }
- }
- }
- },
- "debug": {
- "methods": {
- "sendCapture": {
- "description": "Send encoded debug capture data for component.",
- "request": {
- "$ref": "SendDebugCaptureRequest"
- },
- "response": {
- "$ref": "SendDebugCaptureResponse"
- },
- "parameterOrder": [
- "projectId",
- "jobId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "jobId": {
- "location": "path",
- "description": "The job id.",
- "type": "string",
- "required": true
- },
- "projectId": {
- "description": "The project id.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/debug/sendCapture",
- "id": "dataflow.projects.jobs.debug.sendCapture",
- "path": "v1b3/projects/{projectId}/jobs/{jobId}/debug/sendCapture"
- },
- "getConfig": {
- "response": {
- "$ref": "GetDebugConfigResponse"
- },
- "parameterOrder": [
- "projectId",
- "jobId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "parameters": {
- "jobId": {
- "location": "path",
- "description": "The job id.",
- "type": "string",
- "required": true
- },
- "projectId": {
- "description": "The project id.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/debug/getConfig",
- "id": "dataflow.projects.jobs.debug.getConfig",
- "path": "v1b3/projects/{projectId}/jobs/{jobId}/debug/getConfig",
- "request": {
- "$ref": "GetDebugConfigRequest"
- },
- "description": "Get encoded debug configuration for component. Not cacheable."
- }
- }
- },
- "messages": {
- "methods": {
- "list": {
- "description": "Request the job status.",
- "response": {
- "$ref": "ListJobMessagesResponse"
- },
- "parameterOrder": [
- "projectId",
- "jobId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "parameters": {
- "location": {
- "description": "The location which contains the job specified by job_id.",
- "type": "string",
- "location": "query"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "Return only messages with timestamps \u003c end_time. The default is now\n(i.e. return up to the latest messages available).",
- "type": "string",
- "location": "query"
- },
- "startTime": {
- "format": "google-datetime",
- "description": "If specified, return only messages with timestamps \u003e= start_time.\nThe default is the job creation time (i.e. beginning of messages).",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "description": "If supplied, this should be the value of next_page_token returned\nby an earlier call. This will cause the next page of results to\nbe returned.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "If specified, determines the maximum number of messages to\nreturn. If unspecified, the service may choose an appropriate\ndefault, or may return an arbitrarily large number of results.",
- "type": "integer"
- },
- "minimumImportance": {
- "location": "query",
- "enum": [
- "JOB_MESSAGE_IMPORTANCE_UNKNOWN",
- "JOB_MESSAGE_DEBUG",
- "JOB_MESSAGE_DETAILED",
- "JOB_MESSAGE_BASIC",
- "JOB_MESSAGE_WARNING",
- "JOB_MESSAGE_ERROR"
- ],
- "description": "Filter to only get messages with importance \u003e= level",
- "type": "string"
- },
- "projectId": {
- "location": "path",
- "description": "A project id.",
- "type": "string",
- "required": true
- },
- "jobId": {
- "description": "The job to get messages about.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/messages",
- "id": "dataflow.projects.jobs.messages.list",
- "path": "v1b3/projects/{projectId}/jobs/{jobId}/messages"
- }
- }
- }
- },
"methods": {
- "update": {
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId",
- "jobId"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "location": {
- "description": "The location that contains this job.",
- "type": "string",
- "location": "query"
- },
- "jobId": {
- "location": "path",
- "description": "The job ID.",
- "type": "string",
- "required": true
- },
- "projectId": {
- "location": "path",
- "description": "The ID of the Cloud Platform project that the job belongs to.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}",
- "id": "dataflow.projects.jobs.update",
- "path": "v1b3/projects/{projectId}/jobs/{jobId}",
- "description": "Updates the state of an existing Cloud Dataflow job.",
- "request": {
- "$ref": "Job"
- }
- },
"aggregated": {
- "flatPath": "v1b3/projects/{projectId}/jobs:aggregated",
- "path": "v1b3/projects/{projectId}/jobs:aggregated",
- "id": "dataflow.projects.jobs.aggregated",
"description": "List the jobs of a project across all regions.",
- "httpMethod": "GET",
- "parameterOrder": [
- "projectId"
- ],
"response": {
"$ref": "ListJobsResponse"
},
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
@@ -1146,11 +899,22 @@
"https://www.googleapis.com/auth/userinfo.email"
],
"parameters": {
- "projectId": {
- "location": "path",
- "description": "The project which owns the jobs.",
+ "view": {
"type": "string",
- "required": true
+ "location": "query",
+ "enum": [
+ "JOB_VIEW_UNKNOWN",
+ "JOB_VIEW_SUMMARY",
+ "JOB_VIEW_ALL",
+ "JOB_VIEW_DESCRIPTION"
+ ],
+ "description": "Level of information requested in response. Default is `JOB_VIEW_SUMMARY`."
+ },
+ "projectId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The project which owns the jobs."
},
"filter": {
"location": "query",
@@ -1164,9 +928,45 @@
"type": "string"
},
"location": {
- "description": "The location that contains this job.",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "The location that contains this job."
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Set this to the 'next_page_token' field of a previous response\nto request additional results in a long list."
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "If there are many jobs, limit response to at most this many.\nThe actual number of jobs returned will be the lesser of max_responses\nand an unspecified server-defined limit.",
+ "type": "integer"
+ }
+ },
+ "flatPath": "v1b3/projects/{projectId}/jobs:aggregated",
+ "id": "dataflow.projects.jobs.aggregated",
+ "path": "v1b3/projects/{projectId}/jobs:aggregated"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListJobsResponse"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "parameters": {
+ "location": {
+ "type": "string",
+ "location": "query",
+ "description": "The location that contains this job."
},
"pageToken": {
"location": "query",
@@ -1174,31 +974,10 @@
"type": "string"
},
"pageSize": {
+ "type": "integer",
"location": "query",
"format": "int32",
- "description": "If there are many jobs, limit response to at most this many.\nThe actual number of jobs returned will be the lesser of max_responses\nand an unspecified server-defined limit.",
- "type": "integer"
- },
- "view": {
- "location": "query",
- "enum": [
- "JOB_VIEW_UNKNOWN",
- "JOB_VIEW_SUMMARY",
- "JOB_VIEW_ALL",
- "JOB_VIEW_DESCRIPTION"
- ],
- "description": "Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.",
- "type": "string"
- }
- }
- },
- "list": {
- "parameters": {
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "If there are many jobs, limit response to at most this many.\nThe actual number of jobs returned will be the lesser of max_responses\nand an unspecified server-defined limit.",
- "type": "integer"
+ "description": "If there are many jobs, limit response to at most this many.\nThe actual number of jobs returned will be the lesser of max_responses\nand an unspecified server-defined limit."
},
"view": {
"type": "string",
@@ -1227,37 +1006,21 @@
],
"description": "The kind of filter to use.",
"type": "string"
- },
- "location": {
- "description": "The location that contains this job.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "description": "Set this to the 'next_page_token' field of a previous response\nto request additional results in a long list.",
- "type": "string",
- "location": "query"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
"flatPath": "v1b3/projects/{projectId}/jobs",
- "id": "dataflow.projects.jobs.list",
"path": "v1b3/projects/{projectId}/jobs",
- "description": "List the jobs of a project in a given region.",
- "response": {
- "$ref": "ListJobsResponse"
- },
+ "id": "dataflow.projects.jobs.list",
+ "description": "List the jobs of a project in a given region."
+ },
+ "create": {
+ "httpMethod": "POST",
"parameterOrder": [
"projectId"
],
- "httpMethod": "GET"
- },
- "create": {
+ "response": {
+ "$ref": "Job"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
@@ -1271,11 +1034,12 @@
"type": "string"
},
"replaceJobId": {
- "type": "string",
"location": "query",
- "description": "Deprecated. This field is now in the Job message."
+ "description": "Deprecated. This field is now in the Job message.",
+ "type": "string"
},
"view": {
+ "type": "string",
"location": "query",
"enum": [
"JOB_VIEW_UNKNOWN",
@@ -1283,8 +1047,7 @@
"JOB_VIEW_ALL",
"JOB_VIEW_DESCRIPTION"
],
- "description": "The level of information requested in response.",
- "type": "string"
+ "description": "The level of information requested in response."
},
"projectId": {
"location": "path",
@@ -1294,21 +1057,17 @@
}
},
"flatPath": "v1b3/projects/{projectId}/jobs",
- "id": "dataflow.projects.jobs.create",
"path": "v1b3/projects/{projectId}/jobs",
+ "id": "dataflow.projects.jobs.create",
"request": {
"$ref": "Job"
},
- "description": "Creates a Cloud Dataflow job.",
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST"
+ "description": "Creates a Cloud Dataflow job."
},
"getMetrics": {
+ "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/metrics",
+ "id": "dataflow.projects.jobs.getMetrics",
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}/metrics",
"description": "Request the job status.",
"response": {
"$ref": "JobMetrics"
@@ -1320,10 +1079,10 @@
"httpMethod": "GET",
"parameters": {
"jobId": {
- "location": "path",
- "description": "The job to get messages for.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path",
+ "description": "The job to get messages for."
},
"projectId": {
"location": "path",
@@ -1332,15 +1091,15 @@
"required": true
},
"location": {
+ "type": "string",
"location": "query",
- "description": "The location which contains the job specified by job_id.",
- "type": "string"
+ "description": "The location which contains the job specified by job_id."
},
"startTime": {
+ "type": "string",
"location": "query",
"format": "google-datetime",
- "description": "Return only metric data that has changed since this time.\nDefault is to return all information about all metrics for the job.",
- "type": "string"
+ "description": "Return only metric data that has changed since this time.\nDefault is to return all information about all metrics for the job."
}
},
"scopes": [
@@ -1348,12 +1107,10 @@
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly",
"https://www.googleapis.com/auth/userinfo.email"
- ],
- "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/metrics",
- "id": "dataflow.projects.jobs.getMetrics",
- "path": "v1b3/projects/{projectId}/jobs/{jobId}/metrics"
+ ]
},
"get": {
+ "httpMethod": "GET",
"response": {
"$ref": "Job"
},
@@ -1361,10 +1118,19 @@
"projectId",
"jobId"
],
- "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
"parameters": {
+ "location": {
+ "location": "query",
+ "description": "The location that contains this job.",
+ "type": "string"
+ },
"view": {
- "description": "The level of information requested in response.",
"type": "string",
"location": "query",
"enum": [
@@ -1372,24 +1138,60 @@
"JOB_VIEW_SUMMARY",
"JOB_VIEW_ALL",
"JOB_VIEW_DESCRIPTION"
- ]
+ ],
+ "description": "The level of information requested in response."
},
"jobId": {
- "description": "The job ID.",
"type": "string",
"required": true,
- "location": "path"
+ "location": "path",
+ "description": "The job ID."
},
"projectId": {
+ "type": "string",
+ "required": true,
"location": "path",
- "description": "The ID of the Cloud Platform project that the job belongs to.",
- "type": "string",
- "required": true
- },
+ "description": "The ID of the Cloud Platform project that the job belongs to."
+ }
+ },
+ "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}",
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}",
+ "id": "dataflow.projects.jobs.get",
+ "description": "Gets the state of the specified Cloud Dataflow job."
+ },
+ "update": {
+ "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}",
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}",
+ "id": "dataflow.projects.jobs.update",
+ "description": "Updates the state of an existing Cloud Dataflow job.",
+ "request": {
+ "$ref": "Job"
+ },
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "projectId",
+ "jobId"
+ ],
+ "response": {
+ "$ref": "Job"
+ },
+ "parameters": {
"location": {
+ "location": "query",
"description": "The location that contains this job.",
+ "type": "string"
+ },
+ "jobId": {
"type": "string",
- "location": "query"
+ "required": true,
+ "location": "path",
+ "description": "The job ID."
+ },
+ "projectId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The ID of the Cloud Platform project that the job belongs to."
}
},
"scopes": [
@@ -1397,111 +1199,292 @@
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly",
"https://www.googleapis.com/auth/userinfo.email"
- ],
- "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}",
- "id": "dataflow.projects.jobs.get",
- "path": "v1b3/projects/{projectId}/jobs/{jobId}",
- "description": "Gets the state of the specified Cloud Dataflow job."
+ ]
+ }
+ },
+ "resources": {
+ "workItems": {
+ "methods": {
+ "lease": {
+ "description": "Leases a dataflow WorkItem to run.",
+ "request": {
+ "$ref": "LeaseWorkItemRequest"
+ },
+ "response": {
+ "$ref": "LeaseWorkItemResponse"
+ },
+ "parameterOrder": [
+ "projectId",
+ "jobId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "jobId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Identifies the workflow job this worker belongs to."
+ },
+ "projectId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Identifies the project this worker belongs to."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:lease",
+ "id": "dataflow.projects.jobs.workItems.lease",
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:lease"
+ },
+ "reportStatus": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "jobId"
+ ],
+ "response": {
+ "$ref": "ReportWorkItemStatusResponse"
+ },
+ "parameters": {
+ "jobId": {
+ "location": "path",
+ "description": "The job which the WorkItem is part of.",
+ "type": "string",
+ "required": true
+ },
+ "projectId": {
+ "location": "path",
+ "description": "The project which owns the WorkItem's job.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:reportStatus",
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:reportStatus",
+ "id": "dataflow.projects.jobs.workItems.reportStatus",
+ "description": "Reports the status of dataflow WorkItems leased by a worker.",
+ "request": {
+ "$ref": "ReportWorkItemStatusRequest"
+ }
+ }
+ }
+ },
+ "debug": {
+ "methods": {
+ "sendCapture": {
+ "request": {
+ "$ref": "SendDebugCaptureRequest"
+ },
+ "description": "Send encoded debug capture data for component.",
+ "response": {
+ "$ref": "SendDebugCaptureResponse"
+ },
+ "parameterOrder": [
+ "projectId",
+ "jobId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "parameters": {
+ "jobId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The job id."
+ },
+ "projectId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The project id."
+ }
+ },
+ "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/debug/sendCapture",
+ "id": "dataflow.projects.jobs.debug.sendCapture",
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}/debug/sendCapture"
+ },
+ "getConfig": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "jobId"
+ ],
+ "response": {
+ "$ref": "GetDebugConfigResponse"
+ },
+ "parameters": {
+ "jobId": {
+ "location": "path",
+ "description": "The job id.",
+ "type": "string",
+ "required": true
+ },
+ "projectId": {
+ "location": "path",
+ "description": "The project id.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/debug/getConfig",
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}/debug/getConfig",
+ "id": "dataflow.projects.jobs.debug.getConfig",
+ "description": "Get encoded debug configuration for component. Not cacheable.",
+ "request": {
+ "$ref": "GetDebugConfigRequest"
+ }
+ }
+ }
+ },
+ "messages": {
+ "methods": {
+ "list": {
+ "description": "Request the job status.",
+ "response": {
+ "$ref": "ListJobMessagesResponse"
+ },
+ "parameterOrder": [
+ "projectId",
+ "jobId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "parameters": {
+ "endTime": {
+ "type": "string",
+ "location": "query",
+ "format": "google-datetime",
+ "description": "Return only messages with timestamps \u003c end_time. The default is now\n(i.e. return up to the latest messages available)."
+ },
+ "location": {
+ "type": "string",
+ "location": "query",
+ "description": "The location which contains the job specified by job_id."
+ },
+ "startTime": {
+ "location": "query",
+ "format": "google-datetime",
+ "description": "If specified, return only messages with timestamps \u003e= start_time.\nThe default is the job creation time (i.e. beginning of messages).",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "If supplied, this should be the value of next_page_token returned\nby an earlier call. This will cause the next page of results to\nbe returned.",
+ "type": "string"
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "format": "int32",
+ "description": "If specified, determines the maximum number of messages to\nreturn. If unspecified, the service may choose an appropriate\ndefault, or may return an arbitrarily large number of results."
+ },
+ "minimumImportance": {
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "JOB_MESSAGE_IMPORTANCE_UNKNOWN",
+ "JOB_MESSAGE_DEBUG",
+ "JOB_MESSAGE_DETAILED",
+ "JOB_MESSAGE_BASIC",
+ "JOB_MESSAGE_WARNING",
+ "JOB_MESSAGE_ERROR"
+ ],
+ "description": "Filter to only get messages with importance \u003e= level"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "A project id.",
+ "type": "string",
+ "required": true
+ },
+ "jobId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The job to get messages about."
+ }
+ },
+ "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/messages",
+ "id": "dataflow.projects.jobs.messages.list",
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}/messages"
+ }
+ }
}
}
}
- },
- "methods": {
- "workerMessages": {
- "path": "v1b3/projects/{projectId}/WorkerMessages",
- "id": "dataflow.projects.workerMessages",
- "description": "Send a worker_message to the service.",
- "request": {
- "$ref": "SendWorkerMessagesRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "SendWorkerMessagesResponse"
- },
- "parameters": {
- "projectId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The project to send the WorkerMessages to."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "flatPath": "v1b3/projects/{projectId}/WorkerMessages"
- }
}
}
},
"parameters": {
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
"upload_protocol": {
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string"
},
"prettyPrint": {
+ "location": "query",
"description": "Returns response with indentations and line breaks.",
"default": "true",
- "type": "boolean",
- "location": "query"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
+ "type": "boolean"
},
"fields": {
"location": "query",
"description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
- "callback": {
+ "uploadType": {
+ "type": "string",
"location": "query",
- "description": "JSONP",
- "type": "string"
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
+ },
+ "callback": {
+ "type": "string",
+ "location": "query",
+ "description": "JSONP"
},
"$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
"location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ]
},
"alt": {
+ "default": "json",
"enum": [
"json",
"media",
@@ -1514,1633 +1497,41 @@
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
+ "description": "Data format for response."
},
"key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
+ },
+ "access_token": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth access token."
+ },
+ "quotaUser": {
+ "type": "string",
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth bearer token."
}
},
"schemas": {
- "FloatingPointList": {
- "id": "FloatingPointList",
- "description": "A metric value representing a list of floating point numbers.",
- "type": "object",
- "properties": {
- "elements": {
- "description": "Elements of the list.",
- "items": {
- "type": "number",
- "format": "double"
- },
- "type": "array"
- }
- }
- },
- "CounterUpdate": {
- "type": "object",
- "properties": {
- "distribution": {
- "description": "Distribution data",
- "$ref": "DistributionUpdate"
- },
- "stringList": {
- "$ref": "StringList",
- "description": "List of strings, for Set."
- },
- "shortId": {
- "format": "int64",
- "description": "The service-generated short identifier for this counter.\nThe short_id -\u003e (name, metadata) mapping is constant for the lifetime of\na job.",
- "type": "string"
- },
- "floatingPointList": {
- "$ref": "FloatingPointList",
- "description": "List of floating point numbers, for Set."
- },
- "integer": {
- "description": "Integer value for Sum, Max, Min.",
- "$ref": "SplitInt64"
- },
- "structuredNameAndMetadata": {
- "$ref": "CounterStructuredNameAndMetadata",
- "description": "Counter structured name and metadata."
- },
- "integerList": {
- "description": "List of integers, for Set.",
- "$ref": "IntegerList"
- },
- "integerMean": {
- "$ref": "IntegerMean",
- "description": "Integer mean aggregation value for Mean."
- },
- "floatingPoint": {
- "type": "number",
- "format": "double",
- "description": "Floating point value for Sum, Max, Min."
- },
- "internal": {
- "description": "Value for internally-defined counters used by the Dataflow service.",
- "type": "any"
- },
- "cumulative": {
- "description": "True if this counter is reported as the total cumulative aggregate\nvalue accumulated since the worker started working on this WorkItem.\nBy default this is false, indicating that this counter is reported\nas a delta.",
- "type": "boolean"
- },
- "floatingPointMean": {
- "description": "Floating point mean aggregation value for Mean.",
- "$ref": "FloatingPointMean"
- },
- "boolean": {
- "description": "Boolean value for And, Or.",
- "type": "boolean"
- },
- "nameAndKind": {
- "description": "Counter name and aggregation type.",
- "$ref": "NameAndKind"
- }
- },
- "id": "CounterUpdate",
- "description": "An update to a Counter sent from a worker."
- },
- "SourceMetadata": {
- "description": "Metadata about a Source useful for automatically optimizing\nand tuning the pipeline, etc.",
- "type": "object",
- "properties": {
- "estimatedSizeBytes": {
- "format": "int64",
- "description": "An estimate of the total size (in bytes) of the data that would be\nread from this source. This estimate is in terms of external storage\nsize, before any decompression or other processing done by the reader.",
- "type": "string"
- },
- "infinite": {
- "description": "Specifies that the size of this source is known to be infinite\n(this is a streaming source).",
- "type": "boolean"
- },
- "producesSortedKeys": {
- "type": "boolean",
- "description": "Whether this source is known to produce key/value pairs with\nthe (encoded) keys in lexicographically sorted order."
- }
- },
- "id": "SourceMetadata"
- },
- "DistributionUpdate": {
- "properties": {
- "histogram": {
- "$ref": "Histogram",
- "description": "(Optional) Histogram of value counts for the distribution."
- },
- "max": {
- "description": "The maximum value present in the distribution.",
- "$ref": "SplitInt64"
- },
- "count": {
- "$ref": "SplitInt64",
- "description": "The count of the number of elements present in the distribution."
- },
- "sumOfSquares": {
- "format": "double",
- "description": "Use a double since the sum of squares is likely to overflow int64.",
- "type": "number"
- },
- "min": {
- "$ref": "SplitInt64",
- "description": "The minimum value present in the distribution."
- },
- "sum": {
- "$ref": "SplitInt64",
- "description": "Use an int64 since we'd prefer the added precision. If overflow is a common\nproblem we can detect it and use an additional int64 or a double."
- }
- },
- "id": "DistributionUpdate",
- "description": "A metric value representing a distribution.",
- "type": "object"
- },
- "WorkerHealthReportResponse": {
- "description": "WorkerHealthReportResponse contains information returned to the worker\nin response to a health ping.",
- "type": "object",
- "properties": {
- "reportInterval": {
- "format": "google-duration",
- "description": "A positive value indicates the worker should change its reporting interval\nto the specified value.\n\nThe default value of zero means no change in report rate is requested by\nthe server.",
- "type": "string"
- }
- },
- "id": "WorkerHealthReportResponse"
- },
- "SourceFork": {
- "description": "DEPRECATED in favor of DynamicSourceSplit.",
- "type": "object",
- "properties": {
- "residual": {
- "$ref": "SourceSplitShard",
- "description": "DEPRECATED"
- },
- "residualSource": {
- "$ref": "DerivedSource",
- "description": "DEPRECATED"
- },
- "primary": {
- "$ref": "SourceSplitShard",
- "description": "DEPRECATED"
- },
- "primarySource": {
- "description": "DEPRECATED",
- "$ref": "DerivedSource"
- }
- },
- "id": "SourceFork"
- },
- "WorkItemStatus": {
- "id": "WorkItemStatus",
- "description": "Conveys a worker's progress through the work described by a WorkItem.",
- "type": "object",
- "properties": {
- "reportIndex": {
- "format": "int64",
- "description": "The report index. When a WorkItem is leased, the lease will\ncontain an initial report index. When a WorkItem's status is\nreported to the system, the report should be sent with\nthat report index, and the response will contain the index the\nworker should use for the next report. Reports received with\nunexpected index values will be rejected by the service.\n\nIn order to preserve idempotency, the worker should not alter the\ncontents of a report, even if the worker must submit the same\nreport multiple times before getting back a response. The worker\nshould not submit a subsequent report until the response for the\nprevious report had been received from the service.",
- "type": "string"
- },
- "stopPosition": {
- "$ref": "Position",
- "description": "A worker may split an active map task in two parts, \"primary\" and\n\"residual\", continuing to process the primary part and returning the\nresidual part into the pool of available work.\nThis event is called a \"dynamic split\" and is critical to the dynamic\nwork rebalancing feature. The two obtained sub-tasks are called\n\"parts\" of the split.\nThe parts, if concatenated, must represent the same input as would\nbe read by the current task if the split did not happen.\nThe exact way in which the original task is decomposed into the two\nparts is specified either as a position demarcating them\n(stop_position), or explicitly as two DerivedSources, if this\ntask consumes a user-defined source type (dynamic_source_split).\n\nThe \"current\" task is adjusted as a result of the split: after a task\nwith range [A, B) sends a stop_position update at C, its range is\nconsidered to be [A, C), e.g.:\n* Progress should be interpreted relative to the new range, e.g.\n \"75% completed\" means \"75% of [A, C) completed\"\n* The worker should interpret proposed_stop_position relative to the\n new range, e.g. \"split at 68%\" should be interpreted as\n \"split at 68% of [A, C)\".\n* If the worker chooses to split again using stop_position, only\n stop_positions in [A, C) will be accepted.\n* Etc.\ndynamic_source_split has similar semantics: e.g., if a task with\nsource S splits using dynamic_source_split into {P, R}\n(where P and R must be together equivalent to S), then subsequent\nprogress and proposed_stop_position should be interpreted relative\nto P, and in a potential subsequent dynamic_source_split into {P', R'},\nP' and R' must be together equivalent to P, etc."
- },
- "completed": {
- "description": "True if the WorkItem was completed (successfully or unsuccessfully).",
- "type": "boolean"
- },
- "reportedProgress": {
- "$ref": "ApproximateReportedProgress",
- "description": "The worker's progress through this WorkItem."
- },
- "sourceFork": {
- "description": "DEPRECATED in favor of dynamic_source_split.",
- "$ref": "SourceFork"
- },
- "totalThrottlerWaitTimeSeconds": {
- "format": "double",
- "description": "Total time the worker spent being throttled by external systems.",
- "type": "number"
- },
- "counterUpdates": {
- "description": "Worker output counters for this WorkItem.",
- "items": {
- "$ref": "CounterUpdate"
- },
- "type": "array"
- },
- "workItemId": {
- "description": "Identifies the WorkItem.",
- "type": "string"
- },
- "errors": {
- "description": "Specifies errors which occurred during processing. If errors are\nprovided, and completed = true, then the WorkItem is considered\nto have failed.",
- "items": {
- "$ref": "Status"
- },
- "type": "array"
- },
- "metricUpdates": {
- "description": "DEPRECATED in favor of counter_updates.",
- "items": {
- "$ref": "MetricUpdate"
- },
- "type": "array"
- },
- "dynamicSourceSplit": {
- "description": "See documentation of stop_position.",
- "$ref": "DynamicSourceSplit"
- },
- "sourceOperationResponse": {
- "$ref": "SourceOperationResponse",
- "description": "If the work item represented a SourceOperationRequest, and the work\nis completed, contains the result of the operation."
- },
- "progress": {
- "$ref": "ApproximateProgress",
- "description": "DEPRECATED in favor of reported_progress."
- },
- "requestedLeaseDuration": {
- "format": "google-duration",
- "description": "Amount of time the worker requests for its lease.",
- "type": "string"
- }
- }
- },
- "ComponentSource": {
- "properties": {
- "name": {
- "description": "Dataflow service generated name for this source.",
- "type": "string"
- },
- "userName": {
- "description": "Human-readable name for this transform; may be user or system generated.",
- "type": "string"
- },
- "originalTransformOrCollection": {
- "description": "User name for the original user transform or collection with which this\nsource is most closely associated.",
- "type": "string"
- }
- },
- "id": "ComponentSource",
- "description": "Description of an interstitial value between transforms in an execution\nstage.",
- "type": "object"
- },
- "Histogram": {
- "type": "object",
- "properties": {
- "firstBucketOffset": {
- "type": "integer",
- "format": "int32",
- "description": "Starting index of first stored bucket. The non-inclusive upper-bound of\nthe ith bucket is given by:\n pow(10,(i-first_bucket_offset)/3) * (1,2,5)[(i-first_bucket_offset)%3]"
- },
- "bucketCounts": {
- "description": "Counts of values in each bucket. For efficiency, prefix and trailing\nbuckets with count = 0 are elided. Buckets can store the full range of\nvalues of an unsigned long, with ULLONG_MAX falling into the 59th bucket\nwith range [1e19, 2e19).",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "Histogram",
- "description": "Histogram of value counts for a distribution.\n\nBuckets have an inclusive lower bound and exclusive upper bound and use\n\"1,2,5 bucketing\": The first bucket range is from [0,1) and all subsequent\nbucket boundaries are powers of ten multiplied by 1, 2, or 5. Thus, bucket\nboundaries are 0, 1, 2, 5, 10, 20, 50, 100, 200, 500, 1000, ...\nNegative values are not supported."
- },
- "WorkItemServiceState": {
- "type": "object",
- "properties": {
- "splitRequest": {
- "description": "The progress point in the WorkItem where the Dataflow service\nsuggests that the worker truncate the task.",
- "$ref": "ApproximateSplitRequest"
- },
- "suggestedStopPosition": {
- "$ref": "Position",
- "description": "Obsolete, always empty."
- },
- "reportStatusInterval": {
- "format": "google-duration",
- "description": "New recommended reporting interval.",
- "type": "string"
- },
- "harnessData": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "Other data returned by the service, specific to the particular\nworker harness.",
- "type": "object"
- },
- "leaseExpireTime": {
- "format": "google-datetime",
- "description": "Time at which the current lease will expire.",
- "type": "string"
- },
- "metricShortId": {
- "description": "The short ids that workers should use in subsequent metric updates.\nWorkers should strive to use short ids whenever possible, but it is ok\nto request the short_id again if a worker lost track of it\n(e.g. if the worker is recovering from a crash).\nNOTE: it is possible that the response may have short ids for a subset\nof the metrics.",
- "items": {
- "$ref": "MetricShortId"
- },
- "type": "array"
- },
- "nextReportIndex": {
- "format": "int64",
- "description": "The index value to use for the next report sent by the worker.\nNote: If the report call fails for whatever reason, the worker should\nreuse this index for subsequent report attempts.",
- "type": "string"
- },
- "suggestedStopPoint": {
- "$ref": "ApproximateProgress",
- "description": "DEPRECATED in favor of split_request."
- }
- },
- "id": "WorkItemServiceState",
- "description": "The Dataflow service's idea of the current state of a WorkItem\nbeing processed by a worker."
- },
- "MetricStructuredName": {
- "type": "object",
- "properties": {
- "context": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Zero or more labeled fields which identify the part of the job this\nmetric is associated with, such as the name of a step or collection.\n\nFor example, built-in counters associated with steps will have\ncontext['step'] = \u003cstep-name\u003e. Counters associated with PCollections\nin the SDK will have context['pcollection'] = \u003cpcollection-name\u003e.",
- "type": "object"
- },
- "name": {
- "description": "Worker-defined metric name.",
- "type": "string"
- },
- "origin": {
- "description": "Origin (namespace) of metric name. May be blank for user-define metrics;\nwill be \"dataflow\" for metrics defined by the Dataflow service or SDK.",
- "type": "string"
- }
- },
- "id": "MetricStructuredName",
- "description": "Identifies a metric, by describing the source which generated the\nmetric."
- },
- "SeqMapTaskOutputInfo": {
- "description": "Information about an output of a SeqMapTask.",
- "type": "object",
- "properties": {
- "sink": {
- "$ref": "Sink",
- "description": "The sink to write the output value to."
- },
- "tag": {
- "description": "The id of the TupleTag the user code will tag the output value by.",
- "type": "string"
- }
- },
- "id": "SeqMapTaskOutputInfo"
- },
- "JobExecutionStageInfo": {
- "description": "Contains information about how a particular\ngoogle.dataflow.v1beta3.Step will be executed.",
- "type": "object",
- "properties": {
- "stepName": {
- "description": "The steps associated with the execution stage.\nNote that stages may have several steps, and that a given step\nmight be run by more than one stage.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "JobExecutionStageInfo"
- },
- "KeyRangeLocation": {
- "description": "Location information for a specific key-range of a sharded computation.\nCurrently we only support UTF-8 character splits to simplify encoding into\nJSON.",
- "type": "object",
- "properties": {
- "dataDisk": {
- "description": "The name of the data disk where data for this range is stored.\nThis name is local to the Google Cloud Platform project and uniquely\nidentifies the disk within that project, for example\n\"myproject-1014-104817-4c2-harness-0-disk-1\".",
- "type": "string"
- },
- "start": {
- "description": "The start (inclusive) of the key range.",
- "type": "string"
- },
- "end": {
- "description": "The end (exclusive) of the key range.",
- "type": "string"
- },
- "deprecatedPersistentDirectory": {
- "description": "DEPRECATED. The location of the persistent state for this range, as a\npersistent directory in the worker local filesystem.",
- "type": "string"
- },
- "deliveryEndpoint": {
- "description": "The physical location of this range assignment to be used for\nstreaming computation cross-worker message delivery.",
- "type": "string"
- }
- },
- "id": "KeyRangeLocation"
- },
- "SourceGetMetadataRequest": {
- "description": "A request to compute the SourceMetadata of a Source.",
- "type": "object",
- "properties": {
- "source": {
- "$ref": "Source",
- "description": "Specification of the source whose metadata should be computed."
- }
- },
- "id": "SourceGetMetadataRequest"
- },
- "SeqMapTask": {
- "description": "Describes a particular function to invoke.",
- "type": "object",
- "properties": {
- "outputInfos": {
- "description": "Information about each of the outputs.",
- "items": {
- "$ref": "SeqMapTaskOutputInfo"
- },
- "type": "array"
- },
- "inputs": {
- "description": "Information about each of the inputs.",
- "items": {
- "$ref": "SideInputInfo"
- },
- "type": "array"
- },
- "systemName": {
- "description": "System-defined name of the SeqDo operation.\nUnique across the workflow.",
- "type": "string"
- },
- "stageName": {
- "description": "System-defined name of the stage containing the SeqDo operation.\nUnique across the workflow.",
- "type": "string"
- },
- "userFn": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "The user function to invoke.",
- "type": "object"
- },
- "name": {
- "description": "The user-provided name of the SeqDo operation.",
- "type": "string"
- }
- },
- "id": "SeqMapTask"
- },
- "NameAndKind": {
- "properties": {
- "name": {
- "description": "Name of the counter.",
- "type": "string"
- },
- "kind": {
- "enum": [
- "INVALID",
- "SUM",
- "MAX",
- "MIN",
- "MEAN",
- "OR",
- "AND",
- "SET",
- "DISTRIBUTION"
- ],
- "description": "Counter aggregation kind.",
- "type": "string",
- "enumDescriptions": [
- "Counter aggregation kind was not set.",
- "Aggregated value is the sum of all contributed values.",
- "Aggregated value is the max of all contributed values.",
- "Aggregated value is the min of all contributed values.",
- "Aggregated value is the mean of all contributed values.",
- "Aggregated value represents the logical 'or' of all contributed values.",
- "Aggregated value represents the logical 'and' of all contributed values.",
- "Aggregated value is a set of unique contributed values.",
- "Aggregated value captures statistics about a distribution."
- ]
- }
- },
- "id": "NameAndKind",
- "description": "Basic metadata about a counter.",
- "type": "object"
- },
- "WorkerMessageCode": {
- "type": "object",
- "properties": {
- "code": {
- "description": "The code is a string intended for consumption by a machine that identifies\nthe type of message being sent.\nExamples:\n 1. \"HARNESS_STARTED\" might be used to indicate the worker harness has\n started.\n 2. \"GCS_DOWNLOAD_ERROR\" might be used to indicate an error downloading\n a GCS file as part of the boot process of one of the worker containers.\n\nThis is a string and not an enum to make it easy to add new codes without\nwaiting for an API change.",
- "type": "string"
- },
- "parameters": {
- "description": "Parameters contains specific information about the code.\n\nThis is a struct to allow parameters of different types.\n\nExamples:\n 1. For a \"HARNESS_STARTED\" message parameters might provide the name\n of the worker and additional data like timing information.\n 2. For a \"GCS_DOWNLOAD_ERROR\" parameters might contain fields listing\n the GCS objects being downloaded and fields containing errors.\n\nIn general complex data structures should be avoided. If a worker\nneeds to send a specific and complicated data structure then please\nconsider defining a new proto and adding it to the data oneof in\nWorkerMessageResponse.\n\nConventions:\n Parameters should only be used for information that isn't typically passed\n as a label.\n hostname and other worker identifiers should almost always be passed\n as labels since they will be included on most messages.",
- "type": "object",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object."
- }
- }
- },
- "id": "WorkerMessageCode",
- "description": "A message code is used to report status and error messages to the service.\nThe message codes are intended to be machine readable. The service will\ntake care of translating these into user understandable messages if\nnecessary.\n\nExample use cases:\n 1. Worker processes reporting successful startup.\n 2. Worker processes reporting specific errors (e.g. package staging\n failure)."
- },
- "CustomSourceLocation": {
- "description": "Identifies the location of a custom souce.",
- "type": "object",
- "properties": {
- "stateful": {
- "description": "Whether this source is stateful.",
- "type": "boolean"
- }
- },
- "id": "CustomSourceLocation"
- },
- "MapTask": {
- "description": "MapTask consists of an ordered set of instructions, each of which\ndescribes one particular low-level operation for the worker to\nperform in order to accomplish the MapTask's WorkItem.\n\nEach instruction must appear in the list before any instructions which\ndepends on its output.",
- "type": "object",
- "properties": {
- "instructions": {
- "description": "The instructions in the MapTask.",
- "items": {
- "$ref": "ParallelInstruction"
- },
- "type": "array"
- },
- "stageName": {
- "description": "System-defined name of the stage containing this MapTask.\nUnique across the workflow.",
- "type": "string"
- },
- "systemName": {
- "description": "System-defined name of this MapTask.\nUnique across the workflow.",
- "type": "string"
- }
- },
- "id": "MapTask"
- },
- "FloatingPointMean": {
- "type": "object",
- "properties": {
- "count": {
- "$ref": "SplitInt64",
- "description": "The number of values being aggregated."
- },
- "sum": {
- "format": "double",
- "description": "The sum of all values being aggregated.",
- "type": "number"
- }
- },
- "id": "FloatingPointMean",
- "description": "A representation of a floating point mean metric contribution."
- },
- "ReportWorkItemStatusResponse": {
- "description": "Response from a request to report the status of WorkItems.",
- "type": "object",
- "properties": {
- "workItemServiceStates": {
- "description": "A set of messages indicating the service-side state for each\nWorkItem whose status was reported, in the same order as the\nWorkItemStatus messages in the ReportWorkItemStatusRequest which\nresulting in this response.",
- "items": {
- "$ref": "WorkItemServiceState"
- },
- "type": "array"
- }
- },
- "id": "ReportWorkItemStatusResponse"
- },
- "InstructionOutput": {
- "description": "An output of an instruction.",
- "type": "object",
- "properties": {
- "onlyCountValueBytes": {
- "description": "For system-generated byte and mean byte metrics, certain instructions\nshould only report the value size.",
- "type": "boolean"
- },
- "codec": {
- "description": "The codec to use to encode data being written via this output.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- }
- },
- "name": {
- "description": "The user-provided name of this output.",
- "type": "string"
- },
- "originalName": {
- "description": "System-defined name for this output in the original workflow graph.\nOutputs that do not contribute to an original instruction do not set this.",
- "type": "string"
- },
- "systemName": {
- "type": "string",
- "description": "System-defined name of this output.\nUnique across the workflow."
- },
- "onlyCountKeyBytes": {
- "description": "For system-generated byte and mean byte metrics, certain instructions\nshould only report the key size.",
- "type": "boolean"
- }
- },
- "id": "InstructionOutput"
- },
- "CreateJobFromTemplateRequest": {
- "id": "CreateJobFromTemplateRequest",
- "description": "A request to create a Cloud Dataflow job from a template.",
- "type": "object",
- "properties": {
- "location": {
- "description": "The location to which to direct the request.",
- "type": "string"
- },
- "parameters": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "The runtime parameters to pass to the job.",
- "type": "object"
- },
- "jobName": {
- "description": "Required. The job name to use for the created job.",
- "type": "string"
- },
- "gcsPath": {
- "description": "Required. A Cloud Storage path to the template from which to\ncreate the job.\nMust be a valid Cloud Storage URL, beginning with `gs://`.",
- "type": "string"
- },
- "environment": {
- "$ref": "RuntimeEnvironment",
- "description": "The runtime environment for the job."
- }
- }
- },
- "IntegerMean": {
- "description": "A representation of an integer mean metric contribution.",
- "type": "object",
- "properties": {
- "sum": {
- "$ref": "SplitInt64",
- "description": "The sum of all values being aggregated."
- },
- "count": {
- "description": "The number of values being aggregated.",
- "$ref": "SplitInt64"
- }
- },
- "id": "IntegerMean"
- },
- "ListJobsResponse": {
- "description": "Response to a request to list Cloud Dataflow jobs. This may be a partial\nresponse, depending on the page size in the ListJobsRequest.",
- "type": "object",
- "properties": {
- "jobs": {
- "items": {
- "$ref": "Job"
- },
- "type": "array",
- "description": "A subset of the requested job information."
- },
- "failedLocation": {
- "description": "Zero or more messages describing locations that failed to respond.",
- "items": {
- "$ref": "FailedLocation"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "Set if there may be more results than fit in this response.",
- "type": "string"
- }
- },
- "id": "ListJobsResponse"
- },
- "ComputationTopology": {
- "type": "object",
- "properties": {
- "systemStageName": {
- "description": "The system stage name.",
- "type": "string"
- },
- "computationId": {
- "description": "The ID of the computation.",
- "type": "string"
- },
- "inputs": {
- "description": "The inputs to the computation.",
- "items": {
- "$ref": "StreamLocation"
- },
- "type": "array"
- },
- "keyRanges": {
- "description": "The key ranges processed by the computation.",
- "items": {
- "$ref": "KeyRangeLocation"
- },
- "type": "array"
- },
- "stateFamilies": {
- "description": "The state family values.",
- "items": {
- "$ref": "StateFamilyConfig"
- },
- "type": "array"
- },
- "outputs": {
- "description": "The outputs from the computation.",
- "items": {
- "$ref": "StreamLocation"
- },
- "type": "array"
- }
- },
- "id": "ComputationTopology",
- "description": "All configuration data for a particular Computation."
- },
- "RuntimeEnvironment": {
- "properties": {
- "zone": {
- "description": "The Compute Engine [availability\nzone](https://cloud.google.com/compute/docs/regions-zones/regions-zones)\nfor launching worker instances to run your pipeline.",
- "type": "string"
- },
- "maxWorkers": {
- "format": "int32",
- "description": "The maximum number of Google Compute Engine instances to be made\navailable to your pipeline during execution, from 1 to 1000.",
- "type": "integer"
- },
- "serviceAccountEmail": {
- "description": "The email address of the service account to run the job as.",
- "type": "string"
- },
- "tempLocation": {
- "description": "The Cloud Storage path to use for temporary files.\nMust be a valid Cloud Storage URL, beginning with `gs://`.",
- "type": "string"
- },
- "bypassTempDirValidation": {
- "description": "Whether to bypass the safety checks for the job's temporary directory.\nUse with caution.",
- "type": "boolean"
- },
- "machineType": {
- "description": "The machine type to use for the job. Defaults to the value from the\ntemplate if not specified.",
- "type": "string"
- }
- },
- "id": "RuntimeEnvironment",
- "description": "The environment values to set at runtime.",
- "type": "object"
- },
- "MountedDataDisk": {
- "description": "Describes mounted data disk.",
- "type": "object",
- "properties": {
- "dataDisk": {
- "description": "The name of the data disk.\nThis name is local to the Google Cloud Platform project and uniquely\nidentifies the disk within that project, for example\n\"myproject-1014-104817-4c2-harness-0-disk-1\".",
- "type": "string"
- }
- },
- "id": "MountedDataDisk"
- },
- "StreamingSideInputLocation": {
- "id": "StreamingSideInputLocation",
- "description": "Identifies the location of a streaming side input.",
- "type": "object",
- "properties": {
- "tag": {
- "description": "Identifies the particular side input within the streaming Dataflow job.",
- "type": "string"
- },
- "stateFamily": {
- "description": "Identifies the state family where this side input is stored.",
- "type": "string"
- }
- }
- },
- "LaunchTemplateResponse": {
- "description": "Response to the request to launch a template.",
- "type": "object",
- "properties": {
- "job": {
- "$ref": "Job",
- "description": "The job that was launched, if the request was not a dry run and\nthe job was successfully launched."
- }
- },
- "id": "LaunchTemplateResponse"
- },
- "Job": {
- "description": "Defines a job to be run by the Cloud Dataflow service.",
- "type": "object",
- "properties": {
- "currentStateTime": {
- "format": "google-datetime",
- "description": "The timestamp associated with the current state.",
- "type": "string"
- },
- "transformNameMapping": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "The map of transform name prefixes of the job to be replaced to the\ncorresponding name prefixes of the new job.",
- "type": "object"
- },
- "createTime": {
- "format": "google-datetime",
- "description": "The timestamp when the job was initially created. Immutable and set by the\nCloud Dataflow service.",
- "type": "string"
- },
- "environment": {
- "$ref": "Environment",
- "description": "The environment for the job."
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "User-defined labels for this job.\n\nThe labels map can contain no more than 64 entries. Entries of the labels\nmap are UTF8 strings that comply with the following restrictions:\n\n* Keys must conform to regexp: \\p{Ll}\\p{Lo}{0,62}\n* Values must conform to regexp: [\\p{Ll}\\p{Lo}\\p{N}_-]{0,63}\n* Both keys and values are additionally constrained to be \u003c= 128 bytes in\nsize.",
- "type": "object"
- },
- "stageStates": {
- "description": "This field may be mutated by the Cloud Dataflow service;\ncallers cannot mutate it.",
- "items": {
- "$ref": "ExecutionStageState"
- },
- "type": "array"
- },
- "type": {
- "description": "The type of Cloud Dataflow job.",
- "type": "string",
- "enumDescriptions": [
- "The type of the job is unspecified, or unknown.",
- "A batch job with a well-defined end point: data is read, data is\nprocessed, data is written, and the job is done.",
- "A continuously streaming job with no end: data is read,\nprocessed, and written continuously."
- ],
- "enum": [
- "JOB_TYPE_UNKNOWN",
- "JOB_TYPE_BATCH",
- "JOB_TYPE_STREAMING"
- ]
- },
- "projectId": {
- "description": "The ID of the Cloud Platform project that the job belongs to.",
- "type": "string"
- },
- "pipelineDescription": {
- "description": "Preliminary field: The format of this data may change at any time.\nA description of the user pipeline and stages through which it is executed.\nCreated by Cloud Dataflow service. Only retrieved with\nJOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.",
- "$ref": "PipelineDescription"
- },
- "replaceJobId": {
- "description": "If this job is an update of an existing job, this field is the job ID\nof the job it replaced.\n\nWhen sending a `CreateJobRequest`, you can update a job by specifying it\nhere. The job named here is stopped, and its intermediate state is\ntransferred to this job.",
- "type": "string"
- },
- "requestedState": {
- "enumDescriptions": [
- "The job's run state isn't specified.",
- "`JOB_STATE_STOPPED` indicates that the job has not\nyet started to run.",
- "`JOB_STATE_RUNNING` indicates that the job is currently running.",
- "`JOB_STATE_DONE` indicates that the job has successfully completed.\nThis is a terminal job state. This state may be set by the Cloud Dataflow\nservice, as a transition from `JOB_STATE_RUNNING`. It may also be set via a\nCloud Dataflow `UpdateJob` call, if the job has not yet reached a terminal\nstate.",
- "`JOB_STATE_FAILED` indicates that the job has failed. This is a\nterminal job state. This state may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_RUNNING`.",
- "`JOB_STATE_CANCELLED` indicates that the job has been explicitly\ncancelled. This is a terminal job state. This state may only be\nset via a Cloud Dataflow `UpdateJob` call, and only if the job has not\nyet reached another terminal state.",
- "`JOB_STATE_UPDATED` indicates that the job was successfully updated,\nmeaning that this job was stopped and another job was started, inheriting\nstate from this one. This is a terminal job state. This state may only be\nset by the Cloud Dataflow service, and only as a transition from\n`JOB_STATE_RUNNING`.",
- "`JOB_STATE_DRAINING` indicates that the job is in the process of draining.\nA draining job has stopped pulling from its input sources and is processing\nany data that remains in-flight. This state may be set via a Cloud Dataflow\n`UpdateJob` call, but only as a transition from `JOB_STATE_RUNNING`. Jobs\nthat are draining may only transition to `JOB_STATE_DRAINED`,\n`JOB_STATE_CANCELLED`, or `JOB_STATE_FAILED`.",
- "`JOB_STATE_DRAINED` indicates that the job has been drained.\nA drained job terminated by stopping pulling from its input sources and\nprocessing any data that remained in-flight when draining was requested.\nThis state is a terminal state, may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_DRAINING`.",
- "'JOB_STATE_PENDING' indicates that the job has been created but is not yet\nrunning. Jobs that are pending may only transition to `JOB_STATE_RUNNING`,\nor `JOB_STATE_FAILED`.",
- "'JOB_STATE_CANCELLING' indicates that the job has been explicitly cancelled\nand is in the process of stopping. Jobs that are cancelling may only\ntransition to 'JOB_STATE_CANCELLED' or 'JOB_STATE_FAILED'."
- ],
- "enum": [
- "JOB_STATE_UNKNOWN",
- "JOB_STATE_STOPPED",
- "JOB_STATE_RUNNING",
- "JOB_STATE_DONE",
- "JOB_STATE_FAILED",
- "JOB_STATE_CANCELLED",
- "JOB_STATE_UPDATED",
- "JOB_STATE_DRAINING",
- "JOB_STATE_DRAINED",
- "JOB_STATE_PENDING",
- "JOB_STATE_CANCELLING"
- ],
- "description": "The job's requested state.\n\n`UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and\n`JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may\nalso be used to directly set a job's requested state to\n`JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the\njob if it has not already reached a terminal state.",
- "type": "string"
- },
- "tempFiles": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "A set of files the system should be aware of that are used\nfor temporary storage. These temporary files will be\nremoved on job completion.\nNo duplicates are allowed.\nNo file patterns are supported.\n\nThe supported files are:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}"
- },
- "clientRequestId": {
- "description": "The client's unique identifier of the job, re-used across retried attempts.\nIf this field is set, the service will ensure its uniqueness.\nThe request to create a job will fail if the service has knowledge of a\npreviously submitted job with the same client's ID and job name.\nThe caller may use this field to ensure idempotence of job\ncreation across retried attempts to create a job.\nBy default, the field is empty and, in that case, the service ignores it.",
- "type": "string"
- },
- "name": {
- "description": "The user-specified Cloud Dataflow job name.\n\nOnly one Job with a given name may exist in a project at any\ngiven time. If a caller attempts to create a Job with the same\nname as an already-existing Job, the attempt returns the\nexisting Job.\n\nThe name must match the regular expression\n`[a-z]([-a-z0-9]{0,38}[a-z0-9])?`",
- "type": "string"
- },
- "steps": {
- "description": "The top-level steps that constitute the entire job.",
- "items": {
- "$ref": "Step"
- },
- "type": "array"
- },
- "replacedByJobId": {
- "description": "If another job is an update of this job (and thus, this job is in\n`JOB_STATE_UPDATED`), this field contains the ID of that job.",
- "type": "string"
- },
- "executionInfo": {
- "description": "Deprecated.",
- "$ref": "JobExecutionInfo"
- },
- "id": {
- "description": "The unique ID of this job.\n\nThis field is set by the Cloud Dataflow service when the Job is\ncreated, and is immutable for the life of the job.",
- "type": "string"
- },
- "currentState": {
- "description": "The current state of the job.\n\nJobs are created in the `JOB_STATE_STOPPED` state unless otherwise\nspecified.\n\nA job in the `JOB_STATE_RUNNING` state may asynchronously enter a\nterminal state. After a job has reached a terminal state, no\nfurther state updates may be made.\n\nThis field may be mutated by the Cloud Dataflow service;\ncallers cannot mutate it.",
- "type": "string",
- "enumDescriptions": [
- "The job's run state isn't specified.",
- "`JOB_STATE_STOPPED` indicates that the job has not\nyet started to run.",
- "`JOB_STATE_RUNNING` indicates that the job is currently running.",
- "`JOB_STATE_DONE` indicates that the job has successfully completed.\nThis is a terminal job state. This state may be set by the Cloud Dataflow\nservice, as a transition from `JOB_STATE_RUNNING`. It may also be set via a\nCloud Dataflow `UpdateJob` call, if the job has not yet reached a terminal\nstate.",
- "`JOB_STATE_FAILED` indicates that the job has failed. This is a\nterminal job state. This state may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_RUNNING`.",
- "`JOB_STATE_CANCELLED` indicates that the job has been explicitly\ncancelled. This is a terminal job state. This state may only be\nset via a Cloud Dataflow `UpdateJob` call, and only if the job has not\nyet reached another terminal state.",
- "`JOB_STATE_UPDATED` indicates that the job was successfully updated,\nmeaning that this job was stopped and another job was started, inheriting\nstate from this one. This is a terminal job state. This state may only be\nset by the Cloud Dataflow service, and only as a transition from\n`JOB_STATE_RUNNING`.",
- "`JOB_STATE_DRAINING` indicates that the job is in the process of draining.\nA draining job has stopped pulling from its input sources and is processing\nany data that remains in-flight. This state may be set via a Cloud Dataflow\n`UpdateJob` call, but only as a transition from `JOB_STATE_RUNNING`. Jobs\nthat are draining may only transition to `JOB_STATE_DRAINED`,\n`JOB_STATE_CANCELLED`, or `JOB_STATE_FAILED`.",
- "`JOB_STATE_DRAINED` indicates that the job has been drained.\nA drained job terminated by stopping pulling from its input sources and\nprocessing any data that remained in-flight when draining was requested.\nThis state is a terminal state, may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_DRAINING`.",
- "'JOB_STATE_PENDING' indicates that the job has been created but is not yet\nrunning. Jobs that are pending may only transition to `JOB_STATE_RUNNING`,\nor `JOB_STATE_FAILED`.",
- "'JOB_STATE_CANCELLING' indicates that the job has been explicitly cancelled\nand is in the process of stopping. Jobs that are cancelling may only\ntransition to 'JOB_STATE_CANCELLED' or 'JOB_STATE_FAILED'."
- ],
- "enum": [
- "JOB_STATE_UNKNOWN",
- "JOB_STATE_STOPPED",
- "JOB_STATE_RUNNING",
- "JOB_STATE_DONE",
- "JOB_STATE_FAILED",
- "JOB_STATE_CANCELLED",
- "JOB_STATE_UPDATED",
- "JOB_STATE_DRAINING",
- "JOB_STATE_DRAINED",
- "JOB_STATE_PENDING",
- "JOB_STATE_CANCELLING"
- ]
- },
- "location": {
- "description": "The location that contains this job.",
- "type": "string"
- }
- },
- "id": "Job"
- },
- "DynamicSourceSplit": {
- "description": "When a task splits using WorkItemStatus.dynamic_source_split, this\nmessage describes the two parts of the split relative to the\ndescription of the current task's input.",
- "type": "object",
- "properties": {
- "residual": {
- "description": "Residual part (returned to the pool of work).\nSpecified relative to the previously-current source.",
- "$ref": "DerivedSource"
- },
- "primary": {
- "description": "Primary part (continued to be processed by worker).\nSpecified relative to the previously-current source.\nBecomes current.",
- "$ref": "DerivedSource"
- }
- },
- "id": "DynamicSourceSplit"
- },
- "DerivedSource": {
- "description": "Specification of one of the bundles produced as a result of splitting\na Source (e.g. when executing a SourceSplitRequest, or when\nsplitting an active task using WorkItemStatus.dynamic_source_split),\nrelative to the source being split.",
- "type": "object",
- "properties": {
- "derivationMode": {
- "description": "What source to base the produced source on (if any).",
- "type": "string",
- "enumDescriptions": [
- "The source derivation is unknown, or unspecified.",
- "Produce a completely independent Source with no base.",
- "Produce a Source based on the Source being split.",
- "Produce a Source based on the base of the Source being split."
- ],
- "enum": [
- "SOURCE_DERIVATION_MODE_UNKNOWN",
- "SOURCE_DERIVATION_MODE_INDEPENDENT",
- "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT",
- "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT"
- ]
- },
- "source": {
- "description": "Specification of the source.",
- "$ref": "Source"
- }
- },
- "id": "DerivedSource"
- },
- "SideInputId": {
- "description": "Uniquely identifies a side input.",
- "type": "object",
- "properties": {
- "inputIndex": {
- "format": "int32",
- "description": "The index of the side input, from the list of non_parallel_inputs.",
- "type": "integer"
- },
- "declaringStepName": {
- "description": "The step that receives and usually consumes this side input.",
- "type": "string"
- }
- },
- "id": "SideInputId"
- },
- "SourceOperationResponse": {
- "description": "The result of a SourceOperationRequest, specified in\nReportWorkItemStatusRequest.source_operation when the work item\nis completed.",
- "type": "object",
- "properties": {
- "getMetadata": {
- "$ref": "SourceGetMetadataResponse",
- "description": "A response to a request to get metadata about a source."
- },
- "split": {
- "$ref": "SourceSplitResponse",
- "description": "A response to a request to split a source."
- }
- },
- "id": "SourceOperationResponse"
- },
- "SideInputInfo": {
- "description": "Information about a side input of a DoFn or an input of a SeqDoFn.",
- "type": "object",
- "properties": {
- "tag": {
- "description": "The id of the tag the user code will access this side input by;\nthis should correspond to the tag of some MultiOutputInfo.",
- "type": "string"
- },
- "kind": {
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object."
- },
- "description": "How to interpret the source element(s) as a side input value.",
- "type": "object"
- },
- "sources": {
- "description": "The source(s) to read element(s) from to get the value of this side input.\nIf more than one source, then the elements are taken from the\nsources, in the specified order if order matters.\nAt least one source is required.",
- "items": {
- "$ref": "Source"
- },
- "type": "array"
- }
- },
- "id": "SideInputInfo"
- },
- "SendDebugCaptureResponse": {
- "description": "Response to a send capture request.\nnothing",
- "type": "object",
- "properties": {},
- "id": "SendDebugCaptureResponse"
- },
- "WriteInstruction": {
- "description": "An instruction that writes records.\nTakes one input, produces no outputs.",
- "type": "object",
- "properties": {
- "input": {
- "$ref": "InstructionInput",
- "description": "The input."
- },
- "sink": {
- "description": "The sink to write to.",
- "$ref": "Sink"
- }
- },
- "id": "WriteInstruction"
- },
- "ConcatPosition": {
- "properties": {
- "position": {
- "description": "Position within the inner source.",
- "$ref": "Position"
- },
- "index": {
- "format": "int32",
- "description": "Index of the inner source.",
- "type": "integer"
- }
- },
- "id": "ConcatPosition",
- "description": "A position that encapsulates an inner position and an index for the inner\nposition. A ConcatPosition can be used by a reader of a source that\nencapsulates a set of other sources.",
- "type": "object"
- },
- "CounterStructuredNameAndMetadata": {
- "type": "object",
- "properties": {
- "metadata": {
- "description": "Metadata associated with a counter",
- "$ref": "CounterMetadata"
- },
- "name": {
- "description": "Structured name of the counter.",
- "$ref": "CounterStructuredName"
- }
- },
- "id": "CounterStructuredNameAndMetadata",
- "description": "A single message which encapsulates structured name and metadata for a given\ncounter."
- },
- "StreamingComputationRanges": {
- "type": "object",
- "properties": {
- "computationId": {
- "description": "The ID of the computation.",
- "type": "string"
- },
- "rangeAssignments": {
- "description": "Data disk assignments for ranges from this computation.",
- "items": {
- "$ref": "KeyRangeDataDiskAssignment"
- },
- "type": "array"
- }
- },
- "id": "StreamingComputationRanges",
- "description": "Describes full or partial data disk assignment information of the computation\nranges."
- },
- "AutoscalingSettings": {
- "properties": {
- "algorithm": {
- "enum": [
- "AUTOSCALING_ALGORITHM_UNKNOWN",
- "AUTOSCALING_ALGORITHM_NONE",
- "AUTOSCALING_ALGORITHM_BASIC"
- ],
- "description": "The algorithm to use for autoscaling.",
- "type": "string",
- "enumDescriptions": [
- "The algorithm is unknown, or unspecified.",
- "Disable autoscaling.",
- "Increase worker count over time to reduce job execution time."
- ]
- },
- "maxNumWorkers": {
- "format": "int32",
- "description": "The maximum number of workers to cap scaling at.",
- "type": "integer"
- }
- },
- "id": "AutoscalingSettings",
- "description": "Settings for WorkerPool autoscaling.",
- "type": "object"
- },
- "ExecutionStageSummary": {
- "description": "Description of the composing transforms, names/ids, and input/outputs of a\nstage of execution. Some composing transforms and sources may have been\ngenerated by the Dataflow service during execution planning.",
- "type": "object",
- "properties": {
- "componentSource": {
- "description": "Collections produced and consumed by component transforms of this stage.",
- "items": {
- "$ref": "ComponentSource"
- },
- "type": "array"
- },
- "kind": {
- "enumDescriptions": [
- "Unrecognized transform type.",
- "ParDo transform.",
- "Group By Key transform.",
- "Flatten transform.",
- "Read transform.",
- "Write transform.",
- "Constructs from a constant value, such as with Create.of.",
- "Creates a Singleton view of a collection.",
- "Opening or closing a shuffle session, often as part of a GroupByKey."
- ],
- "enum": [
- "UNKNOWN_KIND",
- "PAR_DO_KIND",
- "GROUP_BY_KEY_KIND",
- "FLATTEN_KIND",
- "READ_KIND",
- "WRITE_KIND",
- "CONSTANT_KIND",
- "SINGLETON_KIND",
- "SHUFFLE_KIND"
- ],
- "description": "Type of tranform this stage is executing.",
- "type": "string"
- },
- "outputSource": {
- "items": {
- "$ref": "StageSource"
- },
- "type": "array",
- "description": "Output sources for this stage."
- },
- "name": {
- "description": "Dataflow service generated name for this stage.",
- "type": "string"
- },
- "inputSource": {
- "description": "Input sources for this stage.",
- "items": {
- "$ref": "StageSource"
- },
- "type": "array"
- },
- "id": {
- "type": "string",
- "description": "Dataflow service generated id for this stage."
- },
- "componentTransform": {
- "description": "Transforms that comprise this execution stage.",
- "items": {
- "$ref": "ComponentTransform"
- },
- "type": "array"
- }
- },
- "id": "ExecutionStageSummary"
- },
- "SendWorkerMessagesRequest": {
- "type": "object",
- "properties": {
- "workerMessages": {
- "description": "The WorkerMessages to send.",
- "items": {
- "$ref": "WorkerMessage"
- },
- "type": "array"
- },
- "location": {
- "type": "string",
- "description": "The location which contains the job"
- }
- },
- "id": "SendWorkerMessagesRequest",
- "description": "A request for sending worker messages to the service."
- },
- "SourceSplitShard": {
- "description": "DEPRECATED in favor of DerivedSource.",
- "type": "object",
- "properties": {
- "derivationMode": {
- "description": "DEPRECATED",
- "type": "string",
- "enumDescriptions": [
- "The source derivation is unknown, or unspecified.",
- "Produce a completely independent Source with no base.",
- "Produce a Source based on the Source being split.",
- "Produce a Source based on the base of the Source being split."
- ],
- "enum": [
- "SOURCE_DERIVATION_MODE_UNKNOWN",
- "SOURCE_DERIVATION_MODE_INDEPENDENT",
- "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT",
- "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT"
- ]
- },
- "source": {
- "$ref": "Source",
- "description": "DEPRECATED"
- }
- },
- "id": "SourceSplitShard"
- },
- "CPUTime": {
- "description": "Modeled after information exposed by /proc/stat.",
- "type": "object",
- "properties": {
- "timestamp": {
- "format": "google-datetime",
- "description": "Timestamp of the measurement.",
- "type": "string"
- },
- "totalMs": {
- "format": "uint64",
- "description": "Total active CPU time across all cores (ie., non-idle) in milliseconds\nsince start-up.",
- "type": "string"
- },
- "rate": {
- "format": "double",
- "description": "Average CPU utilization rate (% non-idle cpu / second) since previous\nsample.",
- "type": "number"
- }
- },
- "id": "CPUTime"
- },
- "Environment": {
- "description": "Describes the environment in which a Dataflow Job runs.",
- "type": "object",
- "properties": {
- "userAgent": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "A description of the process that generated the request.",
- "type": "object"
- },
- "sdkPipelineOptions": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "The Cloud Dataflow SDK pipeline options specified by the user. These\noptions are passed through the service and are used to recreate the\nSDK pipeline options on the worker in a language agnostic and platform\nindependent way.",
- "type": "object"
- },
- "clusterManagerApiService": {
- "description": "The type of cluster manager API to use. If unknown or\nunspecified, the service will attempt to choose a reasonable\ndefault. This should be in the form of the API service name,\ne.g. \"compute.googleapis.com\".",
- "type": "string"
- },
- "tempStoragePrefix": {
- "description": "The prefix of the resources the system should use for temporary\nstorage. The system will append the suffix \"/temp-{JOBNAME} to\nthis resource prefix, where {JOBNAME} is the value of the\njob_name field. The resulting bucket and object prefix is used\nas the prefix of the resources used to store temporary data\nneeded during the job execution. NOTE: This will override the\nvalue in taskrunner_settings.\nThe supported resource type is:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}",
- "type": "string"
- },
- "workerPools": {
- "description": "The worker pools. At least one \"harness\" worker pool must be\nspecified in order for the job to have workers.",
- "items": {
- "$ref": "WorkerPool"
- },
- "type": "array"
- },
- "dataset": {
- "description": "The dataset for the current project where various workflow\nrelated tables are stored.\n\nThe supported resource type is:\n\nGoogle BigQuery:\n bigquery.googleapis.com/{dataset}",
- "type": "string"
- },
- "experiments": {
- "description": "The list of experiments to enable.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "internalExperiments": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Experimental settings."
- },
- "version": {
- "description": "A structure describing which components and their versions of the service\nare required in order to run the job.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- }
- },
- "serviceAccountEmail": {
- "description": "Identity to run virtual machines as. Defaults to the default account.",
- "type": "string"
- }
- },
- "id": "Environment"
- },
- "StreamingComputationTask": {
- "description": "A task which describes what action should be performed for the specified\nstreaming computation ranges.",
- "type": "object",
- "properties": {
- "computationRanges": {
- "description": "Contains ranges of a streaming computation this task should apply to.",
- "items": {
- "$ref": "StreamingComputationRanges"
- },
- "type": "array"
- },
- "dataDisks": {
- "description": "Describes the set of data disks this task should apply to.",
- "items": {
- "$ref": "MountedDataDisk"
- },
- "type": "array"
- },
- "taskType": {
- "enum": [
- "STREAMING_COMPUTATION_TASK_UNKNOWN",
- "STREAMING_COMPUTATION_TASK_STOP",
- "STREAMING_COMPUTATION_TASK_START"
- ],
- "description": "A type of streaming computation task.",
- "type": "string",
- "enumDescriptions": [
- "The streaming computation task is unknown, or unspecified.",
- "Stop processing specified streaming computation range(s).",
- "Start processing specified streaming computation range(s)."
- ]
- }
- },
- "id": "StreamingComputationTask"
- },
- "SendDebugCaptureRequest": {
- "description": "Request to send encoded debug information.",
- "type": "object",
- "properties": {
- "componentId": {
- "description": "The internal component id for which debug information is sent.",
- "type": "string"
- },
- "workerId": {
- "description": "The worker id, i.e., VM hostname.",
- "type": "string"
- },
- "location": {
- "description": "The location which contains the job specified by job_id.",
- "type": "string"
- },
- "data": {
- "description": "The encoded debug information.",
- "type": "string"
- }
- },
- "id": "SendDebugCaptureRequest"
- },
- "GetDebugConfigResponse": {
- "description": "Response to a get debug configuration request.",
- "type": "object",
- "properties": {
- "config": {
- "description": "The encoded debug configuration for the requested component.",
- "type": "string"
- }
- },
- "id": "GetDebugConfigResponse"
- },
- "ComponentTransform": {
- "description": "Description of a transform executed as part of an execution stage.",
- "type": "object",
- "properties": {
- "userName": {
- "type": "string",
- "description": "Human-readable name for this transform; may be user or system generated."
- },
- "originalTransform": {
- "description": "User name for the original user transform with which this transform is\nmost closely associated.",
- "type": "string"
- },
- "name": {
- "description": "Dataflow service generated name for this source.",
- "type": "string"
- }
- },
- "id": "ComponentTransform"
- },
- "StreamingSetupTask": {
- "description": "A task which initializes part of a streaming Dataflow job.",
- "type": "object",
- "properties": {
- "streamingComputationTopology": {
- "$ref": "TopologyConfig",
- "description": "The global topology of the streaming Dataflow job."
- },
- "drain": {
- "description": "The user has requested drain.",
- "type": "boolean"
- },
- "workerHarnessPort": {
- "format": "int32",
- "description": "The TCP port used by the worker to communicate with the Dataflow\nworker harness.",
- "type": "integer"
- },
- "receiveWorkPort": {
- "format": "int32",
- "description": "The TCP port on which the worker should listen for messages from\nother streaming computation workers.",
- "type": "integer"
- }
- },
- "id": "StreamingSetupTask"
- },
- "PubsubLocation": {
- "description": "Identifies a pubsub location to use for transferring data into or\nout of a streaming Dataflow job.",
- "type": "object",
- "properties": {
- "withAttributes": {
- "description": "If true, then the client has requested to get pubsub attributes.",
- "type": "boolean"
- },
- "idLabel": {
- "description": "If set, contains a pubsub label from which to extract record ids.\nIf left empty, record deduplication will be strictly best effort.",
- "type": "string"
- },
- "topic": {
- "description": "A pubsub topic, in the form of\n\"pubsub.googleapis.com/topics/\u003cproject-id\u003e/\u003ctopic-name\u003e\"",
- "type": "string"
- },
- "timestampLabel": {
- "description": "If set, contains a pubsub label from which to extract record timestamps.\nIf left empty, record timestamps will be generated upon arrival.",
- "type": "string"
- },
- "subscription": {
- "description": "A pubsub subscription, in the form of\n\"pubsub.googleapis.com/subscriptions/\u003cproject-id\u003e/\u003csubscription-name\u003e\"",
- "type": "string"
- },
- "dropLateData": {
- "description": "Indicates whether the pipeline allows late-arriving data.",
- "type": "boolean"
- },
- "trackingSubscription": {
- "description": "If set, specifies the pubsub subscription that will be used for tracking\ncustom time timestamps for watermark estimation.",
- "type": "string"
- }
- },
- "id": "PubsubLocation"
- },
- "WorkerHealthReport": {
- "description": "WorkerHealthReport contains information about the health of a worker.\n\nThe VM should be identified by the labels attached to the WorkerMessage that\nthis health ping belongs to.",
- "type": "object",
- "properties": {
- "reportInterval": {
- "format": "google-duration",
- "description": "The interval at which the worker is sending health reports.\nThe default value of 0 should be interpreted as the field is not being\nexplicitly set by the worker.",
- "type": "string"
- },
- "vmIsHealthy": {
- "description": "Whether the VM is healthy.",
- "type": "boolean"
- },
- "pods": {
- "description": "The pods running on the worker. See:\nhttp://kubernetes.io/v1.1/docs/api-reference/v1/definitions.html#_v1_pod\n\nThis field is used by the worker to send the status of the indvidual\ncontainers running on each worker.",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "type": "object"
- },
- "type": "array"
- },
- "vmStartupTime": {
- "format": "google-datetime",
- "description": "The time the VM was booted.",
- "type": "string"
- }
- },
- "id": "WorkerHealthReport"
- },
- "JobMessage": {
- "type": "object",
- "properties": {
- "id": {
- "description": "Deprecated.",
- "type": "string"
- },
- "messageImportance": {
- "description": "Importance level of the message.",
- "type": "string",
- "enumDescriptions": [
- "The message importance isn't specified, or is unknown.",
- "The message is at the 'debug' level: typically only useful for\nsoftware engineers working on the code the job is running.\nTypically, Dataflow pipeline runners do not display log messages\nat this level by default.",
- "The message is at the 'detailed' level: somewhat verbose, but\npotentially useful to users. Typically, Dataflow pipeline\nrunners do not display log messages at this level by default.\nThese messages are displayed by default in the Dataflow\nmonitoring UI.",
- "The message is at the 'basic' level: useful for keeping\ntrack of the execution of a Dataflow pipeline. Typically,\nDataflow pipeline runners display log messages at this level by\ndefault, and these messages are displayed by default in the\nDataflow monitoring UI.",
- "The message is at the 'warning' level: indicating a condition\npertaining to a job which may require human intervention.\nTypically, Dataflow pipeline runners display log messages at this\nlevel by default, and these messages are displayed by default in\nthe Dataflow monitoring UI.",
- "The message is at the 'error' level: indicating a condition\npreventing a job from succeeding. Typically, Dataflow pipeline\nrunners display log messages at this level by default, and these\nmessages are displayed by default in the Dataflow monitoring UI."
- ],
- "enum": [
- "JOB_MESSAGE_IMPORTANCE_UNKNOWN",
- "JOB_MESSAGE_DEBUG",
- "JOB_MESSAGE_DETAILED",
- "JOB_MESSAGE_BASIC",
- "JOB_MESSAGE_WARNING",
- "JOB_MESSAGE_ERROR"
- ]
- },
- "messageText": {
- "description": "The text of the message.",
- "type": "string"
- },
- "time": {
- "format": "google-datetime",
- "description": "The timestamp of the message.",
- "type": "string"
- }
- },
- "id": "JobMessage",
- "description": "A particular message pertaining to a Dataflow job."
- },
- "ParameterMetadata": {
- "description": "Metadata for a specific parameter.",
- "type": "object",
- "properties": {
- "helpText": {
- "description": "Required. The help text to display for the parameter.",
- "type": "string"
- },
- "isOptional": {
- "description": "Optional. Whether the parameter is optional. Defaults to false.",
- "type": "boolean"
- },
- "name": {
- "description": "Required. The name of the parameter.",
- "type": "string"
- },
- "regexes": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "Optional. Regexes that the parameter must match."
- },
- "label": {
- "description": "Required. The label to display for the parameter.",
- "type": "string"
- }
- },
- "id": "ParameterMetadata"
- },
"MultiOutputInfo": {
"description": "Information about an output of a multi-output DoFn.",
"type": "object",
@@ -3157,8 +1548,8 @@
"type": "object",
"properties": {
"options": {
- "description": "Hints for tuning the splitting process.",
- "$ref": "SourceSplitOptions"
+ "$ref": "SourceSplitOptions",
+ "description": "Hints for tuning the splitting process."
},
"source": {
"$ref": "Source",
@@ -3172,8 +1563,8 @@
"type": "object",
"properties": {
"metadata": {
- "description": "The computed metadata.",
- "$ref": "SourceMetadata"
+ "$ref": "SourceMetadata",
+ "description": "The computed metadata."
}
},
"id": "SourceGetMetadataResponse"
@@ -3188,19 +1579,20 @@
"type": "integer"
},
"command": {
- "type": "string",
- "description": "The shell command to run."
+ "description": "The shell command to run.",
+ "type": "string"
}
},
"id": "ShellTask"
},
"MetricShortId": {
+ "description": "The metric short id is returned to the user alongside an offset into\nReportWorkItemStatusRequest",
"type": "object",
"properties": {
"metricIndex": {
+ "type": "integer",
"format": "int32",
- "description": "The index of the corresponding metric in\nthe ReportWorkItemStatusRequest. Required.",
- "type": "integer"
+ "description": "The index of the corresponding metric in\nthe ReportWorkItemStatusRequest. Required."
},
"shortId": {
"format": "int64",
@@ -3208,13 +1600,13 @@
"type": "string"
}
},
- "id": "MetricShortId",
- "description": "The metric short id is returned to the user alongside an offset into\nReportWorkItemStatusRequest"
+ "id": "MetricShortId"
},
"AutoscalingEvent": {
"type": "object",
"properties": {
"eventType": {
+ "type": "string",
"enumDescriptions": [
"Default type for the enum. Value should never be returned.",
"The TARGET_NUM_WORKERS_CHANGED type should be used when the target\nworker pool size has changed at the start of an actuation. An event\nshould always be specified as TARGET_NUM_WORKERS_CHANGED if it reflects\na change in the target_num_workers.",
@@ -3229,8 +1621,7 @@
"ACTUATION_FAILURE",
"NO_CHANGE"
],
- "description": "The type of autoscaling event to report.",
- "type": "string"
+ "description": "The type of autoscaling event to report."
},
"targetNumWorkers": {
"format": "int64",
@@ -3238,9 +1629,9 @@
"type": "string"
},
"currentNumWorkers": {
+ "type": "string",
"format": "int64",
- "description": "The current number of workers the job has.",
- "type": "string"
+ "description": "The current number of workers the job has."
},
"time": {
"type": "string",
@@ -3256,36 +1647,23 @@
"description": "A structured message reporting an autoscaling decision made by the Dataflow\nservice."
},
"TaskRunnerSettings": {
- "description": "Taskrunner configuration settings.",
"type": "object",
"properties": {
- "vmId": {
- "description": "The ID string of the VM.",
- "type": "string"
- },
- "taskUser": {
- "description": "The UNIX user ID on the worker VM to use for tasks launched by\ntaskrunner; e.g. \"root\".",
- "type": "string"
- },
- "alsologtostderr": {
- "description": "Whether to also send taskrunner log info to stderr.",
- "type": "boolean"
- },
"taskGroup": {
- "description": "The UNIX group ID on the worker VM to use for tasks launched by\ntaskrunner; e.g. \"wheel\".",
- "type": "string"
+ "type": "string",
+ "description": "The UNIX group ID on the worker VM to use for tasks launched by\ntaskrunner; e.g. \"wheel\"."
},
"harnessCommand": {
- "description": "The command to launch the worker harness.",
- "type": "string"
+ "type": "string",
+ "description": "The command to launch the worker harness."
},
"logDir": {
- "description": "The directory on the VM to store logs.",
- "type": "string"
+ "type": "string",
+ "description": "The directory on the VM to store logs."
},
"dataflowApiVersion": {
- "description": "The API version of endpoint, e.g. \"v1b3\"",
- "type": "string"
+ "type": "string",
+ "description": "The API version of endpoint, e.g. \"v1b3\""
},
"oauthScopes": {
"description": "The OAuth2 scopes to be requested by the taskrunner in order to\naccess the Cloud Dataflow API.",
@@ -3294,81 +1672,94 @@
},
"type": "array"
},
- "streamingWorkerMainClass": {
- "description": "The streaming worker main class name.",
- "type": "string"
- },
"logUploadLocation": {
"description": "Indicates where to put logs. If this is not specified, the logs\nwill not be uploaded.\n\nThe supported resource type is:\n\nGoogle Cloud Storage:\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}",
"type": "string"
},
+ "streamingWorkerMainClass": {
+ "description": "The streaming worker main class name.",
+ "type": "string"
+ },
"workflowFileName": {
"description": "The file to store the workflow in.",
"type": "string"
},
"languageHint": {
- "description": "The suggested backend language.",
- "type": "string"
- },
- "commandlinesFileName": {
- "description": "The file to store preprocessing commands in.",
- "type": "string"
+ "type": "string",
+ "description": "The suggested backend language."
},
"baseTaskDir": {
- "description": "The location on the worker for task-specific subdirectories.",
- "type": "string"
+ "type": "string",
+ "description": "The location on the worker for task-specific subdirectories."
},
"tempStoragePrefix": {
- "description": "The prefix of the resources the taskrunner should use for\ntemporary storage.\n\nThe supported resource type is:\n\nGoogle Cloud Storage:\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}",
- "type": "string"
+ "type": "string",
+ "description": "The prefix of the resources the taskrunner should use for\ntemporary storage.\n\nThe supported resource type is:\n\nGoogle Cloud Storage:\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}"
+ },
+ "commandlinesFileName": {
+ "type": "string",
+ "description": "The file to store preprocessing commands in."
},
"baseUrl": {
"description": "The base URL for the taskrunner to use when accessing Google Cloud APIs.\n\nWhen workers access Google Cloud APIs, they logically do so via\nrelative URLs. If this field is specified, it supplies the base\nURL to use for resolving these relative URLs. The normative\nalgorithm used is defined by RFC 1808, \"Relative Uniform Resource\nLocators\".\n\nIf not specified, the default value is \"http://www.googleapis.com/\"",
"type": "string"
},
"logToSerialconsole": {
- "description": "Whether to send taskrunner log info to Google Compute Engine VM serial\nconsole.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "Whether to send taskrunner log info to Google Compute Engine VM serial\nconsole."
},
"continueOnException": {
- "description": "Whether to continue taskrunner if an exception is hit.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "Whether to continue taskrunner if an exception is hit."
},
"parallelWorkerSettings": {
"$ref": "WorkerSettings",
"description": "The settings to pass to the parallel worker harness."
+ },
+ "taskUser": {
+ "description": "The UNIX user ID on the worker VM to use for tasks launched by\ntaskrunner; e.g. \"root\".",
+ "type": "string"
+ },
+ "vmId": {
+ "type": "string",
+ "description": "The ID string of the VM."
+ },
+ "alsologtostderr": {
+ "type": "boolean",
+ "description": "Whether to also send taskrunner log info to stderr."
}
},
- "id": "TaskRunnerSettings"
+ "id": "TaskRunnerSettings",
+ "description": "Taskrunner configuration settings."
},
"Position": {
"description": "Position defines a position within a collection of data. The value\ncan be either the end position, a key (used with ordered\ncollections), a byte offset, or a record index.",
"type": "object",
"properties": {
- "recordIndex": {
- "format": "int64",
- "description": "Position is a record index.",
- "type": "string"
- },
"shufflePosition": {
- "description": "CloudPosition is a base64 encoded BatchShufflePosition (with FIXED\nsharding).",
- "type": "string"
- },
- "byteOffset": {
- "format": "int64",
- "description": "Position is a byte offset.",
- "type": "string"
+ "type": "string",
+ "description": "CloudPosition is a base64 encoded BatchShufflePosition (with FIXED\nsharding)."
},
"concatPosition": {
"$ref": "ConcatPosition",
"description": "CloudPosition is a concat position."
},
+ "byteOffset": {
+ "type": "string",
+ "format": "int64",
+ "description": "Position is a byte offset."
+ },
"end": {
- "description": "Position is past all other positions. Also useful for the end\nposition of an unbounded range.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "Position is past all other positions. Also useful for the end\nposition of an unbounded range."
},
"key": {
- "description": "Position is a string key, ordered lexicographically.",
+ "type": "string",
+ "description": "Position is a string key, ordered lexicographically."
+ },
+ "recordIndex": {
+ "format": "int64",
+ "description": "Position is a record index.",
"type": "string"
}
},
@@ -3379,9 +1770,9 @@
"type": "object",
"properties": {
"lowBits": {
+ "type": "integer",
"format": "uint32",
- "description": "The low order bits: n & 0xffffffff.",
- "type": "integer"
+ "description": "The low order bits: n & 0xffffffff."
},
"highBits": {
"format": "int32",
@@ -3392,80 +1783,55 @@
"id": "SplitInt64"
},
"Source": {
+ "description": "A source that records can be read and decoded from.",
+ "type": "object",
"properties": {
"metadata": {
"$ref": "SourceMetadata",
"description": "Optionally, metadata for this source can be supplied right away,\navoiding a SourceGetMetadataOperation roundtrip\n(see SourceOperationRequest).\n\nThis field is meaningful only in the Source objects populated\nby the user (e.g. when filling in a DerivedSource).\nSource objects supplied by the framework to the user don't have\nthis field populated."
},
"baseSpecs": {
- "description": "While splitting, sources may specify the produced bundles\nas differences against another source, in order to save backend-side\nmemory and allow bigger jobs. For details, see SourceSplitRequest.\nTo support this use case, the full set of parameters of the source\nis logically obtained by taking the latest explicitly specified value\nof each parameter in the order:\nbase_specs (later items win), spec (overrides anything in base_specs).",
"items": {
+ "type": "object",
"additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "type": "object"
+ "type": "any",
+ "description": "Properties of the object."
+ }
},
- "type": "array"
+ "type": "array",
+ "description": "While splitting, sources may specify the produced bundles\nas differences against another source, in order to save backend-side\nmemory and allow bigger jobs. For details, see SourceSplitRequest.\nTo support this use case, the full set of parameters of the source\nis logically obtained by taking the latest explicitly specified value\nof each parameter in the order:\nbase_specs (later items win), spec (overrides anything in base_specs)."
},
"doesNotNeedSplitting": {
- "type": "boolean",
- "description": "Setting this value to true hints to the framework that the source\ndoesn't need splitting, and using SourceSplitRequest on it would\nyield SOURCE_SPLIT_OUTCOME_USE_CURRENT.\n\nE.g. a file splitter may set this to true when splitting a single file\ninto a set of byte ranges of appropriate size, and set this\nto false when splitting a filepattern into individual files.\nHowever, for efficiency, a file splitter may decide to produce\nfile subranges directly from the filepattern to avoid a splitting\nround-trip.\n\nSee SourceSplitRequest for an overview of the splitting process.\n\nThis field is meaningful only in the Source objects populated\nby the user (e.g. when filling in a DerivedSource).\nSource objects supplied by the framework to the user don't have\nthis field populated."
+ "description": "Setting this value to true hints to the framework that the source\ndoesn't need splitting, and using SourceSplitRequest on it would\nyield SOURCE_SPLIT_OUTCOME_USE_CURRENT.\n\nE.g. a file splitter may set this to true when splitting a single file\ninto a set of byte ranges of appropriate size, and set this\nto false when splitting a filepattern into individual files.\nHowever, for efficiency, a file splitter may decide to produce\nfile subranges directly from the filepattern to avoid a splitting\nround-trip.\n\nSee SourceSplitRequest for an overview of the splitting process.\n\nThis field is meaningful only in the Source objects populated\nby the user (e.g. when filling in a DerivedSource).\nSource objects supplied by the framework to the user don't have\nthis field populated.",
+ "type": "boolean"
},
"codec": {
"additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
+ "type": "any",
+ "description": "Properties of the object."
},
"description": "The codec to use to decode data read from the source.",
"type": "object"
},
"spec": {
- "description": "The source to read from, plus its parameters.",
- "type": "object",
"additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- }
+ "type": "any",
+ "description": "Properties of the object."
+ },
+ "description": "The source to read from, plus its parameters.",
+ "type": "object"
}
},
- "id": "Source",
- "description": "A source that records can be read and decoded from.",
- "type": "object"
+ "id": "Source"
},
"WorkerPool": {
- "description": "Describes one particular pool of Cloud Dataflow workers to be\ninstantiated by the Cloud Dataflow service in order to perform the\ncomputations required by a job. Note that a workflow job may use\nmultiple pools, in order to match the various computational\nrequirements of the various stages of the job.",
"type": "object",
"properties": {
- "workerHarnessContainerImage": {
- "description": "Required. Docker container image that executes the Cloud Dataflow worker\nharness, residing in Google Container Registry.",
- "type": "string"
- },
- "machineType": {
- "description": "Machine type (e.g. \"n1-standard-1\"). If empty or unspecified, the\nservice will attempt to choose a reasonable default.",
- "type": "string"
- },
- "diskType": {
- "description": "Type of root disk for VMs. If empty or unspecified, the service will\nattempt to choose a reasonable default.",
- "type": "string"
- },
- "kind": {
- "description": "The kind of the worker pool; currently only `harness` and `shuffle`\nare supported.",
- "type": "string"
- },
- "dataDisks": {
- "description": "Data disks that are used by a VM in this workflow.",
- "items": {
- "$ref": "Disk"
- },
- "type": "array"
- },
"subnetwork": {
"description": "Subnetwork to which VMs will be assigned, if desired. Expected to be of\nthe form \"regions/REGION/subnetworks/SUBNETWORK\".",
"type": "string"
},
"ipConfiguration": {
- "description": "Configuration for VM IPs.",
"type": "string",
"enumDescriptions": [
"The configuration is unknown, or unspecified.",
@@ -3476,15 +1842,16 @@
"WORKER_IP_UNSPECIFIED",
"WORKER_IP_PUBLIC",
"WORKER_IP_PRIVATE"
- ]
+ ],
+ "description": "Configuration for VM IPs."
},
"taskrunnerSettings": {
"$ref": "TaskRunnerSettings",
"description": "Settings passed through to Google Compute Engine workers when\nusing the standard Dataflow task runner. Users should ignore\nthis field."
},
"autoscalingSettings": {
- "description": "Settings for autoscaling of this WorkerPool.",
- "$ref": "AutoscalingSettings"
+ "$ref": "AutoscalingSettings",
+ "description": "Settings for autoscaling of this WorkerPool."
},
"metadata": {
"type": "object",
@@ -3493,7 +1860,17 @@
},
"description": "Metadata to set on the Google Compute Engine VMs."
},
+ "network": {
+ "type": "string",
+ "description": "Network to which VMs will be assigned. If empty or unspecified,\nthe service will use the network \"default\"."
+ },
"defaultPackageSet": {
+ "enum": [
+ "DEFAULT_PACKAGE_SET_UNKNOWN",
+ "DEFAULT_PACKAGE_SET_NONE",
+ "DEFAULT_PACKAGE_SET_JAVA",
+ "DEFAULT_PACKAGE_SET_PYTHON"
+ ],
"description": "The default package set to install. This allows the service to\nselect a default set of packages which are useful to worker\nharnesses written in a particular language.",
"type": "string",
"enumDescriptions": [
@@ -3501,26 +1878,16 @@
"Indicates that no packages should be staged at the worker unless\nexplicitly specified by the job.",
"Stage packages typically useful to workers written in Java.",
"Stage pacakges typically useful to workers written in Python."
- ],
- "enum": [
- "DEFAULT_PACKAGE_SET_UNKNOWN",
- "DEFAULT_PACKAGE_SET_NONE",
- "DEFAULT_PACKAGE_SET_JAVA",
- "DEFAULT_PACKAGE_SET_PYTHON"
]
},
- "network": {
- "description": "Network to which VMs will be assigned. If empty or unspecified,\nthe service will use the network \"default\".",
- "type": "string"
- },
- "numWorkers": {
+ "numThreadsPerWorker": {
"type": "integer",
"format": "int32",
- "description": "Number of Google Compute Engine workers in this pool needed to\nexecute the job. If zero or unspecified, the service will\nattempt to choose a reasonable default."
+ "description": "The number of threads per worker harness. If empty or unspecified, the\nservice will choose a number of threads (according to the number of cores\non the selected machine type for batch, or 1 by convention for streaming)."
},
- "numThreadsPerWorker": {
+ "numWorkers": {
"format": "int32",
- "description": "The number of threads per worker harness. If empty or unspecified, the\nservice will choose a number of threads (according to the number of cores\non the selected machine type for batch, or 1 by convention for streaming).",
+ "description": "Number of Google Compute Engine workers in this pool needed to\nexecute the job. If zero or unspecified, the service will\nattempt to choose a reasonable default.",
"type": "integer"
},
"zone": {
@@ -3528,23 +1895,17 @@
"type": "string"
},
"diskSourceImage": {
- "description": "Fully qualified source image for disks.",
- "type": "string"
+ "type": "string",
+ "description": "Fully qualified source image for disks."
},
"packages": {
- "description": "Packages to be installed on workers.",
"items": {
"$ref": "Package"
},
- "type": "array"
+ "type": "array",
+ "description": "Packages to be installed on workers."
},
"teardownPolicy": {
- "enumDescriptions": [
- "The teardown policy isn't specified, or is unknown.",
- "Always teardown the resource.",
- "Teardown the resource on success. This is useful for debugging\nfailures.",
- "Never teardown the resource. This is useful for debugging and\ndevelopment."
- ],
"enum": [
"TEARDOWN_POLICY_UNKNOWN",
"TEARDOWN_ALWAYS",
@@ -3552,11 +1913,17 @@
"TEARDOWN_NEVER"
],
"description": "Sets the policy for determining when to turndown worker pool.\nAllowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and\n`TEARDOWN_NEVER`.\n`TEARDOWN_ALWAYS` means workers are always torn down regardless of whether\nthe job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down\nif the job succeeds. `TEARDOWN_NEVER` means the workers are never torn\ndown.\n\nIf the workers are not torn down by the service, they will\ncontinue to run and use Google Compute Engine VM resources in the\nuser's project until they are explicitly terminated by the user.\nBecause of this, Google recommends using the `TEARDOWN_ALWAYS`\npolicy except for small, manually supervised test jobs.\n\nIf unknown or unspecified, the service will attempt to choose a reasonable\ndefault.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "The teardown policy isn't specified, or is unknown.",
+ "Always teardown the resource.",
+ "Teardown the resource on success. This is useful for debugging\nfailures.",
+ "Never teardown the resource. This is useful for debugging and\ndevelopment."
+ ]
},
"onHostMaintenance": {
- "description": "The action to take on host maintenance, as defined by the Google\nCompute Engine API.",
- "type": "string"
+ "type": "string",
+ "description": "The action to take on host maintenance, as defined by the Google\nCompute Engine API."
},
"poolArgs": {
"additionalProperties": {
@@ -3570,102 +1937,59 @@
"format": "int32",
"description": "Size of root disk for VMs, in GB. If zero or unspecified, the service will\nattempt to choose a reasonable default.",
"type": "integer"
+ },
+ "workerHarnessContainerImage": {
+ "type": "string",
+ "description": "Required. Docker container image that executes the Cloud Dataflow worker\nharness, residing in Google Container Registry."
+ },
+ "machineType": {
+ "description": "Machine type (e.g. \"n1-standard-1\"). If empty or unspecified, the\nservice will attempt to choose a reasonable default.",
+ "type": "string"
+ },
+ "diskType": {
+ "type": "string",
+ "description": "Type of root disk for VMs. If empty or unspecified, the service will\nattempt to choose a reasonable default."
+ },
+ "kind": {
+ "description": "The kind of the worker pool; currently only `harness` and `shuffle`\nare supported.",
+ "type": "string"
+ },
+ "dataDisks": {
+ "items": {
+ "$ref": "Disk"
+ },
+ "type": "array",
+ "description": "Data disks that are used by a VM in this workflow."
}
},
- "id": "WorkerPool"
+ "id": "WorkerPool",
+ "description": "Describes one particular pool of Cloud Dataflow workers to be\ninstantiated by the Cloud Dataflow service in order to perform the\ncomputations required by a job. Note that a workflow job may use\nmultiple pools, in order to match the various computational\nrequirements of the various stages of the job."
},
"SourceOperationRequest": {
- "id": "SourceOperationRequest",
- "description": "A work item that represents the different operations that can be\nperformed on a user-defined Source specification.",
"type": "object",
"properties": {
"split": {
- "description": "Information about a request to split a source.",
- "$ref": "SourceSplitRequest"
+ "$ref": "SourceSplitRequest",
+ "description": "Information about a request to split a source."
},
"getMetadata": {
- "description": "Information about a request to get metadata about a source.",
- "$ref": "SourceGetMetadataRequest"
- }
- }
- },
- "StructuredMessage": {
- "description": "A rich message format, including a human readable string, a key for\nidentifying the message, and structured data associated with the message for\nprogrammatic consumption.",
- "type": "object",
- "properties": {
- "messageKey": {
- "description": "Idenfier for this message type. Used by external systems to\ninternationalize or personalize message.",
- "type": "string"
- },
- "messageText": {
- "description": "Human-readable version of message.",
- "type": "string"
- },
- "parameters": {
- "description": "The structured data associated with this message.",
- "items": {
- "$ref": "Parameter"
- },
- "type": "array"
+ "$ref": "SourceGetMetadataRequest",
+ "description": "Information about a request to get metadata about a source."
}
},
- "id": "StructuredMessage"
+ "id": "SourceOperationRequest",
+ "description": "A work item that represents the different operations that can be\nperformed on a user-defined Source specification."
},
"WorkItem": {
- "description": "WorkItem represents basic information about a WorkItem to be executed\nin the cloud.",
"type": "object",
"properties": {
- "reportStatusInterval": {
- "format": "google-duration",
- "description": "Recommended reporting interval.",
- "type": "string"
- },
- "streamingSetupTask": {
- "$ref": "StreamingSetupTask",
- "description": "Additional information for StreamingSetupTask WorkItems."
- },
- "sourceOperationTask": {
- "$ref": "SourceOperationRequest",
- "description": "Additional information for source operation WorkItems."
- },
- "leaseExpireTime": {
- "format": "google-datetime",
- "description": "Time when the lease on this Work will expire.",
- "type": "string"
- },
- "streamingConfigTask": {
- "description": "Additional information for StreamingConfigTask WorkItems.",
- "$ref": "StreamingConfigTask"
- },
- "initialReportIndex": {
- "format": "int64",
- "description": "The initial index to use when reporting the status of the WorkItem.",
- "type": "string"
- },
- "shellTask": {
- "description": "Additional information for ShellTask WorkItems.",
- "$ref": "ShellTask"
- },
- "streamingComputationTask": {
- "description": "Additional information for StreamingComputationTask WorkItems.",
- "$ref": "StreamingComputationTask"
- },
- "jobId": {
- "description": "Identifies the workflow job this WorkItem belongs to.",
- "type": "string"
- },
- "id": {
- "type": "string",
- "format": "int64",
- "description": "Identifies this WorkItem."
- },
"configuration": {
- "description": "Work item-specific configuration as an opaque blob.",
- "type": "string"
+ "type": "string",
+ "description": "Work item-specific configuration as an opaque blob."
},
"mapTask": {
- "description": "Additional information for MapTask WorkItems.",
- "$ref": "MapTask"
+ "$ref": "MapTask",
+ "description": "Additional information for MapTask WorkItems."
},
"seqMapTask": {
"$ref": "SeqMapTask",
@@ -3679,13 +2003,97 @@
"type": "array"
},
"projectId": {
+ "description": "Identifies the cloud project this WorkItem belongs to.",
+ "type": "string"
+ },
+ "sourceOperationTask": {
+ "$ref": "SourceOperationRequest",
+ "description": "Additional information for source operation WorkItems."
+ },
+ "streamingSetupTask": {
+ "$ref": "StreamingSetupTask",
+ "description": "Additional information for StreamingSetupTask WorkItems."
+ },
+ "reportStatusInterval": {
+ "format": "google-duration",
+ "description": "Recommended reporting interval.",
+ "type": "string"
+ },
+ "streamingConfigTask": {
+ "$ref": "StreamingConfigTask",
+ "description": "Additional information for StreamingConfigTask WorkItems."
+ },
+ "leaseExpireTime": {
"type": "string",
- "description": "Identifies the cloud project this WorkItem belongs to."
+ "format": "google-datetime",
+ "description": "Time when the lease on this Work will expire."
+ },
+ "initialReportIndex": {
+ "format": "int64",
+ "description": "The initial index to use when reporting the status of the WorkItem.",
+ "type": "string"
+ },
+ "shellTask": {
+ "$ref": "ShellTask",
+ "description": "Additional information for ShellTask WorkItems."
+ },
+ "streamingComputationTask": {
+ "$ref": "StreamingComputationTask",
+ "description": "Additional information for StreamingComputationTask WorkItems."
+ },
+ "jobId": {
+ "description": "Identifies the workflow job this WorkItem belongs to.",
+ "type": "string"
+ },
+ "id": {
+ "type": "string",
+ "format": "int64",
+ "description": "Identifies this WorkItem."
}
},
- "id": "WorkItem"
+ "id": "WorkItem",
+ "description": "WorkItem represents basic information about a WorkItem to be executed\nin the cloud."
+ },
+ "StructuredMessage": {
+ "type": "object",
+ "properties": {
+ "messageKey": {
+ "type": "string",
+ "description": "Idenfier for this message type. Used by external systems to\ninternationalize or personalize message."
+ },
+ "messageText": {
+ "description": "Human-readable version of message.",
+ "type": "string"
+ },
+ "parameters": {
+ "items": {
+ "$ref": "Parameter"
+ },
+ "type": "array",
+ "description": "The structured data associated with this message."
+ }
+ },
+ "id": "StructuredMessage",
+ "description": "A rich message format, including a human readable string, a key for\nidentifying the message, and structured data associated with the message for\nprogrammatic consumption."
+ },
+ "ReportedParallelism": {
+ "description": "Represents the level of parallelism in a WorkItem's input,\nreported by the worker.",
+ "type": "object",
+ "properties": {
+ "isInfinite": {
+ "type": "boolean",
+ "description": "Specifies whether the parallelism is infinite. If true, \"value\" is\nignored.\nInfinite parallelism means the service will assume that the work item\ncan always be split into more non-empty work items by dynamic splitting.\nThis is a work-around for lack of support for infinity by the current\nJSON-based Java RPC stack."
+ },
+ "value": {
+ "format": "double",
+ "description": "Specifies the level of parallelism in case it is finite.",
+ "type": "number"
+ }
+ },
+ "id": "ReportedParallelism"
},
"ResourceUtilizationReport": {
+ "type": "object",
"properties": {
"cpuTime": {
"items": {
@@ -3696,36 +2104,17 @@
}
},
"id": "ResourceUtilizationReport",
- "description": "Worker metrics exported from workers. This contains resource utilization\nmetrics accumulated from a variety of sources. For more information, see\ngo/df-resource-signals.",
- "type": "object"
- },
- "ReportedParallelism": {
- "properties": {
- "isInfinite": {
- "description": "Specifies whether the parallelism is infinite. If true, \"value\" is\nignored.\nInfinite parallelism means the service will assume that the work item\ncan always be split into more non-empty work items by dynamic splitting.\nThis is a work-around for lack of support for infinity by the current\nJSON-based Java RPC stack.",
- "type": "boolean"
- },
- "value": {
- "format": "double",
- "description": "Specifies the level of parallelism in case it is finite.",
- "type": "number"
- }
- },
- "id": "ReportedParallelism",
- "description": "Represents the level of parallelism in a WorkItem's input,\nreported by the worker.",
- "type": "object"
+ "description": "Worker metrics exported from workers. This contains resource utilization\nmetrics accumulated from a variety of sources. For more information, see\ngo/df-resource-signals."
},
"TopologyConfig": {
- "id": "TopologyConfig",
- "description": "Global topology of the streaming Dataflow job, including all\ncomputations and their sharded locations.",
"type": "object",
"properties": {
"computations": {
- "description": "The computations associated with a streaming Dataflow job.",
"items": {
"$ref": "ComputationTopology"
},
- "type": "array"
+ "type": "array",
+ "description": "The computations associated with a streaming Dataflow job."
},
"persistentStateVersion": {
"format": "int32",
@@ -3733,11 +2122,11 @@
"type": "integer"
},
"dataDiskAssignments": {
- "description": "The disks assigned to a streaming Dataflow job.",
"items": {
"$ref": "DataDiskAssignment"
},
- "type": "array"
+ "type": "array",
+ "description": "The disks assigned to a streaming Dataflow job."
},
"forwardingKeyBits": {
"format": "int32",
@@ -3751,27 +2140,28 @@
"description": "Maps user stage names to stable computation names.",
"type": "object"
}
- }
+ },
+ "id": "TopologyConfig",
+ "description": "Global topology of the streaming Dataflow job, including all\ncomputations and their sharded locations."
},
"SourceSplitOptions": {
- "description": "Hints for splitting a Source into bundles (parts for parallel\nprocessing) using SourceSplitRequest.",
"type": "object",
"properties": {
"desiredBundleSizeBytes": {
+ "type": "string",
"format": "int64",
- "description": "The source should be split into a set of bundles where the estimated size\nof each is approximately this many bytes.",
- "type": "string"
+ "description": "The source should be split into a set of bundles where the estimated size\nof each is approximately this many bytes."
},
"desiredShardSizeBytes": {
+ "type": "string",
"format": "int64",
- "description": "DEPRECATED in favor of desired_bundle_size_bytes.",
- "type": "string"
+ "description": "DEPRECATED in favor of desired_bundle_size_bytes."
}
},
- "id": "SourceSplitOptions"
+ "id": "SourceSplitOptions",
+ "description": "Hints for splitting a Source into bundles (parts for parallel\nprocessing) using SourceSplitRequest."
},
"ReadInstruction": {
- "description": "An instruction that reads records.\nTakes no inputs, produces one output.",
"type": "object",
"properties": {
"source": {
@@ -3779,9 +2169,11 @@
"description": "The source to read from."
}
},
- "id": "ReadInstruction"
+ "id": "ReadInstruction",
+ "description": "An instruction that reads records.\nTakes no inputs, produces one output."
},
"WorkerSettings": {
+ "type": "object",
"properties": {
"servicePath": {
"description": "The Cloud Dataflow service path relative to the root URL, for example,\n\"dataflow/v1b3/projects\".",
@@ -3792,16 +2184,16 @@
"type": "string"
},
"workerId": {
- "description": "The ID of the worker running this pipeline.",
- "type": "string"
+ "type": "string",
+ "description": "The ID of the worker running this pipeline."
},
"tempStoragePrefix": {
- "type": "string",
- "description": "The prefix of the resources the system should use for temporary\nstorage.\n\nThe supported resource type is:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}"
+ "description": "The prefix of the resources the system should use for temporary\nstorage.\n\nThe supported resource type is:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}",
+ "type": "string"
},
"reportingEnabled": {
- "description": "Whether to send work progress updates to the service.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "Whether to send work progress updates to the service."
},
"baseUrl": {
"description": "The base URL for accessing Google Cloud APIs.\n\nWhen workers access Google Cloud APIs, they logically do so via\nrelative URLs. If this field is specified, it supplies the base\nURL to use for resolving these relative URLs. The normative\nalgorithm used is defined by RFC 1808, \"Relative Uniform Resource\nLocators\".\n\nIf not specified, the default value is \"http://www.googleapis.com/\"",
@@ -3809,8 +2201,7 @@
}
},
"id": "WorkerSettings",
- "description": "Provides data to pass through to the worker harness.",
- "type": "object"
+ "description": "Provides data to pass through to the worker harness."
},
"DataDiskAssignment": {
"description": "Data disk assignment for a given VM instance.",
@@ -3824,8 +2215,8 @@
"type": "array"
},
"vmInstance": {
- "description": "VM instance name the data disks mounted to, for example\n\"myproject-1014-104817-4c2-harness-0\".",
- "type": "string"
+ "type": "string",
+ "description": "VM instance name the data disks mounted to, for example\n\"myproject-1014-104817-4c2-harness-0\"."
}
},
"id": "DataDiskAssignment"
@@ -3842,29 +2233,27 @@
"id": "StreamingStageLocation"
},
"ApproximateSplitRequest": {
- "description": "A suggestion by the service to the worker to dynamically split the WorkItem.",
"type": "object",
"properties": {
- "fractionConsumed": {
- "format": "double",
- "description": "A fraction at which to split the work item, from 0.0 (beginning of the\ninput) to 1.0 (end of the input).",
- "type": "number"
- },
"position": {
"$ref": "Position",
"description": "A Position at which to split the work item."
+ },
+ "fractionConsumed": {
+ "type": "number",
+ "format": "double",
+ "description": "A fraction at which to split the work item, from 0.0 (beginning of the\ninput) to 1.0 (end of the input)."
}
},
- "id": "ApproximateSplitRequest"
+ "id": "ApproximateSplitRequest",
+ "description": "A suggestion by the service to the worker to dynamically split the WorkItem."
},
"Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
"details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
"type": "object",
"additionalProperties": {
@@ -3872,33 +2261,30 @@
"description": "Properties of the object. Contains field @type with type URL."
}
},
- "type": "array",
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use."
+ "type": "array"
},
"code": {
+ "type": "integer",
"format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer"
+ "description": "The status code, which should be an enum value of google.rpc.Code."
+ },
+ "message": {
+ "type": "string",
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client."
}
},
- "id": "Status",
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons."
+ "id": "Status"
},
"ExecutionStageState": {
"description": "A message describing the state of a particular execution stage.",
"type": "object",
"properties": {
- "executionStageName": {
- "description": "The name of the execution stage.",
- "type": "string"
- },
"currentStateTime": {
"format": "google-datetime",
"description": "The time at which the stage transitioned to this state.",
"type": "string"
},
"executionStageState": {
- "description": "Executions stage states allow the same set of values as JobState.",
"type": "string",
"enumDescriptions": [
"The job's run state isn't specified.",
@@ -3925,14 +2311,17 @@
"JOB_STATE_DRAINED",
"JOB_STATE_PENDING",
"JOB_STATE_CANCELLING"
- ]
+ ],
+ "description": "Executions stage states allow the same set of values as JobState."
+ },
+ "executionStageName": {
+ "description": "The name of the execution stage.",
+ "type": "string"
}
},
"id": "ExecutionStageState"
},
"StreamLocation": {
- "id": "StreamLocation",
- "description": "Describes a stream of data, either as input to be processed or as\noutput of a streaming Dataflow job.",
"type": "object",
"properties": {
"customSourceLocation": {
@@ -3948,61 +2337,48 @@
"description": "The stream is a pubsub stream."
},
"streamingStageLocation": {
- "description": "The stream is part of another computation within the current\nstreaming Dataflow job.",
- "$ref": "StreamingStageLocation"
+ "$ref": "StreamingStageLocation",
+ "description": "The stream is part of another computation within the current\nstreaming Dataflow job."
}
- }
+ },
+ "id": "StreamLocation",
+ "description": "Describes a stream of data, either as input to be processed or as\noutput of a streaming Dataflow job."
},
"SendWorkerMessagesResponse": {
- "description": "The response to the worker messages.",
"type": "object",
"properties": {
"workerMessageResponses": {
- "description": "The servers response to the worker messages.",
"items": {
"$ref": "WorkerMessageResponse"
},
- "type": "array"
+ "type": "array",
+ "description": "The servers response to the worker messages."
}
},
- "id": "SendWorkerMessagesResponse"
+ "id": "SendWorkerMessagesResponse",
+ "description": "The response to the worker messages."
},
- "StreamingComputationConfig": {
- "description": "Configuration information for a single streaming computation.",
+ "LeaseWorkItemResponse": {
"type": "object",
"properties": {
- "computationId": {
- "description": "Unique identifier for this computation.",
- "type": "string"
- },
- "stageName": {
- "description": "Stage name of this computation.",
- "type": "string"
- },
- "systemName": {
- "description": "System defined name for this computation.",
- "type": "string"
- },
- "instructions": {
- "description": "Instructions that comprise the computation.",
+ "workItems": {
"items": {
- "$ref": "ParallelInstruction"
+ "$ref": "WorkItem"
},
- "type": "array"
+ "type": "array",
+ "description": "A list of the leased WorkItems."
}
},
- "id": "StreamingComputationConfig"
+ "id": "LeaseWorkItemResponse",
+ "description": "Response to a request to lease WorkItems."
},
"TransformSummary": {
+ "description": "Description of the type, names/ids, and input/outputs for a transform.",
"type": "object",
"properties": {
- "name": {
- "description": "User provided name for this transform instance.",
- "type": "string"
- },
"id": {
- "description": "SDK generated id of this transform instance.",
- "type": "string"
+ "type": "string",
+ "description": "SDK generated id of this transform instance."
},
"displayData": {
"description": "Transform-specific display data.",
@@ -4045,32 +2421,69 @@
]
},
"inputCollectionName": {
- "description": "User names for all collection inputs to this transform.",
"items": {
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "description": "User names for all collection inputs to this transform."
+ },
+ "name": {
+ "description": "User provided name for this transform instance.",
+ "type": "string"
}
},
- "id": "TransformSummary",
- "description": "Description of the type, names/ids, and input/outputs for a transform."
+ "id": "TransformSummary"
},
- "LeaseWorkItemResponse": {
- "description": "Response to a request to lease WorkItems.",
+ "StreamingComputationConfig": {
+ "description": "Configuration information for a single streaming computation.",
"type": "object",
"properties": {
- "workItems": {
- "description": "A list of the leased WorkItems.",
+ "stageName": {
+ "type": "string",
+ "description": "Stage name of this computation."
+ },
+ "systemName": {
+ "description": "System defined name for this computation.",
+ "type": "string"
+ },
+ "instructions": {
+ "description": "Instructions that comprise the computation.",
"items": {
- "$ref": "WorkItem"
+ "$ref": "ParallelInstruction"
},
"type": "array"
+ },
+ "computationId": {
+ "description": "Unique identifier for this computation.",
+ "type": "string"
}
},
- "id": "LeaseWorkItemResponse"
+ "id": "StreamingComputationConfig"
+ },
+ "Sink": {
+ "type": "object",
+ "properties": {
+ "codec": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "The codec to use to encode data written to the sink.",
+ "type": "object"
+ },
+ "spec": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object."
+ },
+ "description": "The sink to write to, plus its parameters."
+ }
+ },
+ "id": "Sink",
+ "description": "A sink that records can be encoded and written to."
},
"LaunchTemplateParameters": {
- "description": "Parameters to provide to the template being launched.",
"type": "object",
"properties": {
"jobName": {
@@ -4082,54 +2495,31 @@
"description": "The runtime environment for the job."
},
"parameters": {
+ "type": "object",
"additionalProperties": {
"type": "string"
},
- "description": "The runtime parameters to pass to the job.",
- "type": "object"
+ "description": "The runtime parameters to pass to the job."
}
},
- "id": "LaunchTemplateParameters"
- },
- "Sink": {
- "description": "A sink that records can be encoded and written to.",
- "type": "object",
- "properties": {
- "codec": {
- "description": "The codec to use to encode data written to the sink.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- }
- },
- "spec": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "The sink to write to, plus its parameters.",
- "type": "object"
- }
- },
- "id": "Sink"
+ "id": "LaunchTemplateParameters",
+ "description": "Parameters to provide to the template being launched."
},
"FlattenInstruction": {
- "description": "An instruction that copies its inputs (zero or more) to its (single) output.",
"type": "object",
"properties": {
"inputs": {
- "description": "Describes the inputs to the flatten instruction.",
"items": {
"$ref": "InstructionInput"
},
- "type": "array"
+ "type": "array",
+ "description": "Describes the inputs to the flatten instruction."
}
},
- "id": "FlattenInstruction"
+ "id": "FlattenInstruction",
+ "description": "An instruction that copies its inputs (zero or more) to its (single) output."
},
"PartialGroupByKeyInstruction": {
- "description": "An instruction that does a partial group-by-key.\nOne input and one output.",
"type": "object",
"properties": {
"inputElementCodec": {
@@ -4149,8 +2539,8 @@
"description": "The value combining function to invoke."
},
"originalCombineValuesInputStoreName": {
- "description": "If this instruction includes a combining function this is the name of the\nintermediate store between the GBK and the CombineValues.",
- "type": "string"
+ "type": "string",
+ "description": "If this instruction includes a combining function this is the name of the\nintermediate store between the GBK and the CombineValues."
},
"originalCombineValuesStepName": {
"description": "If this instruction includes a combining function, this is the name of the\nCombineValues instruction lifted into this instruction.",
@@ -4168,15 +2558,33 @@
"description": "Describes the input to the partial group-by-key instruction."
}
},
- "id": "PartialGroupByKeyInstruction"
+ "id": "PartialGroupByKeyInstruction",
+ "description": "An instruction that does a partial group-by-key.\nOne input and one output."
+ },
+ "InstructionInput": {
+ "description": "An input of an instruction, as a reference to an output of a\nproducer instruction.",
+ "type": "object",
+ "properties": {
+ "producerInstructionIndex": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The index (origin zero) of the parallel instruction that produces\nthe output to be consumed by this input. This index is relative\nto the list of instructions in this input's instruction's\ncontaining MapTask."
+ },
+ "outputNum": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The output index (origin zero) within the producer."
+ }
+ },
+ "id": "InstructionInput"
},
"StageSource": {
"type": "object",
"properties": {
"sizeBytes": {
+ "type": "string",
"format": "int64",
- "description": "Size of the source, if measurable.",
- "type": "string"
+ "description": "Size of the source, if measurable."
},
"name": {
"description": "Dataflow service generated name for this source.",
@@ -4187,47 +2595,28 @@
"type": "string"
},
"originalTransformOrCollection": {
- "description": "User name for the original user transform or collection with which this\nsource is most closely associated.",
- "type": "string"
+ "type": "string",
+ "description": "User name for the original user transform or collection with which this\nsource is most closely associated."
}
},
"id": "StageSource",
"description": "Description of an input or output of an execution stage."
},
- "InstructionInput": {
- "id": "InstructionInput",
- "description": "An input of an instruction, as a reference to an output of a\nproducer instruction.",
- "type": "object",
- "properties": {
- "outputNum": {
- "format": "int32",
- "description": "The output index (origin zero) within the producer.",
- "type": "integer"
- },
- "producerInstructionIndex": {
- "format": "int32",
- "description": "The index (origin zero) of the parallel instruction that produces\nthe output to be consumed by this input. This index is relative\nto the list of instructions in this input's instruction's\ncontaining MapTask.",
- "type": "integer"
- }
- }
- },
"StringList": {
- "description": "A metric value representing a list of strings.",
"type": "object",
"properties": {
"elements": {
- "description": "Elements of the list.",
"items": {
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "description": "Elements of the list."
}
},
- "id": "StringList"
+ "id": "StringList",
+ "description": "A metric value representing a list of strings."
},
"DisplayData": {
- "id": "DisplayData",
- "description": "Data provided with a pipeline or transform to provide descriptive info.",
"type": "object",
"properties": {
"key": {
@@ -4238,40 +2627,40 @@
"description": "A possible additional shorter value to display.\nFor example a java_class_name_value of com.mypackage.MyDoFn\nwill be stored with MyDoFn as the short_str_value and\ncom.mypackage.MyDoFn as the java_class_name value.\nshort_str_value can be displayed and java_class_name_value\nwill be displayed as a tooltip.",
"type": "string"
},
- "url": {
- "description": "An optional full URL.",
- "type": "string"
- },
"label": {
"type": "string",
"description": "An optional label to display in a dax UI for the element."
},
- "timestampValue": {
+ "url": {
"type": "string",
+ "description": "An optional full URL."
+ },
+ "timestampValue": {
"format": "google-datetime",
- "description": "Contains value if the data is of timestamp type."
+ "description": "Contains value if the data is of timestamp type.",
+ "type": "string"
},
"javaClassValue": {
- "type": "string",
- "description": "Contains value if the data is of java class type."
+ "description": "Contains value if the data is of java class type.",
+ "type": "string"
},
"boolValue": {
- "type": "boolean",
- "description": "Contains value if the data is of a boolean type."
+ "description": "Contains value if the data is of a boolean type.",
+ "type": "boolean"
},
"strValue": {
"description": "Contains value if the data is of string type.",
"type": "string"
},
- "durationValue": {
- "format": "google-duration",
- "description": "Contains value if the data is of duration type.",
- "type": "string"
- },
"int64Value": {
+ "type": "string",
"format": "int64",
- "description": "Contains value if the data is of int64 type.",
- "type": "string"
+ "description": "Contains value if the data is of int64 type."
+ },
+ "durationValue": {
+ "type": "string",
+ "format": "google-duration",
+ "description": "Contains value if the data is of duration type."
},
"namespace": {
"description": "The namespace for the key. This is usually a class name or programming\nlanguage namespace (i.e. python module) which defines the display data.\nThis allows a dax monitoring system to specially handle the data\nand perform custom rendering.",
@@ -4282,46 +2671,29 @@
"description": "Contains value if the data is of float type.",
"type": "number"
}
- }
- },
- "GetDebugConfigRequest": {
- "description": "Request to get updated debug configuration for component.",
- "type": "object",
- "properties": {
- "componentId": {
- "description": "The internal component id for which debug configuration is\nrequested.",
- "type": "string"
- },
- "workerId": {
- "description": "The worker id, i.e., VM hostname.",
- "type": "string"
- },
- "location": {
- "description": "The location which contains the job specified by job_id.",
- "type": "string"
- }
},
- "id": "GetDebugConfigRequest"
+ "id": "DisplayData",
+ "description": "Data provided with a pipeline or transform to provide descriptive info."
},
"LeaseWorkItemRequest": {
"description": "Request to lease WorkItems.",
"type": "object",
"properties": {
"workerCapabilities": {
- "description": "Worker capabilities. WorkItems might be limited to workers with specific\ncapabilities.",
"items": {
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "description": "Worker capabilities. WorkItems might be limited to workers with specific\ncapabilities."
},
"workerId": {
- "description": "Identifies the worker leasing work -- typically the ID of the\nvirtual machine running the worker.",
- "type": "string"
+ "type": "string",
+ "description": "Identifies the worker leasing work -- typically the ID of the\nvirtual machine running the worker."
},
"requestedLeaseDuration": {
- "type": "string",
"format": "google-duration",
- "description": "The initial lease period."
+ "description": "The initial lease period.",
+ "type": "string"
},
"currentWorkerTime": {
"type": "string",
@@ -4329,21 +2701,39 @@
"description": "The current timestamp at the worker."
},
"workItemTypes": {
+ "description": "Filter for WorkItem type.",
"items": {
"type": "string"
},
- "type": "array",
- "description": "Filter for WorkItem type."
+ "type": "array"
},
"location": {
- "description": "The location which contains the WorkItem's job.",
- "type": "string"
+ "type": "string",
+ "description": "The location which contains the WorkItem's job."
}
},
"id": "LeaseWorkItemRequest"
},
+ "GetDebugConfigRequest": {
+ "type": "object",
+ "properties": {
+ "location": {
+ "description": "The location which contains the job specified by job_id.",
+ "type": "string"
+ },
+ "componentId": {
+ "type": "string",
+ "description": "The internal component id for which debug configuration is\nrequested."
+ },
+ "workerId": {
+ "description": "The worker id, i.e., VM hostname.",
+ "type": "string"
+ }
+ },
+ "id": "GetDebugConfigRequest",
+ "description": "Request to get updated debug configuration for component."
+ },
"GetTemplateResponse": {
- "description": "The response to a GetTemplate request.",
"type": "object",
"properties": {
"metadata": {
@@ -4351,26 +2741,27 @@
"description": "The template metadata describing the template name, available\nparameters, etc."
},
"status": {
- "description": "The status of the get template request. Any problems with the\nrequest will be indicated in the error_details.",
- "$ref": "Status"
+ "$ref": "Status",
+ "description": "The status of the get template request. Any problems with the\nrequest will be indicated in the error_details."
}
},
- "id": "GetTemplateResponse"
+ "id": "GetTemplateResponse",
+ "description": "The response to a GetTemplate request."
},
"Parameter": {
- "description": "Structured data associated with this message.",
"type": "object",
"properties": {
"key": {
- "description": "Key or name for this parameter.",
- "type": "string"
+ "type": "string",
+ "description": "Key or name for this parameter."
},
"value": {
"description": "Value for this parameter.",
"type": "any"
}
},
- "id": "Parameter"
+ "id": "Parameter",
+ "description": "Structured data associated with this message."
},
"ReportWorkItemStatusRequest": {
"description": "Request to report the status of WorkItems.",
@@ -4386,21 +2777,48 @@
"type": "string"
},
"location": {
- "description": "The location which contains the WorkItem's job.",
- "type": "string"
+ "type": "string",
+ "description": "The location which contains the WorkItem's job."
},
"workItemStatuses": {
- "description": "The order is unimportant, except that the order of the\nWorkItemServiceState messages in the ReportWorkItemStatusResponse\ncorresponds to the order of WorkItemStatus messages here.",
"items": {
"$ref": "WorkItemStatus"
},
- "type": "array"
+ "type": "array",
+ "description": "The order is unimportant, except that the order of the\nWorkItemServiceState messages in the ReportWorkItemStatusResponse\ncorresponds to the order of WorkItemStatus messages here."
}
},
"id": "ReportWorkItemStatusRequest"
},
+ "PipelineDescription": {
+ "description": "A descriptive representation of submitted pipeline as well as the executed\nform. This data is provided by the Dataflow service for ease of visualizing\nthe pipeline and interpretting Dataflow provided metrics.",
+ "type": "object",
+ "properties": {
+ "originalPipelineTransform": {
+ "items": {
+ "$ref": "TransformSummary"
+ },
+ "type": "array",
+ "description": "Description of each transform in the pipeline and collections between them."
+ },
+ "displayData": {
+ "items": {
+ "$ref": "DisplayData"
+ },
+ "type": "array",
+ "description": "Pipeline level display data."
+ },
+ "executionPipelineStage": {
+ "items": {
+ "$ref": "ExecutionStageSummary"
+ },
+ "type": "array",
+ "description": "Description of each stage of execution of the pipeline."
+ }
+ },
+ "id": "PipelineDescription"
+ },
"StreamingConfigTask": {
- "description": "A task that carries configuration information for streaming computations.",
"type": "object",
"properties": {
"streamingComputationConfigs": {
@@ -4411,8 +2829,8 @@
"type": "array"
},
"windmillServiceEndpoint": {
- "description": "If present, the worker must use this endpoint to communicate with Windmill\nService dispatchers, otherwise the worker must continue to use whatever\nendpoint it had been using.",
- "type": "string"
+ "type": "string",
+ "description": "If present, the worker must use this endpoint to communicate with Windmill\nService dispatchers, otherwise the worker must continue to use whatever\nendpoint it had been using."
},
"userStepToStateFamilyNameMap": {
"additionalProperties": {
@@ -4427,61 +2845,10 @@
"type": "string"
}
},
- "id": "StreamingConfigTask"
- },
- "PipelineDescription": {
- "type": "object",
- "properties": {
- "displayData": {
- "description": "Pipeline level display data.",
- "items": {
- "$ref": "DisplayData"
- },
- "type": "array"
- },
- "executionPipelineStage": {
- "description": "Description of each stage of execution of the pipeline.",
- "items": {
- "$ref": "ExecutionStageSummary"
- },
- "type": "array"
- },
- "originalPipelineTransform": {
- "items": {
- "$ref": "TransformSummary"
- },
- "type": "array",
- "description": "Description of each transform in the pipeline and collections between them."
- }
- },
- "id": "PipelineDescription",
- "description": "A descriptive representation of submitted pipeline as well as the executed\nform. This data is provided by the Dataflow service for ease of visualizing\nthe pipeline and interpretting Dataflow provided metrics."
- },
- "Step": {
- "description": "Defines a particular step within a Cloud Dataflow job.\n\nA job consists of multiple steps, each of which performs some\nspecific operation as part of the overall job. Data is typically\npassed from one step to another as part of the job.\n\nHere's an example of a sequence of steps which together implement a\nMap-Reduce job:\n\n * Read a collection of data from some source, parsing the\n collection's elements.\n\n * Validate the elements.\n\n * Apply a user-defined function to map each element to some value\n and extract an element-specific key value.\n\n * Group elements with the same key into a single element with\n that key, transforming a multiply-keyed collection into a\n uniquely-keyed collection.\n\n * Write the elements out to some data sink.\n\nNote that the Cloud Dataflow service may be used to run many different\ntypes of jobs, not just Map-Reduce.",
- "type": "object",
- "properties": {
- "properties": {
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object."
- },
- "description": "Named properties associated with the step. Each kind of\npredefined step has its own required set of properties.\nMust be provided on Create. Only retrieved with JOB_VIEW_ALL.",
- "type": "object"
- },
- "name": {
- "description": "The name that identifies the step. This must be unique for each\nstep with respect to all other steps in the Cloud Dataflow job.",
- "type": "string"
- },
- "kind": {
- "description": "The kind of step in the Cloud Dataflow job.",
- "type": "string"
- }
- },
- "id": "Step"
+ "id": "StreamingConfigTask",
+ "description": "A task that carries configuration information for streaming computations."
},
"JobExecutionInfo": {
- "description": "Additional information about how a Cloud Dataflow job will be executed that\nisn't contained in the submitted job.",
"type": "object",
"properties": {
"stages": {
@@ -4492,15 +2859,39 @@
"type": "object"
}
},
- "id": "JobExecutionInfo"
+ "id": "JobExecutionInfo",
+ "description": "Additional information about how a Cloud Dataflow job will be executed that\nisn't contained in the submitted job."
+ },
+ "Step": {
+ "description": "Defines a particular step within a Cloud Dataflow job.\n\nA job consists of multiple steps, each of which performs some\nspecific operation as part of the overall job. Data is typically\npassed from one step to another as part of the job.\n\nHere's an example of a sequence of steps which together implement a\nMap-Reduce job:\n\n * Read a collection of data from some source, parsing the\n collection's elements.\n\n * Validate the elements.\n\n * Apply a user-defined function to map each element to some value\n and extract an element-specific key value.\n\n * Group elements with the same key into a single element with\n that key, transforming a multiply-keyed collection into a\n uniquely-keyed collection.\n\n * Write the elements out to some data sink.\n\nNote that the Cloud Dataflow service may be used to run many different\ntypes of jobs, not just Map-Reduce.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name that identifies the step. This must be unique for each\nstep with respect to all other steps in the Cloud Dataflow job."
+ },
+ "kind": {
+ "description": "The kind of step in the Cloud Dataflow job.",
+ "type": "string"
+ },
+ "properties": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object."
+ },
+ "description": "Named properties associated with the step. Each kind of\npredefined step has its own required set of properties.\nMust be provided on Create. Only retrieved with JOB_VIEW_ALL."
+ }
+ },
+ "id": "Step"
},
"FailedLocation": {
"description": "Indicates which location failed to respond to a request for data.",
"type": "object",
"properties": {
"name": {
- "description": "The name of the failed location.",
- "type": "string"
+ "type": "string",
+ "description": "The name of the failed location."
}
},
"id": "FailedLocation"
@@ -4509,60 +2900,57 @@
"type": "object",
"properties": {
"diskType": {
- "description": "Disk storage type, as defined by Google Compute Engine. This\nmust be a disk type appropriate to the project and zone in which\nthe workers will run. If unknown or unspecified, the service\nwill attempt to choose a reasonable default.\n\nFor example, the standard persistent disk type is a resource name\ntypically ending in \"pd-standard\". If SSD persistent disks are\navailable, the resource name typically ends with \"pd-ssd\". The\nactual valid values are defined the Google Compute Engine API,\nnot by the Cloud Dataflow API; consult the Google Compute Engine\ndocumentation for more information about determining the set of\navailable disk types for a particular project and zone.\n\nGoogle Compute Engine Disk types are local to a particular\nproject in a particular zone, and so the resource name will\ntypically look something like this:\n\ncompute.googleapis.com/projects/project-id/zones/zone/diskTypes/pd-standard",
- "type": "string"
+ "type": "string",
+ "description": "Disk storage type, as defined by Google Compute Engine. This\nmust be a disk type appropriate to the project and zone in which\nthe workers will run. If unknown or unspecified, the service\nwill attempt to choose a reasonable default.\n\nFor example, the standard persistent disk type is a resource name\ntypically ending in \"pd-standard\". If SSD persistent disks are\navailable, the resource name typically ends with \"pd-ssd\". The\nactual valid values are defined the Google Compute Engine API,\nnot by the Cloud Dataflow API; consult the Google Compute Engine\ndocumentation for more information about determining the set of\navailable disk types for a particular project and zone.\n\nGoogle Compute Engine Disk types are local to a particular\nproject in a particular zone, and so the resource name will\ntypically look something like this:\n\ncompute.googleapis.com/projects/project-id/zones/zone/diskTypes/pd-standard"
},
"sizeGb": {
+ "type": "integer",
"format": "int32",
- "description": "Size of disk in GB. If zero or unspecified, the service will\nattempt to choose a reasonable default.",
- "type": "integer"
+ "description": "Size of disk in GB. If zero or unspecified, the service will\nattempt to choose a reasonable default."
},
"mountPoint": {
- "description": "Directory in a VM where disk is mounted.",
- "type": "string"
+ "type": "string",
+ "description": "Directory in a VM where disk is mounted."
}
},
"id": "Disk",
"description": "Describes the data disk used by a workflow job."
},
"ListJobMessagesResponse": {
+ "type": "object",
"properties": {
- "jobMessages": {
- "description": "Messages in ascending timestamp order.",
- "items": {
- "$ref": "JobMessage"
- },
- "type": "array"
- },
- "nextPageToken": {
- "type": "string",
- "description": "The token to obtain the next page of results if there are more."
- },
"autoscalingEvents": {
"description": "Autoscaling events in ascending timestamp order.",
"items": {
"$ref": "AutoscalingEvent"
},
"type": "array"
+ },
+ "jobMessages": {
+ "items": {
+ "$ref": "JobMessage"
+ },
+ "type": "array",
+ "description": "Messages in ascending timestamp order."
+ },
+ "nextPageToken": {
+ "description": "The token to obtain the next page of results if there are more.",
+ "type": "string"
}
},
"id": "ListJobMessagesResponse",
- "description": "Response to a request to list job messages.",
- "type": "object"
+ "description": "Response to a request to list job messages."
},
"CounterMetadata": {
"description": "CounterMetadata includes all static non-name non-value counter attributes.",
"type": "object",
"properties": {
- "otherUnits": {
- "description": "A string referring to the unit type.",
- "type": "string"
- },
"description": {
- "description": "Human-readable description of the counter semantics.",
- "type": "string"
+ "type": "string",
+ "description": "Human-readable description of the counter semantics."
},
"kind": {
+ "type": "string",
"enumDescriptions": [
"Counter aggregation kind was not set.",
"Aggregated value is the sum of all contributed values.",
@@ -4585,20 +2973,9 @@
"SET",
"DISTRIBUTION"
],
- "description": "Counter aggregation kind.",
- "type": "string"
+ "description": "Counter aggregation kind."
},
"standardUnits": {
- "enumDescriptions": [
- "Counter returns a value in bytes.",
- "Counter returns a value in bytes per second.",
- "Counter returns a value in milliseconds.",
- "Counter returns a value in microseconds.",
- "Counter returns a value in nanoseconds.",
- "Counter returns a timestamp in milliseconds.",
- "Counter returns a timestamp in microseconds.",
- "Counter returns a timestamp in nanoseconds."
- ],
"enum": [
"BYTES",
"BYTES_PER_SEC",
@@ -4610,15 +2987,32 @@
"TIMESTAMP_NSEC"
],
"description": "System defined Units, see above enum.",
+ "type": "string",
+ "enumDescriptions": [
+ "Counter returns a value in bytes.",
+ "Counter returns a value in bytes per second.",
+ "Counter returns a value in milliseconds.",
+ "Counter returns a value in microseconds.",
+ "Counter returns a value in nanoseconds.",
+ "Counter returns a timestamp in milliseconds.",
+ "Counter returns a timestamp in microseconds.",
+ "Counter returns a timestamp in nanoseconds."
+ ]
+ },
+ "otherUnits": {
+ "description": "A string referring to the unit type.",
"type": "string"
}
},
"id": "CounterMetadata"
},
"ApproximateReportedProgress": {
- "description": "A progress measurement of a WorkItem by a worker.",
"type": "object",
"properties": {
+ "remainingParallelism": {
+ "$ref": "ReportedParallelism",
+ "description": "Total amount of parallelism in the input of this task that remains,\n(i.e. can be delegated to this task and any new tasks via dynamic\nsplitting). Always at least 1 for non-finished work items and 0 for\nfinished.\n\n\"Amount of parallelism\" refers to how many non-empty parts of the input\ncan be read in parallel. This does not necessarily equal number\nof records. An input that can be read in parallel down to the\nindividual records is called \"perfectly splittable\".\nAn example of non-perfectly parallelizable input is a block-compressed\nfile format where a block of records has to be read as a whole,\nbut different blocks can be read in parallel.\n\nExamples:\n* If we are processing record #30 (starting at 1) out of 50 in a perfectly\n splittable 50-record input, this value should be 21 (20 remaining + 1\n current).\n* If we are reading through block 3 in a block-compressed file consisting\n of 5 blocks, this value should be 3 (since blocks 4 and 5 can be\n processed in parallel by new tasks via dynamic splitting and the current\n task remains processing block 3).\n* If we are reading through the last block in a block-compressed file,\n or reading or processing the last record in a perfectly splittable\n input, this value should be 1, because apart from the current task, no\n additional remainder can be split off."
+ },
"position": {
"$ref": "Position",
"description": "A Position within the work to represent a progress."
@@ -4631,35 +3025,18 @@
"consumedParallelism": {
"$ref": "ReportedParallelism",
"description": "Total amount of parallelism in the portion of input of this task that has\nalready been consumed and is no longer active. In the first two examples\nabove (see remaining_parallelism), the value should be 29 or 2\nrespectively. The sum of remaining_parallelism and consumed_parallelism\nshould equal the total amount of parallelism in this work item. If\nspecified, must be finite."
- },
- "remainingParallelism": {
- "$ref": "ReportedParallelism",
- "description": "Total amount of parallelism in the input of this task that remains,\n(i.e. can be delegated to this task and any new tasks via dynamic\nsplitting). Always at least 1 for non-finished work items and 0 for\nfinished.\n\n\"Amount of parallelism\" refers to how many non-empty parts of the input\ncan be read in parallel. This does not necessarily equal number\nof records. An input that can be read in parallel down to the\nindividual records is called \"perfectly splittable\".\nAn example of non-perfectly parallelizable input is a block-compressed\nfile format where a block of records has to be read as a whole,\nbut different blocks can be read in parallel.\n\nExamples:\n* If we are processing record #30 (starting at 1) out of 50 in a perfectly\n splittable 50-record input, this value should be 21 (20 remaining + 1\n current).\n* If we are reading through block 3 in a block-compressed file consisting\n of 5 blocks, this value should be 3 (since blocks 4 and 5 can be\n processed in parallel by new tasks via dynamic splitting and the current\n task remains processing block 3).\n* If we are reading through the last block in a block-compressed file,\n or reading or processing the last record in a perfectly splittable\n input, this value should be 1, because apart from the current task, no\n additional remainder can be split off."
}
},
- "id": "ApproximateReportedProgress"
- },
- "IntegerList": {
- "id": "IntegerList",
- "description": "A metric value representing a list of integers.",
- "type": "object",
- "properties": {
- "elements": {
- "items": {
- "$ref": "SplitInt64"
- },
- "type": "array",
- "description": "Elements of the list."
- }
- }
+ "id": "ApproximateReportedProgress",
+ "description": "A progress measurement of a WorkItem by a worker."
},
"StateFamilyConfig": {
"description": "State family configuration.",
"type": "object",
"properties": {
"stateFamily": {
- "type": "string",
- "description": "The state family value."
+ "description": "The state family value.",
+ "type": "string"
},
"isRead": {
"description": "If true, this family corresponds to a read operation.",
@@ -4668,16 +3045,36 @@
},
"id": "StateFamilyConfig"
},
- "ResourceUtilizationReportResponse": {
- "description": "Service-side response to WorkerMessage reporting resource utilization.",
- "type": "object",
- "properties": {},
- "id": "ResourceUtilizationReportResponse"
- },
- "SourceSplitResponse": {
- "description": "The response to a SourceSplitRequest.",
+ "IntegerList": {
"type": "object",
"properties": {
+ "elements": {
+ "description": "Elements of the list.",
+ "items": {
+ "$ref": "SplitInt64"
+ },
+ "type": "array"
+ }
+ },
+ "id": "IntegerList",
+ "description": "A metric value representing a list of integers."
+ },
+ "ResourceUtilizationReportResponse": {
+ "type": "object",
+ "properties": {},
+ "id": "ResourceUtilizationReportResponse",
+ "description": "Service-side response to WorkerMessage reporting resource utilization."
+ },
+ "SourceSplitResponse": {
+ "type": "object",
+ "properties": {
+ "bundles": {
+ "description": "If outcome is SPLITTING_HAPPENED, then this is a list of bundles\ninto which the source was split. Otherwise this field is ignored.\nThis list can be empty, which means the source represents an empty input.",
+ "items": {
+ "$ref": "DerivedSource"
+ },
+ "type": "array"
+ },
"shards": {
"items": {
"$ref": "SourceSplitShard"
@@ -4686,6 +3083,7 @@
"description": "DEPRECATED in favor of bundles."
},
"outcome": {
+ "type": "string",
"enumDescriptions": [
"The source split outcome is unknown, or unspecified.",
"The current source should be processed \"as is\" without splitting.",
@@ -4696,18 +3094,11 @@
"SOURCE_SPLIT_OUTCOME_USE_CURRENT",
"SOURCE_SPLIT_OUTCOME_SPLITTING_HAPPENED"
],
- "description": "Indicates whether splitting happened and produced a list of bundles.\nIf this is USE_CURRENT_SOURCE_AS_IS, the current source should\nbe processed \"as is\" without splitting. \"bundles\" is ignored in this case.\nIf this is SPLITTING_HAPPENED, then \"bundles\" contains a list of\nbundles into which the source was split.",
- "type": "string"
- },
- "bundles": {
- "items": {
- "$ref": "DerivedSource"
- },
- "type": "array",
- "description": "If outcome is SPLITTING_HAPPENED, then this is a list of bundles\ninto which the source was split. Otherwise this field is ignored.\nThis list can be empty, which means the source represents an empty input."
+ "description": "Indicates whether splitting happened and produced a list of bundles.\nIf this is USE_CURRENT_SOURCE_AS_IS, the current source should\nbe processed \"as is\" without splitting. \"bundles\" is ignored in this case.\nIf this is SPLITTING_HAPPENED, then \"bundles\" contains a list of\nbundles into which the source was split."
}
},
- "id": "SourceSplitResponse"
+ "id": "SourceSplitResponse",
+ "description": "The response to a SourceSplitRequest."
},
"ParallelInstruction": {
"description": "Describes a particular operation comprising a MapTask.",
@@ -4721,32 +3112,32 @@
"type": "array"
},
"name": {
- "type": "string",
- "description": "User-provided name of this operation."
- },
- "parDo": {
- "description": "Additional information for ParDo instructions.",
- "$ref": "ParDoInstruction"
+ "description": "User-provided name of this operation.",
+ "type": "string"
},
"read": {
"$ref": "ReadInstruction",
"description": "Additional information for Read instructions."
},
+ "parDo": {
+ "$ref": "ParDoInstruction",
+ "description": "Additional information for ParDo instructions."
+ },
"originalName": {
- "description": "System-defined name for the operation in the original workflow graph.",
- "type": "string"
+ "type": "string",
+ "description": "System-defined name for the operation in the original workflow graph."
},
"flatten": {
- "description": "Additional information for Flatten instructions.",
- "$ref": "FlattenInstruction"
- },
- "systemName": {
- "description": "System-defined name of this operation.\nUnique across the workflow.",
- "type": "string"
+ "$ref": "FlattenInstruction",
+ "description": "Additional information for Flatten instructions."
},
"write": {
- "description": "Additional information for Write instructions.",
- "$ref": "WriteInstruction"
+ "$ref": "WriteInstruction",
+ "description": "Additional information for Write instructions."
+ },
+ "systemName": {
+ "type": "string",
+ "description": "System-defined name of this operation.\nUnique across the workflow."
},
"partialGroupByKey": {
"$ref": "PartialGroupByKeyInstruction",
@@ -4756,12 +3147,11 @@
"id": "ParallelInstruction"
},
"KeyRangeDataDiskAssignment": {
- "description": "Data disk assignment information for a specific key-range of a sharded\ncomputation.\nCurrently we only support UTF-8 character splits to simplify encoding into\nJSON.",
"type": "object",
"properties": {
"dataDisk": {
- "description": "The name of the data disk where data for this range is stored.\nThis name is local to the Google Cloud Platform project and uniquely\nidentifies the disk within that project, for example\n\"myproject-1014-104817-4c2-harness-0-disk-1\".",
- "type": "string"
+ "type": "string",
+ "description": "The name of the data disk where data for this range is stored.\nThis name is local to the Google Cloud Platform project and uniquely\nidentifies the disk within that project, for example\n\"myproject-1014-104817-4c2-harness-0-disk-1\"."
},
"start": {
"description": "The start (inclusive) of the key range.",
@@ -4772,14 +3162,15 @@
"type": "string"
}
},
- "id": "KeyRangeDataDiskAssignment"
+ "id": "KeyRangeDataDiskAssignment",
+ "description": "Data disk assignment information for a specific key-range of a sharded\ncomputation.\nCurrently we only support UTF-8 character splits to simplify encoding into\nJSON."
},
"Package": {
"type": "object",
"properties": {
"location": {
- "type": "string",
- "description": "The resource to read the package from. The supported resource type is:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}\n bucket.storage.googleapis.com/"
+ "description": "The resource to read the package from. The supported resource type is:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}\n bucket.storage.googleapis.com/",
+ "type": "string"
},
"name": {
"description": "The name of the package.",
@@ -4793,42 +3184,41 @@
"description": "An instruction that does a ParDo operation.\nTakes one main input and zero or more side inputs, and produces\nzero or more outputs.\nRuns user code.",
"type": "object",
"properties": {
- "sideInputs": {
- "description": "Zero or more side inputs.",
- "items": {
- "$ref": "SideInputInfo"
- },
- "type": "array"
- },
- "multiOutputInfos": {
- "description": "Information about each of the outputs, if user_fn is a MultiDoFn.",
- "items": {
- "$ref": "MultiOutputInfo"
- },
- "type": "array"
- },
"userFn": {
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
- "description": "The user function to invoke.",
- "type": "object"
+ "description": "The user function to invoke."
},
"input": {
- "description": "The input.",
- "$ref": "InstructionInput"
+ "$ref": "InstructionInput",
+ "description": "The input."
},
"numOutputs": {
"format": "int32",
"description": "The number of outputs.",
"type": "integer"
+ },
+ "sideInputs": {
+ "items": {
+ "$ref": "SideInputInfo"
+ },
+ "type": "array",
+ "description": "Zero or more side inputs."
+ },
+ "multiOutputInfos": {
+ "items": {
+ "$ref": "MultiOutputInfo"
+ },
+ "type": "array",
+ "description": "Information about each of the outputs, if user_fn is a MultiDoFn."
}
},
"id": "ParDoInstruction"
},
"WorkerShutdownNotice": {
- "description": "Shutdown notification from workers. This is to be sent by the shutdown\nscript of the worker VM so that the backend knows that the VM is being\nshut down.",
"type": "object",
"properties": {
"reason": {
@@ -4836,22 +3226,12 @@
"description": "The reason for the worker shutdown.\nCurrent possible values are:\n \"UNKNOWN\": shutdown reason is unknown.\n \"PREEMPTION\": shutdown reason is preemption.\nOther possible reasons may be added in the future."
}
},
- "id": "WorkerShutdownNotice"
+ "id": "WorkerShutdownNotice",
+ "description": "Shutdown notification from workers. This is to be sent by the shutdown\nscript of the worker VM so that the backend knows that the VM is being\nshut down."
},
"CounterStructuredName": {
+ "type": "object",
"properties": {
- "originalShuffleStepName": {
- "description": "The GroupByKey step name from the original graph.",
- "type": "string"
- },
- "originalStepName": {
- "description": "System generated name of the original step in the user's graph, before\noptimization.",
- "type": "string"
- },
- "workerId": {
- "type": "string",
- "description": "ID of a particular worker."
- },
"originNamespace": {
"description": "A string containing a more specific namespace of the counter's origin.",
"type": "string"
@@ -4865,8 +3245,8 @@
"type": "string"
},
"name": {
- "description": "Counter name. Not necessarily globally-unique, but unique within the\ncontext of the other fields.\nRequired.",
- "type": "string"
+ "type": "string",
+ "description": "Counter name. Not necessarily globally-unique, but unique within the\ncontext of the other fields.\nRequired."
},
"origin": {
"type": "string",
@@ -4885,35 +3265,58 @@
"type": "string"
},
"portion": {
+ "enum": [
+ "ALL",
+ "KEY",
+ "VALUE"
+ ],
"description": "Portion of this counter, either key or value.",
"type": "string",
"enumDescriptions": [
"Counter portion has not been set.",
"Counter reports a key.",
"Counter reports a value."
- ],
- "enum": [
- "ALL",
- "KEY",
- "VALUE"
]
+ },
+ "originalShuffleStepName": {
+ "type": "string",
+ "description": "The GroupByKey step name from the original graph."
+ },
+ "originalStepName": {
+ "description": "System generated name of the original step in the user's graph, before\noptimization.",
+ "type": "string"
+ },
+ "workerId": {
+ "type": "string",
+ "description": "ID of a particular worker."
}
},
"id": "CounterStructuredName",
- "description": "Identifies a counter within a per-job namespace. Counters whose structured\nnames are the same get merged into a single value for the job.",
- "type": "object"
+ "description": "Identifies a counter within a per-job namespace. Counters whose structured\nnames are the same get merged into a single value for the job."
},
"MetricUpdate": {
"description": "Describes the state of a metric.",
"type": "object",
"properties": {
+ "set": {
+ "type": "any",
+ "description": "Worker-computed aggregate value for the \"Set\" aggregation kind. The only\npossible value type is a list of Values whose type can be Long, Double,\nor String, according to the metric's type. All Values in the list must\nbe of the same type."
+ },
+ "cumulative": {
+ "description": "True if this metric is reported as the total cumulative aggregate\nvalue accumulated since the worker started working on this WorkItem.\nBy default this is false, indicating that this metric is reported\nas a delta that is not associated with any WorkItem.",
+ "type": "boolean"
+ },
+ "internal": {
+ "type": "any",
+ "description": "Worker-computed aggregate value for internal use by the Dataflow\nservice."
+ },
"kind": {
- "description": "Metric aggregation kind. The possible metric aggregation kinds are\n\"Sum\", \"Max\", \"Min\", \"Mean\", \"Set\", \"And\", \"Or\", and \"Distribution\".\nThe specified aggregation kind is case-insensitive.\n\nIf omitted, this is not an aggregated value but instead\na single metric sample value.",
- "type": "string"
+ "type": "string",
+ "description": "Metric aggregation kind. The possible metric aggregation kinds are\n\"Sum\", \"Max\", \"Min\", \"Mean\", \"Set\", \"And\", \"Or\", and \"Distribution\".\nThe specified aggregation kind is case-insensitive.\n\nIf omitted, this is not an aggregated value but instead\na single metric sample value."
},
"scalar": {
- "description": "Worker-computed aggregate value for aggregation kinds \"Sum\", \"Max\", \"Min\",\n\"And\", and \"Or\". The possible value types are Long, Double, and Boolean.",
- "type": "any"
+ "type": "any",
+ "description": "Worker-computed aggregate value for aggregation kinds \"Sum\", \"Max\", \"Min\",\n\"And\", and \"Or\". The possible value types are Long, Double, and Boolean."
},
"meanCount": {
"description": "Worker-computed aggregate value for the \"Mean\" aggregation kind.\nThis holds the count of the aggregated values and is used in combination\nwith mean_sum above to obtain the actual mean aggregate value.\nThe only possible value type is Long.",
@@ -4924,83 +3327,70 @@
"type": "any"
},
"updateTime": {
+ "type": "string",
"format": "google-datetime",
- "description": "Timestamp associated with the metric value. Optional when workers are\nreporting work progress; it will be filled in responses from the\nmetrics API.",
- "type": "string"
+ "description": "Timestamp associated with the metric value. Optional when workers are\nreporting work progress; it will be filled in responses from the\nmetrics API."
},
"name": {
- "description": "Name of the metric.",
- "$ref": "MetricStructuredName"
+ "$ref": "MetricStructuredName",
+ "description": "Name of the metric."
},
"distribution": {
- "description": "A struct value describing properties of a distribution of numeric values.",
- "type": "any"
- },
- "set": {
- "description": "Worker-computed aggregate value for the \"Set\" aggregation kind. The only\npossible value type is a list of Values whose type can be Long, Double,\nor String, according to the metric's type. All Values in the list must\nbe of the same type.",
- "type": "any"
- },
- "internal": {
- "description": "Worker-computed aggregate value for internal use by the Dataflow\nservice.",
- "type": "any"
- },
- "cumulative": {
- "description": "True if this metric is reported as the total cumulative aggregate\nvalue accumulated since the worker started working on this WorkItem.\nBy default this is false, indicating that this metric is reported\nas a delta that is not associated with any WorkItem.",
- "type": "boolean"
+ "type": "any",
+ "description": "A struct value describing properties of a distribution of numeric values."
}
},
"id": "MetricUpdate"
},
"ApproximateProgress": {
- "description": "Obsolete in favor of ApproximateReportedProgress and ApproximateSplitRequest.",
"type": "object",
"properties": {
- "remainingTime": {
- "format": "google-duration",
- "description": "Obsolete.",
- "type": "string"
- },
- "position": {
- "$ref": "Position",
- "description": "Obsolete."
- },
"percentComplete": {
"format": "float",
"description": "Obsolete.",
"type": "number"
+ },
+ "remainingTime": {
+ "type": "string",
+ "format": "google-duration",
+ "description": "Obsolete."
+ },
+ "position": {
+ "$ref": "Position",
+ "description": "Obsolete."
}
},
- "id": "ApproximateProgress"
+ "id": "ApproximateProgress",
+ "description": "Obsolete in favor of ApproximateReportedProgress and ApproximateSplitRequest."
},
"WorkerMessageResponse": {
+ "description": "A worker_message response allows the server to pass information to the\nsender.",
+ "type": "object",
"properties": {
- "workerHealthReportResponse": {
- "$ref": "WorkerHealthReportResponse",
- "description": "The service's response to a worker's health report."
- },
"workerShutdownNoticeResponse": {
"$ref": "WorkerShutdownNoticeResponse",
"description": "Service's response to shutdown notice (currently empty)."
},
"workerMetricsResponse": {
- "description": "Service's response to reporting worker metrics (currently empty).",
- "$ref": "ResourceUtilizationReportResponse"
+ "$ref": "ResourceUtilizationReportResponse",
+ "description": "Service's response to reporting worker metrics (currently empty)."
+ },
+ "workerHealthReportResponse": {
+ "$ref": "WorkerHealthReportResponse",
+ "description": "The service's response to a worker's health report."
}
},
- "id": "WorkerMessageResponse",
- "description": "A worker_message response allows the server to pass information to the\nsender.",
- "type": "object"
+ "id": "WorkerMessageResponse"
},
"TemplateMetadata": {
- "description": "Metadata describing a template.",
"type": "object",
"properties": {
"parameters": {
- "description": "The parameters for the template.",
"items": {
"$ref": "ParameterMetadata"
},
- "type": "array"
+ "type": "array",
+ "description": "The parameters for the template."
},
"name": {
"description": "Required. The name of the template.",
@@ -5011,51 +3401,45 @@
"type": "string"
}
},
- "id": "TemplateMetadata"
+ "id": "TemplateMetadata",
+ "description": "Metadata describing a template."
},
"WorkerMessage": {
"description": "WorkerMessage provides information to the backend about a worker.",
"type": "object",
"properties": {
+ "workerShutdownNotice": {
+ "$ref": "WorkerShutdownNotice",
+ "description": "Shutdown notice by workers."
+ },
+ "workerHealthReport": {
+ "$ref": "WorkerHealthReport",
+ "description": "The health of a worker."
+ },
"workerMessageCode": {
- "description": "A worker message code.",
- "$ref": "WorkerMessageCode"
+ "$ref": "WorkerMessageCode",
+ "description": "A worker message code."
},
"workerMetrics": {
"$ref": "ResourceUtilizationReport",
"description": "Resource metrics reported by workers."
},
"labels": {
- "description": "Labels are used to group WorkerMessages.\nFor example, a worker_message about a particular container\nmight have the labels:\n{ \"JOB_ID\": \"2015-04-22\",\n \"WORKER_ID\": \"wordcount-vm-2015…\"\n \"CONTAINER_TYPE\": \"worker\",\n \"CONTAINER_ID\": \"ac1234def\"}\nLabel tags typically correspond to Label enum values. However, for ease\nof development other strings can be used as tags. LABEL_UNSPECIFIED should\nnot be used here.",
"type": "object",
"additionalProperties": {
"type": "string"
- }
+ },
+ "description": "Labels are used to group WorkerMessages.\nFor example, a worker_message about a particular container\nmight have the labels:\n{ \"JOB_ID\": \"2015-04-22\",\n \"WORKER_ID\": \"wordcount-vm-2015…\"\n \"CONTAINER_TYPE\": \"worker\",\n \"CONTAINER_ID\": \"ac1234def\"}\nLabel tags typically correspond to Label enum values. However, for ease\nof development other strings can be used as tags. LABEL_UNSPECIFIED should\nnot be used here."
},
"time": {
"format": "google-datetime",
"description": "The timestamp of the worker_message.",
"type": "string"
- },
- "workerShutdownNotice": {
- "$ref": "WorkerShutdownNotice",
- "description": "Shutdown notice by workers."
- },
- "workerHealthReport": {
- "description": "The health of a worker.",
- "$ref": "WorkerHealthReport"
}
},
"id": "WorkerMessage"
},
- "WorkerShutdownNoticeResponse": {
- "description": "Service-side response to WorkerMessage issuing shutdown notice.",
- "type": "object",
- "properties": {},
- "id": "WorkerShutdownNoticeResponse"
- },
"JobMetrics": {
- "description": "JobMetrics contains a collection of metrics descibing the detailed progress\nof a Dataflow job. Metrics correspond to user-defined and system-defined\nmetrics in the job.\n\nThis resource captures only the most recent values of each metric;\ntime-series data can be queried for them (under the same metric names)\nfrom Cloud Monitoring.",
"type": "object",
"properties": {
"metrics": {
@@ -5066,18 +3450,1637 @@
"type": "array"
},
"metricTime": {
+ "type": "string",
"format": "google-datetime",
- "description": "Timestamp as of which metric values are current.",
+ "description": "Timestamp as of which metric values are current."
+ }
+ },
+ "id": "JobMetrics",
+ "description": "JobMetrics contains a collection of metrics descibing the detailed progress\nof a Dataflow job. Metrics correspond to user-defined and system-defined\nmetrics in the job.\n\nThis resource captures only the most recent values of each metric;\ntime-series data can be queried for them (under the same metric names)\nfrom Cloud Monitoring."
+ },
+ "WorkerShutdownNoticeResponse": {
+ "description": "Service-side response to WorkerMessage issuing shutdown notice.",
+ "type": "object",
+ "properties": {},
+ "id": "WorkerShutdownNoticeResponse"
+ },
+ "FloatingPointList": {
+ "description": "A metric value representing a list of floating point numbers.",
+ "type": "object",
+ "properties": {
+ "elements": {
+ "items": {
+ "type": "number",
+ "format": "double"
+ },
+ "type": "array",
+ "description": "Elements of the list."
+ }
+ },
+ "id": "FloatingPointList"
+ },
+ "CounterUpdate": {
+ "type": "object",
+ "properties": {
+ "floatingPointList": {
+ "$ref": "FloatingPointList",
+ "description": "List of floating point numbers, for Set."
+ },
+ "integer": {
+ "$ref": "SplitInt64",
+ "description": "Integer value for Sum, Max, Min."
+ },
+ "structuredNameAndMetadata": {
+ "$ref": "CounterStructuredNameAndMetadata",
+ "description": "Counter structured name and metadata."
+ },
+ "integerList": {
+ "$ref": "IntegerList",
+ "description": "List of integers, for Set."
+ },
+ "floatingPoint": {
+ "type": "number",
+ "format": "double",
+ "description": "Floating point value for Sum, Max, Min."
+ },
+ "integerMean": {
+ "$ref": "IntegerMean",
+ "description": "Integer mean aggregation value for Mean."
+ },
+ "internal": {
+ "description": "Value for internally-defined counters used by the Dataflow service.",
+ "type": "any"
+ },
+ "cumulative": {
+ "description": "True if this counter is reported as the total cumulative aggregate\nvalue accumulated since the worker started working on this WorkItem.\nBy default this is false, indicating that this counter is reported\nas a delta.",
+ "type": "boolean"
+ },
+ "floatingPointMean": {
+ "$ref": "FloatingPointMean",
+ "description": "Floating point mean aggregation value for Mean."
+ },
+ "boolean": {
+ "type": "boolean",
+ "description": "Boolean value for And, Or."
+ },
+ "nameAndKind": {
+ "$ref": "NameAndKind",
+ "description": "Counter name and aggregation type."
+ },
+ "distribution": {
+ "$ref": "DistributionUpdate",
+ "description": "Distribution data"
+ },
+ "stringList": {
+ "$ref": "StringList",
+ "description": "List of strings, for Set."
+ },
+ "shortId": {
+ "type": "string",
+ "format": "int64",
+ "description": "The service-generated short identifier for this counter.\nThe short_id -\u003e (name, metadata) mapping is constant for the lifetime of\na job."
+ }
+ },
+ "id": "CounterUpdate",
+ "description": "An update to a Counter sent from a worker."
+ },
+ "SourceMetadata": {
+ "description": "Metadata about a Source useful for automatically optimizing\nand tuning the pipeline, etc.",
+ "type": "object",
+ "properties": {
+ "estimatedSizeBytes": {
+ "type": "string",
+ "format": "int64",
+ "description": "An estimate of the total size (in bytes) of the data that would be\nread from this source. This estimate is in terms of external storage\nsize, before any decompression or other processing done by the reader."
+ },
+ "infinite": {
+ "type": "boolean",
+ "description": "Specifies that the size of this source is known to be infinite\n(this is a streaming source)."
+ },
+ "producesSortedKeys": {
+ "type": "boolean",
+ "description": "Whether this source is known to produce key/value pairs with\nthe (encoded) keys in lexicographically sorted order."
+ }
+ },
+ "id": "SourceMetadata"
+ },
+ "DistributionUpdate": {
+ "description": "A metric value representing a distribution.",
+ "type": "object",
+ "properties": {
+ "min": {
+ "$ref": "SplitInt64",
+ "description": "The minimum value present in the distribution."
+ },
+ "sumOfSquares": {
+ "format": "double",
+ "description": "Use a double since the sum of squares is likely to overflow int64.",
+ "type": "number"
+ },
+ "sum": {
+ "$ref": "SplitInt64",
+ "description": "Use an int64 since we'd prefer the added precision. If overflow is a common\nproblem we can detect it and use an additional int64 or a double."
+ },
+ "histogram": {
+ "$ref": "Histogram",
+ "description": "(Optional) Histogram of value counts for the distribution."
+ },
+ "max": {
+ "$ref": "SplitInt64",
+ "description": "The maximum value present in the distribution."
+ },
+ "count": {
+ "$ref": "SplitInt64",
+ "description": "The count of the number of elements present in the distribution."
+ }
+ },
+ "id": "DistributionUpdate"
+ },
+ "SourceFork": {
+ "type": "object",
+ "properties": {
+ "residualSource": {
+ "$ref": "DerivedSource",
+ "description": "DEPRECATED"
+ },
+ "primary": {
+ "$ref": "SourceSplitShard",
+ "description": "DEPRECATED"
+ },
+ "primarySource": {
+ "$ref": "DerivedSource",
+ "description": "DEPRECATED"
+ },
+ "residual": {
+ "$ref": "SourceSplitShard",
+ "description": "DEPRECATED"
+ }
+ },
+ "id": "SourceFork",
+ "description": "DEPRECATED in favor of DynamicSourceSplit."
+ },
+ "WorkerHealthReportResponse": {
+ "description": "WorkerHealthReportResponse contains information returned to the worker\nin response to a health ping.",
+ "type": "object",
+ "properties": {
+ "reportInterval": {
+ "format": "google-duration",
+ "description": "A positive value indicates the worker should change its reporting interval\nto the specified value.\n\nThe default value of zero means no change in report rate is requested by\nthe server.",
"type": "string"
}
},
- "id": "JobMetrics"
+ "id": "WorkerHealthReportResponse"
+ },
+ "WorkItemStatus": {
+ "description": "Conveys a worker's progress through the work described by a WorkItem.",
+ "type": "object",
+ "properties": {
+ "sourceFork": {
+ "$ref": "SourceFork",
+ "description": "DEPRECATED in favor of dynamic_source_split."
+ },
+ "totalThrottlerWaitTimeSeconds": {
+ "type": "number",
+ "format": "double",
+ "description": "Total time the worker spent being throttled by external systems."
+ },
+ "counterUpdates": {
+ "description": "Worker output counters for this WorkItem.",
+ "items": {
+ "$ref": "CounterUpdate"
+ },
+ "type": "array"
+ },
+ "workItemId": {
+ "description": "Identifies the WorkItem.",
+ "type": "string"
+ },
+ "errors": {
+ "items": {
+ "$ref": "Status"
+ },
+ "type": "array",
+ "description": "Specifies errors which occurred during processing. If errors are\nprovided, and completed = true, then the WorkItem is considered\nto have failed."
+ },
+ "metricUpdates": {
+ "description": "DEPRECATED in favor of counter_updates.",
+ "items": {
+ "$ref": "MetricUpdate"
+ },
+ "type": "array"
+ },
+ "dynamicSourceSplit": {
+ "$ref": "DynamicSourceSplit",
+ "description": "See documentation of stop_position."
+ },
+ "sourceOperationResponse": {
+ "$ref": "SourceOperationResponse",
+ "description": "If the work item represented a SourceOperationRequest, and the work\nis completed, contains the result of the operation."
+ },
+ "progress": {
+ "$ref": "ApproximateProgress",
+ "description": "DEPRECATED in favor of reported_progress."
+ },
+ "requestedLeaseDuration": {
+ "format": "google-duration",
+ "description": "Amount of time the worker requests for its lease.",
+ "type": "string"
+ },
+ "reportIndex": {
+ "type": "string",
+ "format": "int64",
+ "description": "The report index. When a WorkItem is leased, the lease will\ncontain an initial report index. When a WorkItem's status is\nreported to the system, the report should be sent with\nthat report index, and the response will contain the index the\nworker should use for the next report. Reports received with\nunexpected index values will be rejected by the service.\n\nIn order to preserve idempotency, the worker should not alter the\ncontents of a report, even if the worker must submit the same\nreport multiple times before getting back a response. The worker\nshould not submit a subsequent report until the response for the\nprevious report had been received from the service."
+ },
+ "stopPosition": {
+ "$ref": "Position",
+ "description": "A worker may split an active map task in two parts, \"primary\" and\n\"residual\", continuing to process the primary part and returning the\nresidual part into the pool of available work.\nThis event is called a \"dynamic split\" and is critical to the dynamic\nwork rebalancing feature. The two obtained sub-tasks are called\n\"parts\" of the split.\nThe parts, if concatenated, must represent the same input as would\nbe read by the current task if the split did not happen.\nThe exact way in which the original task is decomposed into the two\nparts is specified either as a position demarcating them\n(stop_position), or explicitly as two DerivedSources, if this\ntask consumes a user-defined source type (dynamic_source_split).\n\nThe \"current\" task is adjusted as a result of the split: after a task\nwith range [A, B) sends a stop_position update at C, its range is\nconsidered to be [A, C), e.g.:\n* Progress should be interpreted relative to the new range, e.g.\n \"75% completed\" means \"75% of [A, C) completed\"\n* The worker should interpret proposed_stop_position relative to the\n new range, e.g. \"split at 68%\" should be interpreted as\n \"split at 68% of [A, C)\".\n* If the worker chooses to split again using stop_position, only\n stop_positions in [A, C) will be accepted.\n* Etc.\ndynamic_source_split has similar semantics: e.g., if a task with\nsource S splits using dynamic_source_split into {P, R}\n(where P and R must be together equivalent to S), then subsequent\nprogress and proposed_stop_position should be interpreted relative\nto P, and in a potential subsequent dynamic_source_split into {P', R'},\nP' and R' must be together equivalent to P, etc."
+ },
+ "completed": {
+ "description": "True if the WorkItem was completed (successfully or unsuccessfully).",
+ "type": "boolean"
+ },
+ "reportedProgress": {
+ "$ref": "ApproximateReportedProgress",
+ "description": "The worker's progress through this WorkItem."
+ }
+ },
+ "id": "WorkItemStatus"
+ },
+ "ComponentSource": {
+ "type": "object",
+ "properties": {
+ "originalTransformOrCollection": {
+ "type": "string",
+ "description": "User name for the original user transform or collection with which this\nsource is most closely associated."
+ },
+ "name": {
+ "type": "string",
+ "description": "Dataflow service generated name for this source."
+ },
+ "userName": {
+ "type": "string",
+ "description": "Human-readable name for this transform; may be user or system generated."
+ }
+ },
+ "id": "ComponentSource",
+ "description": "Description of an interstitial value between transforms in an execution\nstage."
+ },
+ "Histogram": {
+ "type": "object",
+ "properties": {
+ "firstBucketOffset": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Starting index of first stored bucket. The non-inclusive upper-bound of\nthe ith bucket is given by:\n pow(10,(i-first_bucket_offset)/3) * (1,2,5)[(i-first_bucket_offset)%3]"
+ },
+ "bucketCounts": {
+ "items": {
+ "type": "string",
+ "format": "int64"
+ },
+ "type": "array",
+ "description": "Counts of values in each bucket. For efficiency, prefix and trailing\nbuckets with count = 0 are elided. Buckets can store the full range of\nvalues of an unsigned long, with ULLONG_MAX falling into the 59th bucket\nwith range [1e19, 2e19)."
+ }
+ },
+ "id": "Histogram",
+ "description": "Histogram of value counts for a distribution.\n\nBuckets have an inclusive lower bound and exclusive upper bound and use\n\"1,2,5 bucketing\": The first bucket range is from [0,1) and all subsequent\nbucket boundaries are powers of ten multiplied by 1, 2, or 5. Thus, bucket\nboundaries are 0, 1, 2, 5, 10, 20, 50, 100, 200, 500, 1000, ...\nNegative values are not supported."
+ },
+ "WorkItemServiceState": {
+ "type": "object",
+ "properties": {
+ "splitRequest": {
+ "$ref": "ApproximateSplitRequest",
+ "description": "The progress point in the WorkItem where the Dataflow service\nsuggests that the worker truncate the task."
+ },
+ "suggestedStopPosition": {
+ "$ref": "Position",
+ "description": "Obsolete, always empty."
+ },
+ "reportStatusInterval": {
+ "format": "google-duration",
+ "description": "New recommended reporting interval.",
+ "type": "string"
+ },
+ "harnessData": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object."
+ },
+ "description": "Other data returned by the service, specific to the particular\nworker harness."
+ },
+ "leaseExpireTime": {
+ "type": "string",
+ "format": "google-datetime",
+ "description": "Time at which the current lease will expire."
+ },
+ "metricShortId": {
+ "items": {
+ "$ref": "MetricShortId"
+ },
+ "type": "array",
+ "description": "The short ids that workers should use in subsequent metric updates.\nWorkers should strive to use short ids whenever possible, but it is ok\nto request the short_id again if a worker lost track of it\n(e.g. if the worker is recovering from a crash).\nNOTE: it is possible that the response may have short ids for a subset\nof the metrics."
+ },
+ "nextReportIndex": {
+ "format": "int64",
+ "description": "The index value to use for the next report sent by the worker.\nNote: If the report call fails for whatever reason, the worker should\nreuse this index for subsequent report attempts.",
+ "type": "string"
+ },
+ "suggestedStopPoint": {
+ "$ref": "ApproximateProgress",
+ "description": "DEPRECATED in favor of split_request."
+ }
+ },
+ "id": "WorkItemServiceState",
+ "description": "The Dataflow service's idea of the current state of a WorkItem\nbeing processed by a worker."
+ },
+ "MetricStructuredName": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Worker-defined metric name."
+ },
+ "origin": {
+ "description": "Origin (namespace) of metric name. May be blank for user-define metrics;\nwill be \"dataflow\" for metrics defined by the Dataflow service or SDK.",
+ "type": "string"
+ },
+ "context": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Zero or more labeled fields which identify the part of the job this\nmetric is associated with, such as the name of a step or collection.\n\nFor example, built-in counters associated with steps will have\ncontext['step'] = \u003cstep-name\u003e. Counters associated with PCollections\nin the SDK will have context['pcollection'] = \u003cpcollection-name\u003e."
+ }
+ },
+ "id": "MetricStructuredName",
+ "description": "Identifies a metric, by describing the source which generated the\nmetric."
+ },
+ "SeqMapTaskOutputInfo": {
+ "description": "Information about an output of a SeqMapTask.",
+ "type": "object",
+ "properties": {
+ "sink": {
+ "$ref": "Sink",
+ "description": "The sink to write the output value to."
+ },
+ "tag": {
+ "type": "string",
+ "description": "The id of the TupleTag the user code will tag the output value by."
+ }
+ },
+ "id": "SeqMapTaskOutputInfo"
+ },
+ "JobExecutionStageInfo": {
+ "description": "Contains information about how a particular\ngoogle.dataflow.v1beta3.Step will be executed.",
+ "type": "object",
+ "properties": {
+ "stepName": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "The steps associated with the execution stage.\nNote that stages may have several steps, and that a given step\nmight be run by more than one stage."
+ }
+ },
+ "id": "JobExecutionStageInfo"
+ },
+ "KeyRangeLocation": {
+ "type": "object",
+ "properties": {
+ "deprecatedPersistentDirectory": {
+ "type": "string",
+ "description": "DEPRECATED. The location of the persistent state for this range, as a\npersistent directory in the worker local filesystem."
+ },
+ "deliveryEndpoint": {
+ "description": "The physical location of this range assignment to be used for\nstreaming computation cross-worker message delivery.",
+ "type": "string"
+ },
+ "dataDisk": {
+ "type": "string",
+ "description": "The name of the data disk where data for this range is stored.\nThis name is local to the Google Cloud Platform project and uniquely\nidentifies the disk within that project, for example\n\"myproject-1014-104817-4c2-harness-0-disk-1\"."
+ },
+ "start": {
+ "description": "The start (inclusive) of the key range.",
+ "type": "string"
+ },
+ "end": {
+ "type": "string",
+ "description": "The end (exclusive) of the key range."
+ }
+ },
+ "id": "KeyRangeLocation",
+ "description": "Location information for a specific key-range of a sharded computation.\nCurrently we only support UTF-8 character splits to simplify encoding into\nJSON."
+ },
+ "SourceGetMetadataRequest": {
+ "type": "object",
+ "properties": {
+ "source": {
+ "$ref": "Source",
+ "description": "Specification of the source whose metadata should be computed."
+ }
+ },
+ "id": "SourceGetMetadataRequest",
+ "description": "A request to compute the SourceMetadata of a Source."
+ },
+ "SeqMapTask": {
+ "description": "Describes a particular function to invoke.",
+ "type": "object",
+ "properties": {
+ "stageName": {
+ "type": "string",
+ "description": "System-defined name of the stage containing the SeqDo operation.\nUnique across the workflow."
+ },
+ "systemName": {
+ "type": "string",
+ "description": "System-defined name of the SeqDo operation.\nUnique across the workflow."
+ },
+ "userFn": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "The user function to invoke.",
+ "type": "object"
+ },
+ "name": {
+ "type": "string",
+ "description": "The user-provided name of the SeqDo operation."
+ },
+ "outputInfos": {
+ "description": "Information about each of the outputs.",
+ "items": {
+ "$ref": "SeqMapTaskOutputInfo"
+ },
+ "type": "array"
+ },
+ "inputs": {
+ "items": {
+ "$ref": "SideInputInfo"
+ },
+ "type": "array",
+ "description": "Information about each of the inputs."
+ }
+ },
+ "id": "SeqMapTask"
+ },
+ "NameAndKind": {
+ "description": "Basic metadata about a counter.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the counter.",
+ "type": "string"
+ },
+ "kind": {
+ "type": "string",
+ "enumDescriptions": [
+ "Counter aggregation kind was not set.",
+ "Aggregated value is the sum of all contributed values.",
+ "Aggregated value is the max of all contributed values.",
+ "Aggregated value is the min of all contributed values.",
+ "Aggregated value is the mean of all contributed values.",
+ "Aggregated value represents the logical 'or' of all contributed values.",
+ "Aggregated value represents the logical 'and' of all contributed values.",
+ "Aggregated value is a set of unique contributed values.",
+ "Aggregated value captures statistics about a distribution."
+ ],
+ "enum": [
+ "INVALID",
+ "SUM",
+ "MAX",
+ "MIN",
+ "MEAN",
+ "OR",
+ "AND",
+ "SET",
+ "DISTRIBUTION"
+ ],
+ "description": "Counter aggregation kind."
+ }
+ },
+ "id": "NameAndKind"
+ },
+ "WorkerMessageCode": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "description": "The code is a string intended for consumption by a machine that identifies\nthe type of message being sent.\nExamples:\n 1. \"HARNESS_STARTED\" might be used to indicate the worker harness has\n started.\n 2. \"GCS_DOWNLOAD_ERROR\" might be used to indicate an error downloading\n a GCS file as part of the boot process of one of the worker containers.\n\nThis is a string and not an enum to make it easy to add new codes without\nwaiting for an API change.",
+ "type": "string"
+ },
+ "parameters": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "Parameters contains specific information about the code.\n\nThis is a struct to allow parameters of different types.\n\nExamples:\n 1. For a \"HARNESS_STARTED\" message parameters might provide the name\n of the worker and additional data like timing information.\n 2. For a \"GCS_DOWNLOAD_ERROR\" parameters might contain fields listing\n the GCS objects being downloaded and fields containing errors.\n\nIn general complex data structures should be avoided. If a worker\nneeds to send a specific and complicated data structure then please\nconsider defining a new proto and adding it to the data oneof in\nWorkerMessageResponse.\n\nConventions:\n Parameters should only be used for information that isn't typically passed\n as a label.\n hostname and other worker identifiers should almost always be passed\n as labels since they will be included on most messages.",
+ "type": "object"
+ }
+ },
+ "id": "WorkerMessageCode",
+ "description": "A message code is used to report status and error messages to the service.\nThe message codes are intended to be machine readable. The service will\ntake care of translating these into user understandable messages if\nnecessary.\n\nExample use cases:\n 1. Worker processes reporting successful startup.\n 2. Worker processes reporting specific errors (e.g. package staging\n failure)."
+ },
+ "CustomSourceLocation": {
+ "description": "Identifies the location of a custom souce.",
+ "type": "object",
+ "properties": {
+ "stateful": {
+ "description": "Whether this source is stateful.",
+ "type": "boolean"
+ }
+ },
+ "id": "CustomSourceLocation"
+ },
+ "MapTask": {
+ "description": "MapTask consists of an ordered set of instructions, each of which\ndescribes one particular low-level operation for the worker to\nperform in order to accomplish the MapTask's WorkItem.\n\nEach instruction must appear in the list before any instructions which\ndepends on its output.",
+ "type": "object",
+ "properties": {
+ "stageName": {
+ "type": "string",
+ "description": "System-defined name of the stage containing this MapTask.\nUnique across the workflow."
+ },
+ "systemName": {
+ "description": "System-defined name of this MapTask.\nUnique across the workflow.",
+ "type": "string"
+ },
+ "instructions": {
+ "items": {
+ "$ref": "ParallelInstruction"
+ },
+ "type": "array",
+ "description": "The instructions in the MapTask."
+ }
+ },
+ "id": "MapTask"
+ },
+ "FloatingPointMean": {
+ "description": "A representation of a floating point mean metric contribution.",
+ "type": "object",
+ "properties": {
+ "sum": {
+ "format": "double",
+ "description": "The sum of all values being aggregated.",
+ "type": "number"
+ },
+ "count": {
+ "$ref": "SplitInt64",
+ "description": "The number of values being aggregated."
+ }
+ },
+ "id": "FloatingPointMean"
+ },
+ "ReportWorkItemStatusResponse": {
+ "type": "object",
+ "properties": {
+ "workItemServiceStates": {
+ "description": "A set of messages indicating the service-side state for each\nWorkItem whose status was reported, in the same order as the\nWorkItemStatus messages in the ReportWorkItemStatusRequest which\nresulting in this response.",
+ "items": {
+ "$ref": "WorkItemServiceState"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ReportWorkItemStatusResponse",
+ "description": "Response from a request to report the status of WorkItems."
+ },
+ "InstructionOutput": {
+ "type": "object",
+ "properties": {
+ "originalName": {
+ "type": "string",
+ "description": "System-defined name for this output in the original workflow graph.\nOutputs that do not contribute to an original instruction do not set this."
+ },
+ "systemName": {
+ "type": "string",
+ "description": "System-defined name of this output.\nUnique across the workflow."
+ },
+ "onlyCountKeyBytes": {
+ "type": "boolean",
+ "description": "For system-generated byte and mean byte metrics, certain instructions\nshould only report the key size."
+ },
+ "onlyCountValueBytes": {
+ "type": "boolean",
+ "description": "For system-generated byte and mean byte metrics, certain instructions\nshould only report the value size."
+ },
+ "codec": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "The codec to use to encode data being written via this output."
+ },
+ "name": {
+ "type": "string",
+ "description": "The user-provided name of this output."
+ }
+ },
+ "id": "InstructionOutput",
+ "description": "An output of an instruction."
+ },
+ "CreateJobFromTemplateRequest": {
+ "type": "object",
+ "properties": {
+ "jobName": {
+ "type": "string",
+ "description": "Required. The job name to use for the created job."
+ },
+ "gcsPath": {
+ "type": "string",
+ "description": "Required. A Cloud Storage path to the template from which to\ncreate the job.\nMust be a valid Cloud Storage URL, beginning with `gs://`."
+ },
+ "environment": {
+ "$ref": "RuntimeEnvironment",
+ "description": "The runtime environment for the job."
+ },
+ "location": {
+ "description": "The location to which to direct the request.",
+ "type": "string"
+ },
+ "parameters": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The runtime parameters to pass to the job."
+ }
+ },
+ "id": "CreateJobFromTemplateRequest",
+ "description": "A request to create a Cloud Dataflow job from a template."
+ },
+ "IntegerMean": {
+ "type": "object",
+ "properties": {
+ "count": {
+ "$ref": "SplitInt64",
+ "description": "The number of values being aggregated."
+ },
+ "sum": {
+ "$ref": "SplitInt64",
+ "description": "The sum of all values being aggregated."
+ }
+ },
+ "id": "IntegerMean",
+ "description": "A representation of an integer mean metric contribution."
+ },
+ "ListJobsResponse": {
+ "type": "object",
+ "properties": {
+ "failedLocation": {
+ "items": {
+ "$ref": "FailedLocation"
+ },
+ "type": "array",
+ "description": "Zero or more messages describing locations that failed to respond."
+ },
+ "nextPageToken": {
+ "description": "Set if there may be more results than fit in this response.",
+ "type": "string"
+ },
+ "jobs": {
+ "description": "A subset of the requested job information.",
+ "items": {
+ "$ref": "Job"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListJobsResponse",
+ "description": "Response to a request to list Cloud Dataflow jobs. This may be a partial\nresponse, depending on the page size in the ListJobsRequest."
+ },
+ "ComputationTopology": {
+ "type": "object",
+ "properties": {
+ "stateFamilies": {
+ "description": "The state family values.",
+ "items": {
+ "$ref": "StateFamilyConfig"
+ },
+ "type": "array"
+ },
+ "outputs": {
+ "description": "The outputs from the computation.",
+ "items": {
+ "$ref": "StreamLocation"
+ },
+ "type": "array"
+ },
+ "systemStageName": {
+ "description": "The system stage name.",
+ "type": "string"
+ },
+ "computationId": {
+ "description": "The ID of the computation.",
+ "type": "string"
+ },
+ "inputs": {
+ "description": "The inputs to the computation.",
+ "items": {
+ "$ref": "StreamLocation"
+ },
+ "type": "array"
+ },
+ "keyRanges": {
+ "items": {
+ "$ref": "KeyRangeLocation"
+ },
+ "type": "array",
+ "description": "The key ranges processed by the computation."
+ }
+ },
+ "id": "ComputationTopology",
+ "description": "All configuration data for a particular Computation."
+ },
+ "RuntimeEnvironment": {
+ "type": "object",
+ "properties": {
+ "maxWorkers": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The maximum number of Google Compute Engine instances to be made\navailable to your pipeline during execution, from 1 to 1000."
+ },
+ "serviceAccountEmail": {
+ "type": "string",
+ "description": "The email address of the service account to run the job as."
+ },
+ "tempLocation": {
+ "description": "The Cloud Storage path to use for temporary files.\nMust be a valid Cloud Storage URL, beginning with `gs://`.",
+ "type": "string"
+ },
+ "bypassTempDirValidation": {
+ "description": "Whether to bypass the safety checks for the job's temporary directory.\nUse with caution.",
+ "type": "boolean"
+ },
+ "machineType": {
+ "description": "The machine type to use for the job. Defaults to the value from the\ntemplate if not specified.",
+ "type": "string"
+ },
+ "zone": {
+ "description": "The Compute Engine [availability\nzone](https://cloud.google.com/compute/docs/regions-zones/regions-zones)\nfor launching worker instances to run your pipeline.",
+ "type": "string"
+ }
+ },
+ "id": "RuntimeEnvironment",
+ "description": "The environment values to set at runtime."
+ },
+ "StreamingSideInputLocation": {
+ "type": "object",
+ "properties": {
+ "stateFamily": {
+ "type": "string",
+ "description": "Identifies the state family where this side input is stored."
+ },
+ "tag": {
+ "description": "Identifies the particular side input within the streaming Dataflow job.",
+ "type": "string"
+ }
+ },
+ "id": "StreamingSideInputLocation",
+ "description": "Identifies the location of a streaming side input."
+ },
+ "MountedDataDisk": {
+ "description": "Describes mounted data disk.",
+ "type": "object",
+ "properties": {
+ "dataDisk": {
+ "description": "The name of the data disk.\nThis name is local to the Google Cloud Platform project and uniquely\nidentifies the disk within that project, for example\n\"myproject-1014-104817-4c2-harness-0-disk-1\".",
+ "type": "string"
+ }
+ },
+ "id": "MountedDataDisk"
+ },
+ "LaunchTemplateResponse": {
+ "type": "object",
+ "properties": {
+ "job": {
+ "$ref": "Job",
+ "description": "The job that was launched, if the request was not a dry run and\nthe job was successfully launched."
+ }
+ },
+ "id": "LaunchTemplateResponse",
+ "description": "Response to the request to launch a template."
+ },
+ "Job": {
+ "description": "Defines a job to be run by the Cloud Dataflow service.",
+ "type": "object",
+ "properties": {
+ "currentStateTime": {
+ "type": "string",
+ "format": "google-datetime",
+ "description": "The timestamp associated with the current state."
+ },
+ "transformNameMapping": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The map of transform name prefixes of the job to be replaced to the\ncorresponding name prefixes of the new job.",
+ "type": "object"
+ },
+ "environment": {
+ "$ref": "Environment",
+ "description": "The environment for the job."
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "User-defined labels for this job.\n\nThe labels map can contain no more than 64 entries. Entries of the labels\nmap are UTF8 strings that comply with the following restrictions:\n\n* Keys must conform to regexp: \\p{Ll}\\p{Lo}{0,62}\n* Values must conform to regexp: [\\p{Ll}\\p{Lo}\\p{N}_-]{0,63}\n* Both keys and values are additionally constrained to be \u003c= 128 bytes in\nsize.",
+ "type": "object"
+ },
+ "createTime": {
+ "type": "string",
+ "format": "google-datetime",
+ "description": "The timestamp when the job was initially created. Immutable and set by the\nCloud Dataflow service."
+ },
+ "stageStates": {
+ "description": "This field may be mutated by the Cloud Dataflow service;\ncallers cannot mutate it.",
+ "items": {
+ "$ref": "ExecutionStageState"
+ },
+ "type": "array"
+ },
+ "type": {
+ "enum": [
+ "JOB_TYPE_UNKNOWN",
+ "JOB_TYPE_BATCH",
+ "JOB_TYPE_STREAMING"
+ ],
+ "description": "The type of Cloud Dataflow job.",
+ "type": "string",
+ "enumDescriptions": [
+ "The type of the job is unspecified, or unknown.",
+ "A batch job with a well-defined end point: data is read, data is\nprocessed, data is written, and the job is done.",
+ "A continuously streaming job with no end: data is read,\nprocessed, and written continuously."
+ ]
+ },
+ "projectId": {
+ "type": "string",
+ "description": "The ID of the Cloud Platform project that the job belongs to."
+ },
+ "pipelineDescription": {
+ "$ref": "PipelineDescription",
+ "description": "Preliminary field: The format of this data may change at any time.\nA description of the user pipeline and stages through which it is executed.\nCreated by Cloud Dataflow service. Only retrieved with\nJOB_VIEW_DESCRIPTION or JOB_VIEW_ALL."
+ },
+ "replaceJobId": {
+ "type": "string",
+ "description": "If this job is an update of an existing job, this field is the job ID\nof the job it replaced.\n\nWhen sending a `CreateJobRequest`, you can update a job by specifying it\nhere. The job named here is stopped, and its intermediate state is\ntransferred to this job."
+ },
+ "requestedState": {
+ "type": "string",
+ "enumDescriptions": [
+ "The job's run state isn't specified.",
+ "`JOB_STATE_STOPPED` indicates that the job has not\nyet started to run.",
+ "`JOB_STATE_RUNNING` indicates that the job is currently running.",
+ "`JOB_STATE_DONE` indicates that the job has successfully completed.\nThis is a terminal job state. This state may be set by the Cloud Dataflow\nservice, as a transition from `JOB_STATE_RUNNING`. It may also be set via a\nCloud Dataflow `UpdateJob` call, if the job has not yet reached a terminal\nstate.",
+ "`JOB_STATE_FAILED` indicates that the job has failed. This is a\nterminal job state. This state may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_RUNNING`.",
+ "`JOB_STATE_CANCELLED` indicates that the job has been explicitly\ncancelled. This is a terminal job state. This state may only be\nset via a Cloud Dataflow `UpdateJob` call, and only if the job has not\nyet reached another terminal state.",
+ "`JOB_STATE_UPDATED` indicates that the job was successfully updated,\nmeaning that this job was stopped and another job was started, inheriting\nstate from this one. This is a terminal job state. This state may only be\nset by the Cloud Dataflow service, and only as a transition from\n`JOB_STATE_RUNNING`.",
+ "`JOB_STATE_DRAINING` indicates that the job is in the process of draining.\nA draining job has stopped pulling from its input sources and is processing\nany data that remains in-flight. This state may be set via a Cloud Dataflow\n`UpdateJob` call, but only as a transition from `JOB_STATE_RUNNING`. Jobs\nthat are draining may only transition to `JOB_STATE_DRAINED`,\n`JOB_STATE_CANCELLED`, or `JOB_STATE_FAILED`.",
+ "`JOB_STATE_DRAINED` indicates that the job has been drained.\nA drained job terminated by stopping pulling from its input sources and\nprocessing any data that remained in-flight when draining was requested.\nThis state is a terminal state, may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_DRAINING`.",
+ "'JOB_STATE_PENDING' indicates that the job has been created but is not yet\nrunning. Jobs that are pending may only transition to `JOB_STATE_RUNNING`,\nor `JOB_STATE_FAILED`.",
+ "'JOB_STATE_CANCELLING' indicates that the job has been explicitly cancelled\nand is in the process of stopping. Jobs that are cancelling may only\ntransition to 'JOB_STATE_CANCELLED' or 'JOB_STATE_FAILED'."
+ ],
+ "enum": [
+ "JOB_STATE_UNKNOWN",
+ "JOB_STATE_STOPPED",
+ "JOB_STATE_RUNNING",
+ "JOB_STATE_DONE",
+ "JOB_STATE_FAILED",
+ "JOB_STATE_CANCELLED",
+ "JOB_STATE_UPDATED",
+ "JOB_STATE_DRAINING",
+ "JOB_STATE_DRAINED",
+ "JOB_STATE_PENDING",
+ "JOB_STATE_CANCELLING"
+ ],
+ "description": "The job's requested state.\n\n`UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and\n`JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may\nalso be used to directly set a job's requested state to\n`JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the\njob if it has not already reached a terminal state."
+ },
+ "tempFiles": {
+ "description": "A set of files the system should be aware of that are used\nfor temporary storage. These temporary files will be\nremoved on job completion.\nNo duplicates are allowed.\nNo file patterns are supported.\n\nThe supported files are:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "clientRequestId": {
+ "description": "The client's unique identifier of the job, re-used across retried attempts.\nIf this field is set, the service will ensure its uniqueness.\nThe request to create a job will fail if the service has knowledge of a\npreviously submitted job with the same client's ID and job name.\nThe caller may use this field to ensure idempotence of job\ncreation across retried attempts to create a job.\nBy default, the field is empty and, in that case, the service ignores it.",
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "description": "The user-specified Cloud Dataflow job name.\n\nOnly one Job with a given name may exist in a project at any\ngiven time. If a caller attempts to create a Job with the same\nname as an already-existing Job, the attempt returns the\nexisting Job.\n\nThe name must match the regular expression\n`[a-z]([-a-z0-9]{0,38}[a-z0-9])?`"
+ },
+ "steps": {
+ "items": {
+ "$ref": "Step"
+ },
+ "type": "array",
+ "description": "The top-level steps that constitute the entire job."
+ },
+ "replacedByJobId": {
+ "description": "If another job is an update of this job (and thus, this job is in\n`JOB_STATE_UPDATED`), this field contains the ID of that job.",
+ "type": "string"
+ },
+ "executionInfo": {
+ "$ref": "JobExecutionInfo",
+ "description": "Deprecated."
+ },
+ "id": {
+ "description": "The unique ID of this job.\n\nThis field is set by the Cloud Dataflow service when the Job is\ncreated, and is immutable for the life of the job.",
+ "type": "string"
+ },
+ "currentState": {
+ "enum": [
+ "JOB_STATE_UNKNOWN",
+ "JOB_STATE_STOPPED",
+ "JOB_STATE_RUNNING",
+ "JOB_STATE_DONE",
+ "JOB_STATE_FAILED",
+ "JOB_STATE_CANCELLED",
+ "JOB_STATE_UPDATED",
+ "JOB_STATE_DRAINING",
+ "JOB_STATE_DRAINED",
+ "JOB_STATE_PENDING",
+ "JOB_STATE_CANCELLING"
+ ],
+ "description": "The current state of the job.\n\nJobs are created in the `JOB_STATE_STOPPED` state unless otherwise\nspecified.\n\nA job in the `JOB_STATE_RUNNING` state may asynchronously enter a\nterminal state. After a job has reached a terminal state, no\nfurther state updates may be made.\n\nThis field may be mutated by the Cloud Dataflow service;\ncallers cannot mutate it.",
+ "type": "string",
+ "enumDescriptions": [
+ "The job's run state isn't specified.",
+ "`JOB_STATE_STOPPED` indicates that the job has not\nyet started to run.",
+ "`JOB_STATE_RUNNING` indicates that the job is currently running.",
+ "`JOB_STATE_DONE` indicates that the job has successfully completed.\nThis is a terminal job state. This state may be set by the Cloud Dataflow\nservice, as a transition from `JOB_STATE_RUNNING`. It may also be set via a\nCloud Dataflow `UpdateJob` call, if the job has not yet reached a terminal\nstate.",
+ "`JOB_STATE_FAILED` indicates that the job has failed. This is a\nterminal job state. This state may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_RUNNING`.",
+ "`JOB_STATE_CANCELLED` indicates that the job has been explicitly\ncancelled. This is a terminal job state. This state may only be\nset via a Cloud Dataflow `UpdateJob` call, and only if the job has not\nyet reached another terminal state.",
+ "`JOB_STATE_UPDATED` indicates that the job was successfully updated,\nmeaning that this job was stopped and another job was started, inheriting\nstate from this one. This is a terminal job state. This state may only be\nset by the Cloud Dataflow service, and only as a transition from\n`JOB_STATE_RUNNING`.",
+ "`JOB_STATE_DRAINING` indicates that the job is in the process of draining.\nA draining job has stopped pulling from its input sources and is processing\nany data that remains in-flight. This state may be set via a Cloud Dataflow\n`UpdateJob` call, but only as a transition from `JOB_STATE_RUNNING`. Jobs\nthat are draining may only transition to `JOB_STATE_DRAINED`,\n`JOB_STATE_CANCELLED`, or `JOB_STATE_FAILED`.",
+ "`JOB_STATE_DRAINED` indicates that the job has been drained.\nA drained job terminated by stopping pulling from its input sources and\nprocessing any data that remained in-flight when draining was requested.\nThis state is a terminal state, may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_DRAINING`.",
+ "'JOB_STATE_PENDING' indicates that the job has been created but is not yet\nrunning. Jobs that are pending may only transition to `JOB_STATE_RUNNING`,\nor `JOB_STATE_FAILED`.",
+ "'JOB_STATE_CANCELLING' indicates that the job has been explicitly cancelled\nand is in the process of stopping. Jobs that are cancelling may only\ntransition to 'JOB_STATE_CANCELLED' or 'JOB_STATE_FAILED'."
+ ]
+ },
+ "location": {
+ "description": "The location that contains this job.",
+ "type": "string"
+ }
+ },
+ "id": "Job"
+ },
+ "DerivedSource": {
+ "description": "Specification of one of the bundles produced as a result of splitting\na Source (e.g. when executing a SourceSplitRequest, or when\nsplitting an active task using WorkItemStatus.dynamic_source_split),\nrelative to the source being split.",
+ "type": "object",
+ "properties": {
+ "derivationMode": {
+ "enum": [
+ "SOURCE_DERIVATION_MODE_UNKNOWN",
+ "SOURCE_DERIVATION_MODE_INDEPENDENT",
+ "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT",
+ "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT"
+ ],
+ "description": "What source to base the produced source on (if any).",
+ "type": "string",
+ "enumDescriptions": [
+ "The source derivation is unknown, or unspecified.",
+ "Produce a completely independent Source with no base.",
+ "Produce a Source based on the Source being split.",
+ "Produce a Source based on the base of the Source being split."
+ ]
+ },
+ "source": {
+ "$ref": "Source",
+ "description": "Specification of the source."
+ }
+ },
+ "id": "DerivedSource"
+ },
+ "DynamicSourceSplit": {
+ "type": "object",
+ "properties": {
+ "residual": {
+ "$ref": "DerivedSource",
+ "description": "Residual part (returned to the pool of work).\nSpecified relative to the previously-current source."
+ },
+ "primary": {
+ "$ref": "DerivedSource",
+ "description": "Primary part (continued to be processed by worker).\nSpecified relative to the previously-current source.\nBecomes current."
+ }
+ },
+ "id": "DynamicSourceSplit",
+ "description": "When a task splits using WorkItemStatus.dynamic_source_split, this\nmessage describes the two parts of the split relative to the\ndescription of the current task's input."
+ },
+ "SideInputId": {
+ "type": "object",
+ "properties": {
+ "declaringStepName": {
+ "type": "string",
+ "description": "The step that receives and usually consumes this side input."
+ },
+ "inputIndex": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The index of the side input, from the list of non_parallel_inputs."
+ }
+ },
+ "id": "SideInputId",
+ "description": "Uniquely identifies a side input."
+ },
+ "SourceOperationResponse": {
+ "type": "object",
+ "properties": {
+ "split": {
+ "$ref": "SourceSplitResponse",
+ "description": "A response to a request to split a source."
+ },
+ "getMetadata": {
+ "$ref": "SourceGetMetadataResponse",
+ "description": "A response to a request to get metadata about a source."
+ }
+ },
+ "id": "SourceOperationResponse",
+ "description": "The result of a SourceOperationRequest, specified in\nReportWorkItemStatusRequest.source_operation when the work item\nis completed."
+ },
+ "SendDebugCaptureResponse": {
+ "type": "object",
+ "properties": {},
+ "id": "SendDebugCaptureResponse",
+ "description": "Response to a send capture request.\nnothing"
+ },
+ "SideInputInfo": {
+ "description": "Information about a side input of a DoFn or an input of a SeqDoFn.",
+ "type": "object",
+ "properties": {
+ "tag": {
+ "type": "string",
+ "description": "The id of the tag the user code will access this side input by;\nthis should correspond to the tag of some MultiOutputInfo."
+ },
+ "kind": {
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object."
+ },
+ "description": "How to interpret the source element(s) as a side input value.",
+ "type": "object"
+ },
+ "sources": {
+ "items": {
+ "$ref": "Source"
+ },
+ "type": "array",
+ "description": "The source(s) to read element(s) from to get the value of this side input.\nIf more than one source, then the elements are taken from the\nsources, in the specified order if order matters.\nAt least one source is required."
+ }
+ },
+ "id": "SideInputInfo"
+ },
+ "WriteInstruction": {
+ "description": "An instruction that writes records.\nTakes one input, produces no outputs.",
+ "type": "object",
+ "properties": {
+ "input": {
+ "$ref": "InstructionInput",
+ "description": "The input."
+ },
+ "sink": {
+ "$ref": "Sink",
+ "description": "The sink to write to."
+ }
+ },
+ "id": "WriteInstruction"
+ },
+ "ConcatPosition": {
+ "description": "A position that encapsulates an inner position and an index for the inner\nposition. A ConcatPosition can be used by a reader of a source that\nencapsulates a set of other sources.",
+ "type": "object",
+ "properties": {
+ "position": {
+ "$ref": "Position",
+ "description": "Position within the inner source."
+ },
+ "index": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Index of the inner source."
+ }
+ },
+ "id": "ConcatPosition"
+ },
+ "CounterStructuredNameAndMetadata": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "$ref": "CounterStructuredName",
+ "description": "Structured name of the counter."
+ },
+ "metadata": {
+ "$ref": "CounterMetadata",
+ "description": "Metadata associated with a counter"
+ }
+ },
+ "id": "CounterStructuredNameAndMetadata",
+ "description": "A single message which encapsulates structured name and metadata for a given\ncounter."
+ },
+ "AutoscalingSettings": {
+ "description": "Settings for WorkerPool autoscaling.",
+ "type": "object",
+ "properties": {
+ "algorithm": {
+ "type": "string",
+ "enumDescriptions": [
+ "The algorithm is unknown, or unspecified.",
+ "Disable autoscaling.",
+ "Increase worker count over time to reduce job execution time."
+ ],
+ "enum": [
+ "AUTOSCALING_ALGORITHM_UNKNOWN",
+ "AUTOSCALING_ALGORITHM_NONE",
+ "AUTOSCALING_ALGORITHM_BASIC"
+ ],
+ "description": "The algorithm to use for autoscaling."
+ },
+ "maxNumWorkers": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The maximum number of workers to cap scaling at."
+ }
+ },
+ "id": "AutoscalingSettings"
+ },
+ "StreamingComputationRanges": {
+ "type": "object",
+ "properties": {
+ "rangeAssignments": {
+ "items": {
+ "$ref": "KeyRangeDataDiskAssignment"
+ },
+ "type": "array",
+ "description": "Data disk assignments for ranges from this computation."
+ },
+ "computationId": {
+ "description": "The ID of the computation.",
+ "type": "string"
+ }
+ },
+ "id": "StreamingComputationRanges",
+ "description": "Describes full or partial data disk assignment information of the computation\nranges."
+ },
+ "ExecutionStageSummary": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Dataflow service generated name for this stage."
+ },
+ "inputSource": {
+ "description": "Input sources for this stage.",
+ "items": {
+ "$ref": "StageSource"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "Dataflow service generated id for this stage.",
+ "type": "string"
+ },
+ "componentTransform": {
+ "description": "Transforms that comprise this execution stage.",
+ "items": {
+ "$ref": "ComponentTransform"
+ },
+ "type": "array"
+ },
+ "componentSource": {
+ "items": {
+ "$ref": "ComponentSource"
+ },
+ "type": "array",
+ "description": "Collections produced and consumed by component transforms of this stage."
+ },
+ "kind": {
+ "type": "string",
+ "enumDescriptions": [
+ "Unrecognized transform type.",
+ "ParDo transform.",
+ "Group By Key transform.",
+ "Flatten transform.",
+ "Read transform.",
+ "Write transform.",
+ "Constructs from a constant value, such as with Create.of.",
+ "Creates a Singleton view of a collection.",
+ "Opening or closing a shuffle session, often as part of a GroupByKey."
+ ],
+ "enum": [
+ "UNKNOWN_KIND",
+ "PAR_DO_KIND",
+ "GROUP_BY_KEY_KIND",
+ "FLATTEN_KIND",
+ "READ_KIND",
+ "WRITE_KIND",
+ "CONSTANT_KIND",
+ "SINGLETON_KIND",
+ "SHUFFLE_KIND"
+ ],
+ "description": "Type of tranform this stage is executing."
+ },
+ "outputSource": {
+ "description": "Output sources for this stage.",
+ "items": {
+ "$ref": "StageSource"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ExecutionStageSummary",
+ "description": "Description of the composing transforms, names/ids, and input/outputs of a\nstage of execution. Some composing transforms and sources may have been\ngenerated by the Dataflow service during execution planning."
+ },
+ "SendWorkerMessagesRequest": {
+ "description": "A request for sending worker messages to the service.",
+ "type": "object",
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "The location which contains the job"
+ },
+ "workerMessages": {
+ "items": {
+ "$ref": "WorkerMessage"
+ },
+ "type": "array",
+ "description": "The WorkerMessages to send."
+ }
+ },
+ "id": "SendWorkerMessagesRequest"
+ },
+ "SourceSplitShard": {
+ "type": "object",
+ "properties": {
+ "derivationMode": {
+ "type": "string",
+ "enumDescriptions": [
+ "The source derivation is unknown, or unspecified.",
+ "Produce a completely independent Source with no base.",
+ "Produce a Source based on the Source being split.",
+ "Produce a Source based on the base of the Source being split."
+ ],
+ "enum": [
+ "SOURCE_DERIVATION_MODE_UNKNOWN",
+ "SOURCE_DERIVATION_MODE_INDEPENDENT",
+ "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT",
+ "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT"
+ ],
+ "description": "DEPRECATED"
+ },
+ "source": {
+ "$ref": "Source",
+ "description": "DEPRECATED"
+ }
+ },
+ "id": "SourceSplitShard",
+ "description": "DEPRECATED in favor of DerivedSource."
+ },
+ "CPUTime": {
+ "description": "Modeled after information exposed by /proc/stat.",
+ "type": "object",
+ "properties": {
+ "rate": {
+ "type": "number",
+ "format": "double",
+ "description": "Average CPU utilization rate (% non-idle cpu / second) since previous\nsample."
+ },
+ "timestamp": {
+ "type": "string",
+ "format": "google-datetime",
+ "description": "Timestamp of the measurement."
+ },
+ "totalMs": {
+ "type": "string",
+ "format": "uint64",
+ "description": "Total active CPU time across all cores (ie., non-idle) in milliseconds\nsince start-up."
+ }
+ },
+ "id": "CPUTime"
+ },
+ "Environment": {
+ "type": "object",
+ "properties": {
+ "sdkPipelineOptions": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object."
+ },
+ "description": "The Cloud Dataflow SDK pipeline options specified by the user. These\noptions are passed through the service and are used to recreate the\nSDK pipeline options on the worker in a language agnostic and platform\nindependent way."
+ },
+ "userAgent": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "A description of the process that generated the request.",
+ "type": "object"
+ },
+ "clusterManagerApiService": {
+ "type": "string",
+ "description": "The type of cluster manager API to use. If unknown or\nunspecified, the service will attempt to choose a reasonable\ndefault. This should be in the form of the API service name,\ne.g. \"compute.googleapis.com\"."
+ },
+ "tempStoragePrefix": {
+ "type": "string",
+ "description": "The prefix of the resources the system should use for temporary\nstorage. The system will append the suffix \"/temp-{JOBNAME} to\nthis resource prefix, where {JOBNAME} is the value of the\njob_name field. The resulting bucket and object prefix is used\nas the prefix of the resources used to store temporary data\nneeded during the job execution. NOTE: This will override the\nvalue in taskrunner_settings.\nThe supported resource type is:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}"
+ },
+ "workerPools": {
+ "description": "The worker pools. At least one \"harness\" worker pool must be\nspecified in order for the job to have workers.",
+ "items": {
+ "$ref": "WorkerPool"
+ },
+ "type": "array"
+ },
+ "dataset": {
+ "type": "string",
+ "description": "The dataset for the current project where various workflow\nrelated tables are stored.\n\nThe supported resource type is:\n\nGoogle BigQuery:\n bigquery.googleapis.com/{dataset}"
+ },
+ "experiments": {
+ "description": "The list of experiments to enable.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "version": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "A structure describing which components and their versions of the service\nare required in order to run the job."
+ },
+ "internalExperiments": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Experimental settings."
+ },
+ "serviceAccountEmail": {
+ "description": "Identity to run virtual machines as. Defaults to the default account.",
+ "type": "string"
+ }
+ },
+ "id": "Environment",
+ "description": "Describes the environment in which a Dataflow Job runs."
+ },
+ "StreamingComputationTask": {
+ "description": "A task which describes what action should be performed for the specified\nstreaming computation ranges.",
+ "type": "object",
+ "properties": {
+ "computationRanges": {
+ "items": {
+ "$ref": "StreamingComputationRanges"
+ },
+ "type": "array",
+ "description": "Contains ranges of a streaming computation this task should apply to."
+ },
+ "dataDisks": {
+ "description": "Describes the set of data disks this task should apply to.",
+ "items": {
+ "$ref": "MountedDataDisk"
+ },
+ "type": "array"
+ },
+ "taskType": {
+ "enum": [
+ "STREAMING_COMPUTATION_TASK_UNKNOWN",
+ "STREAMING_COMPUTATION_TASK_STOP",
+ "STREAMING_COMPUTATION_TASK_START"
+ ],
+ "description": "A type of streaming computation task.",
+ "type": "string",
+ "enumDescriptions": [
+ "The streaming computation task is unknown, or unspecified.",
+ "Stop processing specified streaming computation range(s).",
+ "Start processing specified streaming computation range(s)."
+ ]
+ }
+ },
+ "id": "StreamingComputationTask"
+ },
+ "SendDebugCaptureRequest": {
+ "type": "object",
+ "properties": {
+ "componentId": {
+ "description": "The internal component id for which debug information is sent.",
+ "type": "string"
+ },
+ "workerId": {
+ "type": "string",
+ "description": "The worker id, i.e., VM hostname."
+ },
+ "location": {
+ "type": "string",
+ "description": "The location which contains the job specified by job_id."
+ },
+ "data": {
+ "type": "string",
+ "description": "The encoded debug information."
+ }
+ },
+ "id": "SendDebugCaptureRequest",
+ "description": "Request to send encoded debug information."
+ },
+ "GetDebugConfigResponse": {
+ "type": "object",
+ "properties": {
+ "config": {
+ "type": "string",
+ "description": "The encoded debug configuration for the requested component."
+ }
+ },
+ "id": "GetDebugConfigResponse",
+ "description": "Response to a get debug configuration request."
+ },
+ "ComponentTransform": {
+ "description": "Description of a transform executed as part of an execution stage.",
+ "type": "object",
+ "properties": {
+ "originalTransform": {
+ "description": "User name for the original user transform with which this transform is\nmost closely associated.",
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "description": "Dataflow service generated name for this source."
+ },
+ "userName": {
+ "description": "Human-readable name for this transform; may be user or system generated.",
+ "type": "string"
+ }
+ },
+ "id": "ComponentTransform"
+ },
+ "StreamingSetupTask": {
+ "type": "object",
+ "properties": {
+ "receiveWorkPort": {
+ "format": "int32",
+ "description": "The TCP port on which the worker should listen for messages from\nother streaming computation workers.",
+ "type": "integer"
+ },
+ "streamingComputationTopology": {
+ "$ref": "TopologyConfig",
+ "description": "The global topology of the streaming Dataflow job."
+ },
+ "drain": {
+ "description": "The user has requested drain.",
+ "type": "boolean"
+ },
+ "workerHarnessPort": {
+ "format": "int32",
+ "description": "The TCP port used by the worker to communicate with the Dataflow\nworker harness.",
+ "type": "integer"
+ }
+ },
+ "id": "StreamingSetupTask",
+ "description": "A task which initializes part of a streaming Dataflow job."
+ },
+ "PubsubLocation": {
+ "description": "Identifies a pubsub location to use for transferring data into or\nout of a streaming Dataflow job.",
+ "type": "object",
+ "properties": {
+ "withAttributes": {
+ "description": "If true, then the client has requested to get pubsub attributes.",
+ "type": "boolean"
+ },
+ "idLabel": {
+ "description": "If set, contains a pubsub label from which to extract record ids.\nIf left empty, record deduplication will be strictly best effort.",
+ "type": "string"
+ },
+ "topic": {
+ "description": "A pubsub topic, in the form of\n\"pubsub.googleapis.com/topics/\u003cproject-id\u003e/\u003ctopic-name\u003e\"",
+ "type": "string"
+ },
+ "timestampLabel": {
+ "description": "If set, contains a pubsub label from which to extract record timestamps.\nIf left empty, record timestamps will be generated upon arrival.",
+ "type": "string"
+ },
+ "subscription": {
+ "type": "string",
+ "description": "A pubsub subscription, in the form of\n\"pubsub.googleapis.com/subscriptions/\u003cproject-id\u003e/\u003csubscription-name\u003e\""
+ },
+ "dropLateData": {
+ "type": "boolean",
+ "description": "Indicates whether the pipeline allows late-arriving data."
+ },
+ "trackingSubscription": {
+ "description": "If set, specifies the pubsub subscription that will be used for tracking\ncustom time timestamps for watermark estimation.",
+ "type": "string"
+ }
+ },
+ "id": "PubsubLocation"
+ },
+ "WorkerHealthReport": {
+ "description": "WorkerHealthReport contains information about the health of a worker.\n\nThe VM should be identified by the labels attached to the WorkerMessage that\nthis health ping belongs to.",
+ "type": "object",
+ "properties": {
+ "pods": {
+ "description": "The pods running on the worker. See:\nhttp://kubernetes.io/v1.1/docs/api-reference/v1/definitions.html#_v1_pod\n\nThis field is used by the worker to send the status of the indvidual\ncontainers running on each worker.",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object."
+ }
+ },
+ "type": "array"
+ },
+ "vmStartupTime": {
+ "format": "google-datetime",
+ "description": "The time the VM was booted.",
+ "type": "string"
+ },
+ "reportInterval": {
+ "format": "google-duration",
+ "description": "The interval at which the worker is sending health reports.\nThe default value of 0 should be interpreted as the field is not being\nexplicitly set by the worker.",
+ "type": "string"
+ },
+ "vmIsHealthy": {
+ "type": "boolean",
+ "description": "Whether the VM is healthy."
+ }
+ },
+ "id": "WorkerHealthReport"
+ },
+ "JobMessage": {
+ "type": "object",
+ "properties": {
+ "messageImportance": {
+ "type": "string",
+ "enumDescriptions": [
+ "The message importance isn't specified, or is unknown.",
+ "The message is at the 'debug' level: typically only useful for\nsoftware engineers working on the code the job is running.\nTypically, Dataflow pipeline runners do not display log messages\nat this level by default.",
+ "The message is at the 'detailed' level: somewhat verbose, but\npotentially useful to users. Typically, Dataflow pipeline\nrunners do not display log messages at this level by default.\nThese messages are displayed by default in the Dataflow\nmonitoring UI.",
+ "The message is at the 'basic' level: useful for keeping\ntrack of the execution of a Dataflow pipeline. Typically,\nDataflow pipeline runners display log messages at this level by\ndefault, and these messages are displayed by default in the\nDataflow monitoring UI.",
+ "The message is at the 'warning' level: indicating a condition\npertaining to a job which may require human intervention.\nTypically, Dataflow pipeline runners display log messages at this\nlevel by default, and these messages are displayed by default in\nthe Dataflow monitoring UI.",
+ "The message is at the 'error' level: indicating a condition\npreventing a job from succeeding. Typically, Dataflow pipeline\nrunners display log messages at this level by default, and these\nmessages are displayed by default in the Dataflow monitoring UI."
+ ],
+ "enum": [
+ "JOB_MESSAGE_IMPORTANCE_UNKNOWN",
+ "JOB_MESSAGE_DEBUG",
+ "JOB_MESSAGE_DETAILED",
+ "JOB_MESSAGE_BASIC",
+ "JOB_MESSAGE_WARNING",
+ "JOB_MESSAGE_ERROR"
+ ],
+ "description": "Importance level of the message."
+ },
+ "messageText": {
+ "description": "The text of the message.",
+ "type": "string"
+ },
+ "time": {
+ "type": "string",
+ "format": "google-datetime",
+ "description": "The timestamp of the message."
+ },
+ "id": {
+ "description": "Deprecated.",
+ "type": "string"
+ }
+ },
+ "id": "JobMessage",
+ "description": "A particular message pertaining to a Dataflow job."
+ },
+ "ParameterMetadata": {
+ "description": "Metadata for a specific parameter.",
+ "type": "object",
+ "properties": {
+ "helpText": {
+ "description": "Required. The help text to display for the parameter.",
+ "type": "string"
+ },
+ "isOptional": {
+ "description": "Optional. Whether the parameter is optional. Defaults to false.",
+ "type": "boolean"
+ },
+ "name": {
+ "type": "string",
+ "description": "Required. The name of the parameter."
+ },
+ "regexes": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "Optional. Regexes that the parameter must match."
+ },
+ "label": {
+ "description": "Required. The label to display for the parameter.",
+ "type": "string"
+ }
+ },
+ "id": "ParameterMetadata"
}
},
"protocol": "rest",
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"version": "v1b3",
"baseUrl": "https://dataflow.googleapis.com/",
@@ -5099,10 +5102,7 @@
}
}
},
- "description": "Manages Google Cloud Dataflow projects on Google Cloud Platform.",
- "servicePath": "",
"kind": "discovery#restDescription",
- "rootUrl": "https://dataflow.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com"
+ "description": "Manages Google Cloud Dataflow projects on Google Cloud Platform.",
+ "servicePath": ""
}
diff --git a/dataproc/v1/dataproc-api.json b/dataproc/v1/dataproc-api.json
index 5cb87d7..49d4089 100644
--- a/dataproc/v1/dataproc-api.json
+++ b/dataproc/v1/dataproc-api.json
@@ -1,12 +1,8 @@
{
- "rootUrl": "https://dataproc.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "dataproc",
"batchPath": "batch",
- "id": "dataproc:v1",
+ "revision": "20171010",
"documentationLink": "https://cloud.google.com/dataproc/",
- "revision": "20171003",
+ "id": "dataproc:v1",
"title": "Google Cloud Dataproc API",
"ownerName": "Google",
"discoveryVersion": "v1",
@@ -15,126 +11,26 @@
"resources": {
"regions": {
"resources": {
- "jobs": {
+ "clusters": {
"methods": {
- "submit": {
- "description": "Submits a job to a cluster.",
- "request": {
- "$ref": "SubmitJobRequest"
- },
+ "create": {
"response": {
- "$ref": "Job"
+ "$ref": "Operation"
},
"parameterOrder": [
"projectId",
"region"
],
"httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"projectId": {
- "location": "path",
- "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
- "type": "string",
- "required": true
- },
- "region": {
+ "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
"type": "string",
"required": true,
- "location": "path",
- "description": "Required. The Cloud Dataproc region in which to handle the request."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/regions/{region}/jobs:submit",
- "id": "dataproc.projects.regions.jobs.submit",
- "path": "v1/projects/{projectId}/regions/{region}/jobs:submit"
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "jobId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "region": {
- "location": "path",
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "type": "string",
- "required": true
- },
- "jobId": {
- "location": "path",
- "description": "Required. The job ID.",
- "type": "string",
- "required": true
- },
- "projectId": {
- "location": "path",
- "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "id": "dataproc.projects.regions.jobs.delete",
- "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "description": "Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION."
- },
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListJobsResponse"
- },
- "parameterOrder": [
- "projectId",
- "region"
- ],
- "parameters": {
- "clusterName": {
- "location": "query",
- "description": "Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.",
- "type": "string"
- },
- "projectId": {
- "location": "path",
- "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
- "type": "string",
- "required": true
- },
- "filter": {
- "description": "Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is status.state or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be either ACTIVE or INACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND labels.env = staging AND labels.starred = *",
- "type": "string",
- "location": "query"
- },
- "jobStateMatcher": {
- "location": "query",
- "enum": [
- "ALL",
- "ACTIVE",
- "NON_ACTIVE"
- ],
- "description": "Optional. Specifies enumerated categories of jobs to list (default = match ALL jobs).",
- "type": "string"
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "Optional. The page token, returned by a previous call, to request the next page of results."
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Optional. The number of results to return in each response.",
- "type": "integer"
+ "location": "path"
},
"region": {
"description": "Required. The Cloud Dataproc region in which to handle the request.",
@@ -143,116 +39,157 @@
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/regions/{region}/jobs",
- "path": "v1/projects/{projectId}/regions/{region}/jobs",
- "id": "dataproc.projects.regions.jobs.list",
- "description": "Lists regions/{region}/jobs in a project."
- },
- "cancel": {
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "jobId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "jobId": {
- "description": "Required. The job ID.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Required. The ID of the Google Cloud Platform project that the job belongs to."
- },
- "region": {
- "location": "path",
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel",
- "id": "dataproc.projects.regions.jobs.cancel",
- "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel",
- "description": "Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get.",
+ "flatPath": "v1/projects/{projectId}/regions/{region}/clusters",
+ "id": "dataproc.projects.regions.clusters.create",
+ "path": "v1/projects/{projectId}/regions/{region}/clusters",
"request": {
- "$ref": "CancelJobRequest"
- }
+ "$ref": "Cluster"
+ },
+ "description": "Creates a cluster in a project."
},
"get": {
+ "description": "Gets the resource representation for a cluster in a project.",
+ "response": {
+ "$ref": "Cluster"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "clusterName"
+ ],
+ "httpMethod": "GET",
"parameters": {
- "jobId": {
- "location": "path",
- "description": "Required. The job ID.",
- "type": "string",
- "required": true
- },
"projectId": {
- "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
+ "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
"type": "string",
"required": true,
"location": "path"
},
"region": {
- "location": "path",
"description": "Required. The Cloud Dataproc region in which to handle the request.",
"type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clusterName": {
+ "location": "path",
+ "description": "Required. The cluster name.",
+ "type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "id": "dataproc.projects.regions.jobs.get",
- "description": "Gets the resource representation for a job in a project.",
- "httpMethod": "GET",
- "parameterOrder": [
- "projectId",
- "region",
- "jobId"
- ],
- "response": {
- "$ref": "Job"
- }
+ "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "id": "dataproc.projects.regions.clusters.get",
+ "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}"
},
"patch": {
"request": {
- "$ref": "Job"
+ "$ref": "Cluster"
},
- "description": "Updates a job in a project.",
- "httpMethod": "PATCH",
+ "description": "Updates a cluster in a project.",
+ "response": {
+ "$ref": "Operation"
+ },
"parameterOrder": [
"projectId",
"region",
- "jobId"
+ "clusterName"
],
- "response": {
- "$ref": "Job"
- },
+ "httpMethod": "PATCH",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"updateMask": {
- "location": "query",
"format": "google-fieldmask",
- "description": "Required. Specifies the path, relative to \u003ccode\u003eJob\u003c/code\u003e, of the field to update. For example, to update the labels of a Job the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be specified as \u003ccode\u003elabels\u003c/code\u003e, and the PATCH request body would specify the new value. \u003cstrong\u003eNote:\u003c/strong\u003e Currently, \u003ccode\u003elabels\u003c/code\u003e is the only field that can be updated.",
- "type": "string"
+ "description": "Required. Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as config.worker_config.num_instances, and the PATCH request body would specify the new value, as follows:\n{\n \"config\":{\n \"workerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\nSimilarly, to change the number of preemptible workers in a cluster to 5, the update_mask parameter would be config.secondary_worker_config.num_instances, and the PATCH request body would be set as follows:\n{\n \"config\":{\n \"secondaryWorkerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\n\u003cstrong\u003eNote:\u003c/strong\u003e Currently, only the following fields can be updated:\u003ctable\u003e \u003ctbody\u003e \u003ctr\u003e \u003ctd\u003e\u003cstrong\u003eMask\u003c/strong\u003e\u003c/td\u003e \u003ctd\u003e\u003cstrong\u003ePurpose\u003c/strong\u003e\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003e\u003cstrong\u003e\u003cem\u003elabels\u003c/em\u003e\u003c/strong\u003e\u003c/td\u003e \u003ctd\u003eUpdate labels\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003e\u003cstrong\u003e\u003cem\u003econfig.worker_config.num_instances\u003c/em\u003e\u003c/strong\u003e\u003c/td\u003e \u003ctd\u003eResize primary worker group\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003e\u003cstrong\u003e\u003cem\u003econfig.secondary_worker_config.num_instances\u003c/em\u003e\u003c/strong\u003e\u003c/td\u003e \u003ctd\u003eResize secondary worker group\u003c/td\u003e \u003c/tr\u003e \u003c/tbody\u003e \u003c/table\u003e",
+ "type": "string",
+ "location": "query"
+ },
+ "region": {
+ "location": "path",
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true
+ },
+ "clusterName": {
+ "location": "path",
+ "description": "Required. The cluster name.",
+ "type": "string",
+ "required": true
+ },
+ "projectId": {
+ "description": "Required. The ID of the Google Cloud Platform project the cluster belongs to.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "id": "dataproc.projects.regions.clusters.patch",
+ "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}"
+ },
+ "diagnose": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "clusterName"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clusterName": {
+ "description": "Required. The cluster name.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose",
+ "id": "dataproc.projects.regions.clusters.diagnose",
+ "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose",
+ "request": {
+ "$ref": "DiagnoseClusterRequest"
+ },
+ "description": "Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation."
+ },
+ "delete": {
+ "description": "Deletes a cluster in a project.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "clusterName"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "projectId": {
+ "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "type": "string",
+ "required": true,
+ "location": "path"
},
"region": {
"description": "Required. The Cloud Dataproc region in which to handle the request.",
@@ -260,27 +197,20 @@
"required": true,
"location": "path"
},
- "jobId": {
+ "clusterName": {
"location": "path",
- "description": "Required. The job ID.",
- "type": "string",
- "required": true
- },
- "projectId": {
- "location": "path",
- "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
+ "description": "Required. The cluster name.",
"type": "string",
"required": true
}
},
- "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "id": "dataproc.projects.regions.jobs.patch"
- }
- }
- },
- "clusters": {
- "methods": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "id": "dataproc.projects.regions.clusters.delete",
+ "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}"
+ },
"list": {
"flatPath": "v1/projects/{projectId}/regions/{region}/clusters",
"path": "v1/projects/{projectId}/regions/{region}/clusters",
@@ -299,9 +229,9 @@
],
"parameters": {
"filter": {
- "location": "query",
"description": "Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING and ERROR states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"region": {
"location": "path",
@@ -310,9 +240,9 @@
"required": true
},
"pageToken": {
- "location": "query",
"description": "Optional. The standard List page token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageSize": {
"format": "int32",
@@ -321,266 +251,47 @@
"location": "query"
},
"projectId": {
- "type": "string",
- "required": true,
"location": "path",
- "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to."
+ "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "type": "string",
+ "required": true
}
}
- },
- "create": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "region": {
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectId}/regions/{region}/clusters",
- "id": "dataproc.projects.regions.clusters.create",
- "path": "v1/projects/{projectId}/regions/{region}/clusters",
- "request": {
- "$ref": "Cluster"
- },
- "description": "Creates a cluster in a project.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "region"
- ],
- "httpMethod": "POST"
- },
- "patch": {
- "id": "dataproc.projects.regions.clusters.patch",
- "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "description": "Updates a cluster in a project.",
- "request": {
- "$ref": "Cluster"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "clusterName"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "Required. The ID of the Google Cloud Platform project the cluster belongs to.",
- "type": "string",
- "required": true
- },
- "updateMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "Required. Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as config.worker_config.num_instances, and the PATCH request body would specify the new value, as follows:\n{\n \"config\":{\n \"workerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\nSimilarly, to change the number of preemptible workers in a cluster to 5, the update_mask parameter would be config.secondary_worker_config.num_instances, and the PATCH request body would be set as follows:\n{\n \"config\":{\n \"secondaryWorkerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\n\u003cstrong\u003eNote:\u003c/strong\u003e Currently, only the following fields can be updated:\u003ctable\u003e \u003ctbody\u003e \u003ctr\u003e \u003ctd\u003e\u003cstrong\u003eMask\u003c/strong\u003e\u003c/td\u003e \u003ctd\u003e\u003cstrong\u003ePurpose\u003c/strong\u003e\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003e\u003cstrong\u003e\u003cem\u003elabels\u003c/em\u003e\u003c/strong\u003e\u003c/td\u003e \u003ctd\u003eUpdate labels\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003e\u003cstrong\u003e\u003cem\u003econfig.worker_config.num_instances\u003c/em\u003e\u003c/strong\u003e\u003c/td\u003e \u003ctd\u003eResize primary worker group\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003e\u003cstrong\u003e\u003cem\u003econfig.secondary_worker_config.num_instances\u003c/em\u003e\u003c/strong\u003e\u003c/td\u003e \u003ctd\u003eResize secondary worker group\u003c/td\u003e \u003c/tr\u003e \u003c/tbody\u003e \u003c/table\u003e",
- "type": "string"
- },
- "region": {
- "location": "path",
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "type": "string",
- "required": true
- },
- "clusterName": {
- "location": "path",
- "description": "Required. The cluster name.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}"
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "Cluster"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "clusterName"
- ],
- "parameters": {
- "clusterName": {
- "description": "Required. The cluster name.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "location": "path",
- "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
- "type": "string",
- "required": true
- },
- "region": {
- "location": "path",
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "id": "dataproc.projects.regions.clusters.get",
- "description": "Gets the resource representation for a cluster in a project."
- },
- "diagnose": {
- "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose",
- "id": "dataproc.projects.regions.clusters.diagnose",
- "description": "Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation.",
- "request": {
- "$ref": "DiagnoseClusterRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "region",
- "clusterName"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "clusterName": {
- "location": "path",
- "description": "Required. The cluster name.",
- "type": "string",
- "required": true
- },
- "projectId": {
- "location": "path",
- "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
- "type": "string",
- "required": true
- },
- "region": {
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose"
- },
- "delete": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "clusterName"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "clusterName": {
- "description": "Required. The cluster name.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to."
- },
- "region": {
- "location": "path",
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "id": "dataproc.projects.regions.clusters.delete",
- "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "description": "Deletes a cluster in a project."
}
}
},
"operations": {
"methods": {
- "delete": {
+ "get": {
+ "id": "dataproc.projects.regions.operations.get",
+ "path": "v1/{+name}",
+ "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"response": {
- "$ref": "Empty"
+ "$ref": "Operation"
},
"parameterOrder": [
"name"
],
- "httpMethod": "DELETE",
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"name": {
- "description": "The name of the operation resource to be deleted.",
+ "description": "The name of the operation resource.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}",
- "id": "dataproc.projects.regions.operations.delete",
- "path": "v1/{+name}",
- "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED."
- },
- "get": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation resource.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}",
- "id": "dataproc.projects.regions.operations.get",
- "path": "v1/{+name}",
- "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service."
+ "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}"
},
"list": {
+ "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations",
+ "path": "v1/{+name}",
+ "id": "dataproc.projects.regions.operations.list",
+ "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
"httpMethod": "GET",
"parameterOrder": [
"name"
@@ -592,59 +303,344 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "pageSize": {
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer",
- "location": "query"
- },
"filter": {
"location": "query",
"description": "The standard list filter.",
"type": "string"
},
"pageToken": {
- "type": "string",
"location": "query",
- "description": "The standard list page token."
+ "description": "The standard list page token.",
+ "type": "string"
},
"name": {
- "pattern": "^projects/[^/]+/regions/[^/]+/operations$",
"location": "path",
"description": "The name of the operation's parent resource.",
"type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/regions/[^/]+/operations$"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer",
+ "location": "query"
+ }
+ }
+ },
+ "cancel": {
+ "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}:cancel",
+ "path": "v1/{+name}:cancel",
+ "id": "dataproc.projects.regions.operations.cancel",
+ "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource to be cancelled.",
+ "type": "string",
"required": true
}
},
- "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations",
- "path": "v1/{+name}",
- "id": "dataproc.projects.regions.operations.list",
- "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id."
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
},
- "cancel": {
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
"parameters": {
"name": {
- "description": "The name of the operation resource to be cancelled.",
+ "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource to be deleted.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}",
+ "id": "dataproc.projects.regions.operations.delete",
+ "path": "v1/{+name}",
+ "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED."
+ }
+ }
+ },
+ "jobs": {
+ "methods": {
+ "list": {
+ "flatPath": "v1/projects/{projectId}/regions/{region}/jobs",
+ "path": "v1/projects/{projectId}/regions/{region}/jobs",
+ "id": "dataproc.projects.regions.jobs.list",
+ "description": "Lists regions/{region}/jobs in a project.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId",
+ "region"
+ ],
+ "response": {
+ "$ref": "ListJobsResponse"
+ },
+ "parameters": {
+ "projectId": {
+ "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
+ "location": "path"
+ },
+ "filter": {
+ "description": "Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is status.state or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be either ACTIVE or INACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND labels.env = staging AND labels.starred = *",
+ "type": "string",
+ "location": "query"
+ },
+ "jobStateMatcher": {
+ "location": "query",
+ "enum": [
+ "ALL",
+ "ACTIVE",
+ "NON_ACTIVE"
+ ],
+ "description": "Optional. Specifies enumerated categories of jobs to list (default = match ALL jobs).",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Optional. The page token, returned by a previous call, to request the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Optional. The number of results to return in each response.",
+ "type": "integer"
+ },
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clusterName": {
+ "location": "query",
+ "description": "Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "cancel": {
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "jobId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "jobId": {
+ "description": "Required. The job ID.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel",
+ "id": "dataproc.projects.regions.jobs.cancel",
+ "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel",
+ "description": "Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get.",
+ "request": {
+ "$ref": "CancelJobRequest"
+ }
+ },
+ "get": {
+ "description": "Gets the resource representation for a job in a project.",
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "jobId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "jobId": {
+ "description": "Required. The job ID.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "projectId": {
+ "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "region": {
+ "location": "path",
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "id": "dataproc.projects.regions.jobs.get",
+ "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}"
+ },
+ "patch": {
+ "description": "Updates a job in a project.",
+ "request": {
+ "$ref": "Job"
+ },
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "jobId"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "jobId": {
+ "location": "path",
+ "description": "Required. The job ID.",
+ "type": "string",
+ "required": true
+ },
+ "projectId": {
+ "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "Required. Specifies the path, relative to \u003ccode\u003eJob\u003c/code\u003e, of the field to update. For example, to update the labels of a Job the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be specified as \u003ccode\u003elabels\u003c/code\u003e, and the PATCH request body would specify the new value. \u003cstrong\u003eNote:\u003c/strong\u003e Currently, \u003ccode\u003elabels\u003c/code\u003e is the only field that can be updated.",
+ "type": "string",
+ "location": "query"
+ },
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true,
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}:cancel",
- "path": "v1/{+name}:cancel",
- "id": "dataproc.projects.regions.operations.cancel",
- "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.",
+ "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "id": "dataproc.projects.regions.jobs.patch",
+ "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}"
+ },
+ "submit": {
+ "flatPath": "v1/projects/{projectId}/regions/{region}/jobs:submit",
+ "path": "v1/projects/{projectId}/regions/{region}/jobs:submit",
+ "id": "dataproc.projects.regions.jobs.submit",
+ "request": {
+ "$ref": "SubmitJobRequest"
+ },
+ "description": "Submits a job to a cluster.",
"httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "region"
+ ],
+ "response": {
+ "$ref": "Job"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
+ "type": "string",
+ "required": true
+ },
+ "region": {
+ "location": "path",
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true
+ }
+ }
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "jobId"
+ ],
"response": {
"$ref": "Empty"
},
- "parameterOrder": [
- "name"
- ]
+ "parameters": {
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "jobId": {
+ "location": "path",
+ "description": "Required. The job ID.",
+ "type": "string",
+ "required": true
+ },
+ "projectId": {
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "id": "dataproc.projects.regions.jobs.delete",
+ "description": "Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION."
}
}
}
@@ -654,45 +650,6 @@
}
},
"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.",
- "default": "true",
- "type": "boolean"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format."
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
"alt": {
"type": "string",
"enumDescriptions": [
@@ -709,20 +666,20 @@
"proto"
]
},
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
"key": {
"location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string"
},
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
"quotaUser": {
- "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pp": {
"location": "query",
@@ -739,9 +696,231 @@
"location": "query",
"description": "OAuth 2.0 token for the current user.",
"type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
}
},
"schemas": {
+ "JobScheduling": {
+ "properties": {
+ "maxFailuresPerHour": {
+ "format": "int32",
+ "description": "Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.",
+ "type": "integer"
+ }
+ },
+ "id": "JobScheduling",
+ "description": "Job scheduling options.Beta Feature: These options are available for testing purposes only. They may be changed before final release.",
+ "type": "object"
+ },
+ "InstanceGroupConfig": {
+ "description": "Optional. The config settings for Google Compute Engine resources in an instance group, such as a master or worker group.",
+ "type": "object",
+ "properties": {
+ "diskConfig": {
+ "description": "Optional. Disk option config settings.",
+ "$ref": "DiskConfig"
+ },
+ "imageUri": {
+ "description": "Output-only. The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.",
+ "type": "string"
+ },
+ "isPreemptible": {
+ "description": "Optional. Specifies that this instance group contains preemptible instances.",
+ "type": "boolean"
+ },
+ "machineTypeUri": {
+ "description": "Optional. The Google Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2\nprojects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2\nn1-standard-2",
+ "type": "string"
+ },
+ "managedGroupConfig": {
+ "$ref": "ManagedGroupConfig",
+ "description": "Output-only. The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups."
+ },
+ "instanceNames": {
+ "description": "Optional. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "accelerators": {
+ "description": "Optional. The Google Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.",
+ "items": {
+ "$ref": "AcceleratorConfig"
+ },
+ "type": "array"
+ },
+ "numInstances": {
+ "format": "int32",
+ "description": "Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.",
+ "type": "integer"
+ }
+ },
+ "id": "InstanceGroupConfig"
+ },
+ "NodeInitializationAction": {
+ "description": "Specifies an executable to run on a fully configured node and a timeout period for executable completion.",
+ "type": "object",
+ "properties": {
+ "executableFile": {
+ "description": "Required. Google Cloud Storage URI of executable file.",
+ "type": "string"
+ },
+ "executionTimeout": {
+ "format": "google-duration",
+ "description": "Optional. Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.",
+ "type": "string"
+ }
+ },
+ "id": "NodeInitializationAction"
+ },
+ "ListJobsResponse": {
+ "description": "A list of jobs in a project.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Optional. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent \u003ccode\u003eListJobsRequest\u003c/code\u003e.",
+ "type": "string"
+ },
+ "jobs": {
+ "description": "Output-only. Jobs list.",
+ "items": {
+ "$ref": "Job"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListJobsResponse"
+ },
+ "CancelJobRequest": {
+ "properties": {},
+ "id": "CancelJobRequest",
+ "description": "A request to cancel a job.",
+ "type": "object"
+ },
+ "SparkSqlJob": {
+ "properties": {
+ "queryList": {
+ "description": "A list of queries.",
+ "$ref": "QueryList"
+ },
+ "queryFileUri": {
+ "description": "The HCFS URI of the script that contains SQL queries.",
+ "type": "string"
+ },
+ "scriptVariables": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name=\"value\";).",
+ "type": "object"
+ },
+ "jarFileUris": {
+ "description": "Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "loggingConfig": {
+ "$ref": "LoggingConfig",
+ "description": "Optional. The runtime log config for job execution."
+ },
+ "properties": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.",
+ "type": "object"
+ }
+ },
+ "id": "SparkSqlJob",
+ "description": "A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries.",
+ "type": "object"
+ },
+ "Cluster": {
+ "description": "Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.",
+ "type": "object",
+ "properties": {
+ "projectId": {
+ "description": "Required. The Google Cloud Platform project ID that the cluster belongs to.",
+ "type": "string"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional. The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster.",
+ "type": "object"
+ },
+ "metrics": {
+ "$ref": "ClusterMetrics",
+ "description": "Contains cluster daemon metrics such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release."
+ },
+ "status": {
+ "description": "Output-only. Cluster status.",
+ "$ref": "ClusterStatus"
+ },
+ "statusHistory": {
+ "description": "Output-only. The previous cluster status.",
+ "items": {
+ "$ref": "ClusterStatus"
+ },
+ "type": "array"
+ },
+ "config": {
+ "description": "Required. The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.",
+ "$ref": "ClusterConfig"
+ },
+ "clusterUuid": {
+ "description": "Output-only. A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.",
+ "type": "string"
+ },
+ "clusterName": {
+ "description": "Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.",
+ "type": "string"
+ }
+ },
+ "id": "Cluster"
+ },
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
"type": "object",
@@ -751,11 +930,11 @@
"type": "string"
},
"operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "Operation"
},
- "type": "array",
- "description": "A list of operations that matches the specified filter in the request."
+ "type": "array"
}
},
"id": "ListOperationsResponse"
@@ -776,26 +955,47 @@
"id": "JobPlacement"
},
"SoftwareConfig": {
- "type": "object",
"properties": {
"imageVersion": {
"description": "Optional. The version of software inside the cluster. It must match the regular expression [0-9]+\\.[0-9]+. If unspecified, it defaults to the latest version (see Cloud Dataproc Versioning).",
"type": "string"
},
"properties": {
+ "description": "Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, such as core:fs.defaultFS. The following are supported prefixes and their mappings:\ncapacity-scheduler: capacity-scheduler.xml\ncore: core-site.xml\ndistcp: distcp-default.xml\nhdfs: hdfs-site.xml\nhive: hive-site.xml\nmapred: mapred-site.xml\npig: pig.properties\nspark: spark-defaults.conf\nyarn: yarn-site.xmlFor more information, see Cluster properties.",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, such as core:fs.defaultFS. The following are supported prefixes and their mappings:\ncapacity-scheduler: capacity-scheduler.xml\ncore: core-site.xml\ndistcp: distcp-default.xml\nhdfs: hdfs-site.xml\nhive: hive-site.xml\nmapred: mapred-site.xml\npig: pig.properties\nspark: spark-defaults.conf\nyarn: yarn-site.xmlFor more information, see Cluster properties.",
- "type": "object"
+ }
}
},
"id": "SoftwareConfig",
- "description": "Specifies the selection and config of software inside the cluster."
+ "description": "Specifies the selection and config of software inside the cluster.",
+ "type": "object"
},
"ClusterStatus": {
+ "description": "The status of a cluster and its instances.",
"type": "object",
"properties": {
+ "state": {
+ "enum": [
+ "UNKNOWN",
+ "CREATING",
+ "RUNNING",
+ "ERROR",
+ "DELETING",
+ "UPDATING"
+ ],
+ "description": "Output-only. The cluster's state.",
+ "type": "string",
+ "enumDescriptions": [
+ "The cluster state is unknown.",
+ "The cluster is being created and set up. It is not ready for use.",
+ "The cluster is currently running and healthy. It is ready for use.",
+ "The cluster encountered an error. It is not ready for use.",
+ "The cluster is being deleted. It cannot be used.",
+ "The cluster is being updated. It continues to accept and process jobs."
+ ]
+ },
"substate": {
"enum": [
"UNSPECIFIED",
@@ -818,60 +1018,14 @@
"detail": {
"description": "Output-only. Optional details of cluster's state.",
"type": "string"
- },
- "state": {
- "enumDescriptions": [
- "The cluster state is unknown.",
- "The cluster is being created and set up. It is not ready for use.",
- "The cluster is currently running and healthy. It is ready for use.",
- "The cluster encountered an error. It is not ready for use.",
- "The cluster is being deleted. It cannot be used.",
- "The cluster is being updated. It continues to accept and process jobs."
- ],
- "enum": [
- "UNKNOWN",
- "CREATING",
- "RUNNING",
- "ERROR",
- "DELETING",
- "UPDATING"
- ],
- "description": "Output-only. The cluster's state.",
- "type": "string"
}
},
- "id": "ClusterStatus",
- "description": "The status of a cluster and its instances."
+ "id": "ClusterStatus"
},
"PigJob": {
"description": "A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN.",
"type": "object",
"properties": {
- "scriptVariables": {
- "description": "Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "jarFileUris": {
- "description": "Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "loggingConfig": {
- "$ref": "LoggingConfig",
- "description": "Optional. The runtime log config for job execution."
- },
- "properties": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.",
- "type": "object"
- },
"continueOnFailure": {
"description": "Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.",
"type": "boolean"
@@ -883,6 +1037,31 @@
"queryFileUri": {
"description": "The HCFS URI of the script that contains the Pig queries.",
"type": "string"
+ },
+ "jarFileUris": {
+ "description": "Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "scriptVariables": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).",
+ "type": "object"
+ },
+ "loggingConfig": {
+ "$ref": "LoggingConfig",
+ "description": "Optional. The runtime log config for job execution."
+ },
+ "properties": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.",
+ "type": "object"
}
},
"id": "PigJob"
@@ -905,86 +1084,10 @@
},
"id": "ListClustersResponse"
},
- "SparkJob": {
- "id": "SparkJob",
- "description": "A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN.",
+ "Job": {
+ "description": "A Cloud Dataproc job resource.",
"type": "object",
"properties": {
- "loggingConfig": {
- "$ref": "LoggingConfig",
- "description": "Optional. The runtime log config for job execution."
- },
- "properties": {
- "description": "Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "args": {
- "description": "Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "fileUris": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks."
- },
- "mainClass": {
- "description": "The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.",
- "type": "string"
- },
- "archiveUris": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip."
- },
- "mainJarFileUri": {
- "description": "The HCFS URI of the jar file that contains the main class.",
- "type": "string"
- },
- "jarFileUris": {
- "description": "Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- }
- },
- "Job": {
- "properties": {
- "hadoopJob": {
- "description": "Job is a Hadoop job.",
- "$ref": "HadoopJob"
- },
- "placement": {
- "description": "Required. Job information, including how, when, and where to run the job.",
- "$ref": "JobPlacement"
- },
- "status": {
- "description": "Output-only. The job status. Additional application-specific status information may be contained in the \u003ccode\u003etype_job\u003c/code\u003e and \u003ccode\u003eyarn_applications\u003c/code\u003e fields.",
- "$ref": "JobStatus"
- },
- "driverControlFilesUri": {
- "description": "Output-only. If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.",
- "type": "string"
- },
- "scheduling": {
- "description": "Optional. Job scheduling configuration.",
- "$ref": "JobScheduling"
- },
- "pigJob": {
- "$ref": "PigJob",
- "description": "Job is a Pig job."
- },
"hiveJob": {
"$ref": "HiveJob",
"description": "Job is a Hive job."
@@ -1023,17 +1126,93 @@
"type": "array"
},
"pysparkJob": {
- "$ref": "PySparkJob",
- "description": "Job is a Pyspark job."
+ "description": "Job is a Pyspark job.",
+ "$ref": "PySparkJob"
},
"reference": {
- "$ref": "JobReference",
- "description": "Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a \u003ccode\u003ejob_id\u003c/code\u003e."
+ "description": "Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a \u003ccode\u003ejob_id\u003c/code\u003e.",
+ "$ref": "JobReference"
+ },
+ "hadoopJob": {
+ "description": "Job is a Hadoop job.",
+ "$ref": "HadoopJob"
+ },
+ "placement": {
+ "description": "Required. Job information, including how, when, and where to run the job.",
+ "$ref": "JobPlacement"
+ },
+ "status": {
+ "description": "Output-only. The job status. Additional application-specific status information may be contained in the \u003ccode\u003etype_job\u003c/code\u003e and \u003ccode\u003eyarn_applications\u003c/code\u003e fields.",
+ "$ref": "JobStatus"
+ },
+ "driverControlFilesUri": {
+ "description": "Output-only. If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.",
+ "type": "string"
+ },
+ "scheduling": {
+ "$ref": "JobScheduling",
+ "description": "Optional. Job scheduling configuration."
+ },
+ "pigJob": {
+ "$ref": "PigJob",
+ "description": "Job is a Pig job."
}
},
- "id": "Job",
- "description": "A Cloud Dataproc job resource.",
- "type": "object"
+ "id": "Job"
+ },
+ "SparkJob": {
+ "description": "A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN.",
+ "type": "object",
+ "properties": {
+ "jarFileUris": {
+ "description": "Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "loggingConfig": {
+ "$ref": "LoggingConfig",
+ "description": "Optional. The runtime log config for job execution."
+ },
+ "properties": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.",
+ "type": "object"
+ },
+ "args": {
+ "description": "Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "fileUris": {
+ "description": "Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "mainClass": {
+ "description": "The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.",
+ "type": "string"
+ },
+ "archiveUris": {
+ "description": "Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "mainJarFileUri": {
+ "description": "The HCFS URI of the jar file that contains the main class.",
+ "type": "string"
+ }
+ },
+ "id": "SparkJob"
},
"JobStatus": {
"properties": {
@@ -1042,6 +1221,8 @@
"type": "string"
},
"state": {
+ "description": "Output-only. A state message specifying the overall job state.",
+ "type": "string",
"enumDescriptions": [
"The job state is unknown.",
"The job is pending; it has been submitted, but is not yet running.",
@@ -1065,25 +1246,23 @@
"DONE",
"ERROR",
"ATTEMPT_FAILURE"
- ],
- "description": "Output-only. A state message specifying the overall job state.",
- "type": "string"
+ ]
},
"substate": {
- "type": "string",
- "enumDescriptions": [
- "",
- "The Job is submitted to the agent.Applies to RUNNING state.",
- "The Job has been received and is awaiting execution (it may be waiting for a condition to be met). See the \"details\" field for the reason for the delay.Applies to RUNNING state.",
- "The agent-reported status is out of date, which may be caused by a loss of communication between the agent and Cloud Dataproc. If the agent does not send a timely update, the job will fail.Applies to RUNNING state."
- ],
"enum": [
"UNSPECIFIED",
"SUBMITTED",
"QUEUED",
"STALE_STATUS"
],
- "description": "Output-only. Additional state information, which includes status reported by the agent."
+ "description": "Output-only. Additional state information, which includes status reported by the agent.",
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "The Job is submitted to the agent.Applies to RUNNING state.",
+ "The Job has been received and is awaiting execution (it may be waiting for a condition to be met). See the \"details\" field for the reason for the delay.Applies to RUNNING state.",
+ "The agent-reported status is out of date, which may be caused by a loss of communication between the agent and Cloud Dataproc. If the agent does not send a timely update, the job will fail.Applies to RUNNING state."
+ ]
},
"stateStartTime": {
"format": "google-datetime",
@@ -1114,10 +1293,6 @@
"description": "The status of the operation.",
"type": "object",
"properties": {
- "innerState": {
- "type": "string",
- "description": "Output-only. A message containing the detailed operation state."
- },
"stateStartTime": {
"format": "google-datetime",
"description": "Output-only. The time this state was entered.",
@@ -1128,6 +1303,12 @@
"type": "string"
},
"state": {
+ "enum": [
+ "UNKNOWN",
+ "PENDING",
+ "RUNNING",
+ "DONE"
+ ],
"description": "Output-only. A message containing the operation state.",
"type": "string",
"enumDescriptions": [
@@ -1135,13 +1316,11 @@
"The operation has been created.",
"The operation is running.",
"The operation is done; either cancelled or completed."
- ],
- "enum": [
- "UNKNOWN",
- "PENDING",
- "RUNNING",
- "DONE"
]
+ },
+ "innerState": {
+ "description": "Output-only. A message containing the detailed operation state.",
+ "type": "string"
}
},
"id": "ClusterOperationStatus"
@@ -1150,16 +1329,18 @@
"description": "A YARN application created by a job. Application information is a subset of \u003ccode\u003eorg.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto\u003c/code\u003e.Beta Feature: This report is available for testing purposes only. It may be changed before final release.",
"type": "object",
"properties": {
- "trackingUrl": {
- "description": "Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.",
- "type": "string"
- },
- "progress": {
- "format": "float",
- "description": "Required. The numerical progress of the application, from 1 to 100.",
- "type": "number"
- },
"state": {
+ "enumDescriptions": [
+ "Status is unspecified.",
+ "Status is NEW.",
+ "Status is NEW_SAVING.",
+ "Status is SUBMITTED.",
+ "Status is ACCEPTED.",
+ "Status is RUNNING.",
+ "Status is FINISHED.",
+ "Status is FAILED.",
+ "Status is KILLED."
+ ],
"enum": [
"STATE_UNSPECIFIED",
"NEW",
@@ -1172,22 +1353,20 @@
"KILLED"
],
"description": "Required. The application state.",
- "type": "string",
- "enumDescriptions": [
- "Status is unspecified.",
- "Status is NEW.",
- "Status is NEW_SAVING.",
- "Status is SUBMITTED.",
- "Status is ACCEPTED.",
- "Status is RUNNING.",
- "Status is FINISHED.",
- "Status is FAILED.",
- "Status is KILLED."
- ]
+ "type": "string"
},
"name": {
"description": "Required. The application name.",
"type": "string"
+ },
+ "trackingUrl": {
+ "description": "Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.",
+ "type": "string"
+ },
+ "progress": {
+ "format": "float",
+ "description": "Required. The numerical progress of the application, from 1 to 100.",
+ "type": "number"
}
},
"id": "YarnApplication"
@@ -1207,23 +1386,7 @@
"type": "object"
},
"HadoopJob": {
- "type": "object",
"properties": {
- "mainJarFileUri": {
- "type": "string",
- "description": "The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'"
- },
- "jarFileUris": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks."
- },
- "loggingConfig": {
- "$ref": "LoggingConfig",
- "description": "Optional. The runtime log config for job execution."
- },
"properties": {
"additionalProperties": {
"type": "string"
@@ -1255,33 +1418,49 @@
"type": "string"
},
"type": "array"
+ },
+ "mainJarFileUri": {
+ "description": "The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'",
+ "type": "string"
+ },
+ "jarFileUris": {
+ "description": "Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "loggingConfig": {
+ "$ref": "LoggingConfig",
+ "description": "Optional. The runtime log config for job execution."
}
},
"id": "HadoopJob",
- "description": "A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html)."
+ "description": "A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html).",
+ "type": "object"
},
"DiagnoseClusterRequest": {
- "description": "A request to collect cluster diagnostic information.",
- "type": "object",
"properties": {},
- "id": "DiagnoseClusterRequest"
+ "id": "DiagnoseClusterRequest",
+ "description": "A request to collect cluster diagnostic information.",
+ "type": "object"
},
"DiskConfig": {
- "type": "object",
"properties": {
- "bootDiskSizeGb": {
- "format": "int32",
- "description": "Optional. Size in GB of the boot disk (default is 500GB).",
- "type": "integer"
- },
"numLocalSsds": {
"format": "int32",
"description": "Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.",
"type": "integer"
+ },
+ "bootDiskSizeGb": {
+ "format": "int32",
+ "description": "Optional. Size in GB of the boot disk (default is 500GB).",
+ "type": "integer"
}
},
"id": "DiskConfig",
- "description": "Specifies the config of disk options for a group of VM instances."
+ "description": "Specifies the config of disk options for a group of VM instances.",
+ "type": "object"
},
"ClusterOperationMetadata": {
"description": "Metadata describing the operation.",
@@ -1310,8 +1489,8 @@
"type": "object"
},
"status": {
- "$ref": "ClusterOperationStatus",
- "description": "Output-only. Current operation status."
+ "description": "Output-only. Current operation status.",
+ "$ref": "ClusterOperationStatus"
},
"statusHistory": {
"description": "Output-only. The previous operation status.",
@@ -1320,22 +1499,22 @@
},
"type": "array"
},
- "clusterName": {
- "type": "string",
- "description": "Output-only. Name of the cluster for the operation."
- },
"clusterUuid": {
"description": "Output-only. Cluster UUID for the operation.",
"type": "string"
+ },
+ "clusterName": {
+ "description": "Output-only. Name of the cluster for the operation.",
+ "type": "string"
}
},
"id": "ClusterOperationMetadata"
},
"Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
"type": "object",
"properties": {},
- "id": "Empty",
- "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}."
+ "id": "Empty"
},
"HiveJob": {
"description": "A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN.",
@@ -1346,20 +1525,13 @@
"type": "boolean"
},
"queryList": {
- "$ref": "QueryList",
- "description": "A list of queries."
+ "description": "A list of queries.",
+ "$ref": "QueryList"
},
"queryFileUri": {
"description": "The HCFS URI of the script that contains Hive queries.",
"type": "string"
},
- "scriptVariables": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name=\"value\";).",
- "type": "object"
- },
"jarFileUris": {
"description": "Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.",
"items": {
@@ -1367,12 +1539,19 @@
},
"type": "array"
},
- "properties": {
- "description": "Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.",
- "type": "object",
+ "scriptVariables": {
"additionalProperties": {
"type": "string"
- }
+ },
+ "description": "Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name=\"value\";).",
+ "type": "object"
+ },
+ "properties": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.",
+ "type": "object"
}
},
"id": "HiveJob"
@@ -1392,6 +1571,26 @@
"description": "The cluster config.",
"type": "object",
"properties": {
+ "workerConfig": {
+ "description": "Optional. The Google Compute Engine config settings for worker instances in a cluster.",
+ "$ref": "InstanceGroupConfig"
+ },
+ "gceClusterConfig": {
+ "description": "Required. The shared Google Compute Engine config settings for all instances in a cluster.",
+ "$ref": "GceClusterConfig"
+ },
+ "softwareConfig": {
+ "$ref": "SoftwareConfig",
+ "description": "Optional. The config settings for software inside the cluster."
+ },
+ "masterConfig": {
+ "description": "Optional. The Google Compute Engine config settings for the master instance in a cluster.",
+ "$ref": "InstanceGroupConfig"
+ },
+ "secondaryWorkerConfig": {
+ "$ref": "InstanceGroupConfig",
+ "description": "Optional. The Google Compute Engine config settings for additional worker instances in a cluster."
+ },
"initializationActions": {
"description": "Optional. Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget):\nROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)\nif [[ \"${ROLE}\" == 'Master' ]]; then\n ... master specific actions ...\nelse\n ... worker specific actions ...\nfi\n",
"items": {
@@ -1400,28 +1599,8 @@
"type": "array"
},
"configBucket": {
- "type": "string",
- "description": "Optional. A Google Cloud Storage staging bucket used for sharing generated SSH keys and config. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then it will create and manage this project-level, per-location bucket for you."
- },
- "workerConfig": {
- "$ref": "InstanceGroupConfig",
- "description": "Optional. The Google Compute Engine config settings for worker instances in a cluster."
- },
- "gceClusterConfig": {
- "$ref": "GceClusterConfig",
- "description": "Required. The shared Google Compute Engine config settings for all instances in a cluster."
- },
- "softwareConfig": {
- "$ref": "SoftwareConfig",
- "description": "Optional. The config settings for software inside the cluster."
- },
- "masterConfig": {
- "$ref": "InstanceGroupConfig",
- "description": "Optional. The Google Compute Engine config settings for the master instance in a cluster."
- },
- "secondaryWorkerConfig": {
- "description": "Optional. The Google Compute Engine config settings for additional worker instances in a cluster.",
- "$ref": "InstanceGroupConfig"
+ "description": "Optional. A Google Cloud Storage staging bucket used for sharing generated SSH keys and config. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then it will create and manage this project-level, per-location bucket for you.",
+ "type": "string"
}
},
"id": "ClusterConfig"
@@ -1430,24 +1609,6 @@
"description": "A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN.",
"type": "object",
"properties": {
- "jarFileUris": {
- "description": "Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "loggingConfig": {
- "description": "Optional. The runtime log config for job execution.",
- "$ref": "LoggingConfig"
- },
- "properties": {
- "description": "Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
"args": {
"description": "Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.",
"items": {
@@ -1479,25 +1640,30 @@
"type": "string"
},
"type": "array"
+ },
+ "jarFileUris": {
+ "description": "Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "loggingConfig": {
+ "$ref": "LoggingConfig",
+ "description": "Optional. The runtime log config for job execution."
+ },
+ "properties": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.",
+ "type": "object"
}
},
"id": "PySparkJob"
},
"GceClusterConfig": {
- "description": "Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster.",
- "type": "object",
"properties": {
- "internalIpOnly": {
- "description": "Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.",
- "type": "boolean"
- },
- "metadata": {
- "description": "The Google Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
"serviceAccountScopes": {
"description": "Optional. The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included:\nhttps://www.googleapis.com/auth/cloud.useraccounts.readonly\nhttps://www.googleapis.com/auth/devstorage.read_write\nhttps://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:\nhttps://www.googleapis.com/auth/bigquery\nhttps://www.googleapis.com/auth/bigtable.admin.table\nhttps://www.googleapis.com/auth/bigtable.data\nhttps://www.googleapis.com/auth/devstorage.full_control",
"items": {
@@ -1525,13 +1691,27 @@
"type": "string"
},
"zoneUri": {
- "type": "string",
- "description": "Optional. The zone where the Google Compute Engine cluster will be located. On a create request, it is required in the \"global\" region. If omitted in a non-global Cloud Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]\nprojects/[project_id]/zones/[zone]\nus-central1-f"
+ "description": "Optional. The zone where the Google Compute Engine cluster will be located. On a create request, it is required in the \"global\" region. If omitted in a non-global Cloud Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]\nprojects/[project_id]/zones/[zone]\nus-central1-f",
+ "type": "string"
+ },
+ "metadata": {
+ "description": "The Google Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "internalIpOnly": {
+ "description": "Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.",
+ "type": "boolean"
}
},
- "id": "GceClusterConfig"
+ "id": "GceClusterConfig",
+ "description": "Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster.",
+ "type": "object"
},
"AcceleratorConfig": {
+ "description": "Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).",
"type": "object",
"properties": {
"acceleratorTypeUri": {
@@ -1544,8 +1724,7 @@
"type": "integer"
}
},
- "id": "AcceleratorConfig",
- "description": "Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine)."
+ "id": "AcceleratorConfig"
},
"ClusterMetrics": {
"description": "Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release.",
@@ -1560,12 +1739,12 @@
"type": "object"
},
"hdfsMetrics": {
- "additionalProperties": {
- "type": "string",
- "format": "int64"
- },
"description": "The HDFS metrics.",
- "type": "object"
+ "type": "object",
+ "additionalProperties": {
+ "format": "int64",
+ "type": "string"
+ }
}
},
"id": "ClusterMetrics"
@@ -1616,22 +1795,21 @@
"type": "string"
},
"error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure or cancellation."
+ "description": "The error result of the operation in case of failure or cancellation.",
+ "$ref": "Status"
},
"metadata": {
+ "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
"type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- },
- "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any."
+ }
}
},
"id": "Operation"
},
"JobReference": {
- "id": "JobReference",
"description": "Encapsulates the full scoping used to reference a job.",
"type": "object",
"properties": {
@@ -1643,23 +1821,35 @@
"description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
"type": "string"
}
- }
+ },
+ "id": "JobReference"
},
"SubmitJobRequest": {
- "description": "A request to submit a job.",
- "type": "object",
"properties": {
"job": {
"description": "Required. The job resource.",
"$ref": "Job"
}
},
- "id": "SubmitJobRequest"
+ "id": "SubmitJobRequest",
+ "description": "A request to submit a job.",
+ "type": "object"
},
"Status": {
"description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "type": "array"
+ },
"code": {
"format": "int32",
"description": "The status code, which should be an enum value of google.rpc.Code.",
@@ -1668,210 +1858,16 @@
"message": {
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
"type": "string"
- },
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- },
- "type": "array"
}
},
"id": "Status"
- },
- "JobScheduling": {
- "properties": {
- "maxFailuresPerHour": {
- "format": "int32",
- "description": "Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.",
- "type": "integer"
- }
- },
- "id": "JobScheduling",
- "description": "Job scheduling options.Beta Feature: These options are available for testing purposes only. They may be changed before final release.",
- "type": "object"
- },
- "InstanceGroupConfig": {
- "type": "object",
- "properties": {
- "machineTypeUri": {
- "description": "Optional. The Google Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2\nprojects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2\nn1-standard-2",
- "type": "string"
- },
- "imageUri": {
- "type": "string",
- "description": "Output-only. The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version."
- },
- "isPreemptible": {
- "description": "Optional. Specifies that this instance group contains preemptible instances.",
- "type": "boolean"
- },
- "managedGroupConfig": {
- "$ref": "ManagedGroupConfig",
- "description": "Output-only. The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups."
- },
- "instanceNames": {
- "description": "Optional. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "accelerators": {
- "description": "Optional. The Google Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.",
- "items": {
- "$ref": "AcceleratorConfig"
- },
- "type": "array"
- },
- "numInstances": {
- "type": "integer",
- "format": "int32",
- "description": "Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1."
- },
- "diskConfig": {
- "$ref": "DiskConfig",
- "description": "Optional. Disk option config settings."
- }
- },
- "id": "InstanceGroupConfig",
- "description": "Optional. The config settings for Google Compute Engine resources in an instance group, such as a master or worker group."
- },
- "ListJobsResponse": {
- "description": "A list of jobs in a project.",
- "type": "object",
- "properties": {
- "jobs": {
- "description": "Output-only. Jobs list.",
- "items": {
- "$ref": "Job"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "Optional. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent \u003ccode\u003eListJobsRequest\u003c/code\u003e.",
- "type": "string"
- }
- },
- "id": "ListJobsResponse"
- },
- "NodeInitializationAction": {
- "type": "object",
- "properties": {
- "executionTimeout": {
- "format": "google-duration",
- "description": "Optional. Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.",
- "type": "string"
- },
- "executableFile": {
- "description": "Required. Google Cloud Storage URI of executable file.",
- "type": "string"
- }
- },
- "id": "NodeInitializationAction",
- "description": "Specifies an executable to run on a fully configured node and a timeout period for executable completion."
- },
- "CancelJobRequest": {
- "description": "A request to cancel a job.",
- "type": "object",
- "properties": {},
- "id": "CancelJobRequest"
- },
- "SparkSqlJob": {
- "description": "A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries.",
- "type": "object",
- "properties": {
- "queryFileUri": {
- "description": "The HCFS URI of the script that contains SQL queries.",
- "type": "string"
- },
- "queryList": {
- "description": "A list of queries.",
- "$ref": "QueryList"
- },
- "scriptVariables": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name=\"value\";).",
- "type": "object"
- },
- "jarFileUris": {
- "description": "Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "loggingConfig": {
- "$ref": "LoggingConfig",
- "description": "Optional. The runtime log config for job execution."
- },
- "properties": {
- "description": "Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- }
- },
- "id": "SparkSqlJob"
- },
- "Cluster": {
- "id": "Cluster",
- "description": "Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.",
- "type": "object",
- "properties": {
- "labels": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional. The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster."
- },
- "status": {
- "$ref": "ClusterStatus",
- "description": "Output-only. Cluster status."
- },
- "metrics": {
- "$ref": "ClusterMetrics",
- "description": "Contains cluster daemon metrics such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release."
- },
- "statusHistory": {
- "description": "Output-only. The previous cluster status.",
- "items": {
- "$ref": "ClusterStatus"
- },
- "type": "array"
- },
- "config": {
- "description": "Required. The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.",
- "$ref": "ClusterConfig"
- },
- "clusterName": {
- "description": "Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.",
- "type": "string"
- },
- "clusterUuid": {
- "description": "Output-only. A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.",
- "type": "string"
- },
- "projectId": {
- "description": "Required. The Google Cloud Platform project ID that the cluster belongs to.",
- "type": "string"
- }
- }
}
},
- "protocol": "rest",
"icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
},
+ "protocol": "rest",
"version": "v1",
"baseUrl": "https://dataproc.googleapis.com/",
"auth": {
@@ -1885,5 +1881,9 @@
},
"servicePath": "",
"description": "Manages Hadoop-based clusters and jobs on Google Cloud Platform.",
- "kind": "discovery#restDescription"
+ "kind": "discovery#restDescription",
+ "rootUrl": "https://dataproc.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "dataproc"
}
diff --git a/dataproc/v1beta2/dataproc-api.json b/dataproc/v1beta2/dataproc-api.json
index c1d374f..56cd14e 100644
--- a/dataproc/v1beta2/dataproc-api.json
+++ b/dataproc/v1beta2/dataproc-api.json
@@ -1,825 +1,16 @@
{
- "rootUrl": "https://dataproc.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "dataproc",
- "batchPath": "batch",
- "id": "dataproc:v1beta2",
- "documentationLink": "https://cloud.google.com/dataproc/",
- "revision": "20171003",
"title": "Google Cloud Dataproc API",
- "ownerName": "Google",
"discoveryVersion": "v1",
+ "ownerName": "Google",
"version_module": true,
"resources": {
"projects": {
"resources": {
"regions": {
"resources": {
- "jobs": {
- "methods": {
- "cancel": {
- "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel",
- "id": "dataproc.projects.regions.jobs.cancel",
- "request": {
- "$ref": "CancelJobRequest"
- },
- "description": "Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get.",
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "region",
- "jobId"
- ],
- "response": {
- "$ref": "Job"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "region": {
- "location": "path",
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "type": "string",
- "required": true
- },
- "jobId": {
- "location": "path",
- "description": "Required. The job ID.",
- "type": "string",
- "required": true
- },
- "projectId": {
- "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel"
- },
- "patch": {
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "jobId"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "updateMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "Required. Specifies the path, relative to \u003ccode\u003eJob\u003c/code\u003e, of the field to update. For example, to update the labels of a Job the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be specified as \u003ccode\u003elabels\u003c/code\u003e, and the PATCH request body would specify the new value. \u003cstrong\u003eNote:\u003c/strong\u003e Currently, \u003ccode\u003elabels\u003c/code\u003e is the only field that can be updated.",
- "type": "string"
- },
- "region": {
- "location": "path",
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "type": "string",
- "required": true
- },
- "jobId": {
- "location": "path",
- "description": "Required. The job ID.",
- "type": "string",
- "required": true
- },
- "projectId": {
- "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "id": "dataproc.projects.regions.jobs.patch",
- "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "request": {
- "$ref": "Job"
- },
- "description": "Updates a job in a project."
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "jobId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "region": {
- "location": "path",
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "type": "string",
- "required": true
- },
- "jobId": {
- "location": "path",
- "description": "Required. The job ID.",
- "type": "string",
- "required": true
- },
- "projectId": {
- "location": "path",
- "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "id": "dataproc.projects.regions.jobs.get",
- "description": "Gets the resource representation for a job in a project."
- },
- "submit": {
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId",
- "region"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
- "type": "string",
- "required": true
- },
- "region": {
- "location": "path",
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs:submit",
- "id": "dataproc.projects.regions.jobs.submit",
- "path": "v1beta2/projects/{projectId}/regions/{region}/jobs:submit",
- "description": "Submits a job to a cluster.",
- "request": {
- "$ref": "SubmitJobRequest"
- }
- },
- "delete": {
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "jobId"
- ],
- "parameters": {
- "region": {
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "jobId": {
- "location": "path",
- "description": "Required. The job ID.",
- "type": "string",
- "required": true
- },
- "projectId": {
- "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "id": "dataproc.projects.regions.jobs.delete",
- "description": "Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION."
- },
- "list": {
- "response": {
- "$ref": "ListJobsResponse"
- },
- "parameterOrder": [
- "projectId",
- "region"
- ],
- "httpMethod": "GET",
- "parameters": {
- "clusterName": {
- "location": "query",
- "description": "Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.",
- "type": "string"
- },
- "projectId": {
- "location": "path",
- "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
- "type": "string",
- "required": true
- },
- "filter": {
- "location": "query",
- "description": "Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is status.state or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be either ACTIVE or INACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND labels.env = staging AND labels.starred = *",
- "type": "string"
- },
- "jobStateMatcher": {
- "enum": [
- "ALL",
- "ACTIVE",
- "NON_ACTIVE"
- ],
- "description": "Optional. Specifies enumerated categories of jobs to list (default = match ALL jobs).",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "description": "Optional. The page token, returned by a previous call, to request the next page of results.",
- "type": "string"
- },
- "pageSize": {
- "format": "int32",
- "description": "Optional. The number of results to return in each response.",
- "type": "integer",
- "location": "query"
- },
- "region": {
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs",
- "id": "dataproc.projects.regions.jobs.list",
- "path": "v1beta2/projects/{projectId}/regions/{region}/jobs",
- "description": "Lists regions/{region}/jobs in a project."
- }
- }
- },
- "workflowTemplates": {
- "methods": {
- "instantiate": {
- "id": "dataproc.projects.regions.workflowTemplates.instantiate",
- "path": "v1beta2/{+name}:instantiate",
- "description": "Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling google.cloud.dataproc.v1beta2.OperationService.GetOperation. The Operation will complete when entire workflow is finished.The running workflow can be aborted via google.cloud.dataproc.v1beta2.OperationService.CancelOperation.The google.cloud.dataproc.v1beta2.Operation.metadata will always be google.cloud.dataproc.v1beta2.WorkflowMetadata.The google.cloud.dataproc.v1beta2.Operation.result will always be google.protobuf.Empty.",
- "request": {
- "$ref": "InstantiateWorkflowTemplateRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "description": "Required The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}:instantiate"
- },
- "get": {
- "id": "dataproc.projects.regions.workflowTemplates.get",
- "path": "v1beta2/{+name}",
- "description": "Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter.",
- "response": {
- "$ref": "WorkflowTemplate"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "Required The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$",
- "location": "path"
- },
- "version": {
- "format": "int32",
- "description": "Optional The version of workflow template to retrieve. Only previously instatiated versions can be retrieved.If unspecified, retrieves the current version.",
- "type": "integer",
- "location": "query"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}"
- },
- "update": {
- "httpMethod": "PUT",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "WorkflowTemplate"
- },
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$",
- "location": "path",
- "description": "Output-only The \"resource name\" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}",
- "path": "v1beta2/{+name}",
- "id": "dataproc.projects.regions.workflowTemplates.update",
- "description": "Updates (replaces) workflow template. The updated template must contain version that matches the current server version.",
- "request": {
- "$ref": "WorkflowTemplate"
- }
- },
- "delete": {
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "version": {
- "format": "int32",
- "description": "Optional The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version.",
- "type": "integer",
- "location": "query"
- },
- "name": {
- "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$",
- "location": "path",
- "description": "Required The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}",
- "path": "v1beta2/{+name}",
- "id": "dataproc.projects.regions.workflowTemplates.delete",
- "description": "Deletes a workflow template. It does not cancel in-progress workflows."
- },
- "list": {
- "response": {
- "$ref": "ListWorkflowTemplatesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Optional The page token, returned by a previous call, to request the next page of results.",
- "type": "string"
- },
- "pageSize": {
- "format": "int32",
- "description": "Optional The maximum number of results to return in each response.",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "pattern": "^projects/[^/]+/regions/[^/]+$",
- "location": "path",
- "description": "Required The \"resource name\" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates",
- "id": "dataproc.projects.regions.workflowTemplates.list",
- "path": "v1beta2/{+parent}/workflowTemplates",
- "description": "Lists workflows that match the specified filter in the request."
- },
- "create": {
- "path": "v1beta2/{+parent}/workflowTemplates",
- "id": "dataproc.projects.regions.workflowTemplates.create",
- "description": "Creates new workflow template.",
- "request": {
- "$ref": "WorkflowTemplate"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "WorkflowTemplate"
- },
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+/regions/[^/]+$",
- "location": "path",
- "description": "Required The \"resource name\" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates"
- }
- }
- },
- "clusters": {
- "methods": {
- "delete": {
- "description": "Deletes a cluster in a project.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "clusterName"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "clusterUuid": {
- "description": "Optional. Specifying the cluster_uuid means the RPC should fail (with error NOT_FOUND) if cluster with specified UUID does not exist.",
- "type": "string",
- "location": "query"
- },
- "clusterName": {
- "location": "path",
- "description": "Required. The cluster name.",
- "type": "string",
- "required": true
- },
- "projectId": {
- "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "region": {
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "id": "dataproc.projects.regions.clusters.delete",
- "path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}"
- },
- "diagnose": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "clusterName"
- ],
- "httpMethod": "POST",
- "parameters": {
- "clusterName": {
- "location": "path",
- "description": "Required. The cluster name.",
- "type": "string",
- "required": true
- },
- "projectId": {
- "location": "path",
- "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
- "type": "string",
- "required": true
- },
- "region": {
- "location": "path",
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose",
- "id": "dataproc.projects.regions.clusters.diagnose",
- "path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose",
- "description": "Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation.",
- "request": {
- "$ref": "DiagnoseClusterRequest"
- }
- },
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListClustersResponse"
- },
- "parameterOrder": [
- "projectId",
- "region"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Optional. The standard List page token.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Optional. The standard List page size.",
- "type": "integer"
- },
- "projectId": {
- "location": "path",
- "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
- "type": "string",
- "required": true
- },
- "filter": {
- "description": "Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING and ERROR states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *",
- "type": "string",
- "location": "query"
- },
- "region": {
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters",
- "path": "v1beta2/projects/{projectId}/regions/{region}/clusters",
- "id": "dataproc.projects.regions.clusters.list",
- "description": "Lists all regions/{region}/clusters in a project."
- },
- "create": {
- "id": "dataproc.projects.regions.clusters.create",
- "path": "v1beta2/projects/{projectId}/regions/{region}/clusters",
- "description": "Creates a cluster in a project.",
- "request": {
- "$ref": "Cluster"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "region"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
- "type": "string",
- "required": true
- },
- "region": {
- "location": "path",
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters"
- },
- "setIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:setIamPolicy",
- "id": "dataproc.projects.regions.clusters.setIamPolicy",
- "path": "v1beta2/{+resource}:setIamPolicy",
- "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
- "request": {
- "$ref": "SetIamPolicyRequest"
- }
- },
- "getIamPolicy": {
- "httpMethod": "GET",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:getIamPolicy",
- "path": "v1beta2/{+resource}:getIamPolicy",
- "id": "dataproc.projects.regions.clusters.getIamPolicy",
- "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set."
- },
- "get": {
- "description": "Gets the resource representation for a cluster in a project.",
- "response": {
- "$ref": "Cluster"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "clusterName"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "region": {
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "clusterName": {
- "location": "path",
- "description": "Required. The cluster name.",
- "type": "string",
- "required": true
- },
- "projectId": {
- "location": "path",
- "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "id": "dataproc.projects.regions.clusters.get",
- "path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}"
- },
- "patch": {
- "path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "id": "dataproc.projects.regions.clusters.patch",
- "description": "Updates a cluster in a project.",
- "request": {
- "$ref": "Cluster"
- },
- "httpMethod": "PATCH",
- "parameterOrder": [
- "projectId",
- "region",
- "clusterName"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "clusterName": {
- "description": "Required. The cluster name.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "gracefulDecommissionTimeout": {
- "format": "google-duration",
- "description": "Optional. Timeout for graceful YARN decomissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day.Only supported on Dataproc image versions 1.2 and higher.",
- "type": "string",
- "location": "query"
- },
- "projectId": {
- "location": "path",
- "description": "Required. The ID of the Google Cloud Platform project the cluster belongs to.",
- "type": "string",
- "required": true
- },
- "updateMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "Required. Specifies the path, relative to \u003ccode\u003eCluster\u003c/code\u003e, of the field to update. For example, to change the number of workers in a cluster to 5, the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be specified as \u003ccode\u003econfig.worker_config.num_instances\u003c/code\u003e, and the PATCH request body would specify the new value, as follows:\n{\n \"config\":{\n \"workerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\nSimilarly, to change the number of preemptible workers in a cluster to 5, the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be \u003ccode\u003econfig.secondary_worker_config.num_instances\u003c/code\u003e, and the PATCH request body would be set as follows:\n{\n \"config\":{\n \"secondaryWorkerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\n\u003cstrong\u003eNote:\u003c/strong\u003e currently only some fields can be updated: |Mask|Purpose| |labels|Updates labels| |config.worker_config.num_instances|Resize primary worker group| |config.secondary_worker_config.num_instances|Resize secondary worker group|",
- "type": "string"
- },
- "region": {
- "location": "path",
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}"
- },
- "testIamPermissions": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:testIamPermissions",
- "path": "v1beta2/{+resource}:testIamPermissions",
- "id": "dataproc.projects.regions.clusters.testIamPermissions",
- "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- }
- }
- }
- },
"operations": {
"methods": {
"cancel": {
- "path": "v1beta2/{+name}:cancel",
- "id": "dataproc.projects.regions.operations.cancel",
- "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.",
- "httpMethod": "POST",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
@@ -832,7 +23,17 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}:cancel"
+ "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}:cancel",
+ "path": "v1beta2/{+name}:cancel",
+ "id": "dataproc.projects.regions.operations.cancel",
+ "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ }
},
"delete": {
"response": {
@@ -842,27 +43,24 @@
"name"
],
"httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be deleted.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
+ "location": "path"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
- "location": "path",
- "description": "The name of the operation resource to be deleted.",
- "type": "string",
- "required": true
- }
- },
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}",
"id": "dataproc.projects.regions.operations.delete",
"path": "v1beta2/{+name}",
"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED."
},
"get": {
- "path": "v1beta2/{+name}",
- "id": "dataproc.projects.regions.operations.get",
- "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"httpMethod": "GET",
"response": {
"$ref": "Operation"
@@ -875,16 +73,22 @@
],
"parameters": {
"name": {
+ "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
+ "location": "path",
"description": "The name of the operation resource.",
"type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
- "location": "path"
+ "required": true
}
},
- "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}"
+ "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}",
+ "path": "v1beta2/{+name}",
+ "id": "dataproc.projects.regions.operations.get",
+ "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service."
},
"list": {
+ "id": "dataproc.projects.regions.operations.list",
+ "path": "v1beta2/{+name}",
+ "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
"response": {
"$ref": "ListOperationsResponse"
},
@@ -892,6 +96,9 @@
"name"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"filter": {
"description": "The standard list filter.",
@@ -917,13 +124,798 @@
"type": "integer"
}
},
+ "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations"
+ }
+ }
+ },
+ "jobs": {
+ "methods": {
+ "cancel": {
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel",
+ "id": "dataproc.projects.regions.jobs.cancel",
+ "request": {
+ "$ref": "CancelJobRequest"
+ },
+ "description": "Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "jobId"
+ ],
+ "response": {
+ "$ref": "Job"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations",
- "id": "dataproc.projects.regions.operations.list",
+ "parameters": {
+ "jobId": {
+ "location": "path",
+ "description": "Required. The job ID.",
+ "type": "string",
+ "required": true
+ },
+ "projectId": {
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
+ "type": "string",
+ "required": true
+ },
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ }
+ },
+ "get": {
+ "description": "Gets the resource representation for a job in a project.",
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "jobId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "jobId": {
+ "description": "Required. The job ID.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "projectId": {
+ "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "id": "dataproc.projects.regions.jobs.get",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}"
+ },
+ "patch": {
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "jobId"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "updateMask": {
+ "type": "string",
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Required. Specifies the path, relative to \u003ccode\u003eJob\u003c/code\u003e, of the field to update. For example, to update the labels of a Job the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be specified as \u003ccode\u003elabels\u003c/code\u003e, and the PATCH request body would specify the new value. \u003cstrong\u003eNote:\u003c/strong\u003e Currently, \u003ccode\u003elabels\u003c/code\u003e is the only field that can be updated."
+ },
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "jobId": {
+ "location": "path",
+ "description": "Required. The job ID.",
+ "type": "string",
+ "required": true
+ },
+ "projectId": {
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "id": "dataproc.projects.regions.jobs.patch",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "description": "Updates a job in a project.",
+ "request": {
+ "$ref": "Job"
+ }
+ },
+ "submit": {
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs:submit",
+ "id": "dataproc.projects.regions.jobs.submit",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/jobs:submit",
+ "request": {
+ "$ref": "SubmitJobRequest"
+ },
+ "description": "Submits a job to a cluster.",
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "projectId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project that the job belongs to."
+ }
+ }
+ },
+ "delete": {
+ "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "id": "dataproc.projects.regions.jobs.delete",
+ "description": "Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "jobId"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "jobId": {
+ "description": "Required. The job ID.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
+ "type": "string",
+ "required": true
+ },
+ "region": {
+ "location": "path",
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}"
+ },
+ "list": {
+ "description": "Lists regions/{region}/jobs in a project.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId",
+ "region"
+ ],
+ "response": {
+ "$ref": "ListJobsResponse"
+ },
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. The page token, returned by a previous call, to request the next page of results.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Optional. The number of results to return in each response.",
+ "type": "integer",
+ "location": "query"
+ },
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clusterName": {
+ "type": "string",
+ "location": "query",
+ "description": "Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster."
+ },
+ "projectId": {
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
+ "type": "string",
+ "required": true
+ },
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is status.state or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be either ACTIVE or INACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND labels.env = staging AND labels.starred = *"
+ },
+ "jobStateMatcher": {
+ "location": "query",
+ "enum": [
+ "ALL",
+ "ACTIVE",
+ "NON_ACTIVE"
+ ],
+ "description": "Optional. Specifies enumerated categories of jobs to list (default = match ALL jobs).",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/jobs",
+ "id": "dataproc.projects.regions.jobs.list"
+ }
+ }
+ },
+ "workflowTemplates": {
+ "methods": {
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "WorkflowTemplate"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$",
+ "location": "path"
+ },
+ "version": {
+ "location": "query",
+ "format": "int32",
+ "description": "Optional. The version of workflow template to retrieve. Only previously instatiated versions can be retrieved.If unspecified, retrieves the current version.",
+ "type": "integer"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}",
"path": "v1beta2/{+name}",
- "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id."
+ "id": "dataproc.projects.regions.workflowTemplates.get",
+ "description": "Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter."
+ },
+ "update": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$",
+ "location": "path",
+ "description": "Output only. The \"resource name\" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}",
+ "path": "v1beta2/{+name}",
+ "id": "dataproc.projects.regions.workflowTemplates.update",
+ "request": {
+ "$ref": "WorkflowTemplate"
+ },
+ "description": "Updates (replaces) workflow template. The updated template must contain version that matches the current server version.",
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "WorkflowTemplate"
+ }
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "version": {
+ "location": "query",
+ "format": "int32",
+ "description": "Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version.",
+ "type": "integer"
+ },
+ "name": {
+ "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$",
+ "location": "path",
+ "description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}",
+ "id": "dataproc.projects.regions.workflowTemplates.delete",
+ "path": "v1beta2/{+name}",
+ "description": "Deletes a workflow template. It does not cancel in-progress workflows."
+ },
+ "list": {
+ "path": "v1beta2/{+parent}/workflowTemplates",
+ "id": "dataproc.projects.regions.workflowTemplates.list",
+ "description": "Lists workflows that match the specified filter in the request.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListWorkflowTemplatesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. The page token, returned by a previous call, to request the next page of results.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Optional. The maximum number of results to return in each response.",
+ "type": "integer"
+ },
+ "parent": {
+ "description": "Required. The \"resource name\" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/regions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates"
+ },
+ "create": {
+ "response": {
+ "$ref": "WorkflowTemplate"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "description": "Required. The \"resource name\" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/regions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates",
+ "id": "dataproc.projects.regions.workflowTemplates.create",
+ "path": "v1beta2/{+parent}/workflowTemplates",
+ "description": "Creates new workflow template.",
+ "request": {
+ "$ref": "WorkflowTemplate"
+ }
+ },
+ "instantiate": {
+ "description": "Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling google.cloud.dataproc.v1beta2.OperationService.GetOperation. The Operation will complete when entire workflow is finished.The running workflow can be aborted via google.cloud.dataproc.v1beta2.OperationService.CancelOperation.The google.cloud.dataproc.v1beta2.Operation.metadata will always be google.cloud.dataproc.v1beta2.WorkflowMetadata.The google.cloud.dataproc.v1beta2.Operation.result will always be google.protobuf.Empty.",
+ "request": {
+ "$ref": "InstantiateWorkflowTemplateRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$",
+ "location": "path",
+ "description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}:instantiate",
+ "path": "v1beta2/{+name}:instantiate",
+ "id": "dataproc.projects.regions.workflowTemplates.instantiate"
+ }
+ }
+ },
+ "clusters": {
+ "methods": {
+ "patch": {
+ "id": "dataproc.projects.regions.clusters.patch",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "description": "Updates a cluster in a project.",
+ "request": {
+ "$ref": "Cluster"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "clusterName"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project the cluster belongs to.",
+ "type": "string",
+ "required": true
+ },
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "Required. Specifies the path, relative to \u003ccode\u003eCluster\u003c/code\u003e, of the field to update. For example, to change the number of workers in a cluster to 5, the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be specified as \u003ccode\u003econfig.worker_config.num_instances\u003c/code\u003e, and the PATCH request body would specify the new value, as follows:\n{\n \"config\":{\n \"workerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\nSimilarly, to change the number of preemptible workers in a cluster to 5, the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be \u003ccode\u003econfig.secondary_worker_config.num_instances\u003c/code\u003e, and the PATCH request body would be set as follows:\n{\n \"config\":{\n \"secondaryWorkerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\n\u003cstrong\u003eNote:\u003c/strong\u003e currently only some fields can be updated: |Mask|Purpose| |labels|Updates labels| |config.worker_config.num_instances|Resize primary worker group| |config.secondary_worker_config.num_instances|Resize secondary worker group|",
+ "type": "string",
+ "location": "query"
+ },
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "clusterName": {
+ "location": "path",
+ "description": "Required. The cluster name.",
+ "type": "string",
+ "required": true
+ },
+ "gracefulDecommissionTimeout": {
+ "format": "google-duration",
+ "description": "Optional. Timeout for graceful YARN decomissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day.Only supported on Dataproc image versions 1.2 and higher.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}"
+ },
+ "get": {
+ "parameters": {
+ "clusterName": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "Required. The cluster name."
+ },
+ "projectId": {
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "type": "string",
+ "required": true
+ },
+ "region": {
+ "location": "path",
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "id": "dataproc.projects.regions.clusters.get",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "description": "Gets the resource representation for a cluster in a project.",
+ "response": {
+ "$ref": "Cluster"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "clusterName"
+ ],
+ "httpMethod": "GET"
+ },
+ "testIamPermissions": {
+ "path": "v1beta2/{+resource}:testIamPermissions",
+ "id": "dataproc.projects.regions.clusters.testIamPermissions",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:testIamPermissions"
+ },
+ "diagnose": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "clusterName"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "type": "string",
+ "required": true
+ },
+ "region": {
+ "location": "path",
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true
+ },
+ "clusterName": {
+ "description": "Required. The cluster name.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose",
+ "id": "dataproc.projects.regions.clusters.diagnose",
+ "description": "Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation.",
+ "request": {
+ "$ref": "DiagnoseClusterRequest"
+ }
+ },
+ "delete": {
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "clusterName"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "type": "string",
+ "required": true
+ },
+ "region": {
+ "location": "path",
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true
+ },
+ "clusterUuid": {
+ "description": "Optional. Specifying the cluster_uuid means the RPC should fail (with error NOT_FOUND) if cluster with specified UUID does not exist.",
+ "type": "string",
+ "location": "query"
+ },
+ "clusterName": {
+ "description": "Required. The cluster name.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "id": "dataproc.projects.regions.clusters.delete",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "description": "Deletes a cluster in a project."
+ },
+ "list": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. The standard List page token.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Optional. The standard List page size.",
+ "type": "integer"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "type": "string",
+ "required": true
+ },
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING and ERROR states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *"
+ },
+ "region": {
+ "location": "path",
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters",
+ "id": "dataproc.projects.regions.clusters.list",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/clusters",
+ "description": "Lists all regions/{region}/clusters in a project.",
+ "response": {
+ "$ref": "ListClustersResponse"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region"
+ ],
+ "httpMethod": "GET"
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "region"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/clusters",
+ "id": "dataproc.projects.regions.clusters.create",
+ "request": {
+ "$ref": "Cluster"
+ },
+ "description": "Creates a cluster in a project."
+ },
+ "setIamPolicy": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:setIamPolicy",
+ "path": "v1beta2/{+resource}:setIamPolicy",
+ "id": "dataproc.projects.regions.clusters.setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any existing policy."
+ },
+ "getIamPolicy": {
+ "id": "dataproc.projects.regions.clusters.getIamPolicy",
+ "path": "v1beta2/{+resource}:getIamPolicy",
+ "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:getIamPolicy"
}
}
}
@@ -933,153 +925,39 @@
"resources": {
"workflowTemplates": {
"methods": {
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "WorkflowTemplate"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path",
- "description": "Required The \"resource name\" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates",
- "path": "v1beta2/{+parent}/workflowTemplates",
- "id": "dataproc.projects.locations.workflowTemplates.create",
- "request": {
- "$ref": "WorkflowTemplate"
- },
- "description": "Creates new workflow template."
- },
- "instantiate": {
- "request": {
- "$ref": "InstantiateWorkflowTemplateRequest"
- },
- "description": "Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling google.cloud.dataproc.v1beta2.OperationService.GetOperation. The Operation will complete when entire workflow is finished.The running workflow can be aborted via google.cloud.dataproc.v1beta2.OperationService.CancelOperation.The google.cloud.dataproc.v1beta2.Operation.metadata will always be google.cloud.dataproc.v1beta2.WorkflowMetadata.The google.cloud.dataproc.v1beta2.Operation.result will always be google.protobuf.Empty.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
- "location": "path",
- "description": "Required The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}:instantiate",
- "path": "v1beta2/{+name}:instantiate",
- "id": "dataproc.projects.locations.workflowTemplates.instantiate"
- },
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "WorkflowTemplate"
- },
- "parameters": {
- "version": {
- "format": "int32",
- "description": "Optional The version of workflow template to retrieve. Only previously instatiated versions can be retrieved.If unspecified, retrieves the current version.",
- "type": "integer",
- "location": "query"
- },
- "name": {
- "description": "Required The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}",
- "path": "v1beta2/{+name}",
- "id": "dataproc.projects.locations.workflowTemplates.get",
- "description": "Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter."
- },
- "update": {
- "response": {
- "$ref": "WorkflowTemplate"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
- "location": "path",
- "description": "Output-only The \"resource name\" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}",
- "id": "dataproc.projects.locations.workflowTemplates.update",
- "path": "v1beta2/{+name}",
- "request": {
- "$ref": "WorkflowTemplate"
- },
- "description": "Updates (replaces) workflow template. The updated template must contain version that matches the current server version."
- },
"delete": {
- "path": "v1beta2/{+name}",
- "id": "dataproc.projects.locations.workflowTemplates.delete",
"description": "Deletes a workflow template. It does not cancel in-progress workflows.",
- "httpMethod": "DELETE",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"name"
],
+ "httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"version": {
- "format": "int32",
- "description": "Optional The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version.",
"type": "integer",
- "location": "query"
+ "location": "query",
+ "format": "int32",
+ "description": "Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version."
},
"name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
- "location": "path",
- "description": "Required The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
+ "description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
"type": "string",
- "required": true
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
+ "location": "path"
}
},
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}"
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}",
+ "id": "dataproc.projects.locations.workflowTemplates.delete",
+ "path": "v1beta2/{+name}"
},
"list": {
+ "description": "Lists workflows that match the specified filter in the request.",
"httpMethod": "GET",
"response": {
"$ref": "ListWorkflowTemplatesResponse"
@@ -1091,29 +969,143 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "pageToken": {
- "description": "Optional The page token, returned by a previous call, to request the next page of results.",
- "type": "string",
- "location": "query"
- },
"pageSize": {
"format": "int32",
- "description": "Optional The maximum number of results to return in each response.",
+ "description": "Optional. The maximum number of results to return in each response.",
"type": "integer",
"location": "query"
},
"parent": {
- "description": "Required The \"resource name\" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path",
+ "description": "Required. The \"resource name\" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}",
+ "type": "string",
+ "required": true
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Optional. The page token, returned by a previous call, to request the next page of results."
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates",
+ "path": "v1beta2/{+parent}/workflowTemplates",
+ "id": "dataproc.projects.locations.workflowTemplates.list"
+ },
+ "create": {
+ "response": {
+ "$ref": "WorkflowTemplate"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "description": "Required. The \"resource name\" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+$",
"location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates",
+ "id": "dataproc.projects.locations.workflowTemplates.create",
"path": "v1beta2/{+parent}/workflowTemplates",
- "id": "dataproc.projects.locations.workflowTemplates.list",
- "description": "Lists workflows that match the specified filter in the request."
+ "description": "Creates new workflow template.",
+ "request": {
+ "$ref": "WorkflowTemplate"
+ }
+ },
+ "instantiate": {
+ "parameters": {
+ "name": {
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
+ "location": "path",
+ "description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}:instantiate",
+ "path": "v1beta2/{+name}:instantiate",
+ "id": "dataproc.projects.locations.workflowTemplates.instantiate",
+ "description": "Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling google.cloud.dataproc.v1beta2.OperationService.GetOperation. The Operation will complete when entire workflow is finished.The running workflow can be aborted via google.cloud.dataproc.v1beta2.OperationService.CancelOperation.The google.cloud.dataproc.v1beta2.Operation.metadata will always be google.cloud.dataproc.v1beta2.WorkflowMetadata.The google.cloud.dataproc.v1beta2.Operation.result will always be google.protobuf.Empty.",
+ "request": {
+ "$ref": "InstantiateWorkflowTemplateRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ }
+ },
+ "get": {
+ "id": "dataproc.projects.locations.workflowTemplates.get",
+ "path": "v1beta2/{+name}",
+ "description": "Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter.",
+ "response": {
+ "$ref": "WorkflowTemplate"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "version": {
+ "format": "int32",
+ "description": "Optional. The version of workflow template to retrieve. Only previously instatiated versions can be retrieved.If unspecified, retrieves the current version.",
+ "type": "integer",
+ "location": "query"
+ },
+ "name": {
+ "location": "path",
+ "description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}"
+ },
+ "update": {
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "WorkflowTemplate"
+ },
+ "parameters": {
+ "name": {
+ "description": "Output only. The \"resource name\" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}",
+ "path": "v1beta2/{+name}",
+ "id": "dataproc.projects.locations.workflowTemplates.update",
+ "description": "Updates (replaces) workflow template. The updated template must contain version that matches the current server version.",
+ "request": {
+ "$ref": "WorkflowTemplate"
+ }
}
}
}
@@ -1124,45 +1116,51 @@
},
"parameters": {
"upload_protocol": {
- "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"prettyPrint": {
- "location": "query",
"description": "Returns response with indentations and line breaks.",
"default": "true",
- "type": "boolean"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
+ "type": "boolean",
+ "location": "query"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
+ "uploadType": {
+ "type": "string",
"location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
+ },
+ "$.xgafv": {
"enum": [
"1",
"2"
],
"description": "V1 error format.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query"
},
"callback": {
+ "type": "string",
"location": "query",
- "description": "JSONP",
- "type": "string"
+ "description": "JSONP"
},
"alt": {
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
"description": "Data format for response.",
"default": "json",
"enum": [
@@ -1170,34 +1168,28 @@
"media",
"proto"
],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
"type": "string"
},
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "access_token": {
+ "description": "OAuth access token.",
"type": "string",
"location": "query"
},
+ "key": {
+ "type": "string",
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
+ },
"quotaUser": {
+ "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pp": {
+ "location": "query",
"description": "Pretty-print response.",
"default": "true",
- "type": "boolean",
- "location": "query"
+ "type": "boolean"
},
"bearer_token": {
"location": "query",
@@ -1211,293 +1203,30 @@
}
},
"schemas": {
- "Operation": {
- "properties": {
- "response": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.",
- "type": "object"
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.",
- "type": "string"
- },
- "error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure or cancellation."
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
- "type": "object"
- },
- "done": {
- "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
- "type": "boolean"
- }
- },
- "id": "Operation",
- "description": "This resource represents a long-running operation that is the result of a network API call.",
- "type": "object"
- },
- "ListWorkflowTemplatesResponse": {
- "description": "A response to a request to list workflow templates in a project.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Output-only This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent \u003ccode\u003eListWorkflowTemplatesRequest\u003c/code\u003e.",
- "type": "string"
- },
- "templates": {
- "description": "Output-only WorkflowTemplates list.",
- "items": {
- "$ref": "WorkflowTemplate"
- },
- "type": "array"
- }
- },
- "id": "ListWorkflowTemplatesResponse"
- },
- "JobReference": {
- "description": "Encapsulates the full scoping used to reference a job.",
- "type": "object",
- "properties": {
- "jobId": {
- "description": "Optional. The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.",
- "type": "string"
- },
- "projectId": {
- "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
- "type": "string"
- }
- },
- "id": "JobReference"
- },
- "Status": {
- "properties": {
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- },
- "type": "array"
- },
- "code": {
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
- "type": "string"
- }
- },
- "id": "Status",
- "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
- "type": "object"
- },
- "Binding": {
- "description": "Associates members with a role.",
- "type": "object",
- "properties": {
- "members": {
- "description": "Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:\nallUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.\nallAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.\nuser:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.\nserviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.\ngroup:{emailid}: An email address that represents a Google group. For example, admins@example.com.\ndomain:{domain}: A Google Apps domain name that represents all the users of that domain. For example, google.com or example.com.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "role": {
- "description": "Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner. Required",
- "type": "string"
- }
- },
- "id": "Binding"
- },
- "InstanceGroupConfig": {
- "description": "Optional. The config settings for Google Compute Engine resources in an instance group, such as a master or worker group.",
- "type": "object",
- "properties": {
- "diskConfig": {
- "$ref": "DiskConfig",
- "description": "Optional. Disk option config settings."
- },
- "managedGroupConfig": {
- "$ref": "ManagedGroupConfig",
- "description": "Output-only. The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups."
- },
- "isPreemptible": {
- "description": "Optional. Specifies that this instance group contains preemptible instances.",
- "type": "boolean"
- },
- "imageUri": {
- "description": "Output-only. The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.",
- "type": "string"
- },
- "machineTypeUri": {
- "description": "Optional. The Google Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2\nprojects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2\nn1-standard-2",
- "type": "string"
- },
- "instanceNames": {
- "description": "Optional. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "accelerators": {
- "description": "Optional. The Google Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.",
- "items": {
- "$ref": "AcceleratorConfig"
- },
- "type": "array"
- },
- "numInstances": {
- "format": "int32",
- "description": "Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.",
- "type": "integer"
- }
- },
- "id": "InstanceGroupConfig"
- },
- "ListJobsResponse": {
- "description": "A list of jobs in a project.",
- "type": "object",
- "properties": {
- "jobs": {
- "description": "Output-only. Jobs list.",
- "items": {
- "$ref": "Job"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "Optional. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent \u003ccode\u003eListJobsRequest\u003c/code\u003e.",
- "type": "string"
- }
- },
- "id": "ListJobsResponse"
- },
- "NodeInitializationAction": {
- "description": "Specifies an executable to run on a fully configured node and a timeout period for executable completion.",
- "type": "object",
- "properties": {
- "executionTimeout": {
- "format": "google-duration",
- "description": "Optional. Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.",
- "type": "string"
- },
- "executableFile": {
- "description": "Required. Google Cloud Storage URI of executable file.",
- "type": "string"
- }
- },
- "id": "NodeInitializationAction"
- },
- "CancelJobRequest": {
- "description": "A request to cancel a job.",
- "type": "object",
- "properties": {},
- "id": "CancelJobRequest"
- },
- "SparkSqlJob": {
- "properties": {
- "queryList": {
- "description": "A list of queries.",
- "$ref": "QueryList"
- },
- "queryFileUri": {
- "description": "The HCFS URI of the script that contains SQL queries.",
- "type": "string"
- },
- "scriptVariables": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name=\"value\";).",
- "type": "object"
- },
- "jarFileUris": {
- "description": "Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "loggingConfig": {
- "$ref": "LoggingConfig",
- "description": "Optional. The runtime log config for job execution."
- },
- "properties": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.",
- "type": "object"
- }
- },
- "id": "SparkSqlJob",
- "description": "A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries.",
- "type": "object"
- },
- "ListOperationsResponse": {
- "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"
- }
- },
- "id": "ListOperationsResponse",
- "description": "The response message for Operations.ListOperations.",
- "type": "object"
- },
"JobPlacement": {
- "description": "Cloud Dataproc job config.",
- "type": "object",
"properties": {
"clusterUuid": {
"description": "Output-only. A cluster UUID generated by the Cloud Dataproc service when the job is submitted.",
"type": "string"
},
"clusterName": {
- "description": "Required. The name of the cluster where the job will be submitted.",
- "type": "string"
+ "type": "string",
+ "description": "Required. The name of the cluster where the job will be submitted."
}
},
- "id": "JobPlacement"
+ "id": "JobPlacement",
+ "description": "Cloud Dataproc job config.",
+ "type": "object"
},
"PigJob": {
- "description": "A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN.",
- "type": "object",
"properties": {
- "continueOnFailure": {
- "description": "Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.",
- "type": "boolean"
- },
"queryList": {
"$ref": "QueryList",
"description": "A list of queries."
},
"queryFileUri": {
- "description": "The HCFS URI of the script that contains the Pig queries.",
- "type": "string"
+ "type": "string",
+ "description": "The HCFS URI of the script that contains the Pig queries."
},
"jarFileUris": {
"description": "Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.",
@@ -1507,50 +1236,39 @@
"type": "array"
},
"scriptVariables": {
+ "type": "object",
"additionalProperties": {
"type": "string"
},
- "description": "Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).",
- "type": "object"
+ "description": "Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value])."
},
"loggingConfig": {
- "description": "Optional. The runtime log config for job execution.",
- "$ref": "LoggingConfig"
+ "$ref": "LoggingConfig",
+ "description": "Optional. The runtime log config for job execution."
},
"properties": {
+ "description": "Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.",
- "type": "object"
+ }
+ },
+ "continueOnFailure": {
+ "description": "Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.",
+ "type": "boolean"
}
},
- "id": "PigJob"
+ "id": "PigJob",
+ "description": "A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN.",
+ "type": "object"
},
"ClusterStatus": {
+ "description": "The status of a cluster and its instances.",
+ "type": "object",
"properties": {
- "substate": {
- "enumDescriptions": [
- "",
- "The cluster is known to be in an unhealthy state (for example, critical daemons are not running or HDFS capacity is exhausted).Applies to RUNNING state.",
- "The agent-reported status is out of date (may occur if Cloud Dataproc loses communication with Agent).Applies to RUNNING state."
- ],
- "enum": [
- "UNSPECIFIED",
- "UNHEALTHY",
- "STALE_STATUS"
- ],
- "description": "Output-only. Additional state information that includes status reported by the agent.",
- "type": "string"
- },
- "stateStartTime": {
- "format": "google-datetime",
- "description": "Output-only. Time when this state was entered.",
- "type": "string"
- },
"detail": {
- "description": "Output-only. Optional details of cluster's state.",
- "type": "string"
+ "type": "string",
+ "description": "Output-only. Optional details of cluster's state."
},
"state": {
"enum": [
@@ -1571,55 +1289,72 @@
"The cluster is being deleted. It cannot be used.",
"The cluster is being updated. It continues to accept and process jobs."
]
+ },
+ "substate": {
+ "enum": [
+ "UNSPECIFIED",
+ "UNHEALTHY",
+ "STALE_STATUS"
+ ],
+ "description": "Output-only. Additional state information that includes status reported by the agent.",
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "The cluster is known to be in an unhealthy state (for example, critical daemons are not running or HDFS capacity is exhausted).Applies to RUNNING state.",
+ "The agent-reported status is out of date (may occur if Cloud Dataproc loses communication with Agent).Applies to RUNNING state."
+ ]
+ },
+ "stateStartTime": {
+ "format": "google-datetime",
+ "description": "Output-only. Time when this state was entered.",
+ "type": "string"
}
},
- "id": "ClusterStatus",
- "description": "The status of a cluster and its instances.",
- "type": "object"
+ "id": "ClusterStatus"
},
"WorkflowTemplate": {
"description": "A Cloud Dataproc workflow template resource.",
"type": "object",
"properties": {
+ "version": {
+ "format": "int32",
+ "description": "Optional. Used to perform a consistent read-modify-write.This field should be left blank for a CreateWorkflowTemplate request. It is required for an UpdateWorkflowTemplate request, and must match the current server version. A typical update template flow would fetch the current template with a GetWorkflowTemplate request, which will return the current template with the version field filled in with the current server version. The user updates other fields in the template, then returns it as part of the UpdateWorkflowTemplate request.",
+ "type": "integer"
+ },
+ "id": {
+ "description": "Required. The template id.",
+ "type": "string"
+ },
"jobs": {
- "description": "Required The Directed Acyclic Graph of Jobs to submit.",
+ "description": "Required. The Directed Acyclic Graph of Jobs to submit.",
"items": {
"$ref": "OrderedJob"
},
"type": "array"
},
+ "createTime": {
+ "format": "google-datetime",
+ "description": "Output only. The time template was created.",
+ "type": "string"
+ },
"labels": {
"additionalProperties": {
"type": "string"
},
- "description": "Optional The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).No more than 32 labels can be associated with a template.",
+ "description": "Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).No more than 32 labels can be associated with a template.",
"type": "object"
},
- "createTime": {
- "format": "google-datetime",
- "description": "Output-only The time template was created.",
- "type": "string"
- },
"placement": {
- "description": "Required WorkflowTemplate scheduling information.",
+ "description": "Required. WorkflowTemplate scheduling information.",
"$ref": "WorkflowTemplatePlacement"
},
"updateTime": {
"format": "google-datetime",
- "description": "Output-only The time template was last updated.",
+ "description": "Output only. The time template was last updated.",
"type": "string"
},
"name": {
- "description": "Output-only The \"resource name\" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
- "type": "string"
- },
- "version": {
- "format": "int32",
- "description": "Optional Used to perform a consistent read-modify-write.This field should be left blank for a CreateWorkflowTemplate request. It is required for an UpdateWorkflowTemplate request, and must match the current server version. A typical update template flow would fetch the current template with a GetWorkflowTemplate request, which will return the current template with the version field filled in with the current server version. The user updates other fields in the template, then returns it as part of the UpdateWorkflowTemplate request.",
- "type": "integer"
- },
- "id": {
- "description": "Required The template id.",
+ "description": "Output only. The \"resource name\" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
"type": "string"
}
},
@@ -1644,22 +1379,13 @@
"id": "ListClustersResponse"
},
"Job": {
+ "id": "Job",
+ "description": "A Cloud Dataproc job resource.",
+ "type": "object",
"properties": {
- "hadoopJob": {
- "$ref": "HadoopJob",
- "description": "Job is a Hadoop job."
- },
- "placement": {
- "$ref": "JobPlacement",
- "description": "Required. Job information, including how, when, and where to run the job."
- },
- "status": {
- "$ref": "JobStatus",
- "description": "Output-only. The job status. Additional application-specific status information may be contained in the \u003ccode\u003etype_job\u003c/code\u003e and \u003ccode\u003eyarn_applications\u003c/code\u003e fields."
- },
"driverControlFilesUri": {
- "description": "Output-only. If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.",
- "type": "string"
+ "type": "string",
+ "description": "Output-only. If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri."
},
"scheduling": {
"description": "Optional. Job scheduling configuration.",
@@ -1670,8 +1396,8 @@
"description": "Job is a Pig job."
},
"hiveJob": {
- "description": "Job is a Hive job.",
- "$ref": "HiveJob"
+ "$ref": "HiveJob",
+ "description": "Job is a Hive job."
},
"labels": {
"additionalProperties": {
@@ -1681,12 +1407,16 @@
"type": "object"
},
"driverOutputResourceUri": {
- "description": "Output-only. A URI pointing to the location of the stdout of the job's driver program.",
- "type": "string"
+ "type": "string",
+ "description": "Output-only. A URI pointing to the location of the stdout of the job's driver program."
+ },
+ "sparkJob": {
+ "description": "Job is a Spark job.",
+ "$ref": "SparkJob"
},
"sparkSqlJob": {
- "$ref": "SparkSqlJob",
- "description": "Job is a SparkSql job."
+ "description": "Job is a SparkSql job.",
+ "$ref": "SparkSqlJob"
},
"statusHistory": {
"description": "Output-only. The previous job status.",
@@ -1695,10 +1425,6 @@
},
"type": "array"
},
- "sparkJob": {
- "description": "Job is a Spark job.",
- "$ref": "SparkJob"
- },
"yarnApplications": {
"description": "Output-only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It may be changed before final release.",
"items": {
@@ -1713,26 +1439,20 @@
"reference": {
"$ref": "JobReference",
"description": "Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a \u003ccode\u003ejob_id\u003c/code\u003e."
- }
- },
- "id": "Job",
- "description": "A Cloud Dataproc job resource.",
- "type": "object"
- },
- "ManagedGroupConfig": {
- "properties": {
- "instanceGroupManagerName": {
- "description": "Output-only. The name of the Instance Group Manager for this group.",
- "type": "string"
},
- "instanceTemplateName": {
- "description": "Output-only. The name of the Instance Template used for the Managed Instance Group.",
- "type": "string"
+ "hadoopJob": {
+ "$ref": "HadoopJob",
+ "description": "Job is a Hadoop job."
+ },
+ "placement": {
+ "description": "Required. Job information, including how, when, and where to run the job.",
+ "$ref": "JobPlacement"
+ },
+ "status": {
+ "description": "Output-only. The job status. Additional application-specific status information may be contained in the \u003ccode\u003etype_job\u003c/code\u003e and \u003ccode\u003eyarn_applications\u003c/code\u003e fields.",
+ "$ref": "JobStatus"
}
- },
- "id": "ManagedGroupConfig",
- "description": "Specifies the resources used to actively manage an instance group.",
- "type": "object"
+ }
},
"LifecycleConfig": {
"description": "Specifies the cluster auto delete related schedule configuration.",
@@ -1756,35 +1476,23 @@
},
"id": "LifecycleConfig"
},
- "ManagedCluster": {
- "description": "Cluster that is managed by the workflow.",
+ "ManagedGroupConfig": {
+ "id": "ManagedGroupConfig",
+ "description": "Specifies the resources used to actively manage an instance group.",
"type": "object",
"properties": {
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \\p{Ll}\\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \\p{Ll}\\p{Lo}\\p{N}_-{0,63}No more than 64 labels can be associated with a given cluster.",
- "type": "object"
+ "instanceGroupManagerName": {
+ "description": "Output-only. The name of the Instance Group Manager for this group.",
+ "type": "string"
},
- "config": {
- "$ref": "ClusterConfig",
- "description": "Required The cluster configuration."
- },
- "clusterName": {
- "description": "Required The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.",
+ "instanceTemplateName": {
+ "description": "Output-only. The name of the Instance Template used for the Managed Instance Group.",
"type": "string"
}
- },
- "id": "ManagedCluster"
+ }
},
"ClusterOperationStatus": {
"properties": {
- "stateStartTime": {
- "format": "google-datetime",
- "description": "Output-only. The time this state was entered.",
- "type": "string"
- },
"details": {
"description": "Output-only.A message containing any operation metadata details.",
"type": "string"
@@ -1808,12 +1516,39 @@
"innerState": {
"description": "Output-only. A message containing the detailed operation state.",
"type": "string"
+ },
+ "stateStartTime": {
+ "format": "google-datetime",
+ "description": "Output-only. The time this state was entered.",
+ "type": "string"
}
},
"id": "ClusterOperationStatus",
"description": "The status of the operation.",
"type": "object"
},
+ "ManagedCluster": {
+ "description": "Cluster that is managed by the workflow.",
+ "type": "object",
+ "properties": {
+ "labels": {
+ "description": "Optional. The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \\p{Ll}\\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \\p{Ll}\\p{Lo}\\p{N}_-{0,63}No more than 64 labels can be associated with a given cluster.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "config": {
+ "description": "Required. The cluster configuration.",
+ "$ref": "ClusterConfig"
+ },
+ "clusterName": {
+ "description": "Required. The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.",
+ "type": "string"
+ }
+ },
+ "id": "ManagedCluster"
+ },
"HadoopJob": {
"description": "A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html).",
"type": "object",
@@ -1826,8 +1561,8 @@
"type": "array"
},
"loggingConfig": {
- "$ref": "LoggingConfig",
- "description": "Optional. The runtime log config for job execution."
+ "description": "Optional. The runtime log config for job execution.",
+ "$ref": "LoggingConfig"
},
"properties": {
"additionalProperties": {
@@ -1883,21 +1618,8 @@
"id": "QueryList"
},
"YarnApplication": {
- "description": "A YARN application created by a job. Application information is a subset of \u003ccode\u003eorg.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto\u003c/code\u003e.Beta Feature: This report is available for testing purposes only. It may be changed before final release.",
- "type": "object",
"properties": {
"state": {
- "enumDescriptions": [
- "Status is unspecified.",
- "Status is NEW.",
- "Status is NEW_SAVING.",
- "Status is SUBMITTED.",
- "Status is ACCEPTED.",
- "Status is RUNNING.",
- "Status is FINISHED.",
- "Status is FAILED.",
- "Status is KILLED."
- ],
"enum": [
"STATE_UNSPECIFIED",
"NEW",
@@ -1910,7 +1632,18 @@
"KILLED"
],
"description": "Required. The application state.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Status is unspecified.",
+ "Status is NEW.",
+ "Status is NEW_SAVING.",
+ "Status is SUBMITTED.",
+ "Status is ACCEPTED.",
+ "Status is RUNNING.",
+ "Status is FINISHED.",
+ "Status is FAILED.",
+ "Status is KILLED."
+ ]
},
"name": {
"description": "Required. The application name.",
@@ -1926,33 +1659,25 @@
"type": "number"
}
},
- "id": "YarnApplication"
+ "id": "YarnApplication",
+ "description": "A YARN application created by a job. Application information is a subset of \u003ccode\u003eorg.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto\u003c/code\u003e.Beta Feature: This report is available for testing purposes only. It may be changed before final release.",
+ "type": "object"
},
"SetIamPolicyRequest": {
+ "id": "SetIamPolicyRequest",
"description": "Request message for SetIamPolicy method.",
"type": "object",
"properties": {
"policy": {
- "description": "REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.",
- "$ref": "Policy"
+ "$ref": "Policy",
+ "description": "REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them."
}
- },
- "id": "SetIamPolicyRequest"
+ }
},
"HiveJob": {
+ "description": "A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN.",
+ "type": "object",
"properties": {
- "continueOnFailure": {
- "description": "Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.",
- "type": "boolean"
- },
- "queryList": {
- "description": "A list of queries.",
- "$ref": "QueryList"
- },
- "queryFileUri": {
- "description": "The HCFS URI of the script that contains Hive queries.",
- "type": "string"
- },
"jarFileUris": {
"description": "Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.",
"items": {
@@ -1973,50 +1698,66 @@
},
"description": "Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.",
"type": "object"
+ },
+ "continueOnFailure": {
+ "description": "Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.",
+ "type": "boolean"
+ },
+ "queryList": {
+ "$ref": "QueryList",
+ "description": "A list of queries."
+ },
+ "queryFileUri": {
+ "description": "The HCFS URI of the script that contains Hive queries.",
+ "type": "string"
}
},
- "id": "HiveJob",
- "description": "A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN.",
- "type": "object"
+ "id": "HiveJob"
},
"WorkflowGraph": {
+ "description": "The workflow graph.",
+ "type": "object",
"properties": {
"nodes": {
- "description": "Output-only The workflow nodes.",
+ "description": "Output only. The workflow nodes.",
"items": {
"$ref": "WorkflowNode"
},
"type": "array"
}
},
- "id": "WorkflowGraph",
- "description": "The workflow graph.",
- "type": "object"
+ "id": "WorkflowGraph"
},
"DiagnoseClusterResults": {
- "description": "The location of diagnostic output.",
"type": "object",
"properties": {
"outputUri": {
- "description": "Output-only. The Google Cloud Storage URI of the diagnostic output. The output report is a plain text file with a summary of collected diagnostics.",
- "type": "string"
+ "type": "string",
+ "description": "Output-only. The Google Cloud Storage URI of the diagnostic output. The output report is a plain text file with a summary of collected diagnostics."
}
},
- "id": "DiagnoseClusterResults"
+ "id": "DiagnoseClusterResults",
+ "description": "The location of diagnostic output."
},
"ClusterConfig": {
+ "description": "The cluster config.",
+ "type": "object",
"properties": {
+ "gceClusterConfig": {
+ "$ref": "GceClusterConfig",
+ "description": "Required. The shared Google Compute Engine config settings for all instances in a cluster."
+ },
+ "softwareConfig": {
+ "description": "Optional. The config settings for software inside the cluster.",
+ "$ref": "SoftwareConfig"
+ },
"masterConfig": {
"description": "Optional. The Google Compute Engine config settings for the master instance in a cluster.",
"$ref": "InstanceGroupConfig"
},
"secondaryWorkerConfig": {
- "description": "Optional. The Google Compute Engine config settings for additional worker instances in a cluster.",
- "$ref": "InstanceGroupConfig"
- },
- "lifecycleConfig": {
- "description": "Optional. The config setting for auto delete cluster schedule.",
- "$ref": "LifecycleConfig"
+ "$ref": "InstanceGroupConfig",
+ "description": "Optional. The Google Compute Engine config settings for additional worker instances in a cluster."
},
"initializationActions": {
"description": "Optional. Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's \u003ccode\u003erole\u003c/code\u003e metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget):\nROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1beta2/instance/attributes/dataproc-role)\nif [[ \"${ROLE}\" == 'Master' ]]; then\n ... master specific actions ...\nelse\n ... worker specific actions ...\nfi\n",
@@ -2025,6 +1766,10 @@
},
"type": "array"
},
+ "lifecycleConfig": {
+ "$ref": "LifecycleConfig",
+ "description": "Optional. The config setting for auto delete cluster schedule."
+ },
"configBucket": {
"description": "Optional. A Google Cloud Storage staging bucket used for sharing generated SSH keys and config. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then it will create and manage this project-level, per-location bucket for you.",
"type": "string"
@@ -2032,31 +1777,15 @@
"workerConfig": {
"description": "Optional. The Google Compute Engine config settings for worker instances in a cluster.",
"$ref": "InstanceGroupConfig"
- },
- "gceClusterConfig": {
- "description": "Required. The shared Google Compute Engine config settings for all instances in a cluster.",
- "$ref": "GceClusterConfig"
- },
- "softwareConfig": {
- "description": "Optional. The config settings for software inside the cluster.",
- "$ref": "SoftwareConfig"
}
},
- "id": "ClusterConfig",
- "description": "The cluster config.",
- "type": "object"
+ "id": "ClusterConfig"
},
"PySparkJob": {
+ "id": "PySparkJob",
"description": "A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN.",
"type": "object",
"properties": {
- "properties": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.",
- "type": "object"
- },
"args": {
"description": "Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.",
"items": {
@@ -2072,11 +1801,11 @@
"type": "array"
},
"pythonFileUris": {
- "description": "Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.",
"items": {
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "description": "Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip."
},
"mainPythonFileUri": {
"description": "Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.",
@@ -2097,11 +1826,17 @@
"type": "array"
},
"loggingConfig": {
- "description": "Optional. The runtime log config for job execution.",
- "$ref": "LoggingConfig"
+ "$ref": "LoggingConfig",
+ "description": "Optional. The runtime log config for job execution."
+ },
+ "properties": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.",
+ "type": "object"
}
- },
- "id": "PySparkJob"
+ }
},
"TestIamPermissionsRequest": {
"description": "Request message for TestIamPermissions method.",
@@ -2117,14 +1852,30 @@
},
"id": "TestIamPermissionsRequest"
},
+ "AcceleratorConfig": {
+ "description": "Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).",
+ "type": "object",
+ "properties": {
+ "acceleratorTypeUri": {
+ "description": "Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)Examples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80",
+ "type": "string"
+ },
+ "acceleratorCount": {
+ "format": "int32",
+ "description": "The number of the accelerator cards of this type exposed to this instance.",
+ "type": "integer"
+ }
+ },
+ "id": "AcceleratorConfig"
+ },
"ClusterMetrics": {
"description": "Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release.",
"type": "object",
"properties": {
"yarnMetrics": {
"additionalProperties": {
- "format": "int64",
- "type": "string"
+ "type": "string",
+ "format": "int64"
},
"description": "The YARN metrics.",
"type": "object"
@@ -2140,23 +1891,9 @@
},
"id": "ClusterMetrics"
},
- "AcceleratorConfig": {
- "properties": {
- "acceleratorTypeUri": {
- "description": "Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)Examples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80",
- "type": "string"
- },
- "acceleratorCount": {
- "format": "int32",
- "description": "The number of the accelerator cards of this type exposed to this instance.",
- "type": "integer"
- }
- },
- "id": "AcceleratorConfig",
- "description": "Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).",
- "type": "object"
- },
"LoggingConfig": {
+ "description": "The runtime logging config of the job.",
+ "type": "object",
"properties": {
"driverLogLevels": {
"additionalProperties": {
@@ -2177,65 +1914,84 @@
"type": "object"
}
},
- "id": "LoggingConfig",
- "description": "The runtime logging config of the job.",
- "type": "object"
+ "id": "LoggingConfig"
},
"OrderedJob": {
"type": "object",
"properties": {
+ "pysparkJob": {
+ "$ref": "PySparkJob",
+ "description": "Job is a Pyspark job."
+ },
"scheduling": {
"$ref": "JobScheduling",
- "description": "Optional Job scheduling configuration."
- },
- "stepId": {
- "description": "Required The step id. The id must be unique among all jobs within the template.The step id is used as prefix for job id, as job workflow-step-id label, and in prerequisite_step_ids field from other steps.",
- "type": "string"
+ "description": "Optional. Job scheduling configuration."
},
"pigJob": {
- "description": "Job is a Pig job.",
- "$ref": "PigJob"
+ "$ref": "PigJob",
+ "description": "Job is a Pig job."
+ },
+ "stepId": {
+ "type": "string",
+ "description": "Required. The step id. The id must be unique among all jobs within the template.The step id is used as prefix for job id, as job workflow-step-id label, and in prerequisite_step_ids field from other steps."
},
"hadoopJob": {
"$ref": "HadoopJob",
"description": "Job is a Hadoop job."
},
- "hiveJob": {
- "$ref": "HiveJob",
- "description": "Job is a Hive job."
- },
"prerequisiteStepIds": {
- "description": "Optional The optional list of prerequisite job step_ids. If not specified, the job will start at the beginning of workflow.",
+ "description": "Optional. The optional list of prerequisite job step_ids. If not specified, the job will start at the beginning of workflow.",
"items": {
"type": "string"
},
"type": "array"
},
+ "hiveJob": {
+ "description": "Job is a Hive job.",
+ "$ref": "HiveJob"
+ },
"labels": {
"additionalProperties": {
"type": "string"
},
- "description": "Optional The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \\p{Ll}\\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \\p{Ll}\\p{Lo}\\p{N}_-{0,63}No more than 64 labels can be associated with a given job.",
+ "description": "Optional. The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \\p{Ll}\\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \\p{Ll}\\p{Lo}\\p{N}_-{0,63}No more than 64 labels can be associated with a given job.",
"type": "object"
},
"sparkSqlJob": {
- "description": "Job is a SparkSql job.",
- "$ref": "SparkSqlJob"
+ "$ref": "SparkSqlJob",
+ "description": "Job is a SparkSql job."
},
"sparkJob": {
"description": "Job is a Spark job.",
"$ref": "SparkJob"
- },
- "pysparkJob": {
- "description": "Job is a Pyspark job.",
- "$ref": "PySparkJob"
}
},
"id": "OrderedJob"
},
"WorkflowNode": {
+ "description": "The workflow node.",
+ "type": "object",
"properties": {
+ "jobId": {
+ "type": "string",
+ "description": "Output only. The job id; populated after the node enters RUNNING state."
+ },
+ "prerequisiteStepIds": {
+ "description": "Output only. Node's prerequisite nodes.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
"state": {
+ "enumDescriptions": [
+ "",
+ "The node is awaiting prerequisite node to finish.",
+ "The node is runnable but not running.",
+ "The node is running.",
+ "The node completed successfully.",
+ "The node failed. A node can be marked FAILED because its ancestor or peer failed."
+ ],
"enum": [
"NODE_STATUS_UNSPECIFIED",
"BLOCKED",
@@ -2244,69 +2000,50 @@
"COMPLETED",
"FAILED"
],
- "description": "Output-only The node state.",
- "type": "string",
- "enumDescriptions": [
- "",
- "The node is awaiting prerequisite node to finish.",
- "The node is runnable but not running.",
- "The node is running.",
- "The node completed successfully.",
- "The node failed. A node can be marked FAILED because its ancestor or peer failed."
- ]
+ "description": "Output only. The node state.",
+ "type": "string"
},
"error": {
- "description": "Output-only The error detail.",
+ "description": "Output only. The error detail.",
"type": "string"
},
"stepId": {
- "description": "Output-only The name of the node.",
+ "description": "Output only. The name of the node.",
"type": "string"
- },
- "jobId": {
- "description": "Output-only The job id; populated after the node enters RUNNING state.",
- "type": "string"
- },
- "prerequisiteStepIds": {
- "description": "Output-only Node's prerequisite nodes.",
- "items": {
- "type": "string"
- },
- "type": "array"
}
},
- "id": "WorkflowNode",
- "description": "The workflow node.",
- "type": "object"
+ "id": "WorkflowNode"
},
"InstantiateWorkflowTemplateRequest": {
"description": "A request to instantiate a workflow template.",
"type": "object",
"properties": {
+ "instanceId": {
+ "description": "Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.",
+ "type": "string"
+ },
"version": {
"format": "int32",
- "description": "Optional The version of workflow template to instantiate. If specified, the workflow will be instantiated only if the current version of the workflow template has the supplied version.This option cannot be used to instantiate a previous version of workflow template.",
+ "description": "Optional. The version of workflow template to instantiate. If specified, the workflow will be instantiated only if the current version of the workflow template has the supplied version.This option cannot be used to instantiate a previous version of workflow template.",
"type": "integer"
- },
- "instanceId": {
- "description": "Optional A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.",
- "type": "string"
}
},
"id": "InstantiateWorkflowTemplateRequest"
},
"SubmitJobRequest": {
+ "description": "A request to submit a job.",
+ "type": "object",
"properties": {
"job": {
"$ref": "Job",
"description": "Required. The job resource."
}
},
- "id": "SubmitJobRequest",
- "description": "A request to submit a job.",
- "type": "object"
+ "id": "SubmitJobRequest"
},
"JobScheduling": {
+ "description": "Job scheduling options.Beta Feature: These options are available for testing purposes only. They may be changed before final release.",
+ "type": "object",
"properties": {
"maxFailuresPerHour": {
"format": "int32",
@@ -2314,11 +2051,10 @@
"type": "integer"
}
},
- "id": "JobScheduling",
- "description": "Job scheduling options.Beta Feature: These options are available for testing purposes only. They may be changed before final release.",
- "type": "object"
+ "id": "JobScheduling"
},
"Cluster": {
+ "id": "Cluster",
"description": "Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.",
"type": "object",
"properties": {
@@ -2334,8 +2070,12 @@
"$ref": "ClusterStatus"
},
"metrics": {
- "description": "Contains cluster daemon metrics such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release.",
- "$ref": "ClusterMetrics"
+ "$ref": "ClusterMetrics",
+ "description": "Contains cluster daemon metrics such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release."
+ },
+ "config": {
+ "description": "Required. The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.",
+ "$ref": "ClusterConfig"
},
"statusHistory": {
"description": "Output-only. The previous cluster status.",
@@ -2344,24 +2084,19 @@
},
"type": "array"
},
- "config": {
- "description": "Required. The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.",
- "$ref": "ClusterConfig"
- },
"clusterName": {
- "description": "Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.",
- "type": "string"
+ "type": "string",
+ "description": "Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused."
},
"clusterUuid": {
"description": "Output-only. A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.",
"type": "string"
},
"projectId": {
- "description": "Required. The Google Cloud Platform project ID that the cluster belongs to.",
- "type": "string"
+ "type": "string",
+ "description": "Required. The Google Cloud Platform project ID that the cluster belongs to."
}
- },
- "id": "Cluster"
+ }
},
"TestIamPermissionsResponse": {
"description": "Response message for TestIamPermissions method.",
@@ -2381,16 +2116,16 @@
"description": "Specifies the selection and config of software inside the cluster.",
"type": "object",
"properties": {
+ "imageVersion": {
+ "type": "string",
+ "description": "Optional. The version of software inside the cluster. It must match the regular expression [0-9]+\\.[0-9]+. If unspecified, it defaults to the latest version (see Cloud Dataproc Versioning)."
+ },
"properties": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, such as core:fs.defaultFS. The following are supported prefixes and their mappings:\ncapacity-scheduler: capacity-scheduler.xml\ncore: core-site.xml\ndistcp: distcp-default.xml\nhdfs: hdfs-site.xml\nhive: hive-site.xml\nmapred: mapred-site.xml\npig: pig.properties\nspark: spark-defaults.conf\nyarn: yarn-site.xmlFor more information, see Cluster properties.",
"type": "object"
- },
- "imageVersion": {
- "description": "Optional. The version of software inside the cluster. It must match the regular expression [0-9]+\\.[0-9]+. If unspecified, it defaults to the latest version (see Cloud Dataproc Versioning).",
- "type": "string"
}
},
"id": "SoftwareConfig"
@@ -2399,16 +2134,16 @@
"description": "A selector that chooses target cluster for jobs based on metadata.",
"type": "object",
"properties": {
- "zone": {
- "description": "Required The cluster target zone.",
- "type": "string"
- },
"clusterLabels": {
"additionalProperties": {
"type": "string"
},
- "description": "Required The cluster labels. Cluster must have all labels to match.",
+ "description": "Required. The cluster labels. Cluster must have all labels to match.",
"type": "object"
+ },
+ "zone": {
+ "description": "Optional. The zone where workflow process executes. This parameter does not affect the selection of the cluster.If unspecified, the zone of the first cluster matching the selector is used.",
+ "type": "string"
}
},
"id": "ClusterSelector"
@@ -2419,22 +2154,38 @@
"properties": {
"clusterSelector": {
"$ref": "ClusterSelector",
- "description": "Optional A selector that chooses target cluster for jobs based on metadata.The selector is evaluated at the time each job is submitted."
+ "description": "Optional. A selector that chooses target cluster for jobs based on metadata.The selector is evaluated at the time each job is submitted."
},
"managedCluster": {
- "description": "Optional A cluster that is managed by the workflow.",
+ "description": "Optional. A cluster that is managed by the workflow.",
"$ref": "ManagedCluster"
}
},
"id": "WorkflowTemplatePlacement"
},
"WorkflowMetadata": {
+ "description": "A Cloud Dataproc workflow template resource.",
+ "type": "object",
"properties": {
+ "graph": {
+ "description": "Output only. The workflow graph.",
+ "$ref": "WorkflowGraph"
+ },
+ "version": {
+ "format": "int32",
+ "description": "Output only. The version of template at the time of workflow instantiation.",
+ "type": "integer"
+ },
+ "template": {
+ "description": "Output only. The \"resource name\" of the template.",
+ "type": "string"
+ },
"deleteCluster": {
- "description": "Output-only The delete cluster operation metadata.",
- "$ref": "ClusterOperation"
+ "$ref": "ClusterOperation",
+ "description": "Output only. The delete cluster operation metadata."
},
"state": {
+ "type": "string",
"enumDescriptions": [
"Unused.",
"The operation has been created.",
@@ -2447,61 +2198,73 @@
"RUNNING",
"DONE"
],
- "description": "Output-only The workflow state.",
- "type": "string"
+ "description": "Output only. The workflow state."
},
"clusterName": {
- "description": "Output-only The name of the managed cluster.",
+ "description": "Output only. The name of the managed cluster.",
"type": "string"
},
"createCluster": {
- "$ref": "ClusterOperation",
- "description": "Output-only The create cluster operation metadata."
- },
- "version": {
- "format": "int32",
- "description": "Output-only The version of template at the time of workflow instantiation.",
- "type": "integer"
- },
- "graph": {
- "$ref": "WorkflowGraph",
- "description": "Output-only The workflow graph."
- },
- "template": {
- "description": "Output-only The \"resource name\" of the template.",
- "type": "string"
+ "description": "Output only. The create cluster operation metadata.",
+ "$ref": "ClusterOperation"
}
},
- "id": "WorkflowMetadata",
- "description": "A Cloud Dataproc workflow template resource.",
- "type": "object"
+ "id": "WorkflowMetadata"
},
"ClusterOperation": {
+ "type": "object",
"properties": {
+ "done": {
+ "description": "Output only. Indicates the operation is done.",
+ "type": "boolean"
+ },
"error": {
- "description": "Output-only Error, if operation failed.",
+ "description": "Output only. Error, if operation failed.",
"type": "string"
},
"operationId": {
- "description": "Output-only The id of the cluster operation.",
+ "description": "Output only. The id of the cluster operation.",
"type": "string"
- },
- "done": {
- "description": "Output-only Indicates the operation is done.",
- "type": "boolean"
}
},
- "id": "ClusterOperation",
- "type": "object"
+ "id": "ClusterOperation"
},
"SparkJob": {
+ "description": "A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN.",
+ "type": "object",
"properties": {
- "properties": {
- "additionalProperties": {
+ "mainClass": {
+ "description": "The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.",
+ "type": "string"
+ },
+ "archiveUris": {
+ "description": "Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.",
+ "items": {
"type": "string"
},
+ "type": "array"
+ },
+ "mainJarFileUri": {
+ "type": "string",
+ "description": "The HCFS URI of the jar file that contains the main class."
+ },
+ "jarFileUris": {
+ "description": "Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "loggingConfig": {
+ "$ref": "LoggingConfig",
+ "description": "Optional. The runtime log config for job execution."
+ },
+ "properties": {
"description": "Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.",
- "type": "object"
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
},
"args": {
"description": "Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.",
@@ -2516,55 +2279,30 @@
"type": "string"
},
"type": "array"
- },
- "mainClass": {
- "description": "The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.",
- "type": "string"
- },
- "archiveUris": {
- "description": "Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "mainJarFileUri": {
- "description": "The HCFS URI of the jar file that contains the main class.",
- "type": "string"
- },
- "jarFileUris": {
- "description": "Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "loggingConfig": {
- "$ref": "LoggingConfig",
- "description": "Optional. The runtime log config for job execution."
}
},
- "id": "SparkJob",
- "description": "A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN.",
- "type": "object"
+ "id": "SparkJob"
},
"JobStatus": {
+ "id": "JobStatus",
+ "description": "Cloud Dataproc job status.",
+ "type": "object",
"properties": {
"substate": {
- "enum": [
- "UNSPECIFIED",
- "SUBMITTED",
- "QUEUED",
- "STALE_STATUS"
- ],
- "description": "Output-only. Additional state information, which includes status reported by the agent.",
"type": "string",
"enumDescriptions": [
"",
"The Job is submitted to the agent.Applies to RUNNING state.",
"The Job has been received and is awaiting execution (it may be waiting for a condition to be met). See the \"details\" field for the reason for the delay.Applies to RUNNING state.",
"The agent-reported status is out of date, which may be caused by a loss of communication between the agent and Cloud Dataproc. If the agent does not send a timely update, the job will fail.Applies to RUNNING state."
- ]
+ ],
+ "enum": [
+ "UNSPECIFIED",
+ "SUBMITTED",
+ "QUEUED",
+ "STALE_STATUS"
+ ],
+ "description": "Output-only. Additional state information, which includes status reported by the agent."
},
"stateStartTime": {
"format": "google-datetime",
@@ -2603,28 +2341,25 @@
"description": "Output-only. A state message specifying the overall job state.",
"type": "string"
}
- },
- "id": "JobStatus",
- "description": "Cloud Dataproc job status.",
- "type": "object"
+ }
},
"DiagnoseClusterRequest": {
- "description": "A request to collect cluster diagnostic information.",
"type": "object",
"properties": {},
- "id": "DiagnoseClusterRequest"
+ "id": "DiagnoseClusterRequest",
+ "description": "A request to collect cluster diagnostic information."
},
"DiskConfig": {
"properties": {
- "bootDiskSizeGb": {
- "format": "int32",
- "description": "Optional. Size in GB of the boot disk (default is 500GB).",
- "type": "integer"
- },
"numLocalSsds": {
"format": "int32",
"description": "Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.",
"type": "integer"
+ },
+ "bootDiskSizeGb": {
+ "format": "int32",
+ "description": "Optional. Size in GB of the boot disk (default is 500GB).",
+ "type": "integer"
}
},
"id": "DiskConfig",
@@ -2651,11 +2386,11 @@
"type": "array"
},
"labels": {
+ "description": "Output-only. Labels associated with the operation",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "Output-only. Labels associated with the operation",
- "type": "object"
+ }
},
"status": {
"description": "Output-only. Current operation status.",
@@ -2668,13 +2403,13 @@
},
"type": "array"
},
- "clusterUuid": {
- "description": "Output-only. Cluster UUID for the operation.",
- "type": "string"
- },
"clusterName": {
"description": "Output-only. Name of the cluster for the operation.",
"type": "string"
+ },
+ "clusterUuid": {
+ "description": "Output-only. Cluster UUID for the operation.",
+ "type": "string"
}
},
"id": "ClusterOperationMetadata"
@@ -2686,9 +2421,11 @@
"type": "object"
},
"GceClusterConfig": {
- "description": "Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster.",
- "type": "object",
"properties": {
+ "subnetworkUri": {
+ "description": "Optional. The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0\nprojects/[project_id]/regions/us-east1/sub0\nsub0",
+ "type": "string"
+ },
"networkUri": {
"description": "Optional. The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the \"default\" network of the project is used, if it exists. Cannot be a \"Custom Subnet Network\" (see Using Subnetworks for more information).A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default\nprojects/[project_id]/regions/global/default\ndefault",
"type": "string"
@@ -2725,15 +2462,14 @@
"serviceAccount": {
"description": "Optional. The service account of the instances. Defaults to the default Google Compute Engine service account. Custom service accounts need permissions equivalent to the folloing IAM roles:\nroles/logging.logWriter\nroles/storage.objectAdmin(see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts for more information). Example: [account_id]@[project_id].iam.gserviceaccount.com",
"type": "string"
- },
- "subnetworkUri": {
- "description": "Optional. The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0\nprojects/[project_id]/regions/us-east1/sub0\nsub0",
- "type": "string"
}
},
- "id": "GceClusterConfig"
+ "id": "GceClusterConfig",
+ "description": "Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster.",
+ "type": "object"
},
"Policy": {
+ "id": "Policy",
"description": "Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.A Policy consists of a list of bindings. A Binding binds a list of members to a role, where the members can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM.Example\n{\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n}\nFor a description of IAM and its features, see the IAM developer's guide (https://cloud.google.com/iam).",
"type": "object",
"properties": {
@@ -2754,15 +2490,271 @@
},
"type": "array"
}
+ }
+ },
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a network API call.",
+ "type": "object",
+ "properties": {
+ "error": {
+ "description": "The error result of the operation in case of failure or cancellation.",
+ "$ref": "Status"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
+ "type": "object"
+ },
+ "done": {
+ "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
+ "type": "boolean"
+ },
+ "response": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
+ },
+ "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse."
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.",
+ "type": "string"
+ }
},
- "id": "Policy"
+ "id": "Operation"
+ },
+ "ListWorkflowTemplatesResponse": {
+ "description": "A response to a request to list workflow templates in a project.",
+ "type": "object",
+ "properties": {
+ "templates": {
+ "description": "Output only. WorkflowTemplates list.",
+ "items": {
+ "$ref": "WorkflowTemplate"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Output only. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent \u003ccode\u003eListWorkflowTemplatesRequest\u003c/code\u003e.",
+ "type": "string"
+ }
+ },
+ "id": "ListWorkflowTemplatesResponse"
+ },
+ "JobReference": {
+ "properties": {
+ "jobId": {
+ "description": "Optional. The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
+ "type": "string"
+ }
+ },
+ "id": "JobReference",
+ "description": "Encapsulates the full scoping used to reference a job.",
+ "type": "object"
+ },
+ "Status": {
+ "id": "Status",
+ "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
+ "properties": {
+ "code": {
+ "format": "int32",
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "type": "array"
+ }
+ }
+ },
+ "Binding": {
+ "type": "object",
+ "properties": {
+ "members": {
+ "description": "Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:\nallUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.\nallAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.\nuser:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.\nserviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.\ngroup:{emailid}: An email address that represents a Google group. For example, admins@example.com.\ndomain:{domain}: A Google Apps domain name that represents all the users of that domain. For example, google.com or example.com.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "role": {
+ "type": "string",
+ "description": "Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner. Required"
+ }
+ },
+ "id": "Binding",
+ "description": "Associates members with a role."
+ },
+ "InstanceGroupConfig": {
+ "description": "Optional. The config settings for Google Compute Engine resources in an instance group, such as a master or worker group.",
+ "type": "object",
+ "properties": {
+ "isPreemptible": {
+ "description": "Optional. Specifies that this instance group contains preemptible instances.",
+ "type": "boolean"
+ },
+ "managedGroupConfig": {
+ "$ref": "ManagedGroupConfig",
+ "description": "Output-only. The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups."
+ },
+ "imageUri": {
+ "description": "Output-only. The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.",
+ "type": "string"
+ },
+ "machineTypeUri": {
+ "description": "Optional. The Google Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2\nprojects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2\nn1-standard-2",
+ "type": "string"
+ },
+ "instanceNames": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "Optional. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name)."
+ },
+ "accelerators": {
+ "description": "Optional. The Google Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.",
+ "items": {
+ "$ref": "AcceleratorConfig"
+ },
+ "type": "array"
+ },
+ "numInstances": {
+ "format": "int32",
+ "description": "Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.",
+ "type": "integer"
+ },
+ "diskConfig": {
+ "$ref": "DiskConfig",
+ "description": "Optional. Disk option config settings."
+ }
+ },
+ "id": "InstanceGroupConfig"
+ },
+ "ListJobsResponse": {
+ "description": "A list of jobs in a project.",
+ "type": "object",
+ "properties": {
+ "jobs": {
+ "description": "Output-only. Jobs list.",
+ "items": {
+ "$ref": "Job"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Optional. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent \u003ccode\u003eListJobsRequest\u003c/code\u003e.",
+ "type": "string"
+ }
+ },
+ "id": "ListJobsResponse"
+ },
+ "NodeInitializationAction": {
+ "type": "object",
+ "properties": {
+ "executionTimeout": {
+ "format": "google-duration",
+ "description": "Optional. Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.",
+ "type": "string"
+ },
+ "executableFile": {
+ "description": "Required. Google Cloud Storage URI of executable file.",
+ "type": "string"
+ }
+ },
+ "id": "NodeInitializationAction",
+ "description": "Specifies an executable to run on a fully configured node and a timeout period for executable completion."
+ },
+ "CancelJobRequest": {
+ "id": "CancelJobRequest",
+ "description": "A request to cancel a job.",
+ "type": "object",
+ "properties": {}
+ },
+ "SparkSqlJob": {
+ "properties": {
+ "scriptVariables": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name=\"value\";).",
+ "type": "object"
+ },
+ "jarFileUris": {
+ "description": "Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "loggingConfig": {
+ "description": "Optional. The runtime log config for job execution.",
+ "$ref": "LoggingConfig"
+ },
+ "properties": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.",
+ "type": "object"
+ },
+ "queryFileUri": {
+ "description": "The HCFS URI of the script that contains SQL queries.",
+ "type": "string"
+ },
+ "queryList": {
+ "$ref": "QueryList",
+ "description": "A list of queries."
+ }
+ },
+ "id": "SparkSqlJob",
+ "description": "A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries.",
+ "type": "object"
+ },
+ "ListOperationsResponse": {
+ "properties": {
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
+ "items": {
+ "$ref": "Operation"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ }
+ },
+ "id": "ListOperationsResponse",
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object"
}
},
+ "protocol": "rest",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
- "protocol": "rest",
"version": "v1beta2",
"baseUrl": "https://dataproc.googleapis.com/",
"auth": {
@@ -2774,7 +2766,15 @@
}
}
},
- "kind": "discovery#restDescription",
"servicePath": "",
- "description": "Manages Hadoop-based clusters and jobs on Google Cloud Platform."
+ "description": "Manages Hadoop-based clusters and jobs on Google Cloud Platform.",
+ "kind": "discovery#restDescription",
+ "rootUrl": "https://dataproc.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "dataproc",
+ "batchPath": "batch",
+ "id": "dataproc:v1beta2",
+ "revision": "20171010",
+ "documentationLink": "https://cloud.google.com/dataproc/"
}
diff --git a/dataproc/v1beta2/dataproc-gen.go b/dataproc/v1beta2/dataproc-gen.go
index b7dc159..6699590 100644
--- a/dataproc/v1beta2/dataproc-gen.go
+++ b/dataproc/v1beta2/dataproc-gen.go
@@ -433,13 +433,13 @@
}
type ClusterOperation struct {
- // Done: Output-only Indicates the operation is done.
+ // Done: Output only. Indicates the operation is done.
Done bool `json:"done,omitempty"`
- // Error: Output-only Error, if operation failed.
+ // Error: Output only. Error, if operation failed.
Error string `json:"error,omitempty"`
- // OperationId: Output-only The id of the cluster operation.
+ // OperationId: Output only. The id of the cluster operation.
OperationId string `json:"operationId,omitempty"`
// ForceSendFields is a list of field names (e.g. "Done") to
@@ -562,11 +562,14 @@
// ClusterSelector: A selector that chooses target cluster for jobs
// based on metadata.
type ClusterSelector struct {
- // ClusterLabels: Required The cluster labels. Cluster must have all
+ // ClusterLabels: Required. The cluster labels. Cluster must have all
// labels to match.
ClusterLabels map[string]string `json:"clusterLabels,omitempty"`
- // Zone: Required The cluster target zone.
+ // Zone: Optional. The zone where workflow process executes. This
+ // parameter does not affect the selection of the cluster.If
+ // unspecified, the zone of the first cluster matching the selector is
+ // used.
Zone string `json:"zone,omitempty"`
// ForceSendFields is a list of field names (e.g. "ClusterLabels") to
@@ -1051,17 +1054,17 @@
// InstantiateWorkflowTemplateRequest: A request to instantiate a
// workflow template.
type InstantiateWorkflowTemplateRequest struct {
- // InstanceId: Optional A tag that prevents multiple concurrent workflow
- // instances with the same tag from running. This mitigates risk of
- // concurrent instances started due to retries.It is recommended to
- // always set this value to a UUID
+ // InstanceId: Optional. A tag that prevents multiple concurrent
+ // workflow instances with the same tag from running. This mitigates
+ // risk of concurrent instances started due to retries.It is recommended
+ // to always set this value to a UUID
// (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag
// must contain only letters (a-z, A-Z), numbers (0-9), underscores (_),
// and hyphens (-). The maximum length is 40 characters.
InstanceId string `json:"instanceId,omitempty"`
- // Version: Optional The version of workflow template to instantiate. If
- // specified, the workflow will be instantiated only if the current
+ // Version: Optional. The version of workflow template to instantiate.
+ // If specified, the workflow will be instantiated only if the current
// version of the workflow template has the supplied version.This option
// cannot be used to instantiate a previous version of workflow
// template.
@@ -1513,13 +1516,13 @@
// ListWorkflowTemplatesResponse: A response to a request to list
// workflow templates in a project.
type ListWorkflowTemplatesResponse struct {
- // NextPageToken: Output-only This token is included in the response if
+ // NextPageToken: Output only. This token is included in the response if
// there are more results to fetch. To fetch additional results, provide
// this value as the page_token in a subsequent
// <code>ListWorkflowTemplatesRequest</code>.
NextPageToken string `json:"nextPageToken,omitempty"`
- // Templates: Output-only WorkflowTemplates list.
+ // Templates: Output only. WorkflowTemplates list.
Templates []*WorkflowTemplate `json:"templates,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
@@ -1582,16 +1585,16 @@
// ManagedCluster: Cluster that is managed by the workflow.
type ManagedCluster struct {
- // ClusterName: Required The cluster name. Cluster names within a
+ // ClusterName: Required. The cluster name. Cluster names within a
// project must be unique. Names from deleted clusters can be reused.
ClusterName string `json:"clusterName,omitempty"`
- // Config: Required The cluster configuration.
+ // Config: Required. The cluster configuration.
Config *ClusterConfig `json:"config,omitempty"`
- // Labels: Optional The labels to associate with this cluster.Label keys
- // must be between 1 and 63 characters long, and must conform to the
- // following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values
+ // Labels: Optional. The labels to associate with this cluster.Label
+ // keys must be between 1 and 63 characters long, and must conform to
+ // the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values
// must be between 1 and 63 characters long, and must conform to the
// following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more
// than 64 labels can be associated with a given cluster.
@@ -1762,7 +1765,7 @@
// HiveJob: Job is a Hive job.
HiveJob *HiveJob `json:"hiveJob,omitempty"`
- // Labels: Optional The labels to associate with this job.Label keys
+ // Labels: Optional. The labels to associate with this job.Label keys
// must be between 1 and 63 characters long, and must conform to the
// following regular expression: \p{Ll}\p{Lo}{0,62}Label values must be
// between 1 and 63 characters long, and must conform to the following
@@ -1773,7 +1776,7 @@
// PigJob: Job is a Pig job.
PigJob *PigJob `json:"pigJob,omitempty"`
- // PrerequisiteStepIds: Optional The optional list of prerequisite job
+ // PrerequisiteStepIds: Optional. The optional list of prerequisite job
// step_ids. If not specified, the job will start at the beginning of
// workflow.
PrerequisiteStepIds []string `json:"prerequisiteStepIds,omitempty"`
@@ -1781,7 +1784,7 @@
// PysparkJob: Job is a Pyspark job.
PysparkJob *PySparkJob `json:"pysparkJob,omitempty"`
- // Scheduling: Optional Job scheduling configuration.
+ // Scheduling: Optional. Job scheduling configuration.
Scheduling *JobScheduling `json:"scheduling,omitempty"`
// SparkJob: Job is a Spark job.
@@ -1790,7 +1793,7 @@
// SparkSqlJob: Job is a SparkSql job.
SparkSqlJob *SparkSqlJob `json:"sparkSqlJob,omitempty"`
- // StepId: Required The step id. The id must be unique among all jobs
+ // StepId: Required. The step id. The id must be unique among all jobs
// within the template.The step id is used as prefix for job id, as job
// workflow-step-id label, and in prerequisite_step_ids field from other
// steps.
@@ -2412,7 +2415,7 @@
// WorkflowGraph: The workflow graph.
type WorkflowGraph struct {
- // Nodes: Output-only The workflow nodes.
+ // Nodes: Output only. The workflow nodes.
Nodes []*WorkflowNode `json:"nodes,omitempty"`
// ForceSendFields is a list of field names (e.g. "Nodes") to
@@ -2440,19 +2443,19 @@
// WorkflowMetadata: A Cloud Dataproc workflow template resource.
type WorkflowMetadata struct {
- // ClusterName: Output-only The name of the managed cluster.
+ // ClusterName: Output only. The name of the managed cluster.
ClusterName string `json:"clusterName,omitempty"`
- // CreateCluster: Output-only The create cluster operation metadata.
+ // CreateCluster: Output only. The create cluster operation metadata.
CreateCluster *ClusterOperation `json:"createCluster,omitempty"`
- // DeleteCluster: Output-only The delete cluster operation metadata.
+ // DeleteCluster: Output only. The delete cluster operation metadata.
DeleteCluster *ClusterOperation `json:"deleteCluster,omitempty"`
- // Graph: Output-only The workflow graph.
+ // Graph: Output only. The workflow graph.
Graph *WorkflowGraph `json:"graph,omitempty"`
- // State: Output-only The workflow state.
+ // State: Output only. The workflow state.
//
// Possible values:
// "UNKNOWN" - Unused.
@@ -2461,10 +2464,10 @@
// "DONE" - The operation is done; either cancelled or completed.
State string `json:"state,omitempty"`
- // Template: Output-only The "resource name" of the template.
+ // Template: Output only. The "resource name" of the template.
Template string `json:"template,omitempty"`
- // Version: Output-only The version of template at the time of workflow
+ // Version: Output only. The version of template at the time of workflow
// instantiation.
Version int64 `json:"version,omitempty"`
@@ -2493,17 +2496,17 @@
// WorkflowNode: The workflow node.
type WorkflowNode struct {
- // Error: Output-only The error detail.
+ // Error: Output only. The error detail.
Error string `json:"error,omitempty"`
- // JobId: Output-only The job id; populated after the node enters
+ // JobId: Output only. The job id; populated after the node enters
// RUNNING state.
JobId string `json:"jobId,omitempty"`
- // PrerequisiteStepIds: Output-only Node's prerequisite nodes.
+ // PrerequisiteStepIds: Output only. Node's prerequisite nodes.
PrerequisiteStepIds []string `json:"prerequisiteStepIds,omitempty"`
- // State: Output-only The node state.
+ // State: Output only. The node state.
//
// Possible values:
// "NODE_STATUS_UNSPECIFIED"
@@ -2515,7 +2518,7 @@
// ancestor or peer failed.
State string `json:"state,omitempty"`
- // StepId: Output-only The name of the node.
+ // StepId: Output only. The name of the node.
StepId string `json:"stepId,omitempty"`
// ForceSendFields is a list of field names (e.g. "Error") to
@@ -2543,16 +2546,16 @@
// WorkflowTemplate: A Cloud Dataproc workflow template resource.
type WorkflowTemplate struct {
- // CreateTime: Output-only The time template was created.
+ // CreateTime: Output only. The time template was created.
CreateTime string `json:"createTime,omitempty"`
- // Id: Required The template id.
+ // Id: Required. The template id.
Id string `json:"id,omitempty"`
- // Jobs: Required The Directed Acyclic Graph of Jobs to submit.
+ // Jobs: Required. The Directed Acyclic Graph of Jobs to submit.
Jobs []*OrderedJob `json:"jobs,omitempty"`
- // Labels: Optional The labels to associate with this template. These
+ // Labels: Optional. The labels to associate with this template. These
// labels will be propagated to all jobs and clusters created by the
// workflow instance.Label keys must contain 1 to 63 characters, and
// must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).Label
@@ -2562,26 +2565,26 @@
// associated with a template.
Labels map[string]string `json:"labels,omitempty"`
- // Name: Output-only The "resource name" of the template, as described
+ // Name: Output only. The "resource name" of the template, as described
// in https://cloud.google.com/apis/design/resource_names of the form
// projects/{project_id}/regions/{region}/workflowTemplates/{template_id}
Name string `json:"name,omitempty"`
- // Placement: Required WorkflowTemplate scheduling information.
+ // Placement: Required. WorkflowTemplate scheduling information.
Placement *WorkflowTemplatePlacement `json:"placement,omitempty"`
- // UpdateTime: Output-only The time template was last updated.
+ // UpdateTime: Output only. The time template was last updated.
UpdateTime string `json:"updateTime,omitempty"`
- // Version: Optional Used to perform a consistent read-modify-write.This
- // field should be left blank for a CreateWorkflowTemplate request. It
- // is required for an UpdateWorkflowTemplate request, and must match the
- // current server version. A typical update template flow would fetch
- // the current template with a GetWorkflowTemplate request, which will
- // return the current template with the version field filled in with the
- // current server version. The user updates other fields in the
- // template, then returns it as part of the UpdateWorkflowTemplate
- // request.
+ // Version: Optional. Used to perform a consistent
+ // read-modify-write.This field should be left blank for a
+ // CreateWorkflowTemplate request. It is required for an
+ // UpdateWorkflowTemplate request, and must match the current server
+ // version. A typical update template flow would fetch the current
+ // template with a GetWorkflowTemplate request, which will return the
+ // current template with the version field filled in with the current
+ // server version. The user updates other fields in the template, then
+ // returns it as part of the UpdateWorkflowTemplate request.
Version int64 `json:"version,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
@@ -2614,12 +2617,12 @@
// WorkflowTemplatePlacement: Specifies workflow execution target.Either
// managed_cluster or cluster_selector is required.
type WorkflowTemplatePlacement struct {
- // ClusterSelector: Optional A selector that chooses target cluster for
+ // ClusterSelector: Optional. A selector that chooses target cluster for
// jobs based on metadata.The selector is evaluated at the time each job
// is submitted.
ClusterSelector *ClusterSelector `json:"clusterSelector,omitempty"`
- // ManagedCluster: Optional A cluster that is managed by the workflow.
+ // ManagedCluster: Optional. A cluster that is managed by the workflow.
ManagedCluster *ManagedCluster `json:"managedCluster,omitempty"`
// ForceSendFields is a list of field names (e.g. "ClusterSelector") to
@@ -2830,7 +2833,7 @@
// ],
// "parameters": {
// "parent": {
- // "description": "Required The \"resource name\" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}",
+ // "description": "Required. The \"resource name\" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}",
// "location": "path",
// "pattern": "^projects/[^/]+/locations/[^/]+$",
// "required": true,
@@ -2869,8 +2872,8 @@
return c
}
-// Version sets the optional parameter "version": Optional The version
-// of workflow template to delete. If specified, will only delete the
+// Version sets the optional parameter "version": The version of
+// workflow template to delete. If specified, will only delete the
// template if the current server version matches specified version.
func (c *ProjectsLocationsWorkflowTemplatesDeleteCall) Version(version int64) *ProjectsLocationsWorkflowTemplatesDeleteCall {
c.urlParams_.Set("version", fmt.Sprint(version))
@@ -2967,14 +2970,14 @@
// ],
// "parameters": {
// "name": {
- // "description": "Required The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
+ // "description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
// "location": "path",
// "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
// "required": true,
// "type": "string"
// },
// "version": {
- // "description": "Optional The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version.",
+ // "description": "Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version.",
// "format": "int32",
// "location": "query",
// "type": "integer"
@@ -3010,10 +3013,9 @@
return c
}
-// Version sets the optional parameter "version": Optional The version
-// of workflow template to retrieve. Only previously instatiated
-// versions can be retrieved.If unspecified, retrieves the current
-// version.
+// Version sets the optional parameter "version": The version of
+// workflow template to retrieve. Only previously instatiated versions
+// can be retrieved.If unspecified, retrieves the current version.
func (c *ProjectsLocationsWorkflowTemplatesGetCall) Version(version int64) *ProjectsLocationsWorkflowTemplatesGetCall {
c.urlParams_.Set("version", fmt.Sprint(version))
return c
@@ -3122,14 +3124,14 @@
// ],
// "parameters": {
// "name": {
- // "description": "Required The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
+ // "description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
// "location": "path",
// "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
// "required": true,
// "type": "string"
// },
// "version": {
- // "description": "Optional The version of workflow template to retrieve. Only previously instatiated versions can be retrieved.If unspecified, retrieves the current version.",
+ // "description": "Optional. The version of workflow template to retrieve. Only previously instatiated versions can be retrieved.If unspecified, retrieves the current version.",
// "format": "int32",
// "location": "query",
// "type": "integer"
@@ -3269,7 +3271,7 @@
// ],
// "parameters": {
// "name": {
- // "description": "Required The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
+ // "description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
// "location": "path",
// "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
// "required": true,
@@ -3308,16 +3310,15 @@
return c
}
-// PageSize sets the optional parameter "pageSize": Optional The maximum
-// number of results to return in each response.
+// PageSize sets the optional parameter "pageSize": The maximum number
+// of results to return in each response.
func (c *ProjectsLocationsWorkflowTemplatesListCall) PageSize(pageSize int64) *ProjectsLocationsWorkflowTemplatesListCall {
c.urlParams_.Set("pageSize", fmt.Sprint(pageSize))
return c
}
-// PageToken sets the optional parameter "pageToken": Optional The page
-// token, returned by a previous call, to request the next page of
-// results.
+// PageToken sets the optional parameter "pageToken": The page token,
+// returned by a previous call, to request the next page of results.
func (c *ProjectsLocationsWorkflowTemplatesListCall) PageToken(pageToken string) *ProjectsLocationsWorkflowTemplatesListCall {
c.urlParams_.Set("pageToken", pageToken)
return c
@@ -3426,18 +3427,18 @@
// ],
// "parameters": {
// "pageSize": {
- // "description": "Optional The maximum number of results to return in each response.",
+ // "description": "Optional. The maximum number of results to return in each response.",
// "format": "int32",
// "location": "query",
// "type": "integer"
// },
// "pageToken": {
- // "description": "Optional The page token, returned by a previous call, to request the next page of results.",
+ // "description": "Optional. The page token, returned by a previous call, to request the next page of results.",
// "location": "query",
// "type": "string"
// },
// "parent": {
- // "description": "Required The \"resource name\" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}",
+ // "description": "Required. The \"resource name\" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}",
// "location": "path",
// "pattern": "^projects/[^/]+/locations/[^/]+$",
// "required": true,
@@ -3591,7 +3592,7 @@
// ],
// "parameters": {
// "name": {
- // "description": "Output-only The \"resource name\" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
+ // "description": "Output only. The \"resource name\" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
// "location": "path",
// "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
// "required": true,
@@ -6820,7 +6821,7 @@
// ],
// "parameters": {
// "parent": {
- // "description": "Required The \"resource name\" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}",
+ // "description": "Required. The \"resource name\" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}",
// "location": "path",
// "pattern": "^projects/[^/]+/regions/[^/]+$",
// "required": true,
@@ -6859,8 +6860,8 @@
return c
}
-// Version sets the optional parameter "version": Optional The version
-// of workflow template to delete. If specified, will only delete the
+// Version sets the optional parameter "version": The version of
+// workflow template to delete. If specified, will only delete the
// template if the current server version matches specified version.
func (c *ProjectsRegionsWorkflowTemplatesDeleteCall) Version(version int64) *ProjectsRegionsWorkflowTemplatesDeleteCall {
c.urlParams_.Set("version", fmt.Sprint(version))
@@ -6957,14 +6958,14 @@
// ],
// "parameters": {
// "name": {
- // "description": "Required The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
+ // "description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
// "location": "path",
// "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$",
// "required": true,
// "type": "string"
// },
// "version": {
- // "description": "Optional The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version.",
+ // "description": "Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version.",
// "format": "int32",
// "location": "query",
// "type": "integer"
@@ -7000,10 +7001,9 @@
return c
}
-// Version sets the optional parameter "version": Optional The version
-// of workflow template to retrieve. Only previously instatiated
-// versions can be retrieved.If unspecified, retrieves the current
-// version.
+// Version sets the optional parameter "version": The version of
+// workflow template to retrieve. Only previously instatiated versions
+// can be retrieved.If unspecified, retrieves the current version.
func (c *ProjectsRegionsWorkflowTemplatesGetCall) Version(version int64) *ProjectsRegionsWorkflowTemplatesGetCall {
c.urlParams_.Set("version", fmt.Sprint(version))
return c
@@ -7112,14 +7112,14 @@
// ],
// "parameters": {
// "name": {
- // "description": "Required The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
+ // "description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
// "location": "path",
// "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$",
// "required": true,
// "type": "string"
// },
// "version": {
- // "description": "Optional The version of workflow template to retrieve. Only previously instatiated versions can be retrieved.If unspecified, retrieves the current version.",
+ // "description": "Optional. The version of workflow template to retrieve. Only previously instatiated versions can be retrieved.If unspecified, retrieves the current version.",
// "format": "int32",
// "location": "query",
// "type": "integer"
@@ -7259,7 +7259,7 @@
// ],
// "parameters": {
// "name": {
- // "description": "Required The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
+ // "description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
// "location": "path",
// "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$",
// "required": true,
@@ -7298,16 +7298,15 @@
return c
}
-// PageSize sets the optional parameter "pageSize": Optional The maximum
-// number of results to return in each response.
+// PageSize sets the optional parameter "pageSize": The maximum number
+// of results to return in each response.
func (c *ProjectsRegionsWorkflowTemplatesListCall) PageSize(pageSize int64) *ProjectsRegionsWorkflowTemplatesListCall {
c.urlParams_.Set("pageSize", fmt.Sprint(pageSize))
return c
}
-// PageToken sets the optional parameter "pageToken": Optional The page
-// token, returned by a previous call, to request the next page of
-// results.
+// PageToken sets the optional parameter "pageToken": The page token,
+// returned by a previous call, to request the next page of results.
func (c *ProjectsRegionsWorkflowTemplatesListCall) PageToken(pageToken string) *ProjectsRegionsWorkflowTemplatesListCall {
c.urlParams_.Set("pageToken", pageToken)
return c
@@ -7416,18 +7415,18 @@
// ],
// "parameters": {
// "pageSize": {
- // "description": "Optional The maximum number of results to return in each response.",
+ // "description": "Optional. The maximum number of results to return in each response.",
// "format": "int32",
// "location": "query",
// "type": "integer"
// },
// "pageToken": {
- // "description": "Optional The page token, returned by a previous call, to request the next page of results.",
+ // "description": "Optional. The page token, returned by a previous call, to request the next page of results.",
// "location": "query",
// "type": "string"
// },
// "parent": {
- // "description": "Required The \"resource name\" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}",
+ // "description": "Required. The \"resource name\" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}",
// "location": "path",
// "pattern": "^projects/[^/]+/regions/[^/]+$",
// "required": true,
@@ -7581,7 +7580,7 @@
// ],
// "parameters": {
// "name": {
- // "description": "Output-only The \"resource name\" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
+ // "description": "Output only. The \"resource name\" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
// "location": "path",
// "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$",
// "required": true,
diff --git a/datastore/v1/datastore-api.json b/datastore/v1/datastore-api.json
index 87af30f..8ea913b 100644
--- a/datastore/v1/datastore-api.json
+++ b/datastore/v1/datastore-api.json
@@ -1,11 +1,15 @@
{
- "discoveryVersion": "v1",
"ownerName": "Google",
+ "discoveryVersion": "v1",
"version_module": true,
"resources": {
"projects": {
"methods": {
"beginTransaction": {
+ "description": "Begins a new transaction.",
+ "request": {
+ "$ref": "BeginTransactionRequest"
+ },
"response": {
"$ref": "BeginTransactionResponse"
},
@@ -15,10 +19,10 @@
"httpMethod": "POST",
"parameters": {
"projectId": {
+ "description": "The ID of the project against which to make the request.",
"type": "string",
"required": true,
- "location": "path",
- "description": "The ID of the project against which to make the request."
+ "location": "path"
}
},
"scopes": [
@@ -27,76 +31,65 @@
],
"flatPath": "v1/projects/{projectId}:beginTransaction",
"id": "datastore.projects.beginTransaction",
- "path": "v1/projects/{projectId}:beginTransaction",
- "description": "Begins a new transaction.",
- "request": {
- "$ref": "BeginTransactionRequest"
- }
+ "path": "v1/projects/{projectId}:beginTransaction"
},
"commit": {
- "response": {
- "$ref": "CommitResponse"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
"parameters": {
"projectId": {
+ "location": "path",
"description": "The ID of the project against which to make the request.",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
}
},
"flatPath": "v1/projects/{projectId}:commit",
- "id": "datastore.projects.commit",
"path": "v1/projects/{projectId}:commit",
+ "id": "datastore.projects.commit",
"request": {
"$ref": "CommitRequest"
},
- "description": "Commits a transaction, optionally creating, deleting or modifying some\nentities."
+ "description": "Commits a transaction, optionally creating, deleting or modifying some\nentities.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "CommitResponse"
+ }
},
"rollback": {
- "id": "datastore.projects.rollback",
- "path": "v1/projects/{projectId}:rollback",
"description": "Rolls back a transaction.",
"request": {
"$ref": "RollbackRequest"
},
- "response": {
- "$ref": "RollbackResponse"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"projectId"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "RollbackResponse"
+ },
"parameters": {
"projectId": {
+ "location": "path",
"description": "The ID of the project against which to make the request.",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
- "flatPath": "v1/projects/{projectId}:rollback"
+ "flatPath": "v1/projects/{projectId}:rollback",
+ "path": "v1/projects/{projectId}:rollback",
+ "id": "datastore.projects.rollback"
},
"runQuery": {
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "RunQueryResponse"
- },
"parameters": {
"projectId": {
"description": "The ID of the project against which to make the request.",
@@ -115,20 +108,16 @@
"description": "Queries for entities.",
"request": {
"$ref": "RunQueryRequest"
- }
- },
- "lookup": {
- "response": {
- "$ref": "LookupResponse"
},
+ "httpMethod": "POST",
"parameterOrder": [
"projectId"
],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
+ "response": {
+ "$ref": "RunQueryResponse"
+ }
+ },
+ "lookup": {
"parameters": {
"projectId": {
"description": "The ID of the project against which to make the request.",
@@ -137,19 +126,26 @@
"location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
"flatPath": "v1/projects/{projectId}:lookup",
- "id": "datastore.projects.lookup",
"path": "v1/projects/{projectId}:lookup",
+ "id": "datastore.projects.lookup",
+ "description": "Looks up entities by key.",
"request": {
"$ref": "LookupRequest"
},
- "description": "Looks up entities by key."
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "LookupResponse"
+ }
},
"allocateIds": {
- "request": {
- "$ref": "AllocateIdsRequest"
- },
- "description": "Allocates IDs for the given keys, which is useful for referencing an entity\nbefore it is inserted.",
"httpMethod": "POST",
"parameterOrder": [
"projectId"
@@ -157,10 +153,6 @@
"response": {
"$ref": "AllocateIdsResponse"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
"parameters": {
"projectId": {
"location": "path",
@@ -169,91 +161,33 @@
"required": true
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
"flatPath": "v1/projects/{projectId}:allocateIds",
"path": "v1/projects/{projectId}:allocateIds",
- "id": "datastore.projects.allocateIds"
+ "id": "datastore.projects.allocateIds",
+ "description": "Allocates IDs for the given keys, which is useful for referencing an entity\nbefore it is inserted.",
+ "request": {
+ "$ref": "AllocateIdsRequest"
+ }
}
},
"resources": {
"operations": {
"methods": {
- "get": {
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
- "response": {
- "$ref": "GoogleLongrunningOperation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation resource.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/operations/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "flatPath": "v1/projects/{projectsId}/operations/{operationsId}",
- "id": "datastore.projects.operations.get",
- "path": "v1/{+name}"
- },
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "GoogleLongrunningListOperationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "The standard list page token."
- },
- "name": {
- "description": "The name of the operation's parent resource.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer"
- },
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "flatPath": "v1/projects/{projectsId}/operations",
- "path": "v1/{+name}/operations",
- "id": "datastore.projects.operations.list",
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id."
- },
"cancel": {
+ "path": "v1/{+name}:cancel",
+ "id": "datastore.projects.operations.cancel",
"description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
- "response": {
- "$ref": "Empty"
- },
"httpMethod": "POST",
"parameterOrder": [
"name"
],
+ "response": {
+ "$ref": "Empty"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
@@ -267,35 +201,101 @@
"location": "path"
}
},
- "flatPath": "v1/projects/{projectsId}/operations/{operationsId}:cancel",
- "id": "datastore.projects.operations.cancel",
- "path": "v1/{+name}:cancel"
+ "flatPath": "v1/projects/{projectsId}/operations/{operationsId}:cancel"
},
"delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
"parameters": {
"name": {
+ "pattern": "^projects/[^/]+/operations/[^/]+$",
+ "location": "path",
"description": "The name of the operation resource to be deleted.",
"type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/operations/{operationsId}",
+ "id": "datastore.projects.operations.delete",
+ "path": "v1/{+name}",
+ "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ]
+ },
+ "get": {
+ "response": {
+ "$ref": "GoogleLongrunningOperation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource.",
+ "type": "string",
"required": true,
"pattern": "^projects/[^/]+/operations/[^/]+$",
"location": "path"
}
},
"flatPath": "v1/projects/{projectsId}/operations/{operationsId}",
+ "id": "datastore.projects.operations.get",
"path": "v1/{+name}",
- "id": "datastore.projects.operations.delete",
- "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`."
+ "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."
+ },
+ "list": {
+ "path": "v1/{+name}/operations",
+ "id": "datastore.projects.operations.list",
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "GoogleLongrunningListOperationsResponse"
+ },
+ "parameters": {
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The name of the operation's parent resource.",
+ "type": "string",
+ "required": true
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "flatPath": "v1/projects/{projectsId}/operations"
}
}
}
@@ -303,20 +303,10 @@
}
},
"parameters": {
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth access token."
- },
"quotaUser": {
- "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pp": {
"location": "query",
@@ -325,14 +315,14 @@
"type": "boolean"
},
"bearer_token": {
+ "location": "query",
"description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"oauth_token": {
+ "location": "query",
"description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
@@ -340,9 +330,14 @@
"location": "query"
},
"prettyPrint": {
+ "location": "query",
"description": "Returns response with indentations and line breaks.",
"default": "true",
- "type": "boolean",
+ "type": "boolean"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
"location": "query"
},
"fields": {
@@ -350,30 +345,30 @@
"description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
"$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
- "location": "query"
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
},
"callback": {
- "location": "query",
"description": "JSONP",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
@@ -382,607 +377,30 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
+ "default": "json"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
}
},
"schemas": {
- "Entity": {
- "description": "A Datastore data object.\n\nAn entity is limited to 1 megabyte when stored. That _roughly_\ncorresponds to a limit of 1 megabyte for the serialized form of this\nmessage.",
- "type": "object",
- "properties": {
- "key": {
- "$ref": "Key",
- "description": "The entity's key.\n\nAn entity must have a key, unless otherwise documented (for example,\nan entity in `Value.entity_value` may have no key).\nAn entity's kind is its key path's last element's kind,\nor null if it has no key."
- },
- "properties": {
- "additionalProperties": {
- "$ref": "Value"
- },
- "description": "The entity's properties.\nThe map's keys are property names.\nA property name matching regex `__.*__` is reserved.\nA reserved property name is forbidden in certain documented contexts.\nThe name must not contain more than 500 characters.\nThe name cannot be `\"\"`.",
- "type": "object"
- }
- },
- "id": "Entity"
- },
- "ReadWrite": {
- "description": "Options specific to read / write transactions.",
- "type": "object",
- "properties": {
- "previousTransaction": {
- "format": "byte",
- "description": "The transaction identifier of the transaction being retried.",
- "type": "string"
- }
- },
- "id": "ReadWrite"
- },
- "GoogleDatastoreAdminV1beta1Progress": {
- "description": "Measures the progress of a particular metric.",
- "type": "object",
- "properties": {
- "workEstimated": {
- "format": "int64",
- "description": "An estimate of how much work needs to be performed. May be zero if the\nwork estimate is unavailable.",
- "type": "string"
- },
- "workCompleted": {
- "format": "int64",
- "description": "The amount of work that has been completed. Note that this may be greater\nthan work_estimated.",
- "type": "string"
- }
- },
- "id": "GoogleDatastoreAdminV1beta1Progress"
- },
- "LookupRequest": {
- "description": "The request for Datastore.Lookup.",
- "type": "object",
- "properties": {
- "readOptions": {
- "$ref": "ReadOptions",
- "description": "The options for this lookup request."
- },
- "keys": {
- "description": "Keys of entities to look up.",
- "items": {
- "$ref": "Key"
- },
- "type": "array"
- }
- },
- "id": "LookupRequest"
- },
- "QueryResultBatch": {
- "description": "A batch of results produced by a query.",
- "type": "object",
- "properties": {
- "skippedCursor": {
- "type": "string",
- "format": "byte",
- "description": "A cursor that points to the position after the last skipped result.\nWill be set when `skipped_results` != 0."
- },
- "skippedResults": {
- "format": "int32",
- "description": "The number of results skipped, typically because of an offset.",
- "type": "integer"
- },
- "entityResultType": {
- "type": "string",
- "enumDescriptions": [
- "Unspecified. This value is never used.",
- "The key and properties.",
- "A projected subset of properties. The entity may have no key.",
- "Only the key."
- ],
- "enum": [
- "RESULT_TYPE_UNSPECIFIED",
- "FULL",
- "PROJECTION",
- "KEY_ONLY"
- ],
- "description": "The result type for every entity in `entity_results`."
- },
- "entityResults": {
- "description": "The results for this batch.",
- "items": {
- "$ref": "EntityResult"
- },
- "type": "array"
- },
- "moreResults": {
- "enumDescriptions": [
- "Unspecified. This value is never used.",
- "There may be additional batches to fetch from this query.",
- "The query is finished, but there may be more results after the limit.",
- "The query is finished, but there may be more results after the end\ncursor.",
- "The query is finished, and there are no more results."
- ],
- "enum": [
- "MORE_RESULTS_TYPE_UNSPECIFIED",
- "NOT_FINISHED",
- "MORE_RESULTS_AFTER_LIMIT",
- "MORE_RESULTS_AFTER_CURSOR",
- "NO_MORE_RESULTS"
- ],
- "description": "The state of the query after the current batch.",
- "type": "string"
- },
- "endCursor": {
- "format": "byte",
- "description": "A cursor that points to the position after the last result in the batch.",
- "type": "string"
- },
- "snapshotVersion": {
- "format": "int64",
- "description": "The version number of the snapshot this batch was returned from.\nThis applies to the range of results from the query's `start_cursor` (or\nthe beginning of the query if no cursor was given) to this batch's\n`end_cursor` (not the query's `end_cursor`).\n\nIn a single transaction, subsequent query result batches for the same query\ncan have a greater snapshot version number. Each batch's snapshot version\nis valid for all preceding batches.\nThe value will be zero for eventually consistent queries.",
- "type": "string"
- }
- },
- "id": "QueryResultBatch"
- },
- "PathElement": {
- "id": "PathElement",
- "description": "A (kind, ID/name) pair used to construct a key path.\n\nIf either name or ID is set, the element is complete.\nIf neither is set, the element is incomplete.",
- "type": "object",
- "properties": {
- "kind": {
- "description": "The kind of the entity.\nA kind matching regex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
- "type": "string"
- },
- "id": {
- "format": "int64",
- "description": "The auto-allocated ID of the entity.\nNever equal to zero. Values less than zero are discouraged and may not\nbe supported in the future.",
- "type": "string"
- },
- "name": {
- "description": "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
- "type": "string"
- }
- }
- },
- "Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "code": {
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
- "details": {
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- },
- "type": "array",
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use."
- }
- },
- "id": "Status"
- },
- "GqlQueryParameter": {
- "type": "object",
- "properties": {
- "cursor": {
- "format": "byte",
- "description": "A query cursor. Query cursors are returned in query\nresult batches.",
- "type": "string"
- },
- "value": {
- "description": "A value parameter.",
- "$ref": "Value"
- }
- },
- "id": "GqlQueryParameter",
- "description": "A binding parameter for a GQL query."
- },
- "GoogleLongrunningListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
- "items": {
- "$ref": "GoogleLongrunningOperation"
- },
- "type": "array"
- }
- },
- "id": "GoogleLongrunningListOperationsResponse"
- },
- "BeginTransactionResponse": {
- "description": "The response for Datastore.BeginTransaction.",
- "type": "object",
- "properties": {
- "transaction": {
- "format": "byte",
- "description": "The transaction identifier (always present).",
- "type": "string"
- }
- },
- "id": "BeginTransactionResponse"
- },
- "AllocateIdsRequest": {
- "properties": {
- "keys": {
- "description": "A list of keys with incomplete key paths for which to allocate IDs.\nNo key may be reserved/read-only.",
- "items": {
- "$ref": "Key"
- },
- "type": "array"
- }
- },
- "id": "AllocateIdsRequest",
- "description": "The request for Datastore.AllocateIds.",
- "type": "object"
- },
- "RunQueryResponse": {
- "description": "The response for Datastore.RunQuery.",
- "type": "object",
- "properties": {
- "query": {
- "$ref": "Query",
- "description": "The parsed form of the `GqlQuery` from the request, if it was set."
- },
- "batch": {
- "description": "A batch of query results (always present).",
- "$ref": "QueryResultBatch"
- }
- },
- "id": "RunQueryResponse"
- },
- "LookupResponse": {
- "description": "The response for Datastore.Lookup.",
- "type": "object",
- "properties": {
- "missing": {
- "description": "Entities not found as `ResultType.KEY_ONLY` entities. The order of results\nin this field is undefined and has no relation to the order of the keys\nin the input.",
- "items": {
- "$ref": "EntityResult"
- },
- "type": "array"
- },
- "found": {
- "description": "Entities found as `ResultType.FULL` entities. The order of results in this\nfield is undefined and has no relation to the order of the keys in the\ninput.",
- "items": {
- "$ref": "EntityResult"
- },
- "type": "array"
- },
- "deferred": {
- "description": "A list of keys that were not looked up due to resource constraints. The\norder of results in this field is undefined and has no relation to the\norder of the keys in the input.",
- "items": {
- "$ref": "Key"
- },
- "type": "array"
- }
- },
- "id": "LookupResponse"
- },
- "CommitRequest": {
- "type": "object",
- "properties": {
- "transaction": {
- "format": "byte",
- "description": "The identifier of the transaction associated with the commit. A\ntransaction identifier is returned by a call to\nDatastore.BeginTransaction.",
- "type": "string"
- },
- "mode": {
- "enumDescriptions": [
- "Unspecified. This value must not be used.",
- "Transactional: The mutations are either all applied, or none are applied.\nLearn about transactions [here](https://cloud.google.com/datastore/docs/concepts/transactions).",
- "Non-transactional: The mutations may not apply as all or none."
- ],
- "enum": [
- "MODE_UNSPECIFIED",
- "TRANSACTIONAL",
- "NON_TRANSACTIONAL"
- ],
- "description": "The type of commit to perform. Defaults to `TRANSACTIONAL`.",
- "type": "string"
- },
- "mutations": {
- "description": "The mutations to perform.\n\nWhen mode is `TRANSACTIONAL`, mutations affecting a single entity are\napplied in order. The following sequences of mutations affecting a single\nentity are not permitted in a single `Commit` request:\n\n- `insert` followed by `insert`\n- `update` followed by `insert`\n- `upsert` followed by `insert`\n- `delete` followed by `update`\n\nWhen mode is `NON_TRANSACTIONAL`, no two mutations may affect a single\nentity.",
- "items": {
- "$ref": "Mutation"
- },
- "type": "array"
- }
- },
- "id": "CommitRequest",
- "description": "The request for Datastore.Commit."
- },
- "BeginTransactionRequest": {
- "description": "The request for Datastore.BeginTransaction.",
- "type": "object",
- "properties": {
- "transactionOptions": {
- "$ref": "TransactionOptions",
- "description": "Options for a new transaction."
- }
- },
- "id": "BeginTransactionRequest"
- },
- "PropertyOrder": {
- "properties": {
- "direction": {
- "enumDescriptions": [
- "Unspecified. This value must not be used.",
- "Ascending.",
- "Descending."
- ],
- "enum": [
- "DIRECTION_UNSPECIFIED",
- "ASCENDING",
- "DESCENDING"
- ],
- "description": "The direction to order by. Defaults to `ASCENDING`.",
- "type": "string"
- },
- "property": {
- "$ref": "PropertyReference",
- "description": "The property to order by."
- }
- },
- "id": "PropertyOrder",
- "description": "The desired order for a specific property.",
- "type": "object"
- },
- "KindExpression": {
- "description": "A representation of a kind.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The name of the kind.",
- "type": "string"
- }
- },
- "id": "KindExpression"
- },
- "LatLng": {
- "id": "LatLng",
- "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.\n\nExample of normalization code in Python:\n\n def NormalizeLongitude(longitude):\n \"\"\"Wraps decimal degrees longitude to [-180.0, 180.0].\"\"\"\n q, r = divmod(longitude, 360.0)\n if r \u003e 180.0 or (r == 180.0 and q \u003c= -1.0):\n return r - 360.0\n return r\n\n def NormalizeLatLng(latitude, longitude):\n \"\"\"Wraps decimal degrees latitude and longitude to\n [-90.0, 90.0] and [-180.0, 180.0], respectively.\"\"\"\n r = latitude % 360.0\n if r \u003c= 90.0:\n return r, NormalizeLongitude(longitude)\n elif r \u003e= 270.0:\n return r - 360, NormalizeLongitude(longitude)\n else:\n return 180 - r, NormalizeLongitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLongitude(181.0)\n assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)\n assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)\n assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)\n assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)\n assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)\n assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)\n assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)\n assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)",
- "type": "object",
- "properties": {
- "latitude": {
- "format": "double",
- "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
- "type": "number"
- },
- "longitude": {
- "format": "double",
- "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
- "type": "number"
- }
- }
- },
- "Key": {
- "type": "object",
- "properties": {
- "partitionId": {
- "description": "Entities are partitioned into subsets, currently identified by a project\nID and namespace ID.\nQueries are scoped to a single partition.",
- "$ref": "PartitionId"
- },
- "path": {
- "description": "The entity path.\nAn entity path consists of one or more elements composed of a kind and a\nstring or numerical identifier, which identify entities. The first\nelement identifies a _root entity_, the second element identifies\na _child_ of the root entity, the third element identifies a child of the\nsecond entity, and so forth. The entities identified by all prefixes of\nthe path are called the element's _ancestors_.\n\nAn entity path is always fully complete: *all* of the entity's ancestors\nare required to be in the path along with the entity identifier itself.\nThe only exception is that in some documented cases, the identifier in the\nlast path element (for the entity) itself may be omitted. For example,\nthe last path element of the key of `Mutation.insert` may have no\nidentifier.\n\nA path can never be empty, and a path can have at most 100 elements.",
- "items": {
- "$ref": "PathElement"
- },
- "type": "array"
- }
- },
- "id": "Key",
- "description": "A unique identifier for an entity.\nIf a key's partition ID or any of its path kinds or names are\nreserved/read-only, the key is reserved/read-only.\nA reserved/read-only key is forbidden in certain documented contexts."
- },
- "PropertyReference": {
- "properties": {
- "name": {
- "description": "The name of the property.\nIf name includes \".\"s, it may be interpreted as a property name path.",
- "type": "string"
- }
- },
- "id": "PropertyReference",
- "description": "A reference to a property relative to the kind expressions.",
- "type": "object"
- },
- "GoogleDatastoreAdminV1beta1EntityFilter": {
- "description": "Identifies a subset of entities in a project. This is specified as\ncombinations of kinds and namespaces (either or both of which may be all, as\ndescribed in the following examples).\nExample usage:\n\nEntire project:\n kinds=[], namespace_ids=[]\n\nKinds Foo and Bar in all namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=[]\n\nKinds Foo and Bar only in the default namespace:\n kinds=['Foo', 'Bar'], namespace_ids=['']\n\nKinds Foo and Bar in both the default and Baz namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz']\n\nThe entire Baz namespace:\n kinds=[], namespace_ids=['Baz']",
- "type": "object",
- "properties": {
- "kinds": {
- "description": "If empty, then this represents all kinds.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "namespaceIds": {
- "description": "An empty list represents all namespaces. This is the preferred\nusage for projects that don't use namespaces.\n\nAn empty string element represents the default namespace. This should be\nused if the project has data in non-default namespaces, but doesn't want to\ninclude them.\nEach namespace in this list must be unique.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "GoogleDatastoreAdminV1beta1EntityFilter"
- },
- "GoogleDatastoreAdminV1beta1CommonMetadata": {
- "id": "GoogleDatastoreAdminV1beta1CommonMetadata",
- "description": "Metadata common to all Datastore Admin operations.",
- "type": "object",
- "properties": {
- "labels": {
- "description": "The client-assigned labels which were provided when the operation was\ncreated. May also include additional labels.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "endTime": {
- "format": "google-datetime",
- "description": "The time the operation ended, either successfully or otherwise.",
- "type": "string"
- },
- "state": {
- "enum": [
- "STATE_UNSPECIFIED",
- "INITIALIZING",
- "PROCESSING",
- "CANCELLING",
- "FINALIZING",
- "SUCCESSFUL",
- "FAILED",
- "CANCELLED"
- ],
- "description": "The current state of the Operation.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified.",
- "Request is being prepared for processing.",
- "Request is actively being processed.",
- "Request is in the process of being cancelled after user called\ngoogle.longrunning.Operations.CancelOperation on the operation.",
- "Request has been processed and is in its finalization stage.",
- "Request has completed successfully.",
- "Request has finished being processed, but encountered an error.",
- "Request has finished being cancelled after user called\ngoogle.longrunning.Operations.CancelOperation."
- ]
- },
- "operationType": {
- "type": "string",
- "enumDescriptions": [
- "Unspecified.",
- "ExportEntities.",
- "ImportEntities."
- ],
- "enum": [
- "OPERATION_TYPE_UNSPECIFIED",
- "EXPORT_ENTITIES",
- "IMPORT_ENTITIES"
- ],
- "description": "The type of the operation. Can be used as a filter in\nListOperationsRequest."
- },
- "startTime": {
- "format": "google-datetime",
- "description": "The time that work began on the operation.",
- "type": "string"
- }
- }
- },
- "Projection": {
- "description": "A representation of a property in a projection.",
- "type": "object",
- "properties": {
- "property": {
- "$ref": "PropertyReference",
- "description": "The property to project."
- }
- },
- "id": "Projection"
- },
- "ArrayValue": {
- "description": "An array value.",
- "type": "object",
- "properties": {
- "values": {
- "description": "Values in the array.\nThe order of this array may not be preserved if it contains a mix of\nindexed and unindexed values.",
- "items": {
- "$ref": "Value"
- },
- "type": "array"
- }
- },
- "id": "ArrayValue"
- },
- "Mutation": {
- "properties": {
- "baseVersion": {
- "format": "int64",
- "description": "The version of the entity that this mutation is being applied to. If this\ndoes not match the current version on the server, the mutation conflicts.",
- "type": "string"
- },
- "insert": {
- "$ref": "Entity",
- "description": "The entity to insert. The entity must not already exist.\nThe entity key's final path element may be incomplete."
- },
- "update": {
- "description": "The entity to update. The entity must already exist.\nMust have a complete key path.",
- "$ref": "Entity"
- },
- "upsert": {
- "$ref": "Entity",
- "description": "The entity to upsert. The entity may or may not already exist.\nThe entity key's final path element may be incomplete."
- },
- "delete": {
- "$ref": "Key",
- "description": "The key of the entity to delete. The entity may or may not already exist.\nMust have a complete key path and must not be reserved/read-only."
- }
- },
- "id": "Mutation",
- "description": "A mutation to apply to an entity.",
- "type": "object"
- },
- "ReadOptions": {
- "description": "The options shared by read requests.",
- "type": "object",
- "properties": {
- "transaction": {
- "format": "byte",
- "description": "The identifier of the transaction in which to read. A\ntransaction identifier is returned by a call to\nDatastore.BeginTransaction.",
- "type": "string"
- },
- "readConsistency": {
- "description": "The non-transactional read consistency to use.\nCannot be set to `STRONG` for global queries.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified. This value must not be used.",
- "Strong consistency.",
- "Eventual consistency."
- ],
- "enum": [
- "READ_CONSISTENCY_UNSPECIFIED",
- "STRONG",
- "EVENTUAL"
- ]
- }
- },
- "id": "ReadOptions"
- },
- "RollbackResponse": {
- "description": "The response for Datastore.Rollback.\n(an empty message).",
- "type": "object",
- "properties": {},
- "id": "RollbackResponse"
- },
- "GoogleDatastoreAdminV1beta1ExportEntitiesResponse": {
- "description": "The response for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities.",
- "type": "object",
- "properties": {
- "outputUrl": {
- "description": "Location of the output metadata file. This can be used to begin an import\ninto Cloud Datastore (this project or another project). See\ngoogle.datastore.admin.v1beta1.ImportEntitiesRequest.input_url.\nOnly present if the operation completed successfully.",
- "type": "string"
- }
- },
- "id": "GoogleDatastoreAdminV1beta1ExportEntitiesResponse"
- },
"MutationResult": {
+ "id": "MutationResult",
"description": "The result of applying a mutation.",
"type": "object",
"properties": {
+ "version": {
+ "format": "int64",
+ "description": "The version of the entity on the server after processing the mutation. If\nthe mutation doesn't change anything on the server, then the version will\nbe the version of the current entity or, if no entity is present, a version\nthat is strictly greater than the version of any previous entity and less\nthan the version of any possible future entity.",
+ "type": "string"
+ },
"conflictDetected": {
"description": "Whether a conflict was detected for this mutation. Always false when a\nconflict detection strategy field is not set in the mutation.",
"type": "boolean"
@@ -990,14 +408,8 @@
"key": {
"$ref": "Key",
"description": "The automatically allocated key.\nSet only when the mutation allocated a key."
- },
- "version": {
- "format": "int64",
- "description": "The version of the entity on the server after processing the mutation. If\nthe mutation doesn't change anything on the server, then the version will\nbe the version of the current entity or, if no entity is present, a version\nthat is strictly greater than the version of any previous entity and less\nthan the version of any possible future entity.",
- "type": "string"
}
- },
- "id": "MutationResult"
+ }
},
"GqlQuery": {
"id": "GqlQuery",
@@ -1033,47 +445,35 @@
"type": "object",
"properties": {
"propertyFilter": {
- "description": "A filter on a property.",
- "$ref": "PropertyFilter"
+ "$ref": "PropertyFilter",
+ "description": "A filter on a property."
},
"compositeFilter": {
- "description": "A composite filter.",
- "$ref": "CompositeFilter"
+ "$ref": "CompositeFilter",
+ "description": "A composite filter."
}
},
"id": "Filter"
},
- "RollbackRequest": {
- "description": "The request for Datastore.Rollback.",
- "type": "object",
- "properties": {
- "transaction": {
- "format": "byte",
- "description": "The transaction identifier, returned by a call to\nDatastore.BeginTransaction.",
- "type": "string"
- }
- },
- "id": "RollbackRequest"
- },
"RunQueryRequest": {
"description": "The request for Datastore.RunQuery.",
"type": "object",
"properties": {
- "readOptions": {
- "$ref": "ReadOptions",
- "description": "The options for this query."
- },
- "query": {
- "description": "The query to run.",
- "$ref": "Query"
- },
"gqlQuery": {
- "description": "The GQL query to run.",
- "$ref": "GqlQuery"
+ "$ref": "GqlQuery",
+ "description": "The GQL query to run."
},
"partitionId": {
"description": "Entities are partitioned into subsets, identified by a partition ID.\nQueries are scoped to a single partition.\nThis partition ID is normalized with the standard default context\npartition ID.",
"$ref": "PartitionId"
+ },
+ "readOptions": {
+ "description": "The options for this query.",
+ "$ref": "ReadOptions"
+ },
+ "query": {
+ "$ref": "Query",
+ "description": "The query to run."
}
},
"id": "RunQueryRequest"
@@ -1084,29 +484,41 @@
"properties": {},
"id": "Empty"
},
+ "RollbackRequest": {
+ "id": "RollbackRequest",
+ "description": "The request for Datastore.Rollback.",
+ "type": "object",
+ "properties": {
+ "transaction": {
+ "format": "byte",
+ "description": "The transaction identifier, returned by a call to\nDatastore.BeginTransaction.",
+ "type": "string"
+ }
+ }
+ },
"GoogleDatastoreAdminV1beta1ExportEntitiesMetadata": {
"description": "Metadata for ExportEntities operations.",
"type": "object",
"properties": {
+ "common": {
+ "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata",
+ "description": "Metadata common to all Datastore Admin operations."
+ },
"progressBytes": {
- "description": "An estimate of the number of bytes processed.",
- "$ref": "GoogleDatastoreAdminV1beta1Progress"
+ "$ref": "GoogleDatastoreAdminV1beta1Progress",
+ "description": "An estimate of the number of bytes processed."
},
"outputUrlPrefix": {
"description": "Location for the export metadata and data files. This will be the same\nvalue as the\ngoogle.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix\nfield. The final output location is provided in\ngoogle.datastore.admin.v1beta1.ExportEntitiesResponse.output_url.",
"type": "string"
},
"entityFilter": {
- "$ref": "GoogleDatastoreAdminV1beta1EntityFilter",
- "description": "Description of which entities are being exported."
+ "description": "Description of which entities are being exported.",
+ "$ref": "GoogleDatastoreAdminV1beta1EntityFilter"
},
"progressEntities": {
- "$ref": "GoogleDatastoreAdminV1beta1Progress",
- "description": "An estimate of the number of entities processed."
- },
- "common": {
- "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata",
- "description": "Metadata common to all Datastore Admin operations."
+ "description": "An estimate of the number of entities processed.",
+ "$ref": "GoogleDatastoreAdminV1beta1Progress"
}
},
"id": "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata"
@@ -1120,8 +532,8 @@
"$ref": "ReadOnly"
},
"readWrite": {
- "description": "The transaction should allow both reads and writes.",
- "$ref": "ReadWrite"
+ "$ref": "ReadWrite",
+ "description": "The transaction should allow both reads and writes."
}
},
"id": "TransactionOptions"
@@ -1131,13 +543,15 @@
"type": "object",
"properties": {
"filters": {
+ "description": "The list of filters to combine.\nMust contain at least one filter.",
"items": {
"$ref": "Filter"
},
- "type": "array",
- "description": "The list of filters to combine.\nMust contain at least one filter."
+ "type": "array"
},
"op": {
+ "description": "The operator for combining multiple filters.",
+ "type": "string",
"enumDescriptions": [
"Unspecified. This value must not be used.",
"The results are required to satisfy each of the combined filters."
@@ -1145,14 +559,14 @@
"enum": [
"OPERATOR_UNSPECIFIED",
"AND"
- ],
- "description": "The operator for combining multiple filters.",
- "type": "string"
+ ]
}
},
"id": "CompositeFilter"
},
"GoogleDatastoreAdminV1beta1ImportEntitiesMetadata": {
+ "description": "Metadata for ImportEntities operations.",
+ "type": "object",
"properties": {
"common": {
"$ref": "GoogleDatastoreAdminV1beta1CommonMetadata",
@@ -1163,54 +577,38 @@
"type": "string"
},
"progressBytes": {
- "$ref": "GoogleDatastoreAdminV1beta1Progress",
- "description": "An estimate of the number of bytes processed."
+ "description": "An estimate of the number of bytes processed.",
+ "$ref": "GoogleDatastoreAdminV1beta1Progress"
},
"entityFilter": {
"$ref": "GoogleDatastoreAdminV1beta1EntityFilter",
"description": "Description of which entities are being imported."
},
"progressEntities": {
- "description": "An estimate of the number of entities processed.",
- "$ref": "GoogleDatastoreAdminV1beta1Progress"
+ "$ref": "GoogleDatastoreAdminV1beta1Progress",
+ "description": "An estimate of the number of entities processed."
}
},
- "id": "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata",
- "description": "Metadata for ImportEntities operations.",
- "type": "object"
+ "id": "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata"
},
"AllocateIdsResponse": {
+ "id": "AllocateIdsResponse",
"description": "The response for Datastore.AllocateIds.",
"type": "object",
"properties": {
"keys": {
+ "description": "The keys specified in the request (in the same order), each with\nits key path completed with a newly allocated ID.",
"items": {
"$ref": "Key"
},
- "type": "array",
- "description": "The keys specified in the request (in the same order), each with\nits key path completed with a newly allocated ID."
+ "type": "array"
}
- },
- "id": "AllocateIdsResponse"
+ }
},
"Query": {
"description": "A query for entities.",
"type": "object",
"properties": {
- "distinctOn": {
- "description": "The properties to make distinct. The query results will contain the first\nresult for each distinct combination of values for the given properties\n(if empty, all results are returned).",
- "items": {
- "$ref": "PropertyReference"
- },
- "type": "array"
- },
- "order": {
- "description": "The order to apply to the query results (if empty, order is unspecified).",
- "items": {
- "$ref": "PropertyOrder"
- },
- "type": "array"
- },
"projection": {
"description": "The projection to return. Defaults to returning all properties.",
"items": {
@@ -1223,15 +621,15 @@
"description": "An ending point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to limit the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).",
"type": "string"
},
- "filter": {
- "$ref": "Filter",
- "description": "The filter to apply."
- },
"limit": {
"format": "int32",
"description": "The maximum number of results to return. Applies after all other\nconstraints. Optional.\nUnspecified is interpreted as no limit.\nMust be \u003e= 0 if specified.",
"type": "integer"
},
+ "filter": {
+ "description": "The filter to apply.",
+ "$ref": "Filter"
+ },
"offset": {
"format": "int32",
"description": "The number of results to skip. Applies before limit, but after all other\nconstraints. Optional. Must be \u003e= 0 if specified.",
@@ -1248,6 +646,20 @@
"$ref": "KindExpression"
},
"type": "array"
+ },
+ "distinctOn": {
+ "description": "The properties to make distinct. The query results will contain the first\nresult for each distinct combination of values for the given properties\n(if empty, all results are returned).",
+ "items": {
+ "$ref": "PropertyReference"
+ },
+ "type": "array"
+ },
+ "order": {
+ "description": "The order to apply to the query results (if empty, order is unspecified).",
+ "items": {
+ "$ref": "PropertyOrder"
+ },
+ "type": "array"
}
},
"id": "Query"
@@ -1256,18 +668,6 @@
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"type": "object",
"properties": {
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- },
- "response": {
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
"name": {
"description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
"type": "string"
@@ -1283,18 +683,29 @@
},
"description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
"type": "object"
+ },
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ },
+ "response": {
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
}
},
"id": "GoogleLongrunningOperation"
},
"ReadOnly": {
+ "id": "ReadOnly",
"description": "Options specific to read-only transactions.",
"type": "object",
- "properties": {},
- "id": "ReadOnly"
+ "properties": {}
},
"PropertyFilter": {
- "id": "PropertyFilter",
"description": "A filter on a specific property.",
"type": "object",
"properties": {
@@ -1303,10 +714,19 @@
"$ref": "Value"
},
"property": {
- "$ref": "PropertyReference",
- "description": "The property to filter by."
+ "description": "The property to filter by.",
+ "$ref": "PropertyReference"
},
"op": {
+ "enumDescriptions": [
+ "Unspecified. This value must not be used.",
+ "Less than.",
+ "Less than or equal.",
+ "Greater than.",
+ "Greater than or equal.",
+ "Equal.",
+ "Has ancestor."
+ ],
"enum": [
"OPERATOR_UNSPECIFIED",
"LESS_THAN",
@@ -1317,18 +737,10 @@
"HAS_ANCESTOR"
],
"description": "The operator to filter by.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified. This value must not be used.",
- "Less than.",
- "Less than or equal.",
- "Greater than.",
- "Greater than or equal.",
- "Equal.",
- "Has ancestor."
- ]
+ "type": "string"
}
- }
+ },
+ "id": "PropertyFilter"
},
"EntityResult": {
"description": "The result of fetching an entity from Datastore.",
@@ -1345,8 +757,8 @@
"type": "string"
},
"entity": {
- "description": "The resulting entity.",
- "$ref": "Entity"
+ "$ref": "Entity",
+ "description": "The resulting entity."
}
},
"id": "EntityResult"
@@ -1360,8 +772,8 @@
"description": "An entity value.\n\n- May have no key.\n- May have a key with an incomplete key path.\n- May have a reserved/read-only key."
},
"geoPointValue": {
- "description": "A geo point value representing a point on the surface of Earth.",
- "$ref": "LatLng"
+ "$ref": "LatLng",
+ "description": "A geo point value representing a point on the surface of Earth."
},
"integerValue": {
"format": "int64",
@@ -1395,14 +807,14 @@
"type": "boolean"
},
"nullValue": {
- "description": "A null value.",
- "type": "string",
"enumDescriptions": [
"Null value."
],
"enum": [
"NULL_VALUE"
- ]
+ ],
+ "description": "A null value.",
+ "type": "string"
},
"blobValue": {
"format": "byte",
@@ -1415,30 +827,30 @@
"type": "integer"
},
"arrayValue": {
- "$ref": "ArrayValue",
- "description": "An array value.\nCannot contain another array value.\nA `Value` instance that sets field `array_value` must not set fields\n`meaning` or `exclude_from_indexes`."
+ "description": "An array value.\nCannot contain another array value.\nA `Value` instance that sets field `array_value` must not set fields\n`meaning` or `exclude_from_indexes`.",
+ "$ref": "ArrayValue"
}
},
"id": "Value"
},
"CommitResponse": {
+ "description": "The response for Datastore.Commit.",
"type": "object",
"properties": {
"indexUpdates": {
- "type": "integer",
"format": "int32",
- "description": "The number of index entries updated during the commit, or zero if none were\nupdated."
+ "description": "The number of index entries updated during the commit, or zero if none were\nupdated.",
+ "type": "integer"
},
"mutationResults": {
+ "description": "The result of performing the mutations.\nThe i-th mutation result corresponds to the i-th mutation in the request.",
"items": {
"$ref": "MutationResult"
},
- "type": "array",
- "description": "The result of performing the mutations.\nThe i-th mutation result corresponds to the i-th mutation in the request."
+ "type": "array"
}
},
- "id": "CommitResponse",
- "description": "The response for Datastore.Commit."
+ "id": "CommitResponse"
},
"PartitionId": {
"description": "A partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty.\n\nA partition ID contains several dimensions:\nproject ID and namespace ID.\n\nPartition dimensions:\n\n- May be `\"\"`.\n- Must be valid UTF-8 bytes.\n- Must have values that match regex `[A-Za-z\\d\\.\\-_]{1,100}`\nIf the value of any dimension matches regex `__.*__`, the partition is\nreserved/read-only.\nA reserved/read-only partition ID is forbidden in certain documented\ncontexts.\n\nForeign partition IDs (in which the project ID does\nnot match the context project ID ) are discouraged.\nReads and writes of foreign partition IDs may fail if the project is not in an active state.",
@@ -1454,13 +866,601 @@
}
},
"id": "PartitionId"
+ },
+ "Entity": {
+ "id": "Entity",
+ "description": "A Datastore data object.\n\nAn entity is limited to 1 megabyte when stored. That _roughly_\ncorresponds to a limit of 1 megabyte for the serialized form of this\nmessage.",
+ "type": "object",
+ "properties": {
+ "key": {
+ "description": "The entity's key.\n\nAn entity must have a key, unless otherwise documented (for example,\nan entity in `Value.entity_value` may have no key).\nAn entity's kind is its key path's last element's kind,\nor null if it has no key.",
+ "$ref": "Key"
+ },
+ "properties": {
+ "additionalProperties": {
+ "$ref": "Value"
+ },
+ "description": "The entity's properties.\nThe map's keys are property names.\nA property name matching regex `__.*__` is reserved.\nA reserved property name is forbidden in certain documented contexts.\nThe name must not contain more than 500 characters.\nThe name cannot be `\"\"`.",
+ "type": "object"
+ }
+ }
+ },
+ "ReadWrite": {
+ "description": "Options specific to read / write transactions.",
+ "type": "object",
+ "properties": {
+ "previousTransaction": {
+ "format": "byte",
+ "description": "The transaction identifier of the transaction being retried.",
+ "type": "string"
+ }
+ },
+ "id": "ReadWrite"
+ },
+ "LookupRequest": {
+ "id": "LookupRequest",
+ "description": "The request for Datastore.Lookup.",
+ "type": "object",
+ "properties": {
+ "keys": {
+ "description": "Keys of entities to look up.",
+ "items": {
+ "$ref": "Key"
+ },
+ "type": "array"
+ },
+ "readOptions": {
+ "$ref": "ReadOptions",
+ "description": "The options for this lookup request."
+ }
+ }
+ },
+ "QueryResultBatch": {
+ "id": "QueryResultBatch",
+ "description": "A batch of results produced by a query.",
+ "type": "object",
+ "properties": {
+ "skippedCursor": {
+ "format": "byte",
+ "description": "A cursor that points to the position after the last skipped result.\nWill be set when `skipped_results` != 0.",
+ "type": "string"
+ },
+ "skippedResults": {
+ "format": "int32",
+ "description": "The number of results skipped, typically because of an offset.",
+ "type": "integer"
+ },
+ "entityResultType": {
+ "enumDescriptions": [
+ "Unspecified. This value is never used.",
+ "The key and properties.",
+ "A projected subset of properties. The entity may have no key.",
+ "Only the key."
+ ],
+ "enum": [
+ "RESULT_TYPE_UNSPECIFIED",
+ "FULL",
+ "PROJECTION",
+ "KEY_ONLY"
+ ],
+ "description": "The result type for every entity in `entity_results`.",
+ "type": "string"
+ },
+ "entityResults": {
+ "description": "The results for this batch.",
+ "items": {
+ "$ref": "EntityResult"
+ },
+ "type": "array"
+ },
+ "endCursor": {
+ "format": "byte",
+ "description": "A cursor that points to the position after the last result in the batch.",
+ "type": "string"
+ },
+ "moreResults": {
+ "description": "The state of the query after the current batch.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified. This value is never used.",
+ "There may be additional batches to fetch from this query.",
+ "The query is finished, but there may be more results after the limit.",
+ "The query is finished, but there may be more results after the end\ncursor.",
+ "The query is finished, and there are no more results."
+ ],
+ "enum": [
+ "MORE_RESULTS_TYPE_UNSPECIFIED",
+ "NOT_FINISHED",
+ "MORE_RESULTS_AFTER_LIMIT",
+ "MORE_RESULTS_AFTER_CURSOR",
+ "NO_MORE_RESULTS"
+ ]
+ },
+ "snapshotVersion": {
+ "format": "int64",
+ "description": "The version number of the snapshot this batch was returned from.\nThis applies to the range of results from the query's `start_cursor` (or\nthe beginning of the query if no cursor was given) to this batch's\n`end_cursor` (not the query's `end_cursor`).\n\nIn a single transaction, subsequent query result batches for the same query\ncan have a greater snapshot version number. Each batch's snapshot version\nis valid for all preceding batches.\nThe value will be zero for eventually consistent queries.",
+ "type": "string"
+ }
+ }
+ },
+ "GoogleDatastoreAdminV1beta1Progress": {
+ "description": "Measures the progress of a particular metric.",
+ "type": "object",
+ "properties": {
+ "workEstimated": {
+ "format": "int64",
+ "description": "An estimate of how much work needs to be performed. May be zero if the\nwork estimate is unavailable.",
+ "type": "string"
+ },
+ "workCompleted": {
+ "format": "int64",
+ "description": "The amount of work that has been completed. Note that this may be greater\nthan work_estimated.",
+ "type": "string"
+ }
+ },
+ "id": "GoogleDatastoreAdminV1beta1Progress"
+ },
+ "PathElement": {
+ "description": "A (kind, ID/name) pair used to construct a key path.\n\nIf either name or ID is set, the element is complete.\nIf neither is set, the element is incomplete.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "The kind of the entity.\nA kind matching regex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
+ "type": "string"
+ },
+ "id": {
+ "format": "int64",
+ "description": "The auto-allocated ID of the entity.\nNever equal to zero. Values less than zero are discouraged and may not\nbe supported in the future.",
+ "type": "string"
+ }
+ },
+ "id": "PathElement"
+ },
+ "GqlQueryParameter": {
+ "description": "A binding parameter for a GQL query.",
+ "type": "object",
+ "properties": {
+ "cursor": {
+ "format": "byte",
+ "description": "A query cursor. Query cursors are returned in query\nresult batches.",
+ "type": "string"
+ },
+ "value": {
+ "description": "A value parameter.",
+ "$ref": "Value"
+ }
+ },
+ "id": "GqlQueryParameter"
+ },
+ "Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
+ "properties": {
+ "code": {
+ "format": "int32",
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "type": "array"
+ }
+ },
+ "id": "Status"
+ },
+ "GoogleLongrunningListOperationsResponse": {
+ "id": "GoogleLongrunningListOperationsResponse",
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
+ "items": {
+ "$ref": "GoogleLongrunningOperation"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "BeginTransactionResponse": {
+ "description": "The response for Datastore.BeginTransaction.",
+ "type": "object",
+ "properties": {
+ "transaction": {
+ "format": "byte",
+ "description": "The transaction identifier (always present).",
+ "type": "string"
+ }
+ },
+ "id": "BeginTransactionResponse"
+ },
+ "LookupResponse": {
+ "description": "The response for Datastore.Lookup.",
+ "type": "object",
+ "properties": {
+ "deferred": {
+ "description": "A list of keys that were not looked up due to resource constraints. The\norder of results in this field is undefined and has no relation to the\norder of the keys in the input.",
+ "items": {
+ "$ref": "Key"
+ },
+ "type": "array"
+ },
+ "missing": {
+ "description": "Entities not found as `ResultType.KEY_ONLY` entities. The order of results\nin this field is undefined and has no relation to the order of the keys\nin the input.",
+ "items": {
+ "$ref": "EntityResult"
+ },
+ "type": "array"
+ },
+ "found": {
+ "description": "Entities found as `ResultType.FULL` entities. The order of results in this\nfield is undefined and has no relation to the order of the keys in the\ninput.",
+ "items": {
+ "$ref": "EntityResult"
+ },
+ "type": "array"
+ }
+ },
+ "id": "LookupResponse"
+ },
+ "RunQueryResponse": {
+ "description": "The response for Datastore.RunQuery.",
+ "type": "object",
+ "properties": {
+ "batch": {
+ "$ref": "QueryResultBatch",
+ "description": "A batch of query results (always present)."
+ },
+ "query": {
+ "$ref": "Query",
+ "description": "The parsed form of the `GqlQuery` from the request, if it was set."
+ }
+ },
+ "id": "RunQueryResponse"
+ },
+ "AllocateIdsRequest": {
+ "id": "AllocateIdsRequest",
+ "description": "The request for Datastore.AllocateIds.",
+ "type": "object",
+ "properties": {
+ "keys": {
+ "description": "A list of keys with incomplete key paths for which to allocate IDs.\nNo key may be reserved/read-only.",
+ "items": {
+ "$ref": "Key"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "CommitRequest": {
+ "id": "CommitRequest",
+ "description": "The request for Datastore.Commit.",
+ "type": "object",
+ "properties": {
+ "mode": {
+ "enumDescriptions": [
+ "Unspecified. This value must not be used.",
+ "Transactional: The mutations are either all applied, or none are applied.\nLearn about transactions [here](https://cloud.google.com/datastore/docs/concepts/transactions).",
+ "Non-transactional: The mutations may not apply as all or none."
+ ],
+ "enum": [
+ "MODE_UNSPECIFIED",
+ "TRANSACTIONAL",
+ "NON_TRANSACTIONAL"
+ ],
+ "description": "The type of commit to perform. Defaults to `TRANSACTIONAL`.",
+ "type": "string"
+ },
+ "mutations": {
+ "description": "The mutations to perform.\n\nWhen mode is `TRANSACTIONAL`, mutations affecting a single entity are\napplied in order. The following sequences of mutations affecting a single\nentity are not permitted in a single `Commit` request:\n\n- `insert` followed by `insert`\n- `update` followed by `insert`\n- `upsert` followed by `insert`\n- `delete` followed by `update`\n\nWhen mode is `NON_TRANSACTIONAL`, no two mutations may affect a single\nentity.",
+ "items": {
+ "$ref": "Mutation"
+ },
+ "type": "array"
+ },
+ "transaction": {
+ "format": "byte",
+ "description": "The identifier of the transaction associated with the commit. A\ntransaction identifier is returned by a call to\nDatastore.BeginTransaction.",
+ "type": "string"
+ }
+ }
+ },
+ "BeginTransactionRequest": {
+ "description": "The request for Datastore.BeginTransaction.",
+ "type": "object",
+ "properties": {
+ "transactionOptions": {
+ "$ref": "TransactionOptions",
+ "description": "Options for a new transaction."
+ }
+ },
+ "id": "BeginTransactionRequest"
+ },
+ "PropertyOrder": {
+ "id": "PropertyOrder",
+ "description": "The desired order for a specific property.",
+ "type": "object",
+ "properties": {
+ "direction": {
+ "description": "The direction to order by. Defaults to `ASCENDING`.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified. This value must not be used.",
+ "Ascending.",
+ "Descending."
+ ],
+ "enum": [
+ "DIRECTION_UNSPECIFIED",
+ "ASCENDING",
+ "DESCENDING"
+ ]
+ },
+ "property": {
+ "$ref": "PropertyReference",
+ "description": "The property to order by."
+ }
+ }
+ },
+ "KindExpression": {
+ "id": "KindExpression",
+ "description": "A representation of a kind.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the kind.",
+ "type": "string"
+ }
+ }
+ },
+ "Key": {
+ "description": "A unique identifier for an entity.\nIf a key's partition ID or any of its path kinds or names are\nreserved/read-only, the key is reserved/read-only.\nA reserved/read-only key is forbidden in certain documented contexts.",
+ "type": "object",
+ "properties": {
+ "path": {
+ "description": "The entity path.\nAn entity path consists of one or more elements composed of a kind and a\nstring or numerical identifier, which identify entities. The first\nelement identifies a _root entity_, the second element identifies\na _child_ of the root entity, the third element identifies a child of the\nsecond entity, and so forth. The entities identified by all prefixes of\nthe path are called the element's _ancestors_.\n\nAn entity path is always fully complete: *all* of the entity's ancestors\nare required to be in the path along with the entity identifier itself.\nThe only exception is that in some documented cases, the identifier in the\nlast path element (for the entity) itself may be omitted. For example,\nthe last path element of the key of `Mutation.insert` may have no\nidentifier.\n\nA path can never be empty, and a path can have at most 100 elements.",
+ "items": {
+ "$ref": "PathElement"
+ },
+ "type": "array"
+ },
+ "partitionId": {
+ "$ref": "PartitionId",
+ "description": "Entities are partitioned into subsets, currently identified by a project\nID and namespace ID.\nQueries are scoped to a single partition."
+ }
+ },
+ "id": "Key"
+ },
+ "LatLng": {
+ "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.\n\nExample of normalization code in Python:\n\n def NormalizeLongitude(longitude):\n \"\"\"Wraps decimal degrees longitude to [-180.0, 180.0].\"\"\"\n q, r = divmod(longitude, 360.0)\n if r \u003e 180.0 or (r == 180.0 and q \u003c= -1.0):\n return r - 360.0\n return r\n\n def NormalizeLatLng(latitude, longitude):\n \"\"\"Wraps decimal degrees latitude and longitude to\n [-90.0, 90.0] and [-180.0, 180.0], respectively.\"\"\"\n r = latitude % 360.0\n if r \u003c= 90.0:\n return r, NormalizeLongitude(longitude)\n elif r \u003e= 270.0:\n return r - 360, NormalizeLongitude(longitude)\n else:\n return 180 - r, NormalizeLongitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLongitude(181.0)\n assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)\n assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)\n assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)\n assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)\n assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)\n assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)\n assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)\n assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)",
+ "type": "object",
+ "properties": {
+ "latitude": {
+ "format": "double",
+ "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
+ "type": "number"
+ },
+ "longitude": {
+ "format": "double",
+ "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
+ "type": "number"
+ }
+ },
+ "id": "LatLng"
+ },
+ "PropertyReference": {
+ "description": "A reference to a property relative to the kind expressions.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the property.\nIf name includes \".\"s, it may be interpreted as a property name path.",
+ "type": "string"
+ }
+ },
+ "id": "PropertyReference"
+ },
+ "GoogleDatastoreAdminV1beta1EntityFilter": {
+ "id": "GoogleDatastoreAdminV1beta1EntityFilter",
+ "description": "Identifies a subset of entities in a project. This is specified as\ncombinations of kinds and namespaces (either or both of which may be all, as\ndescribed in the following examples).\nExample usage:\n\nEntire project:\n kinds=[], namespace_ids=[]\n\nKinds Foo and Bar in all namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=[]\n\nKinds Foo and Bar only in the default namespace:\n kinds=['Foo', 'Bar'], namespace_ids=['']\n\nKinds Foo and Bar in both the default and Baz namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz']\n\nThe entire Baz namespace:\n kinds=[], namespace_ids=['Baz']",
+ "type": "object",
+ "properties": {
+ "kinds": {
+ "description": "If empty, then this represents all kinds.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "namespaceIds": {
+ "description": "An empty list represents all namespaces. This is the preferred\nusage for projects that don't use namespaces.\n\nAn empty string element represents the default namespace. This should be\nused if the project has data in non-default namespaces, but doesn't want to\ninclude them.\nEach namespace in this list must be unique.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "GoogleDatastoreAdminV1beta1CommonMetadata": {
+ "description": "Metadata common to all Datastore Admin operations.",
+ "type": "object",
+ "properties": {
+ "labels": {
+ "description": "The client-assigned labels which were provided when the operation was\ncreated. May also include additional labels.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "The time the operation ended, either successfully or otherwise.",
+ "type": "string"
+ },
+ "state": {
+ "description": "The current state of the Operation.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified.",
+ "Request is being prepared for processing.",
+ "Request is actively being processed.",
+ "Request is in the process of being cancelled after user called\ngoogle.longrunning.Operations.CancelOperation on the operation.",
+ "Request has been processed and is in its finalization stage.",
+ "Request has completed successfully.",
+ "Request has finished being processed, but encountered an error.",
+ "Request has finished being cancelled after user called\ngoogle.longrunning.Operations.CancelOperation."
+ ],
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "INITIALIZING",
+ "PROCESSING",
+ "CANCELLING",
+ "FINALIZING",
+ "SUCCESSFUL",
+ "FAILED",
+ "CANCELLED"
+ ]
+ },
+ "operationType": {
+ "enumDescriptions": [
+ "Unspecified.",
+ "ExportEntities.",
+ "ImportEntities."
+ ],
+ "enum": [
+ "OPERATION_TYPE_UNSPECIFIED",
+ "EXPORT_ENTITIES",
+ "IMPORT_ENTITIES"
+ ],
+ "description": "The type of the operation. Can be used as a filter in\nListOperationsRequest.",
+ "type": "string"
+ },
+ "startTime": {
+ "format": "google-datetime",
+ "description": "The time that work began on the operation.",
+ "type": "string"
+ }
+ },
+ "id": "GoogleDatastoreAdminV1beta1CommonMetadata"
+ },
+ "Projection": {
+ "description": "A representation of a property in a projection.",
+ "type": "object",
+ "properties": {
+ "property": {
+ "$ref": "PropertyReference",
+ "description": "The property to project."
+ }
+ },
+ "id": "Projection"
+ },
+ "ArrayValue": {
+ "id": "ArrayValue",
+ "description": "An array value.",
+ "type": "object",
+ "properties": {
+ "values": {
+ "description": "Values in the array.\nThe order of this array may not be preserved if it contains a mix of\nindexed and unindexed values.",
+ "items": {
+ "$ref": "Value"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "Mutation": {
+ "id": "Mutation",
+ "description": "A mutation to apply to an entity.",
+ "type": "object",
+ "properties": {
+ "upsert": {
+ "$ref": "Entity",
+ "description": "The entity to upsert. The entity may or may not already exist.\nThe entity key's final path element may be incomplete."
+ },
+ "delete": {
+ "description": "The key of the entity to delete. The entity may or may not already exist.\nMust have a complete key path and must not be reserved/read-only.",
+ "$ref": "Key"
+ },
+ "baseVersion": {
+ "format": "int64",
+ "description": "The version of the entity that this mutation is being applied to. If this\ndoes not match the current version on the server, the mutation conflicts.",
+ "type": "string"
+ },
+ "insert": {
+ "description": "The entity to insert. The entity must not already exist.\nThe entity key's final path element may be incomplete.",
+ "$ref": "Entity"
+ },
+ "update": {
+ "description": "The entity to update. The entity must already exist.\nMust have a complete key path.",
+ "$ref": "Entity"
+ }
+ }
+ },
+ "ReadOptions": {
+ "id": "ReadOptions",
+ "description": "The options shared by read requests.",
+ "type": "object",
+ "properties": {
+ "transaction": {
+ "format": "byte",
+ "description": "The identifier of the transaction in which to read. A\ntransaction identifier is returned by a call to\nDatastore.BeginTransaction.",
+ "type": "string"
+ },
+ "readConsistency": {
+ "description": "The non-transactional read consistency to use.\nCannot be set to `STRONG` for global queries.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified. This value must not be used.",
+ "Strong consistency.",
+ "Eventual consistency."
+ ],
+ "enum": [
+ "READ_CONSISTENCY_UNSPECIFIED",
+ "STRONG",
+ "EVENTUAL"
+ ]
+ }
+ }
+ },
+ "RollbackResponse": {
+ "id": "RollbackResponse",
+ "description": "The response for Datastore.Rollback.\n(an empty message).",
+ "type": "object",
+ "properties": {}
+ },
+ "GoogleDatastoreAdminV1beta1ExportEntitiesResponse": {
+ "id": "GoogleDatastoreAdminV1beta1ExportEntitiesResponse",
+ "description": "The response for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities.",
+ "type": "object",
+ "properties": {
+ "outputUrl": {
+ "description": "Location of the output metadata file. This can be used to begin an import\ninto Cloud Datastore (this project or another project). See\ngoogle.datastore.admin.v1beta1.ImportEntitiesRequest.input_url.\nOnly present if the operation completed successfully.",
+ "type": "string"
+ }
+ }
}
},
+ "protocol": "rest",
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
- "protocol": "rest",
"version": "v1",
"baseUrl": "https://datastore.googleapis.com/",
"auth": {
@@ -1475,8 +1475,8 @@
}
}
},
- "description": "Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application.\n",
"servicePath": "",
+ "description": "Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application.\n",
"kind": "discovery#restDescription",
"rootUrl": "https://datastore.googleapis.com/",
"basePath": "",
diff --git a/datastore/v1beta1/datastore-api.json b/datastore/v1beta1/datastore-api.json
index 27c7815..387a06a 100644
--- a/datastore/v1beta1/datastore-api.json
+++ b/datastore/v1beta1/datastore-api.json
@@ -1,13 +1,4 @@
{
- "rootUrl": "https://datastore.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "datastore",
- "batchPath": "batch",
- "id": "datastore:v1beta1",
- "documentationLink": "https://cloud.google.com/datastore/",
- "revision": "20171003",
- "title": "Google Cloud Datastore API",
"ownerName": "Google",
"discoveryVersion": "v1",
"version_module": true,
@@ -15,32 +6,32 @@
"projects": {
"methods": {
"export": {
- "id": "datastore.projects.export",
- "path": "v1beta1/projects/{projectId}:export",
- "request": {
- "$ref": "GoogleDatastoreAdminV1beta1ExportEntitiesRequest"
- },
- "description": "Exports a copy of all or a subset of entities from Google Cloud Datastore\nto another storage system, such as Google Cloud Storage. Recent updates to\nentities may not be reflected in the export. The export occurs in the\nbackground and its progress can be monitored and managed via the\nOperation resource that is created. The output of an export may only be\nused once the associated operation is done. If an export operation is\ncancelled before completion it may leave partial data behind in Google\nCloud Storage.",
- "response": {
- "$ref": "GoogleLongrunningOperation"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"projectId"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "GoogleLongrunningOperation"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
"parameters": {
"projectId": {
+ "location": "path",
"description": "Project ID against which to make the request.",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
}
},
- "flatPath": "v1beta1/projects/{projectId}:export"
+ "flatPath": "v1beta1/projects/{projectId}:export",
+ "path": "v1beta1/projects/{projectId}:export",
+ "id": "datastore.projects.export",
+ "request": {
+ "$ref": "GoogleDatastoreAdminV1beta1ExportEntitiesRequest"
+ },
+ "description": "Exports a copy of all or a subset of entities from Google Cloud Datastore\nto another storage system, such as Google Cloud Storage. Recent updates to\nentities may not be reflected in the export. The export occurs in the\nbackground and its progress can be monitored and managed via the\nOperation resource that is created. The output of an export may only be\nused once the associated operation is done. If an export operation is\ncancelled before completion it may leave partial data behind in Google\nCloud Storage."
},
"import": {
"response": {
@@ -50,10 +41,6 @@
"projectId"
],
"httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
"parameters": {
"projectId": {
"description": "Project ID against which to make the request.",
@@ -62,53 +49,23 @@
"location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
"flatPath": "v1beta1/projects/{projectId}:import",
"id": "datastore.projects.import",
"path": "v1beta1/projects/{projectId}:import",
+ "description": "Imports entities into Google Cloud Datastore. Existing entities with the\nsame key are overwritten. The import occurs in the background and its\nprogress can be monitored and managed via the Operation resource that is\ncreated. If an ImportEntities operation is cancelled, it is possible\nthat a subset of the data has already been imported to Cloud Datastore.",
"request": {
"$ref": "GoogleDatastoreAdminV1beta1ImportEntitiesRequest"
- },
- "description": "Imports entities into Google Cloud Datastore. Existing entities with the\nsame key are overwritten. The import occurs in the background and its\nprogress can be monitored and managed via the Operation resource that is\ncreated. If an ImportEntities operation is cancelled, it is possible\nthat a subset of the data has already been imported to Cloud Datastore."
+ }
}
}
}
},
"parameters": {
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
"alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -116,22 +73,28 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string"
},
"key": {
+ "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
+ "type": "string"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
},
"quotaUser": {
+ "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pp": {
"description": "Pretty-print response.",
@@ -150,65 +113,111 @@
"location": "query"
},
"upload_protocol": {
- "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"prettyPrint": {
- "location": "query",
"description": "Returns response with indentations and line breaks.",
"default": "true",
- "type": "boolean"
+ "type": "boolean",
+ "location": "query"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query"
}
},
"schemas": {
- "GoogleDatastoreAdminV1beta1ExportEntitiesResponse": {
+ "Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
"properties": {
- "outputUrl": {
- "description": "Location of the output metadata file. This can be used to begin an import\ninto Cloud Datastore (this project or another project). See\ngoogle.datastore.admin.v1beta1.ImportEntitiesRequest.input_url.\nOnly present if the operation completed successfully.",
+ "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"
+ },
+ "code": {
+ "format": "int32",
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "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": "GoogleDatastoreAdminV1beta1ExportEntitiesResponse",
- "description": "The response for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities.",
- "type": "object"
+ "id": "Status"
},
- "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata": {
+ "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata": {
"properties": {
"progressEntities": {
- "$ref": "GoogleDatastoreAdminV1beta1Progress",
- "description": "An estimate of the number of entities processed."
- },
- "common": {
- "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata",
- "description": "Metadata common to all Datastore Admin operations."
- },
- "inputUrl": {
- "description": "The location of the import metadata file. This will be the same value as\nthe google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url\nfield.",
- "type": "string"
- },
- "progressBytes": {
- "description": "An estimate of the number of bytes processed.",
+ "description": "An estimate of the number of entities processed.",
"$ref": "GoogleDatastoreAdminV1beta1Progress"
},
+ "common": {
+ "description": "Metadata common to all Datastore Admin operations.",
+ "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata"
+ },
+ "progressBytes": {
+ "$ref": "GoogleDatastoreAdminV1beta1Progress",
+ "description": "An estimate of the number of bytes processed."
+ },
+ "outputUrlPrefix": {
+ "description": "Location for the export metadata and data files. This will be the same\nvalue as the\ngoogle.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix\nfield. The final output location is provided in\ngoogle.datastore.admin.v1beta1.ExportEntitiesResponse.output_url.",
+ "type": "string"
+ },
"entityFilter": {
- "description": "Description of which entities are being imported.",
+ "description": "Description of which entities are being exported.",
"$ref": "GoogleDatastoreAdminV1beta1EntityFilter"
}
},
- "id": "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata",
- "description": "Metadata for ImportEntities operations.",
+ "id": "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata",
+ "description": "Metadata for ExportEntities operations.",
"type": "object"
},
- "GoogleDatastoreAdminV1beta1ImportEntitiesRequest": {
+ "GoogleDatastoreAdminV1beta1ExportEntitiesRequest": {
+ "description": "The request for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities.",
+ "type": "object",
"properties": {
- "inputUrl": {
- "description": "The full resource URL of the external storage location. Currently, only\nGoogle Cloud Storage is supported. So input_url should be of the form:\n`gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE`, where\n`BUCKET_NAME` is the name of the Cloud Storage bucket, `NAMESPACE_PATH` is\nan optional Cloud Storage namespace path (this is not a Cloud Datastore\nnamespace), and `OVERALL_EXPORT_METADATA_FILE` is the metadata file written\nby the ExportEntities operation. For more information about Cloud Storage\nnamespace paths, see\n[Object name\nconsiderations](https://cloud.google.com/storage/docs/naming#object-considerations).\n\nFor more information, see\ngoogle.datastore.admin.v1beta1.ExportEntitiesResponse.output_url.",
+ "outputUrlPrefix": {
+ "description": "Location for the export metadata and data files.\n\nThe full resource URL of the external storage location. Currently, only\nGoogle Cloud Storage is supported. So output_url_prefix should be of the\nform: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the\nname of the Cloud Storage bucket and `NAMESPACE_PATH` is an optional Cloud\nStorage namespace path (this is not a Cloud Datastore namespace). For more\ninformation about Cloud Storage namespace paths, see\n[Object name\nconsiderations](https://cloud.google.com/storage/docs/naming#object-considerations).\n\nThe resulting files will be nested deeper than the specified URL prefix.\nThe final output URL will be provided in the\ngoogle.datastore.admin.v1beta1.ExportEntitiesResponse.output_url\nfield. That value should be used for subsequent ImportEntities operations.\n\nBy nesting the data files deeper, the same Cloud Storage bucket can be used\nin multiple ExportEntities operations without conflict.",
"type": "string"
},
"entityFilter": {
- "$ref": "GoogleDatastoreAdminV1beta1EntityFilter",
- "description": "Optionally specify which kinds/namespaces are to be imported. If provided,\nthe list must be a subset of the EntityFilter used in creating the export,\notherwise a FAILED_PRECONDITION error will be returned. If no filter is\nspecified then all entities from the export are imported."
+ "description": "Description of what data from the project is included in the export.",
+ "$ref": "GoogleDatastoreAdminV1beta1EntityFilter"
},
"labels": {
"additionalProperties": {
@@ -218,10 +227,68 @@
"type": "object"
}
},
- "id": "GoogleDatastoreAdminV1beta1ImportEntitiesRequest",
- "description": "The request for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ImportEntities.",
+ "id": "GoogleDatastoreAdminV1beta1ExportEntitiesRequest"
+ },
+ "GoogleDatastoreAdminV1beta1ExportEntitiesResponse": {
+ "description": "The response for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities.",
+ "type": "object",
+ "properties": {
+ "outputUrl": {
+ "description": "Location of the output metadata file. This can be used to begin an import\ninto Cloud Datastore (this project or another project). See\ngoogle.datastore.admin.v1beta1.ImportEntitiesRequest.input_url.\nOnly present if the operation completed successfully.",
+ "type": "string"
+ }
+ },
+ "id": "GoogleDatastoreAdminV1beta1ExportEntitiesResponse"
+ },
+ "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata": {
+ "properties": {
+ "progressEntities": {
+ "description": "An estimate of the number of entities processed.",
+ "$ref": "GoogleDatastoreAdminV1beta1Progress"
+ },
+ "common": {
+ "description": "Metadata common to all Datastore Admin operations.",
+ "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata"
+ },
+ "inputUrl": {
+ "description": "The location of the import metadata file. This will be the same value as\nthe google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url\nfield.",
+ "type": "string"
+ },
+ "progressBytes": {
+ "$ref": "GoogleDatastoreAdminV1beta1Progress",
+ "description": "An estimate of the number of bytes processed."
+ },
+ "entityFilter": {
+ "$ref": "GoogleDatastoreAdminV1beta1EntityFilter",
+ "description": "Description of which entities are being imported."
+ }
+ },
+ "id": "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata",
+ "description": "Metadata for ImportEntities operations.",
"type": "object"
},
+ "GoogleDatastoreAdminV1beta1ImportEntitiesRequest": {
+ "description": "The request for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ImportEntities.",
+ "type": "object",
+ "properties": {
+ "inputUrl": {
+ "description": "The full resource URL of the external storage location. Currently, only\nGoogle Cloud Storage is supported. So input_url should be of the form:\n`gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE`, where\n`BUCKET_NAME` is the name of the Cloud Storage bucket, `NAMESPACE_PATH` is\nan optional Cloud Storage namespace path (this is not a Cloud Datastore\nnamespace), and `OVERALL_EXPORT_METADATA_FILE` is the metadata file written\nby the ExportEntities operation. For more information about Cloud Storage\nnamespace paths, see\n[Object name\nconsiderations](https://cloud.google.com/storage/docs/naming#object-considerations).\n\nFor more information, see\ngoogle.datastore.admin.v1beta1.ExportEntitiesResponse.output_url.",
+ "type": "string"
+ },
+ "entityFilter": {
+ "description": "Optionally specify which kinds/namespaces are to be imported. If provided,\nthe list must be a subset of the EntityFilter used in creating the export,\notherwise a FAILED_PRECONDITION error will be returned. If no filter is\nspecified then all entities from the export are imported.",
+ "$ref": "GoogleDatastoreAdminV1beta1EntityFilter"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Client-assigned labels.",
+ "type": "object"
+ }
+ },
+ "id": "GoogleDatastoreAdminV1beta1ImportEntitiesRequest"
+ },
"GoogleDatastoreAdminV1beta1Progress": {
"description": "Measures the progress of a particular metric.",
"type": "object",
@@ -240,34 +307,28 @@
"id": "GoogleDatastoreAdminV1beta1Progress"
},
"GoogleDatastoreAdminV1beta1EntityFilter": {
- "description": "Identifies a subset of entities in a project. This is specified as\ncombinations of kinds and namespaces (either or both of which may be all, as\ndescribed in the following examples).\nExample usage:\n\nEntire project:\n kinds=[], namespace_ids=[]\n\nKinds Foo and Bar in all namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=[]\n\nKinds Foo and Bar only in the default namespace:\n kinds=['Foo', 'Bar'], namespace_ids=['']\n\nKinds Foo and Bar in both the default and Baz namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz']\n\nThe entire Baz namespace:\n kinds=[], namespace_ids=['Baz']",
- "type": "object",
"properties": {
- "namespaceIds": {
- "description": "An empty list represents all namespaces. This is the preferred\nusage for projects that don't use namespaces.\n\nAn empty string element represents the default namespace. This should be\nused if the project has data in non-default namespaces, but doesn't want to\ninclude them.\nEach namespace in this list must be unique.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
"kinds": {
"description": "If empty, then this represents all kinds.",
"items": {
"type": "string"
},
"type": "array"
+ },
+ "namespaceIds": {
+ "description": "An empty list represents all namespaces. This is the preferred\nusage for projects that don't use namespaces.\n\nAn empty string element represents the default namespace. This should be\nused if the project has data in non-default namespaces, but doesn't want to\ninclude them.\nEach namespace in this list must be unique.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
},
- "id": "GoogleDatastoreAdminV1beta1EntityFilter"
+ "id": "GoogleDatastoreAdminV1beta1EntityFilter",
+ "description": "Identifies a subset of entities in a project. This is specified as\ncombinations of kinds and namespaces (either or both of which may be all, as\ndescribed in the following examples).\nExample usage:\n\nEntire project:\n kinds=[], namespace_ids=[]\n\nKinds Foo and Bar in all namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=[]\n\nKinds Foo and Bar only in the default namespace:\n kinds=['Foo', 'Bar'], namespace_ids=['']\n\nKinds Foo and Bar in both the default and Baz namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz']\n\nThe entire Baz namespace:\n kinds=[], namespace_ids=['Baz']",
+ "type": "object"
},
"GoogleLongrunningOperation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
"properties": {
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- },
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
@@ -291,11 +352,19 @@
},
"description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
"type": "object"
+ },
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
}
},
- "id": "GoogleLongrunningOperation"
+ "id": "GoogleLongrunningOperation",
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object"
},
"GoogleDatastoreAdminV1beta1CommonMetadata": {
+ "description": "Metadata common to all Datastore Admin operations.",
+ "type": "object",
"properties": {
"state": {
"enum": [
@@ -322,18 +391,18 @@
]
},
"operationType": {
+ "enumDescriptions": [
+ "Unspecified.",
+ "ExportEntities.",
+ "ImportEntities."
+ ],
"enum": [
"OPERATION_TYPE_UNSPECIFIED",
"EXPORT_ENTITIES",
"IMPORT_ENTITIES"
],
"description": "The type of the operation. Can be used as a filter in\nListOperationsRequest.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified.",
- "ExportEntities.",
- "ImportEntities."
- ]
+ "type": "string"
},
"startTime": {
"format": "google-datetime",
@@ -353,85 +422,7 @@
"type": "string"
}
},
- "id": "GoogleDatastoreAdminV1beta1CommonMetadata",
- "description": "Metadata common to all Datastore Admin operations.",
- "type": "object"
- },
- "Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- },
- "type": "array"
- },
- "code": {
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer"
- }
- },
- "id": "Status"
- },
- "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata": {
- "properties": {
- "common": {
- "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata",
- "description": "Metadata common to all Datastore Admin operations."
- },
- "progressBytes": {
- "description": "An estimate of the number of bytes processed.",
- "$ref": "GoogleDatastoreAdminV1beta1Progress"
- },
- "outputUrlPrefix": {
- "description": "Location for the export metadata and data files. This will be the same\nvalue as the\ngoogle.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix\nfield. The final output location is provided in\ngoogle.datastore.admin.v1beta1.ExportEntitiesResponse.output_url.",
- "type": "string"
- },
- "entityFilter": {
- "description": "Description of which entities are being exported.",
- "$ref": "GoogleDatastoreAdminV1beta1EntityFilter"
- },
- "progressEntities": {
- "$ref": "GoogleDatastoreAdminV1beta1Progress",
- "description": "An estimate of the number of entities processed."
- }
- },
- "id": "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata",
- "description": "Metadata for ExportEntities operations.",
- "type": "object"
- },
- "GoogleDatastoreAdminV1beta1ExportEntitiesRequest": {
- "properties": {
- "outputUrlPrefix": {
- "description": "Location for the export metadata and data files.\n\nThe full resource URL of the external storage location. Currently, only\nGoogle Cloud Storage is supported. So output_url_prefix should be of the\nform: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the\nname of the Cloud Storage bucket and `NAMESPACE_PATH` is an optional Cloud\nStorage namespace path (this is not a Cloud Datastore namespace). For more\ninformation about Cloud Storage namespace paths, see\n[Object name\nconsiderations](https://cloud.google.com/storage/docs/naming#object-considerations).\n\nThe resulting files will be nested deeper than the specified URL prefix.\nThe final output URL will be provided in the\ngoogle.datastore.admin.v1beta1.ExportEntitiesResponse.output_url\nfield. That value should be used for subsequent ImportEntities operations.\n\nBy nesting the data files deeper, the same Cloud Storage bucket can be used\nin multiple ExportEntities operations without conflict.",
- "type": "string"
- },
- "entityFilter": {
- "$ref": "GoogleDatastoreAdminV1beta1EntityFilter",
- "description": "Description of what data from the project is included in the export."
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Client-assigned labels.",
- "type": "object"
- }
- },
- "id": "GoogleDatastoreAdminV1beta1ExportEntitiesRequest",
- "description": "The request for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities.",
- "type": "object"
+ "id": "GoogleDatastoreAdminV1beta1CommonMetadata"
}
},
"icons": {
@@ -444,16 +435,25 @@
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
"https://www.googleapis.com/auth/datastore": {
"description": "View and manage your Google Cloud Datastore data"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
+ "servicePath": "",
"description": "Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application.\n",
"kind": "discovery#restDescription",
- "servicePath": ""
+ "rootUrl": "https://datastore.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "datastore",
+ "batchPath": "batch",
+ "documentationLink": "https://cloud.google.com/datastore/",
+ "id": "datastore:v1beta1",
+ "revision": "20171003",
+ "title": "Google Cloud Datastore API"
}
diff --git a/datastore/v1beta3/datastore-api.json b/datastore/v1beta3/datastore-api.json
index d623e76..a65d720 100644
--- a/datastore/v1beta3/datastore-api.json
+++ b/datastore/v1beta3/datastore-api.json
@@ -1,10 +1,64 @@
{
+ "version": "v1beta3",
+ "baseUrl": "https://datastore.googleapis.com/",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/datastore": {
+ "description": "View and manage your Google Cloud Datastore data"
+ }
+ }
+ }
+ },
+ "servicePath": "",
+ "description": "Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application.\n",
+ "kind": "discovery#restDescription",
+ "rootUrl": "https://datastore.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "datastore",
+ "batchPath": "batch",
+ "revision": "20171003",
+ "id": "datastore:v1beta3",
+ "documentationLink": "https://cloud.google.com/datastore/",
+ "title": "Google Cloud Datastore API",
"discoveryVersion": "v1",
"ownerName": "Google",
"version_module": true,
"resources": {
"projects": {
"methods": {
+ "commit": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "CommitResponse"
+ },
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The ID of the project against which to make the request.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "flatPath": "v1beta3/projects/{projectId}:commit",
+ "path": "v1beta3/projects/{projectId}:commit",
+ "id": "datastore.projects.commit",
+ "description": "Commits a transaction, optionally creating, deleting or modifying some\nentities.",
+ "request": {
+ "$ref": "CommitRequest"
+ }
+ },
"beginTransaction": {
"response": {
"$ref": "BeginTransactionResponse"
@@ -33,42 +87,13 @@
},
"description": "Begins a new transaction."
},
- "commit": {
- "description": "Commits a transaction, optionally creating, deleting or modifying some\nentities.",
- "request": {
- "$ref": "CommitRequest"
- },
- "response": {
- "$ref": "CommitResponse"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The ID of the project against which to make the request.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "flatPath": "v1beta3/projects/{projectId}:commit",
- "id": "datastore.projects.commit",
- "path": "v1beta3/projects/{projectId}:commit"
- },
"runQuery": {
- "flatPath": "v1beta3/projects/{projectId}:runQuery",
"id": "datastore.projects.runQuery",
"path": "v1beta3/projects/{projectId}:runQuery",
+ "description": "Queries for entities.",
"request": {
"$ref": "RunQueryRequest"
},
- "description": "Queries for entities.",
"response": {
"$ref": "RunQueryResponse"
},
@@ -76,10 +101,6 @@
"projectId"
],
"httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
"parameters": {
"projectId": {
"location": "path",
@@ -87,7 +108,12 @@
"type": "string",
"required": true
}
- }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "flatPath": "v1beta3/projects/{projectId}:runQuery"
},
"rollback": {
"id": "datastore.projects.rollback",
@@ -118,21 +144,19 @@
"flatPath": "v1beta3/projects/{projectId}:rollback"
},
"lookup": {
+ "path": "v1beta3/projects/{projectId}:lookup",
+ "id": "datastore.projects.lookup",
+ "description": "Looks up entities by key.",
"request": {
"$ref": "LookupRequest"
},
- "description": "Looks up entities by key.",
- "response": {
- "$ref": "LookupResponse"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"projectId"
],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
+ "response": {
+ "$ref": "LookupResponse"
+ },
"parameters": {
"projectId": {
"description": "The ID of the project against which to make the request.",
@@ -141,15 +165,17 @@
"location": "path"
}
},
- "flatPath": "v1beta3/projects/{projectId}:lookup",
- "id": "datastore.projects.lookup",
- "path": "v1beta3/projects/{projectId}:lookup"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "flatPath": "v1beta3/projects/{projectId}:lookup"
},
"allocateIds": {
- "description": "Allocates IDs for the given keys, which is useful for referencing an entity\nbefore it is inserted.",
"request": {
"$ref": "AllocateIdsRequest"
},
+ "description": "Allocates IDs for the given keys, which is useful for referencing an entity\nbefore it is inserted.",
"response": {
"$ref": "AllocateIdsResponse"
},
@@ -157,6 +183,10 @@
"projectId"
],
"httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
"parameters": {
"projectId": {
"description": "The ID of the project against which to make the request.",
@@ -165,10 +195,6 @@
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
"flatPath": "v1beta3/projects/{projectId}:allocateIds",
"id": "datastore.projects.allocateIds",
"path": "v1beta3/projects/{projectId}:allocateIds"
@@ -177,48 +203,77 @@
}
},
"parameters": {
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string",
"location": "query"
},
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
"default": "true",
"type": "boolean",
"location": "query"
},
- "uploadType": {
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
"location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "description": "OAuth 2.0 token for the current user.",
"type": "string"
},
+ "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.",
+ "default": "true",
+ "type": "boolean"
+ },
"fields": {
"location": "query",
"description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
"$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query"
},
"callback": {
- "location": "query",
"description": "JSONP",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"alt": {
- "description": "Data format for response.",
- "default": "json",
"enum": [
"json",
"media",
@@ -230,41 +285,215 @@
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
- "location": "query"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
"location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
- },
- "bearer_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth bearer token."
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
+ "description": "Data format for response.",
+ "default": "json"
}
},
"schemas": {
+ "RunQueryRequest": {
+ "description": "The request for Datastore.RunQuery.",
+ "type": "object",
+ "properties": {
+ "gqlQuery": {
+ "description": "The GQL query to run.",
+ "$ref": "GqlQuery"
+ },
+ "partitionId": {
+ "description": "Entities are partitioned into subsets, identified by a partition ID.\nQueries are scoped to a single partition.\nThis partition ID is normalized with the standard default context\npartition ID.",
+ "$ref": "PartitionId"
+ },
+ "readOptions": {
+ "description": "The options for this query.",
+ "$ref": "ReadOptions"
+ },
+ "query": {
+ "$ref": "Query",
+ "description": "The query to run."
+ }
+ },
+ "id": "RunQueryRequest"
+ },
+ "RollbackRequest": {
+ "description": "The request for Datastore.Rollback.",
+ "type": "object",
+ "properties": {
+ "transaction": {
+ "format": "byte",
+ "description": "The transaction identifier, returned by a call to\nDatastore.BeginTransaction.",
+ "type": "string"
+ }
+ },
+ "id": "RollbackRequest"
+ },
+ "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata": {
+ "description": "Metadata for ExportEntities operations.",
+ "type": "object",
+ "properties": {
+ "progressEntities": {
+ "$ref": "GoogleDatastoreAdminV1beta1Progress",
+ "description": "An estimate of the number of entities processed."
+ },
+ "common": {
+ "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata",
+ "description": "Metadata common to all Datastore Admin operations."
+ },
+ "progressBytes": {
+ "description": "An estimate of the number of bytes processed.",
+ "$ref": "GoogleDatastoreAdminV1beta1Progress"
+ },
+ "outputUrlPrefix": {
+ "description": "Location for the export metadata and data files. This will be the same\nvalue as the\ngoogle.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix\nfield. The final output location is provided in\ngoogle.datastore.admin.v1beta1.ExportEntitiesResponse.output_url.",
+ "type": "string"
+ },
+ "entityFilter": {
+ "description": "Description of which entities are being exported.",
+ "$ref": "GoogleDatastoreAdminV1beta1EntityFilter"
+ }
+ },
+ "id": "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata"
+ },
+ "TransactionOptions": {
+ "description": "Options for beginning a new transaction.\n\nTransactions can be created explicitly with calls to\nDatastore.BeginTransaction or implicitly by setting\nReadOptions.new_transaction in read requests.",
+ "type": "object",
+ "properties": {
+ "readOnly": {
+ "$ref": "ReadOnly",
+ "description": "The transaction should only allow reads."
+ },
+ "readWrite": {
+ "$ref": "ReadWrite",
+ "description": "The transaction should allow both reads and writes."
+ }
+ },
+ "id": "TransactionOptions"
+ },
+ "CompositeFilter": {
+ "properties": {
+ "filters": {
+ "description": "The list of filters to combine.\nMust contain at least one filter.",
+ "items": {
+ "$ref": "Filter"
+ },
+ "type": "array"
+ },
+ "op": {
+ "enumDescriptions": [
+ "Unspecified. This value must not be used.",
+ "The results are required to satisfy each of the combined filters."
+ ],
+ "enum": [
+ "OPERATOR_UNSPECIFIED",
+ "AND"
+ ],
+ "description": "The operator for combining multiple filters.",
+ "type": "string"
+ }
+ },
+ "id": "CompositeFilter",
+ "description": "A filter that merges multiple other filters using the given operator.",
+ "type": "object"
+ },
+ "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata": {
+ "properties": {
+ "common": {
+ "description": "Metadata common to all Datastore Admin operations.",
+ "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata"
+ },
+ "inputUrl": {
+ "description": "The location of the import metadata file. This will be the same value as\nthe google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url\nfield.",
+ "type": "string"
+ },
+ "progressBytes": {
+ "$ref": "GoogleDatastoreAdminV1beta1Progress",
+ "description": "An estimate of the number of bytes processed."
+ },
+ "entityFilter": {
+ "$ref": "GoogleDatastoreAdminV1beta1EntityFilter",
+ "description": "Description of which entities are being imported."
+ },
+ "progressEntities": {
+ "$ref": "GoogleDatastoreAdminV1beta1Progress",
+ "description": "An estimate of the number of entities processed."
+ }
+ },
+ "id": "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata",
+ "description": "Metadata for ImportEntities operations.",
+ "type": "object"
+ },
+ "AllocateIdsResponse": {
+ "properties": {
+ "keys": {
+ "description": "The keys specified in the request (in the same order), each with\nits key path completed with a newly allocated ID.",
+ "items": {
+ "$ref": "Key"
+ },
+ "type": "array"
+ }
+ },
+ "id": "AllocateIdsResponse",
+ "description": "The response for Datastore.AllocateIds.",
+ "type": "object"
+ },
+ "Query": {
+ "properties": {
+ "kind": {
+ "description": "The kinds to query (if empty, returns entities of all kinds).\nCurrently at most 1 kind may be specified.",
+ "items": {
+ "$ref": "KindExpression"
+ },
+ "type": "array"
+ },
+ "distinctOn": {
+ "description": "The properties to make distinct. The query results will contain the first\nresult for each distinct combination of values for the given properties\n(if empty, all results are returned).",
+ "items": {
+ "$ref": "PropertyReference"
+ },
+ "type": "array"
+ },
+ "order": {
+ "description": "The order to apply to the query results (if empty, order is unspecified).",
+ "items": {
+ "$ref": "PropertyOrder"
+ },
+ "type": "array"
+ },
+ "projection": {
+ "description": "The projection to return. Defaults to returning all properties.",
+ "items": {
+ "$ref": "Projection"
+ },
+ "type": "array"
+ },
+ "endCursor": {
+ "format": "byte",
+ "description": "An ending point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to limit the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).",
+ "type": "string"
+ },
+ "limit": {
+ "format": "int32",
+ "description": "The maximum number of results to return. Applies after all other\nconstraints. Optional.\nUnspecified is interpreted as no limit.\nMust be \u003e= 0 if specified.",
+ "type": "integer"
+ },
+ "filter": {
+ "description": "The filter to apply.",
+ "$ref": "Filter"
+ },
+ "offset": {
+ "format": "int32",
+ "description": "The number of results to skip. Applies before limit, but after all other\nconstraints. Optional. Must be \u003e= 0 if specified.",
+ "type": "integer"
+ },
+ "startCursor": {
+ "format": "byte",
+ "description": "A starting point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to continue the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).",
+ "type": "string"
+ }
+ },
+ "id": "Query",
+ "description": "A query for entities.",
+ "type": "object"
+ },
"ReadOnly": {
"description": "Options specific to read-only transactions.",
"type": "object",
@@ -272,23 +501,16 @@
"id": "ReadOnly"
},
"PropertyFilter": {
- "description": "A filter on a specific property.",
- "type": "object",
"properties": {
+ "value": {
+ "$ref": "Value",
+ "description": "The value to compare the property to."
+ },
"property": {
- "$ref": "PropertyReference",
- "description": "The property to filter by."
+ "description": "The property to filter by.",
+ "$ref": "PropertyReference"
},
"op": {
- "enumDescriptions": [
- "Unspecified. This value must not be used.",
- "Less than.",
- "Less than or equal.",
- "Greater than.",
- "Greater than or equal.",
- "Equal.",
- "Has ancestor."
- ],
"enum": [
"OPERATOR_UNSPECIFIED",
"LESS_THAN",
@@ -299,23 +521,24 @@
"HAS_ANCESTOR"
],
"description": "The operator to filter by.",
- "type": "string"
- },
- "value": {
- "description": "The value to compare the property to.",
- "$ref": "Value"
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified. This value must not be used.",
+ "Less than.",
+ "Less than or equal.",
+ "Greater than.",
+ "Greater than or equal.",
+ "Equal.",
+ "Has ancestor."
+ ]
}
},
- "id": "PropertyFilter"
+ "id": "PropertyFilter",
+ "description": "A filter on a specific property.",
+ "type": "object"
},
"EntityResult": {
- "description": "The result of fetching an entity from Datastore.",
- "type": "object",
"properties": {
- "entity": {
- "description": "The resulting entity.",
- "$ref": "Entity"
- },
"cursor": {
"format": "byte",
"description": "A cursor that points to the position after the result entity.\nSet only when the `EntityResult` is part of a `QueryResultBatch` message.",
@@ -325,64 +548,27 @@
"format": "int64",
"description": "The version of the entity, a strictly positive number that monotonically\nincreases with changes to the entity.\n\nThis field is set for `FULL` entity\nresults.\n\nFor missing entities in `LookupResponse`, this\nis the version of the snapshot that was used to look up the entity, and it\nis always set except for eventually consistent reads.",
"type": "string"
- }
- },
- "id": "EntityResult"
- },
- "CommitResponse": {
- "description": "The response for Datastore.Commit.",
- "type": "object",
- "properties": {
- "indexUpdates": {
- "format": "int32",
- "description": "The number of index entries updated during the commit, or zero if none were\nupdated.",
- "type": "integer"
},
- "mutationResults": {
- "description": "The result of performing the mutations.\nThe i-th mutation result corresponds to the i-th mutation in the request.",
- "items": {
- "$ref": "MutationResult"
- },
- "type": "array"
+ "entity": {
+ "$ref": "Entity",
+ "description": "The resulting entity."
}
},
- "id": "CommitResponse"
+ "id": "EntityResult",
+ "description": "The result of fetching an entity from Datastore.",
+ "type": "object"
},
"Value": {
- "description": "A message that can hold any of the supported value types and associated\nmetadata.",
- "type": "object",
"properties": {
- "blobValue": {
- "format": "byte",
- "description": "A blob value.\nMay have at most 1,000,000 bytes.\nWhen `exclude_from_indexes` is false, may have at most 1500 bytes.\nIn JSON requests, must be base64-encoded.",
- "type": "string"
- },
- "meaning": {
- "format": "int32",
- "description": "The `meaning` field should only be populated for backwards compatibility.",
- "type": "integer"
- },
- "arrayValue": {
- "description": "An array value.\nCannot contain another array value.\nA `Value` instance that sets field `array_value` must not set fields\n`meaning` or `exclude_from_indexes`.",
- "$ref": "ArrayValue"
- },
- "entityValue": {
- "$ref": "Entity",
- "description": "An entity value.\n\n- May have no key.\n- May have a key with an incomplete key path.\n- May have a reserved/read-only key."
- },
- "geoPointValue": {
- "$ref": "LatLng",
- "description": "A geo point value representing a point on the surface of Earth."
- },
- "keyValue": {
- "$ref": "Key",
- "description": "A key value."
- },
"integerValue": {
"format": "int64",
"description": "An integer value.",
"type": "string"
},
+ "keyValue": {
+ "$ref": "Key",
+ "description": "A key value."
+ },
"stringValue": {
"description": "A UTF-8 encoded string value.\nWhen `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.\nOtherwise, may be set to at least 1,000,000 bytes.",
"type": "string"
@@ -402,25 +588,66 @@
"type": "string"
},
"nullValue": {
- "type": "string",
"enumDescriptions": [
"Null value."
],
"enum": [
"NULL_VALUE"
],
- "description": "A null value."
+ "description": "A null value.",
+ "type": "string"
},
"booleanValue": {
"description": "A boolean value.",
"type": "boolean"
+ },
+ "blobValue": {
+ "format": "byte",
+ "description": "A blob value.\nMay have at most 1,000,000 bytes.\nWhen `exclude_from_indexes` is false, may have at most 1500 bytes.\nIn JSON requests, must be base64-encoded.",
+ "type": "string"
+ },
+ "meaning": {
+ "format": "int32",
+ "description": "The `meaning` field should only be populated for backwards compatibility.",
+ "type": "integer"
+ },
+ "arrayValue": {
+ "$ref": "ArrayValue",
+ "description": "An array value.\nCannot contain another array value.\nA `Value` instance that sets field `array_value` must not set fields\n`meaning` or `exclude_from_indexes`."
+ },
+ "entityValue": {
+ "description": "An entity value.\n\n- May have no key.\n- May have a key with an incomplete key path.\n- May have a reserved/read-only key.",
+ "$ref": "Entity"
+ },
+ "geoPointValue": {
+ "$ref": "LatLng",
+ "description": "A geo point value representing a point on the surface of Earth."
}
},
- "id": "Value"
+ "id": "Value",
+ "description": "A message that can hold any of the supported value types and associated\nmetadata.",
+ "type": "object"
+ },
+ "CommitResponse": {
+ "description": "The response for Datastore.Commit.",
+ "type": "object",
+ "properties": {
+ "mutationResults": {
+ "description": "The result of performing the mutations.\nThe i-th mutation result corresponds to the i-th mutation in the request.",
+ "items": {
+ "$ref": "MutationResult"
+ },
+ "type": "array"
+ },
+ "indexUpdates": {
+ "format": "int32",
+ "description": "The number of index entries updated during the commit, or zero if none were\nupdated.",
+ "type": "integer"
+ }
+ },
+ "id": "CommitResponse"
},
"PartitionId": {
- "description": "A partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty.\n\nA partition ID contains several dimensions:\nproject ID and namespace ID.\n\nPartition dimensions:\n\n- May be `\"\"`.\n- Must be valid UTF-8 bytes.\n- Must have values that match regex `[A-Za-z\\d\\.\\-_]{1,100}`\nIf the value of any dimension matches regex `__.*__`, the partition is\nreserved/read-only.\nA reserved/read-only partition ID is forbidden in certain documented\ncontexts.\n\nForeign partition IDs (in which the project ID does\nnot match the context project ID ) are discouraged.\nReads and writes of foreign partition IDs may fail if the project is not in an active state.",
- "type": "object",
"properties": {
"projectId": {
"description": "The ID of the project to which the entities belong.",
@@ -431,11 +658,29 @@
"type": "string"
}
},
- "id": "PartitionId"
+ "id": "PartitionId",
+ "description": "A partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty.\n\nA partition ID contains several dimensions:\nproject ID and namespace ID.\n\nPartition dimensions:\n\n- May be `\"\"`.\n- Must be valid UTF-8 bytes.\n- Must have values that match regex `[A-Za-z\\d\\.\\-_]{1,100}`\nIf the value of any dimension matches regex `__.*__`, the partition is\nreserved/read-only.\nA reserved/read-only partition ID is forbidden in certain documented\ncontexts.\n\nForeign partition IDs (in which the project ID does\nnot match the context project ID ) are discouraged.\nReads and writes of foreign partition IDs may fail if the project is not in an active state.",
+ "type": "object"
+ },
+ "Entity": {
+ "properties": {
+ "key": {
+ "$ref": "Key",
+ "description": "The entity's key.\n\nAn entity must have a key, unless otherwise documented (for example,\nan entity in `Value.entity_value` may have no key).\nAn entity's kind is its key path's last element's kind,\nor null if it has no key."
+ },
+ "properties": {
+ "additionalProperties": {
+ "$ref": "Value"
+ },
+ "description": "The entity's properties.\nThe map's keys are property names.\nA property name matching regex `__.*__` is reserved.\nA reserved property name is forbidden in certain documented contexts.\nThe name must not contain more than 500 characters.\nThe name cannot be `\"\"`.",
+ "type": "object"
+ }
+ },
+ "id": "Entity",
+ "description": "A Datastore data object.\n\nAn entity is limited to 1 megabyte when stored. That _roughly_\ncorresponds to a limit of 1 megabyte for the serialized form of this\nmessage.",
+ "type": "object"
},
"ReadWrite": {
- "description": "Options specific to read / write transactions.",
- "type": "object",
"properties": {
"previousTransaction": {
"format": "byte",
@@ -443,60 +688,41 @@
"type": "string"
}
},
- "id": "ReadWrite"
- },
- "Entity": {
- "description": "A Datastore data object.\n\nAn entity is limited to 1 megabyte when stored. That _roughly_\ncorresponds to a limit of 1 megabyte for the serialized form of this\nmessage.",
- "type": "object",
- "properties": {
- "properties": {
- "description": "The entity's properties.\nThe map's keys are property names.\nA property name matching regex `__.*__` is reserved.\nA reserved property name is forbidden in certain documented contexts.\nThe name must not contain more than 500 characters.\nThe name cannot be `\"\"`.",
- "type": "object",
- "additionalProperties": {
- "$ref": "Value"
- }
- },
- "key": {
- "$ref": "Key",
- "description": "The entity's key.\n\nAn entity must have a key, unless otherwise documented (for example,\nan entity in `Value.entity_value` may have no key).\nAn entity's kind is its key path's last element's kind,\nor null if it has no key."
- }
- },
- "id": "Entity"
+ "id": "ReadWrite",
+ "description": "Options specific to read / write transactions.",
+ "type": "object"
},
"LookupRequest": {
- "id": "LookupRequest",
- "description": "The request for Datastore.Lookup.",
- "type": "object",
"properties": {
"readOptions": {
- "description": "The options for this lookup request.",
- "$ref": "ReadOptions"
+ "$ref": "ReadOptions",
+ "description": "The options for this lookup request."
},
"keys": {
+ "description": "Keys of entities to look up.",
"items": {
"$ref": "Key"
},
- "type": "array",
- "description": "Keys of entities to look up."
+ "type": "array"
}
- }
+ },
+ "id": "LookupRequest",
+ "description": "The request for Datastore.Lookup.",
+ "type": "object"
},
"QueryResultBatch": {
- "description": "A batch of results produced by a query.",
- "type": "object",
"properties": {
+ "skippedCursor": {
+ "format": "byte",
+ "description": "A cursor that points to the position after the last skipped result.\nWill be set when `skipped_results` != 0.",
+ "type": "string"
+ },
"skippedResults": {
"format": "int32",
"description": "The number of results skipped, typically because of an offset.",
"type": "integer"
},
"entityResultType": {
- "enumDescriptions": [
- "Unspecified. This value is never used.",
- "The key and properties.",
- "A projected subset of properties. The entity may have no key.",
- "Only the key."
- ],
"enum": [
"RESULT_TYPE_UNSPECIFIED",
"FULL",
@@ -504,7 +730,13 @@
"KEY_ONLY"
],
"description": "The result type for every entity in `entity_results`.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified. This value is never used.",
+ "The key and properties.",
+ "A projected subset of properties. The entity may have no key.",
+ "Only the key."
+ ]
},
"entityResults": {
"description": "The results for this batch.",
@@ -540,18 +772,13 @@
"format": "int64",
"description": "The version number of the snapshot this batch was returned from.\nThis applies to the range of results from the query's `start_cursor` (or\nthe beginning of the query if no cursor was given) to this batch's\n`end_cursor` (not the query's `end_cursor`).\n\nIn a single transaction, subsequent query result batches for the same query\ncan have a greater snapshot version number. Each batch's snapshot version\nis valid for all preceding batches.\nThe value will be zero for eventually consistent queries.",
"type": "string"
- },
- "skippedCursor": {
- "format": "byte",
- "description": "A cursor that points to the position after the last skipped result.\nWill be set when `skipped_results` != 0.",
- "type": "string"
}
},
- "id": "QueryResultBatch"
+ "id": "QueryResultBatch",
+ "description": "A batch of results produced by a query.",
+ "type": "object"
},
"GoogleDatastoreAdminV1beta1Progress": {
- "description": "Measures the progress of a particular metric.",
- "type": "object",
"properties": {
"workEstimated": {
"format": "int64",
@@ -564,17 +791,14 @@
"type": "string"
}
},
- "id": "GoogleDatastoreAdminV1beta1Progress"
+ "id": "GoogleDatastoreAdminV1beta1Progress",
+ "description": "Measures the progress of a particular metric.",
+ "type": "object"
},
"PathElement": {
- "id": "PathElement",
"description": "A (kind, ID/name) pair used to construct a key path.\n\nIf either name or ID is set, the element is complete.\nIf neither is set, the element is incomplete.",
"type": "object",
"properties": {
- "kind": {
- "description": "The kind of the entity.\nA kind matching regex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
- "type": "string"
- },
"id": {
"format": "int64",
"description": "The auto-allocated ID of the entity.\nNever equal to zero. Values less than zero are discouraged and may not\nbe supported in the future.",
@@ -583,10 +807,17 @@
"name": {
"description": "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
"type": "string"
+ },
+ "kind": {
+ "description": "The kind of the entity.\nA kind matching regex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
+ "type": "string"
}
- }
+ },
+ "id": "PathElement"
},
"GqlQueryParameter": {
+ "description": "A binding parameter for a GQL query.",
+ "type": "object",
"properties": {
"cursor": {
"format": "byte",
@@ -598,9 +829,7 @@
"description": "A value parameter."
}
},
- "id": "GqlQueryParameter",
- "description": "A binding parameter for a GQL query.",
- "type": "object"
+ "id": "GqlQueryParameter"
},
"BeginTransactionResponse": {
"properties": {
@@ -614,31 +843,23 @@
"description": "The response for Datastore.BeginTransaction.",
"type": "object"
},
- "AllocateIdsRequest": {
- "id": "AllocateIdsRequest",
- "description": "The request for Datastore.AllocateIds.",
+ "RunQueryResponse": {
+ "description": "The response for Datastore.RunQuery.",
"type": "object",
"properties": {
- "keys": {
- "description": "A list of keys with incomplete key paths for which to allocate IDs.\nNo key may be reserved/read-only.",
- "items": {
- "$ref": "Key"
- },
- "type": "array"
+ "batch": {
+ "description": "A batch of query results (always present).",
+ "$ref": "QueryResultBatch"
+ },
+ "query": {
+ "description": "The parsed form of the `GqlQuery` from the request, if it was set.",
+ "$ref": "Query"
}
- }
+ },
+ "id": "RunQueryResponse"
},
"LookupResponse": {
- "description": "The response for Datastore.Lookup.",
- "type": "object",
"properties": {
- "deferred": {
- "description": "A list of keys that were not looked up due to resource constraints. The\norder of results in this field is undefined and has no relation to the\norder of the keys in the input.",
- "items": {
- "$ref": "Key"
- },
- "type": "array"
- },
"missing": {
"description": "Entities not found as `ResultType.KEY_ONLY` entities. The order of results\nin this field is undefined and has no relation to the order of the keys\nin the input.",
"items": {
@@ -652,24 +873,76 @@
"$ref": "EntityResult"
},
"type": "array"
+ },
+ "deferred": {
+ "description": "A list of keys that were not looked up due to resource constraints. The\norder of results in this field is undefined and has no relation to the\norder of the keys in the input.",
+ "items": {
+ "$ref": "Key"
+ },
+ "type": "array"
}
},
- "id": "LookupResponse"
+ "id": "LookupResponse",
+ "description": "The response for Datastore.Lookup.",
+ "type": "object"
},
- "RunQueryResponse": {
- "description": "The response for Datastore.RunQuery.",
+ "AllocateIdsRequest": {
+ "description": "The request for Datastore.AllocateIds.",
"type": "object",
"properties": {
- "query": {
- "$ref": "Query",
- "description": "The parsed form of the `GqlQuery` from the request, if it was set."
- },
- "batch": {
- "$ref": "QueryResultBatch",
- "description": "A batch of query results (always present)."
+ "keys": {
+ "description": "A list of keys with incomplete key paths for which to allocate IDs.\nNo key may be reserved/read-only.",
+ "items": {
+ "$ref": "Key"
+ },
+ "type": "array"
}
},
- "id": "RunQueryResponse"
+ "id": "AllocateIdsRequest"
+ },
+ "CommitRequest": {
+ "description": "The request for Datastore.Commit.",
+ "type": "object",
+ "properties": {
+ "transaction": {
+ "format": "byte",
+ "description": "The identifier of the transaction associated with the commit. A\ntransaction identifier is returned by a call to\nDatastore.BeginTransaction.",
+ "type": "string"
+ },
+ "mode": {
+ "enum": [
+ "MODE_UNSPECIFIED",
+ "TRANSACTIONAL",
+ "NON_TRANSACTIONAL"
+ ],
+ "description": "The type of commit to perform. Defaults to `TRANSACTIONAL`.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified. This value must not be used.",
+ "Transactional: The mutations are either all applied, or none are applied.\nLearn about transactions [here](https://cloud.google.com/datastore/docs/concepts/transactions).",
+ "Non-transactional: The mutations may not apply as all or none."
+ ]
+ },
+ "mutations": {
+ "description": "The mutations to perform.\n\nWhen mode is `TRANSACTIONAL`, mutations affecting a single entity are\napplied in order. The following sequences of mutations affecting a single\nentity are not permitted in a single `Commit` request:\n\n- `insert` followed by `insert`\n- `update` followed by `insert`\n- `upsert` followed by `insert`\n- `delete` followed by `update`\n\nWhen mode is `NON_TRANSACTIONAL`, no two mutations may affect a single\nentity.",
+ "items": {
+ "$ref": "Mutation"
+ },
+ "type": "array"
+ }
+ },
+ "id": "CommitRequest"
+ },
+ "BeginTransactionRequest": {
+ "description": "The request for Datastore.BeginTransaction.",
+ "type": "object",
+ "properties": {
+ "transactionOptions": {
+ "$ref": "TransactionOptions",
+ "description": "Options for a new transaction."
+ }
+ },
+ "id": "BeginTransactionRequest"
},
"PropertyOrder": {
"description": "The desired order for a specific property.",
@@ -690,58 +963,13 @@
"type": "string"
},
"property": {
- "$ref": "PropertyReference",
- "description": "The property to order by."
+ "description": "The property to order by.",
+ "$ref": "PropertyReference"
}
},
"id": "PropertyOrder"
},
- "CommitRequest": {
- "description": "The request for Datastore.Commit.",
- "type": "object",
- "properties": {
- "mode": {
- "enumDescriptions": [
- "Unspecified. This value must not be used.",
- "Transactional: The mutations are either all applied, or none are applied.\nLearn about transactions [here](https://cloud.google.com/datastore/docs/concepts/transactions).",
- "Non-transactional: The mutations may not apply as all or none."
- ],
- "enum": [
- "MODE_UNSPECIFIED",
- "TRANSACTIONAL",
- "NON_TRANSACTIONAL"
- ],
- "description": "The type of commit to perform. Defaults to `TRANSACTIONAL`.",
- "type": "string"
- },
- "mutations": {
- "description": "The mutations to perform.\n\nWhen mode is `TRANSACTIONAL`, mutations affecting a single entity are\napplied in order. The following sequences of mutations affecting a single\nentity are not permitted in a single `Commit` request:\n\n- `insert` followed by `insert`\n- `update` followed by `insert`\n- `upsert` followed by `insert`\n- `delete` followed by `update`\n\nWhen mode is `NON_TRANSACTIONAL`, no two mutations may affect a single\nentity.",
- "items": {
- "$ref": "Mutation"
- },
- "type": "array"
- },
- "transaction": {
- "format": "byte",
- "description": "The identifier of the transaction associated with the commit. A\ntransaction identifier is returned by a call to\nDatastore.BeginTransaction.",
- "type": "string"
- }
- },
- "id": "CommitRequest"
- },
- "BeginTransactionRequest": {
- "description": "The request for Datastore.BeginTransaction.",
- "type": "object",
- "properties": {
- "transactionOptions": {
- "$ref": "TransactionOptions",
- "description": "Options for a new transaction."
- }
- },
- "id": "BeginTransactionRequest"
- },
"KindExpression": {
- "type": "object",
"properties": {
"name": {
"description": "The name of the kind.",
@@ -749,11 +977,10 @@
}
},
"id": "KindExpression",
- "description": "A representation of a kind."
+ "description": "A representation of a kind.",
+ "type": "object"
},
"LatLng": {
- "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.\n\nExample of normalization code in Python:\n\n def NormalizeLongitude(longitude):\n \"\"\"Wraps decimal degrees longitude to [-180.0, 180.0].\"\"\"\n q, r = divmod(longitude, 360.0)\n if r \u003e 180.0 or (r == 180.0 and q \u003c= -1.0):\n return r - 360.0\n return r\n\n def NormalizeLatLng(latitude, longitude):\n \"\"\"Wraps decimal degrees latitude and longitude to\n [-90.0, 90.0] and [-180.0, 180.0], respectively.\"\"\"\n r = latitude % 360.0\n if r \u003c= 90.0:\n return r, NormalizeLongitude(longitude)\n elif r \u003e= 270.0:\n return r - 360, NormalizeLongitude(longitude)\n else:\n return 180 - r, NormalizeLongitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLongitude(181.0)\n assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)\n assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)\n assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)\n assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)\n assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)\n assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)\n assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)\n assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)",
- "type": "object",
"properties": {
"latitude": {
"format": "double",
@@ -766,7 +993,9 @@
"type": "number"
}
},
- "id": "LatLng"
+ "id": "LatLng",
+ "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.\n\nExample of normalization code in Python:\n\n def NormalizeLongitude(longitude):\n \"\"\"Wraps decimal degrees longitude to [-180.0, 180.0].\"\"\"\n q, r = divmod(longitude, 360.0)\n if r \u003e 180.0 or (r == 180.0 and q \u003c= -1.0):\n return r - 360.0\n return r\n\n def NormalizeLatLng(latitude, longitude):\n \"\"\"Wraps decimal degrees latitude and longitude to\n [-90.0, 90.0] and [-180.0, 180.0], respectively.\"\"\"\n r = latitude % 360.0\n if r \u003c= 90.0:\n return r, NormalizeLongitude(longitude)\n elif r \u003e= 270.0:\n return r - 360, NormalizeLongitude(longitude)\n else:\n return 180 - r, NormalizeLongitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLongitude(181.0)\n assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)\n assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)\n assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)\n assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)\n assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)\n assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)\n assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)\n assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)",
+ "type": "object"
},
"Key": {
"description": "A unique identifier for an entity.\nIf a key's partition ID or any of its path kinds or names are\nreserved/read-only, the key is reserved/read-only.\nA reserved/read-only key is forbidden in certain documented contexts.",
@@ -780,33 +1009,12 @@
"type": "array"
},
"partitionId": {
- "$ref": "PartitionId",
- "description": "Entities are partitioned into subsets, currently identified by a project\nID and namespace ID.\nQueries are scoped to a single partition."
+ "description": "Entities are partitioned into subsets, currently identified by a project\nID and namespace ID.\nQueries are scoped to a single partition.",
+ "$ref": "PartitionId"
}
},
"id": "Key"
},
- "GoogleDatastoreAdminV1beta1EntityFilter": {
- "properties": {
- "kinds": {
- "description": "If empty, then this represents all kinds.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "namespaceIds": {
- "description": "An empty list represents all namespaces. This is the preferred\nusage for projects that don't use namespaces.\n\nAn empty string element represents the default namespace. This should be\nused if the project has data in non-default namespaces, but doesn't want to\ninclude them.\nEach namespace in this list must be unique.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "GoogleDatastoreAdminV1beta1EntityFilter",
- "description": "Identifies a subset of entities in a project. This is specified as\ncombinations of kinds and namespaces (either or both of which may be all, as\ndescribed in the following examples).\nExample usage:\n\nEntire project:\n kinds=[], namespace_ids=[]\n\nKinds Foo and Bar in all namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=[]\n\nKinds Foo and Bar only in the default namespace:\n kinds=['Foo', 'Bar'], namespace_ids=['']\n\nKinds Foo and Bar in both the default and Baz namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz']\n\nThe entire Baz namespace:\n kinds=[], namespace_ids=['Baz']",
- "type": "object"
- },
"PropertyReference": {
"description": "A reference to a property relative to the kind expressions.",
"type": "object",
@@ -818,15 +1026,35 @@
},
"id": "PropertyReference"
},
- "GoogleDatastoreAdminV1beta1CommonMetadata": {
+ "GoogleDatastoreAdminV1beta1EntityFilter": {
+ "description": "Identifies a subset of entities in a project. This is specified as\ncombinations of kinds and namespaces (either or both of which may be all, as\ndescribed in the following examples).\nExample usage:\n\nEntire project:\n kinds=[], namespace_ids=[]\n\nKinds Foo and Bar in all namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=[]\n\nKinds Foo and Bar only in the default namespace:\n kinds=['Foo', 'Bar'], namespace_ids=['']\n\nKinds Foo and Bar in both the default and Baz namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz']\n\nThe entire Baz namespace:\n kinds=[], namespace_ids=['Baz']",
"type": "object",
"properties": {
+ "namespaceIds": {
+ "description": "An empty list represents all namespaces. This is the preferred\nusage for projects that don't use namespaces.\n\nAn empty string element represents the default namespace. This should be\nused if the project has data in non-default namespaces, but doesn't want to\ninclude them.\nEach namespace in this list must be unique.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "kinds": {
+ "description": "If empty, then this represents all kinds.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "GoogleDatastoreAdminV1beta1EntityFilter"
+ },
+ "GoogleDatastoreAdminV1beta1CommonMetadata": {
+ "properties": {
"labels": {
- "description": "The client-assigned labels which were provided when the operation was\ncreated. May also include additional labels.",
- "type": "object",
"additionalProperties": {
"type": "string"
- }
+ },
+ "description": "The client-assigned labels which were provided when the operation was\ncreated. May also include additional labels.",
+ "type": "object"
},
"endTime": {
"format": "google-datetime",
@@ -834,8 +1062,6 @@
"type": "string"
},
"state": {
- "description": "The current state of the Operation.",
- "type": "string",
"enumDescriptions": [
"Unspecified.",
"Request is being prepared for processing.",
@@ -855,11 +1081,11 @@
"SUCCESSFUL",
"FAILED",
"CANCELLED"
- ]
+ ],
+ "description": "The current state of the Operation.",
+ "type": "string"
},
"operationType": {
- "description": "The type of the operation. Can be used as a filter in\nListOperationsRequest.",
- "type": "string",
"enumDescriptions": [
"Unspecified.",
"ExportEntities.",
@@ -869,7 +1095,9 @@
"OPERATION_TYPE_UNSPECIFIED",
"EXPORT_ENTITIES",
"IMPORT_ENTITIES"
- ]
+ ],
+ "description": "The type of the operation. Can be used as a filter in\nListOperationsRequest.",
+ "type": "string"
},
"startTime": {
"format": "google-datetime",
@@ -878,18 +1106,19 @@
}
},
"id": "GoogleDatastoreAdminV1beta1CommonMetadata",
- "description": "Metadata common to all Datastore Admin operations."
+ "description": "Metadata common to all Datastore Admin operations.",
+ "type": "object"
},
"Projection": {
+ "description": "A representation of a property in a projection.",
+ "type": "object",
"properties": {
"property": {
- "description": "The property to project.",
- "$ref": "PropertyReference"
+ "$ref": "PropertyReference",
+ "description": "The property to project."
}
},
- "id": "Projection",
- "description": "A representation of a property in a projection.",
- "type": "object"
+ "id": "Projection"
},
"ArrayValue": {
"properties": {
@@ -907,6 +1136,10 @@
},
"Mutation": {
"properties": {
+ "delete": {
+ "description": "The key of the entity to delete. The entity may or may not already exist.\nMust have a complete key path and must not be reserved/read-only.",
+ "$ref": "Key"
+ },
"baseVersion": {
"format": "int64",
"description": "The version of the entity that this mutation is being applied to. If this\ndoes not match the current version on the server, the mutation conflicts.",
@@ -921,12 +1154,8 @@
"description": "The entity to update. The entity must already exist.\nMust have a complete key path."
},
"upsert": {
- "description": "The entity to upsert. The entity may or may not already exist.\nThe entity key's final path element may be incomplete.",
- "$ref": "Entity"
- },
- "delete": {
- "description": "The key of the entity to delete. The entity may or may not already exist.\nMust have a complete key path and must not be reserved/read-only.",
- "$ref": "Key"
+ "$ref": "Entity",
+ "description": "The entity to upsert. The entity may or may not already exist.\nThe entity key's final path element may be incomplete."
}
},
"id": "Mutation",
@@ -943,7 +1172,6 @@
"type": "string"
},
"readConsistency": {
- "type": "string",
"enumDescriptions": [
"Unspecified. This value must not be used.",
"Strong consistency.",
@@ -954,7 +1182,8 @@
"STRONG",
"EVENTUAL"
],
- "description": "The non-transactional read consistency to use.\nCannot be set to `STRONG` for global queries."
+ "description": "The non-transactional read consistency to use.\nCannot be set to `STRONG` for global queries.",
+ "type": "string"
}
},
"id": "ReadOptions"
@@ -966,7 +1195,6 @@
"type": "object"
},
"GoogleDatastoreAdminV1beta1ExportEntitiesResponse": {
- "type": "object",
"properties": {
"outputUrl": {
"description": "Location of the output metadata file. This can be used to begin an import\ninto Cloud Datastore (this project or another project). See\ngoogle.datastore.admin.v1beta1.ImportEntitiesRequest.input_url.\nOnly present if the operation completed successfully.",
@@ -974,15 +1202,13 @@
}
},
"id": "GoogleDatastoreAdminV1beta1ExportEntitiesResponse",
- "description": "The response for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities."
+ "description": "The response for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities.",
+ "type": "object"
},
"MutationResult": {
+ "description": "The result of applying a mutation.",
"type": "object",
"properties": {
- "key": {
- "description": "The automatically allocated key.\nSet only when the mutation allocated a key.",
- "$ref": "Key"
- },
"version": {
"format": "int64",
"description": "The version of the entity on the server after processing the mutation. If\nthe mutation doesn't change anything on the server, then the version will\nbe the version of the current entity or, if no entity is present, a version\nthat is strictly greater than the version of any previous entity and less\nthan the version of any possible future entity.",
@@ -991,14 +1217,15 @@
"conflictDetected": {
"description": "Whether a conflict was detected for this mutation. Always false when a\nconflict detection strategy field is not set in the mutation.",
"type": "boolean"
+ },
+ "key": {
+ "description": "The automatically allocated key.\nSet only when the mutation allocated a key.",
+ "$ref": "Key"
}
},
- "id": "MutationResult",
- "description": "The result of applying a mutation."
+ "id": "MutationResult"
},
"GqlQuery": {
- "description": "A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).",
- "type": "object",
"properties": {
"queryString": {
"description": "A string of the format described\n[here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).",
@@ -1023,256 +1250,29 @@
"type": "boolean"
}
},
- "id": "GqlQuery"
+ "id": "GqlQuery",
+ "description": "A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).",
+ "type": "object"
},
"Filter": {
"description": "A holder for any type of filter.",
"type": "object",
"properties": {
"compositeFilter": {
- "$ref": "CompositeFilter",
- "description": "A composite filter."
+ "description": "A composite filter.",
+ "$ref": "CompositeFilter"
},
"propertyFilter": {
- "$ref": "PropertyFilter",
- "description": "A filter on a property."
+ "description": "A filter on a property.",
+ "$ref": "PropertyFilter"
}
},
"id": "Filter"
- },
- "RunQueryRequest": {
- "description": "The request for Datastore.RunQuery.",
- "type": "object",
- "properties": {
- "gqlQuery": {
- "$ref": "GqlQuery",
- "description": "The GQL query to run."
- },
- "partitionId": {
- "$ref": "PartitionId",
- "description": "Entities are partitioned into subsets, identified by a partition ID.\nQueries are scoped to a single partition.\nThis partition ID is normalized with the standard default context\npartition ID."
- },
- "readOptions": {
- "$ref": "ReadOptions",
- "description": "The options for this query."
- },
- "query": {
- "description": "The query to run.",
- "$ref": "Query"
- }
- },
- "id": "RunQueryRequest"
- },
- "RollbackRequest": {
- "description": "The request for Datastore.Rollback.",
- "type": "object",
- "properties": {
- "transaction": {
- "format": "byte",
- "description": "The transaction identifier, returned by a call to\nDatastore.BeginTransaction.",
- "type": "string"
- }
- },
- "id": "RollbackRequest"
- },
- "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata": {
- "description": "Metadata for ExportEntities operations.",
- "type": "object",
- "properties": {
- "progressBytes": {
- "$ref": "GoogleDatastoreAdminV1beta1Progress",
- "description": "An estimate of the number of bytes processed."
- },
- "outputUrlPrefix": {
- "description": "Location for the export metadata and data files. This will be the same\nvalue as the\ngoogle.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix\nfield. The final output location is provided in\ngoogle.datastore.admin.v1beta1.ExportEntitiesResponse.output_url.",
- "type": "string"
- },
- "entityFilter": {
- "$ref": "GoogleDatastoreAdminV1beta1EntityFilter",
- "description": "Description of which entities are being exported."
- },
- "progressEntities": {
- "$ref": "GoogleDatastoreAdminV1beta1Progress",
- "description": "An estimate of the number of entities processed."
- },
- "common": {
- "description": "Metadata common to all Datastore Admin operations.",
- "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata"
- }
- },
- "id": "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata"
- },
- "TransactionOptions": {
- "description": "Options for beginning a new transaction.\n\nTransactions can be created explicitly with calls to\nDatastore.BeginTransaction or implicitly by setting\nReadOptions.new_transaction in read requests.",
- "type": "object",
- "properties": {
- "readOnly": {
- "description": "The transaction should only allow reads.",
- "$ref": "ReadOnly"
- },
- "readWrite": {
- "$ref": "ReadWrite",
- "description": "The transaction should allow both reads and writes."
- }
- },
- "id": "TransactionOptions"
- },
- "CompositeFilter": {
- "id": "CompositeFilter",
- "description": "A filter that merges multiple other filters using the given operator.",
- "type": "object",
- "properties": {
- "op": {
- "enum": [
- "OPERATOR_UNSPECIFIED",
- "AND"
- ],
- "description": "The operator for combining multiple filters.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified. This value must not be used.",
- "The results are required to satisfy each of the combined filters."
- ]
- },
- "filters": {
- "description": "The list of filters to combine.\nMust contain at least one filter.",
- "items": {
- "$ref": "Filter"
- },
- "type": "array"
- }
- }
- },
- "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata": {
- "description": "Metadata for ImportEntities operations.",
- "type": "object",
- "properties": {
- "progressEntities": {
- "$ref": "GoogleDatastoreAdminV1beta1Progress",
- "description": "An estimate of the number of entities processed."
- },
- "common": {
- "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata",
- "description": "Metadata common to all Datastore Admin operations."
- },
- "inputUrl": {
- "description": "The location of the import metadata file. This will be the same value as\nthe google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url\nfield.",
- "type": "string"
- },
- "progressBytes": {
- "description": "An estimate of the number of bytes processed.",
- "$ref": "GoogleDatastoreAdminV1beta1Progress"
- },
- "entityFilter": {
- "description": "Description of which entities are being imported.",
- "$ref": "GoogleDatastoreAdminV1beta1EntityFilter"
- }
- },
- "id": "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata"
- },
- "AllocateIdsResponse": {
- "description": "The response for Datastore.AllocateIds.",
- "type": "object",
- "properties": {
- "keys": {
- "items": {
- "$ref": "Key"
- },
- "type": "array",
- "description": "The keys specified in the request (in the same order), each with\nits key path completed with a newly allocated ID."
- }
- },
- "id": "AllocateIdsResponse"
- },
- "Query": {
- "id": "Query",
- "description": "A query for entities.",
- "type": "object",
- "properties": {
- "order": {
- "description": "The order to apply to the query results (if empty, order is unspecified).",
- "items": {
- "$ref": "PropertyOrder"
- },
- "type": "array"
- },
- "projection": {
- "description": "The projection to return. Defaults to returning all properties.",
- "items": {
- "$ref": "Projection"
- },
- "type": "array"
- },
- "endCursor": {
- "format": "byte",
- "description": "An ending point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to limit the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).",
- "type": "string"
- },
- "filter": {
- "$ref": "Filter",
- "description": "The filter to apply."
- },
- "limit": {
- "format": "int32",
- "description": "The maximum number of results to return. Applies after all other\nconstraints. Optional.\nUnspecified is interpreted as no limit.\nMust be \u003e= 0 if specified.",
- "type": "integer"
- },
- "startCursor": {
- "format": "byte",
- "description": "A starting point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to continue the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).",
- "type": "string"
- },
- "offset": {
- "format": "int32",
- "description": "The number of results to skip. Applies before limit, but after all other\nconstraints. Optional. Must be \u003e= 0 if specified.",
- "type": "integer"
- },
- "kind": {
- "description": "The kinds to query (if empty, returns entities of all kinds).\nCurrently at most 1 kind may be specified.",
- "items": {
- "$ref": "KindExpression"
- },
- "type": "array"
- },
- "distinctOn": {
- "description": "The properties to make distinct. The query results will contain the first\nresult for each distinct combination of values for the given properties\n(if empty, all results are returned).",
- "items": {
- "$ref": "PropertyReference"
- },
- "type": "array"
- }
- }
}
},
- "protocol": "rest",
"icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
},
- "version": "v1beta3",
- "baseUrl": "https://datastore.googleapis.com/",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/datastore": {
- "description": "View and manage your Google Cloud Datastore data"
- }
- }
- }
- },
- "servicePath": "",
- "description": "Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application.\n",
- "kind": "discovery#restDescription",
- "rootUrl": "https://datastore.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "datastore",
- "batchPath": "batch",
- "revision": "20171003",
- "id": "datastore:v1beta3",
- "documentationLink": "https://cloud.google.com/datastore/",
- "title": "Google Cloud Datastore API"
+ "protocol": "rest"
}
diff --git a/dlp/v2beta1/dlp-api.json b/dlp/v2beta1/dlp-api.json
index 2d7f4d1..ad8b7bd 100644
--- a/dlp/v2beta1/dlp-api.json
+++ b/dlp/v2beta1/dlp-api.json
@@ -1,436 +1,35 @@
{
- "revision": "20171003",
+ "revision": "20171010",
"documentationLink": "https://cloud.google.com/dlp/docs/",
"id": "dlp:v2beta1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "GooglePrivacyDlpV2beta1Location": {
- "description": "Specifies the location of a finding within its source item.",
- "type": "object",
- "properties": {
- "tableLocation": {
- "$ref": "GooglePrivacyDlpV2beta1TableLocation",
- "description": "Location within a `ContentItem.Table`."
- },
- "codepointRange": {
- "description": "Character offsets within a content item, included when content type\nis a text. Default charset assumed to be UTF-8.",
- "$ref": "GooglePrivacyDlpV2beta1Range"
- },
- "fieldId": {
- "description": "Field id of the field containing the finding.",
- "$ref": "GooglePrivacyDlpV2beta1FieldId"
- },
- "imageBoxes": {
- "description": "Location within an image's pixels.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1ImageLocation"
- }
- },
- "byteRange": {
- "description": "Zero-based byte offsets within a content item.",
- "$ref": "GooglePrivacyDlpV2beta1Range"
- },
- "recordKey": {
- "description": "Key of the finding.",
- "$ref": "GooglePrivacyDlpV2beta1RecordKey"
- }
- },
- "id": "GooglePrivacyDlpV2beta1Location"
- },
- "GooglePrivacyDlpV2beta1RecordSuppression": {
- "properties": {
- "condition": {
- "$ref": "GooglePrivacyDlpV2beta1RecordCondition"
- }
- },
- "id": "GooglePrivacyDlpV2beta1RecordSuppression",
- "description": "Configuration to suppress records whose suppression conditions evaluate to\ntrue.",
- "type": "object"
- },
- "GooglePrivacyDlpV2beta1UnwrappedCryptoKey": {
- "description": "Using raw keys is prone to security risks due to accidentally\nleaking the key. Choose another type of key if possible.",
- "type": "object",
- "properties": {
- "key": {
- "description": "The AES 128/192/256 bit key. [required]",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta1UnwrappedCryptoKey"
- },
- "GooglePrivacyDlpV2beta1EntityId": {
- "description": "An entity in a dataset is a field or set of fields that correspond to a\nsingle person. For example, in medical records the `EntityId` might be\na patient identifier, or for financial records it might be an account\nidentifier. This message is used when generalizations or analysis must be\nconsistent across multiple rows pertaining to the same entity.",
- "type": "object",
- "properties": {
- "field": {
- "$ref": "GooglePrivacyDlpV2beta1FieldId",
- "description": "Composite key indicating which field contains the entity identifier."
- }
- },
- "id": "GooglePrivacyDlpV2beta1EntityId"
- },
- "GooglePrivacyDlpV2beta1InfoTypeDescription": {
- "description": "Description of the information type (infoType).",
- "type": "object",
- "properties": {
- "categories": {
- "description": "List of categories this infoType belongs to.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1CategoryDescription"
- }
- },
- "name": {
- "description": "Internal name of the infoType.",
- "type": "string"
- },
- "displayName": {
- "description": "Human readable form of the infoType name.",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta1InfoTypeDescription"
- },
- "GoogleRpcStatus": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "type": "array",
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- }
- },
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- }
- },
- "id": "GoogleRpcStatus"
- },
- "GooglePrivacyDlpV2beta1PathElement": {
- "description": "A (kind, ID/name) pair used to construct a key path.\n\nIf either name or ID is set, the element is complete.\nIf neither is set, the element is incomplete.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
- "type": "string"
- },
- "kind": {
- "description": "The kind of the entity.\nA kind matching regex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
- "type": "string"
- },
- "id": {
- "description": "The auto-allocated ID of the entity.\nNever equal to zero. Values less than zero are discouraged and may not\nbe supported in the future.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta1PathElement"
- },
- "GooglePrivacyDlpV2beta1SummaryResult": {
- "description": "A collection that informs the user the number of times a particular\n`TransformationResultCode` and error details occurred.",
- "type": "object",
- "properties": {
- "details": {
- "description": "A place for warnings or errors to show up if a transformation didn't\nwork as expected.",
- "type": "string"
- },
- "count": {
- "format": "int64",
- "type": "string"
- },
- "code": {
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "enum": [
- "TRANSFORMATION_RESULT_CODE_UNSPECIFIED",
- "SUCCESS",
- "ERROR"
- ],
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta1SummaryResult"
- },
- "GooglePrivacyDlpV2beta1BigQueryTable": {
- "description": "Message defining the location of a BigQuery table. A table is uniquely\nidentified by its project_id, dataset_id, and table_name. Within a query\na table is often referenced with a string in the format of:\n`\u003cproject_id\u003e:\u003cdataset_id\u003e.\u003ctable_id\u003e` or\n`\u003cproject_id\u003e.\u003cdataset_id\u003e.\u003ctable_id\u003e`.",
- "type": "object",
- "properties": {
- "datasetId": {
- "description": "Dataset ID of the table.",
- "type": "string"
- },
- "tableId": {
- "description": "Name of the table.",
- "type": "string"
- },
- "projectId": {
- "description": "The Google Cloud Platform project ID of the project containing the table.\nIf omitted, project ID is inferred from the API call.",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta1BigQueryTable"
- },
- "GooglePrivacyDlpV2beta1InfoTypeTransformations": {
- "description": "A type of transformation that will scan unstructured text and\napply various `PrimitiveTransformation`s to each finding, where the\ntransformation is applied to only values that were identified as a specific\ninfo_type.",
- "type": "object",
- "properties": {
- "transformations": {
- "description": "Transformation for each info type. Cannot specify more than one\nfor a given info type. [required]",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1InfoTypeTransformation"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta1InfoTypeTransformations"
- },
- "GooglePrivacyDlpV2beta1ListRootCategoriesResponse": {
- "description": "Response for ListRootCategories request.",
- "type": "object",
- "properties": {
- "categories": {
- "description": "List of all into type categories supported by the API.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1CategoryDescription"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta1ListRootCategoriesResponse"
- },
- "GooglePrivacyDlpV2beta1KindExpression": {
- "description": "A representation of a Datastore kind.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The name of the kind.",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta1KindExpression"
- },
- "GooglePrivacyDlpV2beta1FileSet": {
- "description": "Set of files to scan.",
- "type": "object",
- "properties": {
- "url": {
- "description": "The url, in the format `gs://\u003cbucket\u003e/\u003cpath\u003e`. Trailing wildcard in the\npath is allowed.",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta1FileSet"
- },
- "GooglePrivacyDlpV2beta1AnalyzeDataSourceRiskRequest": {
- "description": "Request for creating a risk analysis operation.",
- "type": "object",
- "properties": {
- "privacyMetric": {
- "description": "Privacy metric to compute.",
- "$ref": "GooglePrivacyDlpV2beta1PrivacyMetric"
- },
- "sourceTable": {
- "description": "Input dataset to compute metrics over.",
- "$ref": "GooglePrivacyDlpV2beta1BigQueryTable"
- }
- },
- "id": "GooglePrivacyDlpV2beta1AnalyzeDataSourceRiskRequest"
- },
- "GooglePrivacyDlpV2beta1InfoTypeTransformation": {
- "description": "A transformation to apply to text that is identified as a specific\ninfo_type.",
- "type": "object",
- "properties": {
- "infoTypes": {
- "description": "Info types to apply the transformation to. Empty list will match all\navailable info types for this transformation.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1InfoType"
- }
- },
- "primitiveTransformation": {
- "$ref": "GooglePrivacyDlpV2beta1PrimitiveTransformation",
- "description": "Primitive transformation to apply to the info type. [required]"
- }
- },
- "id": "GooglePrivacyDlpV2beta1InfoTypeTransformation"
- },
- "GooglePrivacyDlpV2beta1Bucket": {
- "description": "Buckets represented as ranges, along with replacement values. Ranges must\nbe non-overlapping.",
- "type": "object",
- "properties": {
- "min": {
- "description": "Lower bound of the range, inclusive. Type should be the same as max if\nused.",
- "$ref": "GooglePrivacyDlpV2beta1Value"
- },
- "max": {
- "description": "Upper bound of the range, exclusive; type must match min.",
- "$ref": "GooglePrivacyDlpV2beta1Value"
- },
- "replacementValue": {
- "$ref": "GooglePrivacyDlpV2beta1Value",
- "description": "Replacement value for this bucket. If not provided\nthe default behavior will be to hyphenate the min-max range."
- }
- },
- "id": "GooglePrivacyDlpV2beta1Bucket"
- },
- "GooglePrivacyDlpV2beta1KAnonymityResult": {
- "description": "Result of the k-anonymity computation.",
- "type": "object",
- "properties": {
- "equivalenceClassHistogramBuckets": {
- "description": "Histogram of k-anonymity equivalence classes.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1KAnonymityHistogramBucket"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta1KAnonymityResult"
- },
- "GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket": {
- "description": "Histogram bucket of value frequencies in the column.",
- "type": "object",
- "properties": {
- "valueFrequencyUpperBound": {
- "description": "Upper bound on the value frequency of the values in this bucket.",
- "format": "int64",
- "type": "string"
- },
- "valueFrequencyLowerBound": {
- "description": "Lower bound on the value frequency of the values in this bucket.",
- "format": "int64",
- "type": "string"
- },
- "bucketValues": {
- "description": "Sample of value frequencies in this bucket. The total number of\nvalues returned per bucket is capped at 20.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1ValueFrequency"
- }
- },
- "bucketSize": {
- "description": "Total number of records in this bucket.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket"
- },
- "GooglePrivacyDlpV2beta1TableLocation": {
- "description": "Location of a finding within a `ContentItem.Table`.",
- "type": "object",
- "properties": {
- "rowIndex": {
- "description": "The zero-based index of the row where the finding is located.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta1TableLocation"
- },
- "GooglePrivacyDlpV2beta1KAnonymityConfig": {
- "description": "k-anonymity metric, used for analysis of reidentification risk.",
- "type": "object",
- "properties": {
- "entityId": {
- "description": "Optional message indicating that each distinct `EntityId` should not\ncontribute to the k-anonymity count more than once per equivalence class.",
- "$ref": "GooglePrivacyDlpV2beta1EntityId"
- },
- "quasiIds": {
- "description": "Set of fields to compute k-anonymity over. When multiple fields are\nspecified, they are considered a single composite key. Structs and\nrepeated data types are not supported; however, nested fields are\nsupported so long as they are not structs themselves or nested within\na repeated field.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1FieldId"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta1KAnonymityConfig"
- },
- "GooglePrivacyDlpV2beta1DatastoreKey": {
- "description": "Record key for a finding in Cloud Datastore.",
- "type": "object",
- "properties": {
- "entityKey": {
- "description": "Datastore entity key.",
- "$ref": "GooglePrivacyDlpV2beta1Key"
- }
- },
- "id": "GooglePrivacyDlpV2beta1DatastoreKey"
- },
- "GooglePrivacyDlpV2beta1RecordKey": {
- "description": "Message for a unique key indicating a record that contains a finding.",
- "type": "object",
- "properties": {
- "datastoreKey": {
- "$ref": "GooglePrivacyDlpV2beta1DatastoreKey"
- },
- "cloudStorageKey": {
- "$ref": "GooglePrivacyDlpV2beta1CloudStorageKey"
- }
- },
- "id": "GooglePrivacyDlpV2beta1RecordKey"
- },
- "GooglePrivacyDlpV2beta1DeidentifyContentRequest": {
- "properties": {
- "items": {
- "description": "The list of items to inspect. Up to 100 are allowed per request.\nAll items will be treated as text/*.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1ContentItem"
- }
- },
- "deidentifyConfig": {
- "$ref": "GooglePrivacyDlpV2beta1DeidentifyConfig",
- "description": "Configuration for the de-identification of the list of content items."
- },
- "inspectConfig": {
- "$ref": "GooglePrivacyDlpV2beta1InspectConfig",
- "description": "Configuration for the inspector."
- }
- },
- "id": "GooglePrivacyDlpV2beta1DeidentifyContentRequest",
- "description": "Request to de-identify a list of items.",
- "type": "object"
- },
"GooglePrivacyDlpV2beta1InspectResult": {
- "description": "All the findings for a single scanned item.",
- "type": "object",
"properties": {
- "findingsTruncated": {
- "description": "If true, then this item might have more findings than were returned,\nand the findings returned are an arbitrary subset of all findings.\nThe findings list might be truncated because the input items were too\nlarge, or because the server reached the maximum amount of resources\nallowed for a single API call. For best results, divide the input into\nsmaller batches.",
- "type": "boolean"
- },
"findings": {
"description": "List of findings for an item.",
"type": "array",
"items": {
"$ref": "GooglePrivacyDlpV2beta1Finding"
}
+ },
+ "findingsTruncated": {
+ "description": "If true, then this item might have more findings than were returned,\nand the findings returned are an arbitrary subset of all findings.\nThe findings list might be truncated because the input items were too\nlarge, or because the server reached the maximum amount of resources\nallowed for a single API call. For best results, divide the input into\nsmaller batches.",
+ "type": "boolean"
}
},
- "id": "GooglePrivacyDlpV2beta1InspectResult"
+ "id": "GooglePrivacyDlpV2beta1InspectResult",
+ "description": "All the findings for a single scanned item.",
+ "type": "object"
},
"GooglePrivacyDlpV2beta1ImageLocation": {
- "description": "Bounding box encompassing detected text within an image.",
- "type": "object",
"properties": {
+ "width": {
+ "description": "Width of the bounding box in pixels.",
+ "format": "int32",
+ "type": "integer"
+ },
"height": {
"description": "Height of the bounding box in pixels.",
"format": "int32",
@@ -445,33 +44,32 @@
"description": "Left coordinate of the bounding box. (0,0) is upper left.",
"format": "int32",
"type": "integer"
- },
- "width": {
- "description": "Width of the bounding box in pixels.",
- "format": "int32",
- "type": "integer"
}
},
- "id": "GooglePrivacyDlpV2beta1ImageLocation"
+ "id": "GooglePrivacyDlpV2beta1ImageLocation",
+ "description": "Bounding box encompassing detected text within an image.",
+ "type": "object"
},
"GooglePrivacyDlpV2beta1ReplaceValueConfig": {
- "description": "Replace each input value with a given `Value`.",
- "type": "object",
"properties": {
"newValue": {
"description": "Value to replace it with.",
"$ref": "GooglePrivacyDlpV2beta1Value"
}
},
- "id": "GooglePrivacyDlpV2beta1ReplaceValueConfig"
+ "id": "GooglePrivacyDlpV2beta1ReplaceValueConfig",
+ "description": "Replace each input value with a given `Value`.",
+ "type": "object"
},
"GooglePrivacyDlpV2beta1ContentItem": {
- "description": "Container structure for the content to inspect.",
- "type": "object",
"properties": {
+ "value": {
+ "description": "String data to inspect or redact.",
+ "type": "string"
+ },
"table": {
- "$ref": "GooglePrivacyDlpV2beta1Table",
- "description": "Structured content for inspection."
+ "description": "Structured content for inspection.",
+ "$ref": "GooglePrivacyDlpV2beta1Table"
},
"data": {
"description": "Content data to inspect or redact.",
@@ -481,16 +79,20 @@
"type": {
"description": "Type of the content, as defined in Content-Type HTTP header.\nSupported types are: all \"text\" types, octet streams, PNG images,\nJPEG images.",
"type": "string"
- },
- "value": {
- "description": "String data to inspect or redact.",
- "type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta1ContentItem"
+ "id": "GooglePrivacyDlpV2beta1ContentItem",
+ "description": "Container structure for the content to inspect.",
+ "type": "object"
},
"GooglePrivacyDlpV2beta1CryptoReplaceFfxFpeConfig": {
+ "description": "Replaces an identifier with an surrogate using FPE with the FFX\nmode of operation.\nThe identifier must be representable by the US-ASCII character set.\nFor a given crypto key and context, the same identifier will be\nreplaced with the same surrogate.\nNote that a given identifier must be either the empty string or be at\nleast two characters long.",
+ "type": "object",
"properties": {
+ "context": {
+ "description": "A context may be used for higher security since the same\nidentifier in two different contexts likely will be given a distinct\nsurrogate. The principle is that the likeliness is inversely related\nto the ratio of the number of distinct identifiers per context over the\nnumber of possible surrogates: As long as this ratio is small, the\nlikehood is large.\n\nIf the context is not set, a default tweak will be used.\nIf the context is set but:\n\n1. there is no record present when transforming a given value or\n1. the field is not present when transforming a given value,\n\na default tweak will be used.\n\nNote that case (1) is expected when an `InfoTypeTransformation` is\napplied to both structured and non-structured `ContentItem`s.\nCurrently, the referenced field may be of value type integer or string.\n\nThe tweak is constructed as a sequence of bytes in big endian byte order\nsuch that:\n\n- a 64 bit integer is encoded followed by a single byte of value 1\n- a string is encoded in UTF-8 format followed by a single byte of value 2\n\nThis is also known as the 'tweak', as in tweakable encryption.",
+ "$ref": "GooglePrivacyDlpV2beta1FieldId"
+ },
"customAlphabet": {
"description": "This is supported by mapping these to the alphanumeric characters\nthat the FFX mode natively supports. This happens before/after\nencryption/decryption.\nEach character listed must appear only once.\nNumber of characters must be in the range [2, 62].\nThis must be encoded as ASCII.\nThe order of characters does not matter.",
"type": "string"
@@ -520,18 +122,19 @@
"description": "The native way to select the alphabet. Must be in the range [2, 62].",
"format": "int32",
"type": "integer"
- },
- "context": {
- "description": "A context may be used for higher security since the same\nidentifier in two different contexts likely will be given a distinct\nsurrogate. The principle is that the likeliness is inversely related\nto the ratio of the number of distinct identifiers per context over the\nnumber of possible surrogates: As long as this ratio is small, the\nlikehood is large.\n\nIf the context is not set, a default tweak will be used.\nIf the context is set but:\n\n1. there is no record present when transforming a given value or\n1. the field is not present when transforming a given value,\n\na default tweak will be used.\n\nNote that case (1) is expected when an `InfoTypeTransformation` is\napplied to both structured and non-structured `ContentItem`s.\nCurrently, the referenced field may be of value type integer or string.\n\nThe tweak is constructed as a sequence of bytes in big endian byte order\nsuch that:\n\n- a 64 bit integer is encoded followed by a single byte of value 1\n- a string is encoded in UTF-8 format followed by a single byte of value 2\n\nThis is also known as the 'tweak', as in tweakable encryption.",
- "$ref": "GooglePrivacyDlpV2beta1FieldId"
}
},
- "id": "GooglePrivacyDlpV2beta1CryptoReplaceFfxFpeConfig",
- "description": "Replaces an identifier with an surrogate using FPE with the FFX\nmode of operation.\nThe identifier must be representable by the US-ASCII character set.\nFor a given crypto key and context, the same identifier will be\nreplaced with the same surrogate.\nNote that a given identifier must be either the empty string or be at\nleast two characters long.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1CryptoReplaceFfxFpeConfig"
},
"GooglePrivacyDlpV2beta1Color": {
+ "description": "Represents a color in the RGB color space.",
+ "type": "object",
"properties": {
+ "red": {
+ "description": "The amount of red in the color as a value in the interval [0, 1].",
+ "format": "float",
+ "type": "number"
+ },
"green": {
"description": "The amount of green in the color as a value in the interval [0, 1].",
"format": "float",
@@ -541,39 +144,11 @@
"description": "The amount of blue in the color as a value in the interval [0, 1].",
"format": "float",
"type": "number"
- },
- "red": {
- "description": "The amount of red in the color as a value in the interval [0, 1].",
- "format": "float",
- "type": "number"
}
},
- "id": "GooglePrivacyDlpV2beta1Color",
- "description": "Represents a color in the RGB color space.",
- "type": "object"
- },
- "GooglePrivacyDlpV2beta1Table": {
- "properties": {
- "headers": {
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1FieldId"
- }
- },
- "rows": {
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1Row"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta1Table",
- "description": "Structured content to inspect. Up to 50,000 `Value`s per request allowed.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1Color"
},
"GooglePrivacyDlpV2beta1ValueFrequency": {
- "description": "A value of a field, including its frequency.",
- "type": "object",
"properties": {
"count": {
"description": "How many times the value is contained in the field.",
@@ -581,19 +156,40 @@
"type": "string"
},
"value": {
- "description": "A value contained in the field in question.",
- "$ref": "GooglePrivacyDlpV2beta1Value"
+ "$ref": "GooglePrivacyDlpV2beta1Value",
+ "description": "A value contained in the field in question."
}
},
- "id": "GooglePrivacyDlpV2beta1ValueFrequency"
+ "id": "GooglePrivacyDlpV2beta1ValueFrequency",
+ "description": "A value of a field, including its frequency.",
+ "type": "object"
+ },
+ "GooglePrivacyDlpV2beta1Table": {
+ "description": "Structured content to inspect. Up to 50,000 `Value`s per request allowed.",
+ "type": "object",
+ "properties": {
+ "rows": {
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1Row"
+ }
+ },
+ "headers": {
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1FieldId"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1Table"
},
"GooglePrivacyDlpV2beta1InfoTypeLimit": {
"description": "Max findings configuration per info type, per content item or long running\noperation.",
"type": "object",
"properties": {
"infoType": {
- "$ref": "GooglePrivacyDlpV2beta1InfoType",
- "description": "Type of information the findings limit applies to. Only one limit per\ninfo_type should be provided. If InfoTypeLimit does not have an\ninfo_type, the DLP API applies the limit against all info_types that are\nfound but not specified in another InfoTypeLimit."
+ "description": "Type of information the findings limit applies to. Only one limit per\ninfo_type should be provided. If InfoTypeLimit does not have an\ninfo_type, the DLP API applies the limit against all info_types that are\nfound but not specified in another InfoTypeLimit.",
+ "$ref": "GooglePrivacyDlpV2beta1InfoType"
},
"maxFindings": {
"description": "Max findings limit for the given infoType.",
@@ -607,14 +203,14 @@
"description": "This is a data encryption key (DEK) (as opposed to\na key encryption key (KEK) stored by KMS).\nWhen using KMS to wrap/unwrap DEKs, be sure to set an appropriate\nIAM policy on the KMS CryptoKey (KEK) to ensure an attacker cannot\nunwrap the data crypto key.",
"type": "object",
"properties": {
+ "unwrapped": {
+ "$ref": "GooglePrivacyDlpV2beta1UnwrappedCryptoKey"
+ },
"transient": {
"$ref": "GooglePrivacyDlpV2beta1TransientCryptoKey"
},
"kmsWrapped": {
"$ref": "GooglePrivacyDlpV2beta1KmsWrappedCryptoKey"
- },
- "unwrapped": {
- "$ref": "GooglePrivacyDlpV2beta1UnwrappedCryptoKey"
}
},
"id": "GooglePrivacyDlpV2beta1CryptoKey"
@@ -623,11 +219,6 @@
"description": "Histogram bucket of sensitive value frequencies in the table.",
"type": "object",
"properties": {
- "bucketSize": {
- "description": "Total number of records in this bucket.",
- "format": "int64",
- "type": "string"
- },
"sensitiveValueFrequencyUpperBound": {
"description": "Upper bound on the sensitive value frequencies of the equivalence\nclasses in this bucket.",
"format": "int64",
@@ -644,12 +235,26 @@
"items": {
"$ref": "GooglePrivacyDlpV2beta1LDiversityEquivalenceClass"
}
+ },
+ "bucketSize": {
+ "description": "Total number of records in this bucket.",
+ "format": "int64",
+ "type": "string"
}
},
"id": "GooglePrivacyDlpV2beta1LDiversityHistogramBucket"
},
"GooglePrivacyDlpV2beta1Value": {
+ "description": "Set of primitive values supported by the system.",
+ "type": "object",
"properties": {
+ "timestampValue": {
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "booleanValue": {
+ "type": "boolean"
+ },
"floatValue": {
"format": "double",
"type": "number"
@@ -666,27 +271,12 @@
},
"dateValue": {
"$ref": "GoogleTypeDate"
- },
- "timestampValue": {
- "format": "google-datetime",
- "type": "string"
- },
- "booleanValue": {
- "type": "boolean"
}
},
- "id": "GooglePrivacyDlpV2beta1Value",
- "description": "Set of primitive values supported by the system.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1Value"
},
"GooglePrivacyDlpV2beta1Condition": {
- "description": "The field type of `value` and `field` do not need to match to be\nconsidered equal, but not all comparisons are possible.\n\nA `value` of type:\n\n- `string` can be compared against all other types\n- `boolean` can only be compared against other booleans\n- `integer` can be compared against doubles or a string if the string value\ncan be parsed as an integer.\n- `double` can be compared against integers or a string if the string can\nbe parsed as a double.\n- `Timestamp` can be compared against strings in RFC 3339 date string\nformat.\n- `TimeOfDay` can be compared against timestamps and strings in the format\nof 'HH:mm:ss'.\n\nIf we fail to compare do to type mismatch, a warning will be given and\nthe condition will evaluate to false.",
- "type": "object",
"properties": {
- "field": {
- "description": "Field within the record this condition is evaluated against. [required]",
- "$ref": "GooglePrivacyDlpV2beta1FieldId"
- },
"operator": {
"enum": [
"RELATIONAL_OPERATOR_UNSPECIFIED",
@@ -712,30 +302,34 @@
]
},
"value": {
- "description": "Value to compare against. [Required, except for `EXISTS` tests.]",
- "$ref": "GooglePrivacyDlpV2beta1Value"
+ "$ref": "GooglePrivacyDlpV2beta1Value",
+ "description": "Value to compare against. [Required, except for `EXISTS` tests.]"
+ },
+ "field": {
+ "description": "Field within the record this condition is evaluated against. [required]",
+ "$ref": "GooglePrivacyDlpV2beta1FieldId"
}
},
- "id": "GooglePrivacyDlpV2beta1Condition"
+ "id": "GooglePrivacyDlpV2beta1Condition",
+ "description": "The field type of `value` and `field` do not need to match to be\nconsidered equal, but not all comparisons are possible.\n\nA `value` of type:\n\n- `string` can be compared against all other types\n- `boolean` can only be compared against other booleans\n- `integer` can be compared against doubles or a string if the string value\ncan be parsed as an integer.\n- `double` can be compared against integers or a string if the string can\nbe parsed as a double.\n- `Timestamp` can be compared against strings in RFC 3339 date string\nformat.\n- `TimeOfDay` can be compared against timestamps and strings in the format\nof 'HH:mm:ss'.\n\nIf we fail to compare do to type mismatch, a warning will be given and\nthe condition will evaluate to false.",
+ "type": "object"
},
"GooglePrivacyDlpV2beta1PartitionId": {
- "description": "Datastore partition ID.\nA partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty.\n\nA partition ID contains several dimensions:\nproject ID and namespace ID.",
- "type": "object",
"properties": {
- "namespaceId": {
- "description": "If not empty, the ID of the namespace to which the entities belong.",
- "type": "string"
- },
"projectId": {
"description": "The ID of the project to which the entities belong.",
"type": "string"
+ },
+ "namespaceId": {
+ "description": "If not empty, the ID of the namespace to which the entities belong.",
+ "type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta1PartitionId"
+ "id": "GooglePrivacyDlpV2beta1PartitionId",
+ "description": "Datastore partition ID.\nA partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty.\n\nA partition ID contains several dimensions:\nproject ID and namespace ID.",
+ "type": "object"
},
"GooglePrivacyDlpV2beta1InspectContentResponse": {
- "description": "Results of inspecting a list of items.",
- "type": "object",
"properties": {
"results": {
"description": "Each content_item from the request has a result in this list, in the\nsame order as the request.",
@@ -745,23 +339,12 @@
}
}
},
- "id": "GooglePrivacyDlpV2beta1InspectContentResponse"
+ "id": "GooglePrivacyDlpV2beta1InspectContentResponse",
+ "description": "Results of inspecting a list of items.",
+ "type": "object"
},
"GooglePrivacyDlpV2beta1RedactContentRequest": {
- "description": "Request to search for potentially sensitive info in a list of items\nand replace it with a default or provided content.",
- "type": "object",
"properties": {
- "inspectConfig": {
- "description": "Configuration for the inspector.",
- "$ref": "GooglePrivacyDlpV2beta1InspectConfig"
- },
- "items": {
- "description": "The list of items to inspect. Up to 100 are allowed per request.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1ContentItem"
- }
- },
"replaceConfigs": {
"description": "The strings to replace findings text findings with. Must specify at least\none of these or one ImageRedactionConfig if redacting images.",
"type": "array",
@@ -775,28 +358,57 @@
"items": {
"$ref": "GooglePrivacyDlpV2beta1ImageRedactionConfig"
}
+ },
+ "inspectConfig": {
+ "description": "Configuration for the inspector.",
+ "$ref": "GooglePrivacyDlpV2beta1InspectConfig"
+ },
+ "items": {
+ "description": "The list of items to inspect. Up to 100 are allowed per request.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1ContentItem"
+ }
}
},
- "id": "GooglePrivacyDlpV2beta1RedactContentRequest"
+ "id": "GooglePrivacyDlpV2beta1RedactContentRequest",
+ "description": "Request to search for potentially sensitive info in a list of items\nand replace it with a default or provided content.",
+ "type": "object"
+ },
+ "GooglePrivacyDlpV2beta1WordList": {
+ "description": "Message defining a list of words or phrases to search for in the data.",
+ "type": "object",
+ "properties": {
+ "words": {
+ "description": "Words or phrases defining the dictionary. No word can be shorter than 3\ncharacters in length. To match, there must be whitespace or punctuation\naround the targeted string. [required]",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1WordList"
},
"GooglePrivacyDlpV2beta1FieldId": {
- "description": "General identifier of a data field in a storage service.",
- "type": "object",
"properties": {
"columnName": {
"description": "Name describing the field.",
"type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta1FieldId"
+ "id": "GooglePrivacyDlpV2beta1FieldId",
+ "description": "General identifier of a data field in a storage service.",
+ "type": "object"
},
"GooglePrivacyDlpV2beta1TransformationSummary": {
- "description": "Summary of a single tranformation.",
- "type": "object",
"properties": {
+ "recordSuppress": {
+ "description": "The specific suppression option these stats apply to.",
+ "$ref": "GooglePrivacyDlpV2beta1RecordSuppression"
+ },
"infoType": {
- "$ref": "GooglePrivacyDlpV2beta1InfoType",
- "description": "Set if the transformation was limited to a specific info_type."
+ "description": "Set if the transformation was limited to a specific info_type.",
+ "$ref": "GooglePrivacyDlpV2beta1InfoType"
},
"transformation": {
"description": "The specific transformation these stats apply to.",
@@ -818,13 +430,11 @@
"items": {
"$ref": "GooglePrivacyDlpV2beta1FieldTransformation"
}
- },
- "recordSuppress": {
- "description": "The specific suppression option these stats apply to.",
- "$ref": "GooglePrivacyDlpV2beta1RecordSuppression"
}
},
- "id": "GooglePrivacyDlpV2beta1TransformationSummary"
+ "id": "GooglePrivacyDlpV2beta1TransformationSummary",
+ "description": "Summary of a single tranformation.",
+ "type": "object"
},
"GoogleLongrunningCancelOperationRequest": {
"description": "The request message for Operations.CancelOperation.",
@@ -860,38 +470,38 @@
"id": "GooglePrivacyDlpV2beta1CharacterMaskConfig"
},
"GooglePrivacyDlpV2beta1TransientCryptoKey": {
+ "description": "Use this to have a random data crypto key generated.\nIt will be discarded after the operation/request finishes.",
+ "type": "object",
"properties": {
"name": {
"description": "Name of the key. [required]\nThis is an arbitrary string used to differentiate different keys.\nA unique key is generated per name: two separate `TransientCryptoKey`\nprotos share the same generated key if their names are the same.\nWhen the data crypto key is generated, this name is not used in any way\n(repeating the api call will result in a different key being generated).",
"type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta1TransientCryptoKey",
- "description": "Use this to have a random data crypto key generated.\nIt will be discarded after the operation/request finishes.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1TransientCryptoKey"
},
"GooglePrivacyDlpV2beta1CreateInspectOperationRequest": {
+ "description": "Request for scheduling a scan of a data subset from a Google Platform data\nrepository.",
+ "type": "object",
"properties": {
+ "storageConfig": {
+ "description": "Specification of the data set to process.",
+ "$ref": "GooglePrivacyDlpV2beta1StorageConfig"
+ },
+ "outputConfig": {
+ "$ref": "GooglePrivacyDlpV2beta1OutputStorageConfig",
+ "description": "Optional location to store findings."
+ },
+ "operationConfig": {
+ "$ref": "GooglePrivacyDlpV2beta1OperationConfig",
+ "description": "Additional configuration settings for long running operations."
+ },
"inspectConfig": {
"description": "Configuration for the inspector.",
"$ref": "GooglePrivacyDlpV2beta1InspectConfig"
- },
- "storageConfig": {
- "$ref": "GooglePrivacyDlpV2beta1StorageConfig",
- "description": "Specification of the data set to process."
- },
- "outputConfig": {
- "description": "Optional location to store findings.",
- "$ref": "GooglePrivacyDlpV2beta1OutputStorageConfig"
- },
- "operationConfig": {
- "description": "Additional configuration settings for long running operations.",
- "$ref": "GooglePrivacyDlpV2beta1OperationConfig"
}
},
- "id": "GooglePrivacyDlpV2beta1CreateInspectOperationRequest",
- "description": "Request for scheduling a scan of a data subset from a Google Platform data\nrepository.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1CreateInspectOperationRequest"
},
"GooglePrivacyDlpV2beta1RedactContentResponse": {
"description": "Results of redacting a list of items.",
@@ -908,20 +518,20 @@
"id": "GooglePrivacyDlpV2beta1RedactContentResponse"
},
"GooglePrivacyDlpV2beta1InfoTypeStatistics": {
- "description": "Statistics regarding a specific InfoType.",
- "type": "object",
"properties": {
+ "infoType": {
+ "$ref": "GooglePrivacyDlpV2beta1InfoType",
+ "description": "The type of finding this stat is for."
+ },
"count": {
"description": "Number of findings for this info type.",
"format": "int64",
"type": "string"
- },
- "infoType": {
- "$ref": "GooglePrivacyDlpV2beta1InfoType",
- "description": "The type of finding this stat is for."
}
},
- "id": "GooglePrivacyDlpV2beta1InfoTypeStatistics"
+ "id": "GooglePrivacyDlpV2beta1InfoTypeStatistics",
+ "description": "Statistics regarding a specific InfoType.",
+ "type": "object"
},
"GooglePrivacyDlpV2beta1PropertyReference": {
"description": "A reference to a property relative to the Datastore kind expressions.",
@@ -935,16 +545,14 @@
"id": "GooglePrivacyDlpV2beta1PropertyReference"
},
"GooglePrivacyDlpV2beta1FieldTransformation": {
- "description": "The transformation to apply to the field.",
- "type": "object",
"properties": {
"condition": {
- "$ref": "GooglePrivacyDlpV2beta1RecordCondition",
- "description": "Only apply the transformation if the condition evaluates to true for the\ngiven `RecordCondition`. The conditions are allowed to reference fields\nthat are not used in the actual transformation. [optional]\n\nExample Use Cases:\n\n- Apply a different bucket transformation to an age column if the zip code\ncolumn for the same record is within a specific range.\n- Redact a field if the date of birth field is greater than 85."
+ "description": "Only apply the transformation if the condition evaluates to true for the\ngiven `RecordCondition`. The conditions are allowed to reference fields\nthat are not used in the actual transformation. [optional]\n\nExample Use Cases:\n\n- Apply a different bucket transformation to an age column if the zip code\ncolumn for the same record is within a specific range.\n- Redact a field if the date of birth field is greater than 85.",
+ "$ref": "GooglePrivacyDlpV2beta1RecordCondition"
},
"infoTypeTransformations": {
- "description": "Treat the contents of the field as free text, and selectively\ntransform content that matches an `InfoType`.",
- "$ref": "GooglePrivacyDlpV2beta1InfoTypeTransformations"
+ "$ref": "GooglePrivacyDlpV2beta1InfoTypeTransformations",
+ "description": "Treat the contents of the field as free text, and selectively\ntransform content that matches an `InfoType`."
},
"fields": {
"description": "Input field(s) to apply the transformation to. [required]",
@@ -954,26 +562,28 @@
}
},
"primitiveTransformation": {
- "description": "Apply the transformation to the entire field.",
- "$ref": "GooglePrivacyDlpV2beta1PrimitiveTransformation"
+ "$ref": "GooglePrivacyDlpV2beta1PrimitiveTransformation",
+ "description": "Apply the transformation to the entire field."
}
},
- "id": "GooglePrivacyDlpV2beta1FieldTransformation"
+ "id": "GooglePrivacyDlpV2beta1FieldTransformation",
+ "description": "The transformation to apply to the field.",
+ "type": "object"
},
"GooglePrivacyDlpV2beta1OutputStorageConfig": {
- "description": "Cloud repository for storing output.",
- "type": "object",
"properties": {
- "table": {
- "description": "Store findings in a new table in the dataset.",
- "$ref": "GooglePrivacyDlpV2beta1BigQueryTable"
- },
"storagePath": {
- "description": "The path to a Google Cloud Storage location to store output.\nThe bucket must already exist and\nthe Google APIs service account for DLP must have write permission to\nwrite to the given bucket.\nResults are split over multiple csv files with each file name matching\nthe pattern \"[operation_id]_[count].csv\", for example\n`3094877188788974909_1.csv`. The `operation_id` matches the\nidentifier for the Operation, and the `count` is a counter used for\ntracking the number of files written.\n\nThe CSV file(s) contain the following columns regardless of storage type\nscanned:\n- id\n- info_type\n- likelihood\n- byte size of finding\n- quote\n- timestamp\n\nFor Cloud Storage the next columns are:\n\n- file_path\n- start_offset\n\nFor Cloud Datastore the next columns are:\n\n- project_id\n- namespace_id\n- path\n- column_name\n- offset\n\nFor BigQuery the next columns are:\n\n- row_number\n- project_id\n- dataset_id\n- table_id",
- "$ref": "GooglePrivacyDlpV2beta1CloudStoragePath"
+ "$ref": "GooglePrivacyDlpV2beta1CloudStoragePath",
+ "description": "The path to a Google Cloud Storage location to store output.\nThe bucket must already exist and\nthe Google APIs service account for DLP must have write permission to\nwrite to the given bucket.\nResults are split over multiple csv files with each file name matching\nthe pattern \"[operation_id]_[count].csv\", for example\n`3094877188788974909_1.csv`. The `operation_id` matches the\nidentifier for the Operation, and the `count` is a counter used for\ntracking the number of files written.\n\nThe CSV file(s) contain the following columns regardless of storage type\nscanned:\n- id\n- info_type\n- likelihood\n- byte size of finding\n- quote\n- timestamp\n\nFor Cloud Storage the next columns are:\n\n- file_path\n- start_offset\n\nFor Cloud Datastore the next columns are:\n\n- project_id\n- namespace_id\n- path\n- column_name\n- offset\n\nFor BigQuery the next columns are:\n\n- row_number\n- project_id\n- dataset_id\n- table_id"
+ },
+ "table": {
+ "$ref": "GooglePrivacyDlpV2beta1BigQueryTable",
+ "description": "Store findings in a new table in the dataset."
}
},
- "id": "GooglePrivacyDlpV2beta1OutputStorageConfig"
+ "id": "GooglePrivacyDlpV2beta1OutputStorageConfig",
+ "description": "Cloud repository for storing output.",
+ "type": "object"
},
"GooglePrivacyDlpV2beta1BucketingConfig": {
"description": "Generalization function that buckets values based on ranges. The ranges and\nreplacement values are dynamically provided by the user for custom behavior,\nsuch as 1-30 -\u003e LOW 31-65 -\u003e MEDIUM 66-100 -\u003e HIGH\nThis can be used on\ndata of type: number, long, string, timestamp.\nIf the bound `Value` type differs from the type of data being transformed, we\nwill first attempt converting the type of the data to be transformed to match\nthe type of the bound before comparing.",
@@ -992,45 +602,47 @@
"description": "Results of de-identifying a list of items.",
"type": "object",
"properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1ContentItem"
+ }
+ },
"summaries": {
"description": "A review of the transformations that took place for each item.",
"type": "array",
"items": {
"$ref": "GooglePrivacyDlpV2beta1DeidentificationSummary"
}
- },
- "items": {
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1ContentItem"
- }
}
},
"id": "GooglePrivacyDlpV2beta1DeidentifyContentResponse"
},
"GooglePrivacyDlpV2beta1KAnonymityEquivalenceClass": {
- "description": "The set of columns' values that share the same k-anonymity value.",
- "type": "object",
"properties": {
- "equivalenceClassSize": {
- "description": "Size of the equivalence class, for example number of rows with the\nabove set of values.",
- "format": "int64",
- "type": "string"
- },
"quasiIdsValues": {
"description": "Set of values defining the equivalence class. One value per\nquasi-identifier column in the original KAnonymity metric message.\nThe order is always the same as the original request.",
"type": "array",
"items": {
"$ref": "GooglePrivacyDlpV2beta1Value"
}
+ },
+ "equivalenceClassSize": {
+ "description": "Size of the equivalence class, for example number of rows with the\nabove set of values.",
+ "format": "int64",
+ "type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta1KAnonymityEquivalenceClass"
+ "id": "GooglePrivacyDlpV2beta1KAnonymityEquivalenceClass",
+ "description": "The set of columns' values that share the same k-anonymity value.",
+ "type": "object"
},
"GoogleLongrunningOperation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
"properties": {
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ },
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
@@ -1044,8 +656,8 @@
"type": "string"
},
"error": {
- "$ref": "GoogleRpcStatus",
- "description": "The error result of the operation in case of failure or cancellation."
+ "description": "The error result of the operation in case of failure or cancellation.",
+ "$ref": "GoogleRpcStatus"
},
"metadata": {
"additionalProperties": {
@@ -1054,15 +666,15 @@
},
"description": "This field will contain an InspectOperationMetadata object for `inspect.operations.create` or a RiskAnalysisOperationMetadata object for `dataSource.analyze`. This will always be returned with the Operation.",
"type": "object"
- },
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
}
},
- "id": "GoogleLongrunningOperation"
+ "id": "GoogleLongrunningOperation",
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object"
},
"GooglePrivacyDlpV2beta1KmsWrappedCryptoKey": {
+ "description": "Include to use an existing data crypto key wrapped by KMS.\nAuthorization requires the following IAM permissions when sending a request\nto perform a crypto transformation using a kms-wrapped crypto key:\ndlp.kms.encrypt",
+ "type": "object",
"properties": {
"wrappedKey": {
"description": "The wrapped data crypto key. [required]",
@@ -1074,14 +686,30 @@
"type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta1KmsWrappedCryptoKey",
- "description": "Include to use an existing data crypto key wrapped by KMS.\nAuthorization requires the following IAM permissions when sending a request\nto perform a crypto transformation using a kms-wrapped crypto key:\ndlp.kms.encrypt",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1KmsWrappedCryptoKey"
},
"GooglePrivacyDlpV2beta1InspectOperationMetadata": {
- "description": "Metadata returned within GetOperation for an inspect request.",
- "type": "object",
"properties": {
+ "requestStorageConfig": {
+ "$ref": "GooglePrivacyDlpV2beta1StorageConfig",
+ "description": "The storage config used to create the Operation."
+ },
+ "processedBytes": {
+ "description": "Total size in bytes that were processed.",
+ "format": "int64",
+ "type": "string"
+ },
+ "infoTypeStats": {
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1InfoTypeStatistics"
+ }
+ },
+ "totalEstimatedBytes": {
+ "description": "Estimate of the number of bytes to process.",
+ "format": "int64",
+ "type": "string"
+ },
"requestInspectConfig": {
"description": "The inspect config used to create the Operation.",
"$ref": "GooglePrivacyDlpV2beta1InspectConfig"
@@ -1094,69 +722,22 @@
"description": "The time which this request was started.",
"format": "google-datetime",
"type": "string"
- },
- "requestStorageConfig": {
- "description": "The storage config used to create the Operation.",
- "$ref": "GooglePrivacyDlpV2beta1StorageConfig"
- },
- "processedBytes": {
- "description": "Total size in bytes that were processed.",
- "format": "int64",
- "type": "string"
- },
- "totalEstimatedBytes": {
- "description": "Estimate of the number of bytes to process.",
- "format": "int64",
- "type": "string"
- },
- "infoTypeStats": {
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1InfoTypeStatistics"
- }
}
},
- "id": "GooglePrivacyDlpV2beta1InspectOperationMetadata"
+ "id": "GooglePrivacyDlpV2beta1InspectOperationMetadata",
+ "description": "Metadata returned within GetOperation for an inspect request.",
+ "type": "object"
},
"GooglePrivacyDlpV2beta1InfoType": {
- "description": "Type of information detected by the API.",
- "type": "object",
"properties": {
"name": {
"description": "Name of the information type.",
"type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta1InfoType"
- },
- "GooglePrivacyDlpV2beta1CharsToIgnore": {
- "description": "Characters to skip when doing deidentification of a value. These will be left\nalone and skipped.",
- "type": "object",
- "properties": {
- "charactersToSkip": {
- "type": "string"
- },
- "commonCharactersToIgnore": {
- "type": "string",
- "enumDescriptions": [
- "",
- "0-9",
- "A-Z",
- "a-z",
- "US Punctuation, one of !\"#$%&'()*+,-./:;\u003c=\u003e?@[\\]^_`{|}~",
- "Whitespace character, one of [ \\t\\n\\x0B\\f\\r]"
- ],
- "enum": [
- "CHARACTER_GROUP_UNSPECIFIED",
- "NUMERIC",
- "ALPHA_UPPER_CASE",
- "ALPHA_LOWER_CASE",
- "PUNCTUATION",
- "WHITESPACE"
- ]
- }
- },
- "id": "GooglePrivacyDlpV2beta1CharsToIgnore"
+ "id": "GooglePrivacyDlpV2beta1InfoType",
+ "description": "Type of information detected by the API.",
+ "type": "object"
},
"GooglePrivacyDlpV2beta1FixedSizeBucketingConfig": {
"description": "Buckets values based on fixed size ranges. The\nBucketing transformation can provide all of this functionality,\nbut requires more configuration. This message is provided as a convenience to\nthe user for simple bucketing strategies.\nThe resulting value will be a hyphenated string of\nlower_bound-upper_bound.\nThis can be used on data of type: double, long.\nIf the bound Value type differs from the type of data\nbeing transformed, we will first attempt converting the type of the data to\nbe transformed to match the type of the bound before comparing.",
@@ -1178,8 +759,40 @@
},
"id": "GooglePrivacyDlpV2beta1FixedSizeBucketingConfig"
},
+ "GooglePrivacyDlpV2beta1CharsToIgnore": {
+ "description": "Characters to skip when doing deidentification of a value. These will be left\nalone and skipped.",
+ "type": "object",
+ "properties": {
+ "charactersToSkip": {
+ "type": "string"
+ },
+ "commonCharactersToIgnore": {
+ "enum": [
+ "CHARACTER_GROUP_UNSPECIFIED",
+ "NUMERIC",
+ "ALPHA_UPPER_CASE",
+ "ALPHA_LOWER_CASE",
+ "PUNCTUATION",
+ "WHITESPACE"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "0-9",
+ "A-Z",
+ "a-z",
+ "US Punctuation, one of !\"#$%&'()*+,-./:;\u003c=\u003e?@[\\]^_`{|}~",
+ "Whitespace character, one of [ \\t\\n\\x0B\\f\\r]"
+ ]
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1CharsToIgnore"
+ },
"GooglePrivacyDlpV2beta1RiskAnalysisOperationResult": {
"properties": {
+ "categoricalStatsResult": {
+ "$ref": "GooglePrivacyDlpV2beta1CategoricalStatsResult"
+ },
"numericalStatsResult": {
"$ref": "GooglePrivacyDlpV2beta1NumericalStatsResult"
},
@@ -1188,15 +801,27 @@
},
"lDiversityResult": {
"$ref": "GooglePrivacyDlpV2beta1LDiversityResult"
- },
- "categoricalStatsResult": {
- "$ref": "GooglePrivacyDlpV2beta1CategoricalStatsResult"
}
},
"id": "GooglePrivacyDlpV2beta1RiskAnalysisOperationResult",
"description": "Result of a risk analysis\n[`Operation`](/dlp/docs/reference/rest/v2beta1/inspect.operations)\nrequest.",
"type": "object"
},
+ "GooglePrivacyDlpV2beta1CategoryDescription": {
+ "properties": {
+ "name": {
+ "description": "Internal name of the category.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Human readable form of the category name.",
+ "type": "string"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1CategoryDescription",
+ "description": "Info Type Category description.",
+ "type": "object"
+ },
"GooglePrivacyDlpV2beta1Conditions": {
"type": "object",
"properties": {
@@ -1209,43 +834,26 @@
},
"id": "GooglePrivacyDlpV2beta1Conditions"
},
- "GooglePrivacyDlpV2beta1CategoryDescription": {
- "description": "Info Type Category description.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Internal name of the category.",
- "type": "string"
- },
- "displayName": {
- "description": "Human readable form of the category name.",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta1CategoryDescription"
- },
"GooglePrivacyDlpV2beta1PrimitiveTransformation": {
- "description": "A rule for transforming a value.",
- "type": "object",
"properties": {
"replaceConfig": {
"$ref": "GooglePrivacyDlpV2beta1ReplaceValueConfig"
},
- "fixedSizeBucketingConfig": {
- "$ref": "GooglePrivacyDlpV2beta1FixedSizeBucketingConfig"
- },
"timePartConfig": {
"$ref": "GooglePrivacyDlpV2beta1TimePartConfig"
},
+ "fixedSizeBucketingConfig": {
+ "$ref": "GooglePrivacyDlpV2beta1FixedSizeBucketingConfig"
+ },
"characterMaskConfig": {
"$ref": "GooglePrivacyDlpV2beta1CharacterMaskConfig"
},
- "bucketingConfig": {
- "$ref": "GooglePrivacyDlpV2beta1BucketingConfig"
- },
"redactConfig": {
"$ref": "GooglePrivacyDlpV2beta1RedactConfig"
},
+ "bucketingConfig": {
+ "$ref": "GooglePrivacyDlpV2beta1BucketingConfig"
+ },
"replaceWithInfoTypeConfig": {
"$ref": "GooglePrivacyDlpV2beta1ReplaceWithInfoTypeConfig"
},
@@ -1256,40 +864,23 @@
"$ref": "GooglePrivacyDlpV2beta1CryptoReplaceFfxFpeConfig"
}
},
- "id": "GooglePrivacyDlpV2beta1PrimitiveTransformation"
+ "id": "GooglePrivacyDlpV2beta1PrimitiveTransformation",
+ "description": "A rule for transforming a value.",
+ "type": "object"
},
"GooglePrivacyDlpV2beta1CategoricalStatsConfig": {
- "description": "Compute numerical stats over an individual column, including\nnumber of distinct values and value count distribution.",
- "type": "object",
"properties": {
"field": {
- "description": "Field to compute categorical stats on. All column types are\nsupported except for arrays and structs. However, it may be more\ninformative to use NumericalStats when the field type is supported,\ndepending on the data.",
- "$ref": "GooglePrivacyDlpV2beta1FieldId"
+ "$ref": "GooglePrivacyDlpV2beta1FieldId",
+ "description": "Field to compute categorical stats on. All column types are\nsupported except for arrays and structs. However, it may be more\ninformative to use NumericalStats when the field type is supported,\ndepending on the data."
}
},
- "id": "GooglePrivacyDlpV2beta1CategoricalStatsConfig"
+ "id": "GooglePrivacyDlpV2beta1CategoricalStatsConfig",
+ "description": "Compute numerical stats over an individual column, including\nnumber of distinct values and value count distribution.",
+ "type": "object"
},
"GooglePrivacyDlpV2beta1Finding": {
- "description": "Container structure describing a single finding within a string or image.",
- "type": "object",
"properties": {
- "infoType": {
- "$ref": "GooglePrivacyDlpV2beta1InfoType",
- "description": "The specific type of info the string might be."
- },
- "createTime": {
- "description": "Timestamp when finding was detected.",
- "format": "google-datetime",
- "type": "string"
- },
- "quote": {
- "description": "The specific string that may be potentially sensitive info.",
- "type": "string"
- },
- "location": {
- "description": "Location of the info found.",
- "$ref": "GooglePrivacyDlpV2beta1Location"
- },
"likelihood": {
"enumDescriptions": [
"Default value; information with all likelihoods is included.",
@@ -1309,18 +900,31 @@
],
"description": "Estimate of how likely it is that the info_type is correct.",
"type": "string"
+ },
+ "infoType": {
+ "description": "The specific type of info the string might be.",
+ "$ref": "GooglePrivacyDlpV2beta1InfoType"
+ },
+ "createTime": {
+ "description": "Timestamp when finding was detected.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "quote": {
+ "description": "The specific string that may be potentially sensitive info.",
+ "type": "string"
+ },
+ "location": {
+ "$ref": "GooglePrivacyDlpV2beta1Location",
+ "description": "Location of the info found."
}
},
- "id": "GooglePrivacyDlpV2beta1Finding"
+ "id": "GooglePrivacyDlpV2beta1Finding",
+ "description": "Container structure describing a single finding within a string or image.",
+ "type": "object"
},
"GooglePrivacyDlpV2beta1RiskAnalysisOperationMetadata": {
- "description": "Metadata returned within the\n[`riskAnalysis.operations.get`](/dlp/docs/reference/rest/v2beta1/riskAnalysis.operations/get)\nfor risk analysis.",
- "type": "object",
"properties": {
- "requestedPrivacyMetric": {
- "$ref": "GooglePrivacyDlpV2beta1PrivacyMetric",
- "description": "Privacy metric to compute."
- },
"createTime": {
"description": "The time which this request was started.",
"format": "google-datetime",
@@ -1329,13 +933,17 @@
"requestedSourceTable": {
"description": "Input dataset to compute metrics over.",
"$ref": "GooglePrivacyDlpV2beta1BigQueryTable"
+ },
+ "requestedPrivacyMetric": {
+ "$ref": "GooglePrivacyDlpV2beta1PrivacyMetric",
+ "description": "Privacy metric to compute."
}
},
- "id": "GooglePrivacyDlpV2beta1RiskAnalysisOperationMetadata"
+ "id": "GooglePrivacyDlpV2beta1RiskAnalysisOperationMetadata",
+ "description": "Metadata returned within the\n[`riskAnalysis.operations.get`](/dlp/docs/reference/rest/v2beta1/riskAnalysis.operations/get)\nfor risk analysis.",
+ "type": "object"
},
"GoogleLongrunningListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
@@ -1349,7 +957,9 @@
}
}
},
- "id": "GoogleLongrunningListOperationsResponse"
+ "id": "GoogleLongrunningListOperationsResponse",
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object"
},
"GooglePrivacyDlpV2beta1Row": {
"properties": {
@@ -1363,48 +973,48 @@
"id": "GooglePrivacyDlpV2beta1Row",
"type": "object"
},
- "GoogleProtobufEmpty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "GoogleProtobufEmpty"
- },
"GooglePrivacyDlpV2beta1ListInspectFindingsResponse": {
- "description": "Response to the ListInspectFindings request.",
- "type": "object",
"properties": {
"nextPageToken": {
"description": "If not empty, indicates that there may be more results that match the\nrequest; this value should be passed in a new `ListInspectFindingsRequest`.",
"type": "string"
},
"result": {
- "$ref": "GooglePrivacyDlpV2beta1InspectResult",
- "description": "The results."
+ "description": "The results.",
+ "$ref": "GooglePrivacyDlpV2beta1InspectResult"
}
},
- "id": "GooglePrivacyDlpV2beta1ListInspectFindingsResponse"
+ "id": "GooglePrivacyDlpV2beta1ListInspectFindingsResponse",
+ "description": "Response to the ListInspectFindings request.",
+ "type": "object"
+ },
+ "GoogleProtobufEmpty": {
+ "properties": {},
+ "id": "GoogleProtobufEmpty",
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object"
},
"GooglePrivacyDlpV2beta1Expressions": {
- "description": "A collection of expressions",
- "type": "object",
"properties": {
"logicalOperator": {
+ "enumDescriptions": [
+ "",
+ ""
+ ],
"enum": [
"LOGICAL_OPERATOR_UNSPECIFIED",
"AND"
],
"description": "The operator to apply to the result of conditions. Default and currently\nonly supported value is `AND`.",
- "type": "string",
- "enumDescriptions": [
- "",
- ""
- ]
+ "type": "string"
},
"conditions": {
"$ref": "GooglePrivacyDlpV2beta1Conditions"
}
},
- "id": "GooglePrivacyDlpV2beta1Expressions"
+ "id": "GooglePrivacyDlpV2beta1Expressions",
+ "description": "A collection of expressions",
+ "type": "object"
},
"GooglePrivacyDlpV2beta1CloudStorageOptions": {
"description": "Options defining a file or a set of files (path ending with *) within\na Google Cloud Storage bucket.",
@@ -1431,6 +1041,13 @@
"description": "Histogram bucket of equivalence class sizes in the table.",
"type": "object",
"properties": {
+ "bucketValues": {
+ "description": "Sample of equivalence classes in this bucket. The total number of\nclasses returned per bucket is capped at 20.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1KAnonymityEquivalenceClass"
+ }
+ },
"equivalenceClassSizeLowerBound": {
"description": "Lower bound on the size of the equivalence classes in this bucket.",
"format": "int64",
@@ -1445,13 +1062,6 @@
"description": "Total number of records in this bucket.",
"format": "int64",
"type": "string"
- },
- "bucketValues": {
- "description": "Sample of equivalence classes in this bucket. The total number of\nclasses returned per bucket is capped at 20.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1KAnonymityEquivalenceClass"
- }
}
},
"id": "GooglePrivacyDlpV2beta1KAnonymityHistogramBucket"
@@ -1467,37 +1077,7 @@
},
"id": "GooglePrivacyDlpV2beta1InspectOperationResult"
},
- "GooglePrivacyDlpV2beta1LDiversityResult": {
- "properties": {
- "sensitiveValueFrequencyHistogramBuckets": {
- "description": "Histogram of l-diversity equivalence class sensitive value frequencies.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1LDiversityHistogramBucket"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta1LDiversityResult",
- "description": "Result of the l-diversity computation.",
- "type": "object"
- },
- "GooglePrivacyDlpV2beta1CategoricalStatsResult": {
- "properties": {
- "valueFrequencyHistogramBuckets": {
- "description": "Histogram of value frequencies in the column.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta1CategoricalStatsResult",
- "description": "Result of the categorical stats computation.",
- "type": "object"
- },
"GooglePrivacyDlpV2beta1Range": {
- "description": "Generic half-open interval [start, end)",
- "type": "object",
"properties": {
"start": {
"description": "Index of the first character of the range (inclusive).",
@@ -1510,20 +1090,40 @@
"type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta1Range"
+ "id": "GooglePrivacyDlpV2beta1Range",
+ "description": "Generic half-open interval [start, end)",
+ "type": "object"
+ },
+ "GooglePrivacyDlpV2beta1CategoricalStatsResult": {
+ "description": "Result of the categorical stats computation.",
+ "type": "object",
+ "properties": {
+ "valueFrequencyHistogramBuckets": {
+ "description": "Histogram of value frequencies in the column.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1CategoricalStatsResult"
+ },
+ "GooglePrivacyDlpV2beta1LDiversityResult": {
+ "description": "Result of the l-diversity computation.",
+ "type": "object",
+ "properties": {
+ "sensitiveValueFrequencyHistogramBuckets": {
+ "description": "Histogram of l-diversity equivalence class sensitive value frequencies.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1LDiversityHistogramBucket"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1LDiversityResult"
},
"GoogleTypeTimeOfDay": {
"properties": {
- "nanos": {
- "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.",
- "format": "int32",
- "type": "integer"
- },
- "seconds": {
- "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may\nallow the value 60 if it allows leap-seconds.",
- "format": "int32",
- "type": "integer"
- },
"minutes": {
"description": "Minutes of hour of day. Must be from 0 to 59.",
"format": "int32",
@@ -1533,6 +1133,16 @@
"description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose\nto allow the value \"24:00:00\" for scenarios like business closing time.",
"format": "int32",
"type": "integer"
+ },
+ "nanos": {
+ "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "seconds": {
+ "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may\nallow the value 60 if it allows leap-seconds.",
+ "format": "int32",
+ "type": "integer"
}
},
"id": "GoogleTypeTimeOfDay",
@@ -1544,8 +1154,8 @@
"type": "object",
"properties": {
"recordTransformations": {
- "$ref": "GooglePrivacyDlpV2beta1RecordTransformations",
- "description": "Treat the dataset as structured. Transformations can be applied to\nspecific locations within structured datasets, such as transforming\na column within a table."
+ "description": "Treat the dataset as structured. Transformations can be applied to\nspecific locations within structured datasets, such as transforming\na column within a table.",
+ "$ref": "GooglePrivacyDlpV2beta1RecordTransformations"
},
"infoTypeTransformations": {
"$ref": "GooglePrivacyDlpV2beta1InfoTypeTransformations",
@@ -1555,8 +1165,6 @@
"id": "GooglePrivacyDlpV2beta1DeidentifyConfig"
},
"GooglePrivacyDlpV2beta1LDiversityConfig": {
- "description": "l-diversity metric, used for analysis of reidentification risk.",
- "type": "object",
"properties": {
"sensitiveAttribute": {
"$ref": "GooglePrivacyDlpV2beta1FieldId",
@@ -1570,48 +1178,48 @@
}
}
},
- "id": "GooglePrivacyDlpV2beta1LDiversityConfig"
+ "id": "GooglePrivacyDlpV2beta1LDiversityConfig",
+ "description": "l-diversity metric, used for analysis of reidentification risk.",
+ "type": "object"
},
"GooglePrivacyDlpV2beta1StorageConfig": {
- "description": "Shared message indicating Cloud storage type.",
- "type": "object",
"properties": {
+ "cloudStorageOptions": {
+ "description": "Google Cloud Storage options specification.",
+ "$ref": "GooglePrivacyDlpV2beta1CloudStorageOptions"
+ },
"datastoreOptions": {
"$ref": "GooglePrivacyDlpV2beta1DatastoreOptions",
"description": "Google Cloud Datastore options specification."
},
"bigQueryOptions": {
- "$ref": "GooglePrivacyDlpV2beta1BigQueryOptions",
- "description": "BigQuery options specification."
- },
- "cloudStorageOptions": {
- "description": "Google Cloud Storage options specification.",
- "$ref": "GooglePrivacyDlpV2beta1CloudStorageOptions"
+ "description": "BigQuery options specification.",
+ "$ref": "GooglePrivacyDlpV2beta1BigQueryOptions"
}
},
- "id": "GooglePrivacyDlpV2beta1StorageConfig"
+ "id": "GooglePrivacyDlpV2beta1StorageConfig",
+ "description": "Shared message indicating Cloud storage type.",
+ "type": "object"
},
"GooglePrivacyDlpV2beta1BigQueryOptions": {
+ "description": "Options defining BigQuery table and row identifiers.",
+ "type": "object",
"properties": {
- "tableReference": {
- "$ref": "GooglePrivacyDlpV2beta1BigQueryTable",
- "description": "Complete BigQuery table reference."
- },
"identifyingFields": {
"description": "References to fields uniquely identifying rows within the table.\nNested fields in the format, like `person.birthdate.year`, are allowed.",
"type": "array",
"items": {
"$ref": "GooglePrivacyDlpV2beta1FieldId"
}
+ },
+ "tableReference": {
+ "$ref": "GooglePrivacyDlpV2beta1BigQueryTable",
+ "description": "Complete BigQuery table reference."
}
},
- "id": "GooglePrivacyDlpV2beta1BigQueryOptions",
- "description": "Options defining BigQuery table and row identifiers.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1BigQueryOptions"
},
"GooglePrivacyDlpV2beta1OperationConfig": {
- "description": "Additional configuration for inspect long running operations.",
- "type": "object",
"properties": {
"maxItemFindings": {
"description": "Max number of findings per file, Datastore entity, or database row.",
@@ -1619,11 +1227,11 @@
"type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta1OperationConfig"
+ "id": "GooglePrivacyDlpV2beta1OperationConfig",
+ "description": "Additional configuration for inspect long running operations.",
+ "type": "object"
},
"GooglePrivacyDlpV2beta1PrivacyMetric": {
- "description": "Privacy metric to compute for reidentification risk analysis.",
- "type": "object",
"properties": {
"lDiversityConfig": {
"$ref": "GooglePrivacyDlpV2beta1LDiversityConfig"
@@ -1638,36 +1246,25 @@
"$ref": "GooglePrivacyDlpV2beta1CategoricalStatsConfig"
}
},
- "id": "GooglePrivacyDlpV2beta1PrivacyMetric"
+ "id": "GooglePrivacyDlpV2beta1PrivacyMetric",
+ "description": "Privacy metric to compute for reidentification risk analysis.",
+ "type": "object"
},
"GooglePrivacyDlpV2beta1ReplaceConfig": {
"properties": {
+ "infoType": {
+ "description": "Type of information to replace. Only one ReplaceConfig per info_type\nshould be provided. If ReplaceConfig does not have an info_type, the DLP\nAPI matches it against all info_types that are found but not specified in\nanother ReplaceConfig.",
+ "$ref": "GooglePrivacyDlpV2beta1InfoType"
+ },
"replaceWith": {
"description": "Content replacing sensitive information of given type. Max 256 chars.",
"type": "string"
- },
- "infoType": {
- "$ref": "GooglePrivacyDlpV2beta1InfoType",
- "description": "Type of information to replace. Only one ReplaceConfig per info_type\nshould be provided. If ReplaceConfig does not have an info_type, the DLP\nAPI matches it against all info_types that are found but not specified in\nanother ReplaceConfig."
}
},
"id": "GooglePrivacyDlpV2beta1ReplaceConfig",
"type": "object"
},
- "GooglePrivacyDlpV2beta1NumericalStatsConfig": {
- "description": "Compute numerical stats over an individual column, including\nmin, max, and quantiles.",
- "type": "object",
- "properties": {
- "field": {
- "$ref": "GooglePrivacyDlpV2beta1FieldId",
- "description": "Field to compute numerical stats on. Supported types are\ninteger, float, date, datetime, timestamp, time."
- }
- },
- "id": "GooglePrivacyDlpV2beta1NumericalStatsConfig"
- },
"GooglePrivacyDlpV2beta1LDiversityEquivalenceClass": {
- "description": "The set of columns' values that share the same l-diversity value.",
- "type": "object",
"properties": {
"equivalenceClassSize": {
"description": "Size of the k-anonymity equivalence class.",
@@ -1694,7 +1291,58 @@
}
}
},
- "id": "GooglePrivacyDlpV2beta1LDiversityEquivalenceClass"
+ "id": "GooglePrivacyDlpV2beta1LDiversityEquivalenceClass",
+ "description": "The set of columns' values that share the same l-diversity value.",
+ "type": "object"
+ },
+ "GooglePrivacyDlpV2beta1NumericalStatsConfig": {
+ "properties": {
+ "field": {
+ "$ref": "GooglePrivacyDlpV2beta1FieldId",
+ "description": "Field to compute numerical stats on. Supported types are\ninteger, float, date, datetime, timestamp, time."
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1NumericalStatsConfig",
+ "description": "Compute numerical stats over an individual column, including\nmin, max, and quantiles.",
+ "type": "object"
+ },
+ "GooglePrivacyDlpV2beta1TimePartConfig": {
+ "description": "For use with `Date`, `Timestamp`, and `TimeOfDay`, extract or preserve a\nportion of the value.",
+ "type": "object",
+ "properties": {
+ "partToExtract": {
+ "enum": [
+ "TIME_PART_UNSPECIFIED",
+ "YEAR",
+ "MONTH",
+ "DAY_OF_MONTH",
+ "DAY_OF_WEEK",
+ "WEEK_OF_YEAR",
+ "HOUR_OF_DAY"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "[000-9999]",
+ "[1-12]",
+ "[1-31]",
+ "[1-7]",
+ "[1-52]",
+ "[0-24]"
+ ]
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1TimePartConfig"
+ },
+ "GooglePrivacyDlpV2beta1RecordCondition": {
+ "description": "A condition for determing whether a transformation should be applied to\na field.",
+ "type": "object",
+ "properties": {
+ "expressions": {
+ "$ref": "GooglePrivacyDlpV2beta1Expressions"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1RecordCondition"
},
"GooglePrivacyDlpV2beta1DeidentificationSummary": {
"description": "High level summary of deidentification.",
@@ -1715,47 +1363,7 @@
},
"id": "GooglePrivacyDlpV2beta1DeidentificationSummary"
},
- "GooglePrivacyDlpV2beta1RecordCondition": {
- "description": "A condition for determing whether a transformation should be applied to\na field.",
- "type": "object",
- "properties": {
- "expressions": {
- "$ref": "GooglePrivacyDlpV2beta1Expressions"
- }
- },
- "id": "GooglePrivacyDlpV2beta1RecordCondition"
- },
- "GooglePrivacyDlpV2beta1TimePartConfig": {
- "description": "For use with `Date`, `Timestamp`, and `TimeOfDay`, extract or preserve a\nportion of the value.",
- "type": "object",
- "properties": {
- "partToExtract": {
- "enumDescriptions": [
- "",
- "[000-9999]",
- "[1-12]",
- "[1-31]",
- "[1-7]",
- "[1-52]",
- "[0-24]"
- ],
- "enum": [
- "TIME_PART_UNSPECIFIED",
- "YEAR",
- "MONTH",
- "DAY_OF_MONTH",
- "DAY_OF_WEEK",
- "WEEK_OF_YEAR",
- "HOUR_OF_DAY"
- ],
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta1TimePartConfig"
- },
"GooglePrivacyDlpV2beta1ListInfoTypesResponse": {
- "description": "Response to the ListInfoTypes request.",
- "type": "object",
"properties": {
"infoTypes": {
"description": "Set of sensitive info types belonging to a category.",
@@ -1765,7 +1373,9 @@
}
}
},
- "id": "GooglePrivacyDlpV2beta1ListInfoTypesResponse"
+ "id": "GooglePrivacyDlpV2beta1ListInfoTypesResponse",
+ "description": "Response to the ListInfoTypes request.",
+ "type": "object"
},
"GooglePrivacyDlpV2beta1CloudStorageKey": {
"description": "Record key for a finding in a Cloud Storage file.",
@@ -1784,16 +1394,10 @@
"id": "GooglePrivacyDlpV2beta1CloudStorageKey"
},
"GooglePrivacyDlpV2beta1NumericalStatsResult": {
- "description": "Result of the numerical stats computation.",
- "type": "object",
"properties": {
- "minValue": {
- "$ref": "GooglePrivacyDlpV2beta1Value",
- "description": "Minimum value appearing in the column."
- },
"maxValue": {
- "description": "Maximum value appearing in the column.",
- "$ref": "GooglePrivacyDlpV2beta1Value"
+ "$ref": "GooglePrivacyDlpV2beta1Value",
+ "description": "Maximum value appearing in the column."
},
"quantileValues": {
"description": "List of 99 values that partition the set of field values into 100 equal\nsized buckets.",
@@ -1801,19 +1405,32 @@
"items": {
"$ref": "GooglePrivacyDlpV2beta1Value"
}
+ },
+ "minValue": {
+ "description": "Minimum value appearing in the column.",
+ "$ref": "GooglePrivacyDlpV2beta1Value"
}
},
- "id": "GooglePrivacyDlpV2beta1NumericalStatsResult"
+ "id": "GooglePrivacyDlpV2beta1NumericalStatsResult",
+ "description": "Result of the numerical stats computation.",
+ "type": "object"
+ },
+ "GooglePrivacyDlpV2beta1Dictionary": {
+ "description": "Custom information type based on a dictionary of words or phrases. This can\nbe used to match sensitive information specific to the data, such as a list\nof employee IDs or job titles.",
+ "type": "object",
+ "properties": {
+ "wordList": {
+ "description": "List of words or phrases to search for.",
+ "$ref": "GooglePrivacyDlpV2beta1WordList"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1Dictionary"
},
"GooglePrivacyDlpV2beta1DatastoreOptions": {
"properties": {
- "partitionId": {
- "description": "A partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty.",
- "$ref": "GooglePrivacyDlpV2beta1PartitionId"
- },
"kind": {
- "$ref": "GooglePrivacyDlpV2beta1KindExpression",
- "description": "The kind to process."
+ "description": "The kind to process.",
+ "$ref": "GooglePrivacyDlpV2beta1KindExpression"
},
"projection": {
"description": "Properties to scan. If none are specified, all properties will be scanned\nby default.",
@@ -1821,6 +1438,10 @@
"items": {
"$ref": "GooglePrivacyDlpV2beta1Projection"
}
+ },
+ "partitionId": {
+ "description": "A partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty.",
+ "$ref": "GooglePrivacyDlpV2beta1PartitionId"
}
},
"id": "GooglePrivacyDlpV2beta1DatastoreOptions",
@@ -1852,17 +1473,13 @@
"description": "Configuration description of the scanning process.\nWhen used with redactContent only info_types and min_likelihood are currently\nused.",
"type": "object",
"properties": {
- "infoTypes": {
- "description": "Restricts what info_types to look for. The values must correspond to\nInfoType values returned by ListInfoTypes or found in documentation.\nEmpty info_types runs all enabled detectors.",
+ "customInfoTypes": {
+ "description": "Custom info types provided by the user.",
"type": "array",
"items": {
- "$ref": "GooglePrivacyDlpV2beta1InfoType"
+ "$ref": "GooglePrivacyDlpV2beta1CustomInfoType"
}
},
- "includeQuote": {
- "description": "When true, a contextual quote from the data that triggered a finding is\nincluded in the response; see Finding.quote.",
- "type": "boolean"
- },
"excludeTypes": {
"description": "When true, excludes type information of the findings.",
"type": "boolean"
@@ -1898,26 +1515,48 @@
"description": "Limits the number of findings per content item or long running operation.",
"format": "int32",
"type": "integer"
+ },
+ "infoTypes": {
+ "description": "Restricts what info_types to look for. The values must correspond to\nInfoType values returned by ListInfoTypes or found in documentation.\nEmpty info_types runs all enabled detectors.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1InfoType"
+ }
+ },
+ "includeQuote": {
+ "description": "When true, a contextual quote from the data that triggered a finding is\nincluded in the response; see Finding.quote.",
+ "type": "boolean"
}
},
"id": "GooglePrivacyDlpV2beta1InspectConfig"
},
"GooglePrivacyDlpV2beta1Projection": {
- "description": "A representation of a Datastore property in a projection.",
- "type": "object",
"properties": {
"property": {
- "$ref": "GooglePrivacyDlpV2beta1PropertyReference",
- "description": "The property to project."
+ "description": "The property to project.",
+ "$ref": "GooglePrivacyDlpV2beta1PropertyReference"
}
},
- "id": "GooglePrivacyDlpV2beta1Projection"
+ "id": "GooglePrivacyDlpV2beta1Projection",
+ "description": "A representation of a Datastore property in a projection.",
+ "type": "object"
},
"GooglePrivacyDlpV2beta1RedactConfig": {
- "description": "Redact a given value. For example, if used with an `InfoTypeTransformation`\ntransforming PHONE_NUMBER, and input 'My phone number is 206-555-0123', the\noutput would be 'My phone number is '.",
- "type": "object",
"properties": {},
- "id": "GooglePrivacyDlpV2beta1RedactConfig"
+ "id": "GooglePrivacyDlpV2beta1RedactConfig",
+ "description": "Redact a given value. For example, if used with an `InfoTypeTransformation`\ntransforming PHONE_NUMBER, and input 'My phone number is 206-555-0123', the\noutput would be 'My phone number is '.",
+ "type": "object"
+ },
+ "GooglePrivacyDlpV2beta1CryptoHashConfig": {
+ "properties": {
+ "cryptoKey": {
+ "$ref": "GooglePrivacyDlpV2beta1CryptoKey",
+ "description": "The key used by the hash function."
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1CryptoHashConfig",
+ "description": "Pseudonymization method that generates surrogates via cryptographic hashing.\nUses SHA-256.\nOutputs a 32 byte digest as an uppercase hex string\n(for example, 41D1567F7F99F1DC2A5FAB886DEE5BEE).\nCurrently, only string and integer values can be hashed.",
+ "type": "object"
},
"GooglePrivacyDlpV2beta1Key": {
"description": "A unique identifier for a Datastore entity.\nIf a key's partition ID or any of its path kinds or names are\nreserved/read-only, the key is reserved/read-only.\nA reserved/read-only key is forbidden in certain documented contexts.",
@@ -1937,31 +1576,20 @@
},
"id": "GooglePrivacyDlpV2beta1Key"
},
- "GooglePrivacyDlpV2beta1CryptoHashConfig": {
- "description": "Pseudonymization method that generates surrogates via cryptographic hashing.\nUses SHA-256.\nOutputs a 32 byte digest as an uppercase hex string\n(for example, 41D1567F7F99F1DC2A5FAB886DEE5BEE).\nCurrently, only string and integer values can be hashed.",
- "type": "object",
- "properties": {
- "cryptoKey": {
- "$ref": "GooglePrivacyDlpV2beta1CryptoKey",
- "description": "The key used by the hash function."
- }
- },
- "id": "GooglePrivacyDlpV2beta1CryptoHashConfig"
- },
"GooglePrivacyDlpV2beta1InspectContentRequest": {
"description": "Request to search for potentially sensitive info in a list of items.",
"type": "object",
"properties": {
+ "inspectConfig": {
+ "description": "Configuration for the inspector.",
+ "$ref": "GooglePrivacyDlpV2beta1InspectConfig"
+ },
"items": {
"description": "The list of items to inspect. Items in a single request are\nconsidered \"related\" unless inspect_config.independent_inputs is true.\nUp to 100 are allowed per request.",
"type": "array",
"items": {
"$ref": "GooglePrivacyDlpV2beta1ContentItem"
}
- },
- "inspectConfig": {
- "description": "Configuration for the inspector.",
- "$ref": "GooglePrivacyDlpV2beta1InspectConfig"
}
},
"id": "GooglePrivacyDlpV2beta1InspectContentRequest"
@@ -1970,6 +1598,11 @@
"description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
"type": "object",
"properties": {
+ "month": {
+ "description": "Month of year. Must be from 1 to 12.",
+ "format": "int32",
+ "type": "integer"
+ },
"year": {
"description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
"format": "int32",
@@ -1979,39 +1612,453 @@
"description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.",
"format": "int32",
"type": "integer"
- },
- "month": {
- "description": "Month of year. Must be from 1 to 12.",
- "format": "int32",
- "type": "integer"
}
},
"id": "GoogleTypeDate"
},
"GooglePrivacyDlpV2beta1ReplaceWithInfoTypeConfig": {
- "description": "Replace each matching finding with the name of the info_type.",
- "type": "object",
"properties": {},
- "id": "GooglePrivacyDlpV2beta1ReplaceWithInfoTypeConfig"
+ "id": "GooglePrivacyDlpV2beta1ReplaceWithInfoTypeConfig",
+ "description": "Replace each matching finding with the name of the info_type.",
+ "type": "object"
},
"GooglePrivacyDlpV2beta1ImageRedactionConfig": {
- "description": "Configuration for determing how redaction of images should occur.",
- "type": "object",
"properties": {
"redactionColor": {
- "$ref": "GooglePrivacyDlpV2beta1Color",
- "description": "The color to use when redacting content from an image. If not specified,\nthe default is black."
+ "description": "The color to use when redacting content from an image. If not specified,\nthe default is black.",
+ "$ref": "GooglePrivacyDlpV2beta1Color"
},
"redactAllText": {
"description": "If true, all text found in the image, regardless whether it matches an\ninfo_type, is redacted.",
"type": "boolean"
},
"infoType": {
- "$ref": "GooglePrivacyDlpV2beta1InfoType",
- "description": "Only one per info_type should be provided per request. If not\nspecified, and redact_all_text is false, the DLP API will redact all\ntext that it matches against all info_types that are found, but not\nspecified in another ImageRedactionConfig."
+ "description": "Only one per info_type should be provided per request. If not\nspecified, and redact_all_text is false, the DLP API will redact all\ntext that it matches against all info_types that are found, but not\nspecified in another ImageRedactionConfig.",
+ "$ref": "GooglePrivacyDlpV2beta1InfoType"
}
},
- "id": "GooglePrivacyDlpV2beta1ImageRedactionConfig"
+ "id": "GooglePrivacyDlpV2beta1ImageRedactionConfig",
+ "description": "Configuration for determing how redaction of images should occur.",
+ "type": "object"
+ },
+ "GooglePrivacyDlpV2beta1Location": {
+ "properties": {
+ "codepointRange": {
+ "description": "Character offsets within a content item, included when content type\nis a text. Default charset assumed to be UTF-8.",
+ "$ref": "GooglePrivacyDlpV2beta1Range"
+ },
+ "fieldId": {
+ "$ref": "GooglePrivacyDlpV2beta1FieldId",
+ "description": "Field id of the field containing the finding."
+ },
+ "imageBoxes": {
+ "description": "Location within an image's pixels.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1ImageLocation"
+ }
+ },
+ "byteRange": {
+ "$ref": "GooglePrivacyDlpV2beta1Range",
+ "description": "Zero-based byte offsets within a content item."
+ },
+ "recordKey": {
+ "description": "Key of the finding.",
+ "$ref": "GooglePrivacyDlpV2beta1RecordKey"
+ },
+ "tableLocation": {
+ "$ref": "GooglePrivacyDlpV2beta1TableLocation",
+ "description": "Location within a `ContentItem.Table`."
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1Location",
+ "description": "Specifies the location of a finding within its source item.",
+ "type": "object"
+ },
+ "GooglePrivacyDlpV2beta1RecordSuppression": {
+ "description": "Configuration to suppress records whose suppression conditions evaluate to\ntrue.",
+ "type": "object",
+ "properties": {
+ "condition": {
+ "$ref": "GooglePrivacyDlpV2beta1RecordCondition"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1RecordSuppression"
+ },
+ "GooglePrivacyDlpV2beta1InfoTypeDescription": {
+ "description": "Description of the information type (infoType).",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Internal name of the infoType.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Human readable form of the infoType name.",
+ "type": "string"
+ },
+ "categories": {
+ "description": "List of categories this infoType belongs to.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1CategoryDescription"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1InfoTypeDescription"
+ },
+ "GooglePrivacyDlpV2beta1EntityId": {
+ "properties": {
+ "field": {
+ "description": "Composite key indicating which field contains the entity identifier.",
+ "$ref": "GooglePrivacyDlpV2beta1FieldId"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1EntityId",
+ "description": "An entity in a dataset is a field or set of fields that correspond to a\nsingle person. For example, in medical records the `EntityId` might be\na patient identifier, or for financial records it might be an account\nidentifier. This message is used when generalizations or analysis must be\nconsistent across multiple rows pertaining to the same entity.",
+ "type": "object"
+ },
+ "GooglePrivacyDlpV2beta1UnwrappedCryptoKey": {
+ "properties": {
+ "key": {
+ "description": "The AES 128/192/256 bit key. [required]",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1UnwrappedCryptoKey",
+ "description": "Using raw keys is prone to security risks due to accidentally\nleaking the key. Choose another type of key if possible.",
+ "type": "object"
+ },
+ "GooglePrivacyDlpV2beta1CustomInfoType": {
+ "description": "Custom information type provided by the user. Used to find domain-specific\nsensitive information configurable to the data in question.",
+ "type": "object",
+ "properties": {
+ "infoType": {
+ "$ref": "GooglePrivacyDlpV2beta1InfoType",
+ "description": "Info type configuration. All custom info types must have configurations\nthat do not conflict with built-in info types or other custom info types."
+ },
+ "dictionary": {
+ "$ref": "GooglePrivacyDlpV2beta1Dictionary",
+ "description": "Dictionary-based custom info type."
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1CustomInfoType"
+ },
+ "GoogleRpcStatus": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
+ "properties": {
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "type": "array",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ }
+ },
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "GoogleRpcStatus"
+ },
+ "GooglePrivacyDlpV2beta1PathElement": {
+ "properties": {
+ "id": {
+ "description": "The auto-allocated ID of the entity.\nNever equal to zero. Values less than zero are discouraged and may not\nbe supported in the future.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "The kind of the entity.\nA kind matching regex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
+ "type": "string"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1PathElement",
+ "description": "A (kind, ID/name) pair used to construct a key path.\n\nIf either name or ID is set, the element is complete.\nIf neither is set, the element is incomplete.",
+ "type": "object"
+ },
+ "GooglePrivacyDlpV2beta1BigQueryTable": {
+ "description": "Message defining the location of a BigQuery table. A table is uniquely\nidentified by its project_id, dataset_id, and table_name. Within a query\na table is often referenced with a string in the format of:\n`\u003cproject_id\u003e:\u003cdataset_id\u003e.\u003ctable_id\u003e` or\n`\u003cproject_id\u003e.\u003cdataset_id\u003e.\u003ctable_id\u003e`.",
+ "type": "object",
+ "properties": {
+ "datasetId": {
+ "description": "Dataset ID of the table.",
+ "type": "string"
+ },
+ "tableId": {
+ "description": "Name of the table.",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The Google Cloud Platform project ID of the project containing the table.\nIf omitted, project ID is inferred from the API call.",
+ "type": "string"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1BigQueryTable"
+ },
+ "GooglePrivacyDlpV2beta1SummaryResult": {
+ "description": "A collection that informs the user the number of times a particular\n`TransformationResultCode` and error details occurred.",
+ "type": "object",
+ "properties": {
+ "details": {
+ "description": "A place for warnings or errors to show up if a transformation didn't\nwork as expected.",
+ "type": "string"
+ },
+ "count": {
+ "format": "int64",
+ "type": "string"
+ },
+ "code": {
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "enum": [
+ "TRANSFORMATION_RESULT_CODE_UNSPECIFIED",
+ "SUCCESS",
+ "ERROR"
+ ],
+ "type": "string"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1SummaryResult"
+ },
+ "GooglePrivacyDlpV2beta1InfoTypeTransformations": {
+ "description": "A type of transformation that will scan unstructured text and\napply various `PrimitiveTransformation`s to each finding, where the\ntransformation is applied to only values that were identified as a specific\ninfo_type.",
+ "type": "object",
+ "properties": {
+ "transformations": {
+ "description": "Transformation for each info type. Cannot specify more than one\nfor a given info type. [required]",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1InfoTypeTransformation"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1InfoTypeTransformations"
+ },
+ "GooglePrivacyDlpV2beta1ListRootCategoriesResponse": {
+ "properties": {
+ "categories": {
+ "description": "List of all into type categories supported by the API.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1CategoryDescription"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1ListRootCategoriesResponse",
+ "description": "Response for ListRootCategories request.",
+ "type": "object"
+ },
+ "GooglePrivacyDlpV2beta1KindExpression": {
+ "description": "A representation of a Datastore kind.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the kind.",
+ "type": "string"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1KindExpression"
+ },
+ "GooglePrivacyDlpV2beta1FileSet": {
+ "properties": {
+ "url": {
+ "description": "The url, in the format `gs://\u003cbucket\u003e/\u003cpath\u003e`. Trailing wildcard in the\npath is allowed.",
+ "type": "string"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1FileSet",
+ "description": "Set of files to scan.",
+ "type": "object"
+ },
+ "GooglePrivacyDlpV2beta1InfoTypeTransformation": {
+ "properties": {
+ "primitiveTransformation": {
+ "description": "Primitive transformation to apply to the info type. [required]",
+ "$ref": "GooglePrivacyDlpV2beta1PrimitiveTransformation"
+ },
+ "infoTypes": {
+ "description": "Info types to apply the transformation to. Empty list will match all\navailable info types for this transformation.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1InfoType"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1InfoTypeTransformation",
+ "description": "A transformation to apply to text that is identified as a specific\ninfo_type.",
+ "type": "object"
+ },
+ "GooglePrivacyDlpV2beta1AnalyzeDataSourceRiskRequest": {
+ "description": "Request for creating a risk analysis operation.",
+ "type": "object",
+ "properties": {
+ "sourceTable": {
+ "description": "Input dataset to compute metrics over.",
+ "$ref": "GooglePrivacyDlpV2beta1BigQueryTable"
+ },
+ "privacyMetric": {
+ "$ref": "GooglePrivacyDlpV2beta1PrivacyMetric",
+ "description": "Privacy metric to compute."
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1AnalyzeDataSourceRiskRequest"
+ },
+ "GooglePrivacyDlpV2beta1KAnonymityResult": {
+ "properties": {
+ "equivalenceClassHistogramBuckets": {
+ "description": "Histogram of k-anonymity equivalence classes.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1KAnonymityHistogramBucket"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1KAnonymityResult",
+ "description": "Result of the k-anonymity computation.",
+ "type": "object"
+ },
+ "GooglePrivacyDlpV2beta1Bucket": {
+ "description": "Buckets represented as ranges, along with replacement values. Ranges must\nbe non-overlapping.",
+ "type": "object",
+ "properties": {
+ "max": {
+ "$ref": "GooglePrivacyDlpV2beta1Value",
+ "description": "Upper bound of the range, exclusive; type must match min."
+ },
+ "replacementValue": {
+ "description": "Replacement value for this bucket. If not provided\nthe default behavior will be to hyphenate the min-max range.",
+ "$ref": "GooglePrivacyDlpV2beta1Value"
+ },
+ "min": {
+ "description": "Lower bound of the range, inclusive. Type should be the same as max if\nused.",
+ "$ref": "GooglePrivacyDlpV2beta1Value"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1Bucket"
+ },
+ "GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket": {
+ "properties": {
+ "bucketSize": {
+ "description": "Total number of records in this bucket.",
+ "format": "int64",
+ "type": "string"
+ },
+ "valueFrequencyUpperBound": {
+ "description": "Upper bound on the value frequency of the values in this bucket.",
+ "format": "int64",
+ "type": "string"
+ },
+ "valueFrequencyLowerBound": {
+ "description": "Lower bound on the value frequency of the values in this bucket.",
+ "format": "int64",
+ "type": "string"
+ },
+ "bucketValues": {
+ "description": "Sample of value frequencies in this bucket. The total number of\nvalues returned per bucket is capped at 20.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1ValueFrequency"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket",
+ "description": "Histogram bucket of value frequencies in the column.",
+ "type": "object"
+ },
+ "GooglePrivacyDlpV2beta1TableLocation": {
+ "description": "Location of a finding within a `ContentItem.Table`.",
+ "type": "object",
+ "properties": {
+ "rowIndex": {
+ "description": "The zero-based index of the row where the finding is located.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1TableLocation"
+ },
+ "GooglePrivacyDlpV2beta1DatastoreKey": {
+ "description": "Record key for a finding in Cloud Datastore.",
+ "type": "object",
+ "properties": {
+ "entityKey": {
+ "description": "Datastore entity key.",
+ "$ref": "GooglePrivacyDlpV2beta1Key"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1DatastoreKey"
+ },
+ "GooglePrivacyDlpV2beta1KAnonymityConfig": {
+ "description": "k-anonymity metric, used for analysis of reidentification risk.",
+ "type": "object",
+ "properties": {
+ "entityId": {
+ "description": "Optional message indicating that each distinct `EntityId` should not\ncontribute to the k-anonymity count more than once per equivalence class.",
+ "$ref": "GooglePrivacyDlpV2beta1EntityId"
+ },
+ "quasiIds": {
+ "description": "Set of fields to compute k-anonymity over. When multiple fields are\nspecified, they are considered a single composite key. Structs and\nrepeated data types are not supported; however, nested fields are\nsupported so long as they are not structs themselves or nested within\na repeated field.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1FieldId"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1KAnonymityConfig"
+ },
+ "GooglePrivacyDlpV2beta1RecordKey": {
+ "description": "Message for a unique key indicating a record that contains a finding.",
+ "type": "object",
+ "properties": {
+ "cloudStorageKey": {
+ "$ref": "GooglePrivacyDlpV2beta1CloudStorageKey"
+ },
+ "datastoreKey": {
+ "$ref": "GooglePrivacyDlpV2beta1DatastoreKey"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1RecordKey"
+ },
+ "GooglePrivacyDlpV2beta1DeidentifyContentRequest": {
+ "description": "Request to de-identify a list of items.",
+ "type": "object",
+ "properties": {
+ "items": {
+ "description": "The list of items to inspect. Up to 100 are allowed per request.\nAll items will be treated as text/*.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1ContentItem"
+ }
+ },
+ "deidentifyConfig": {
+ "$ref": "GooglePrivacyDlpV2beta1DeidentifyConfig",
+ "description": "Configuration for the de-identification of the list of content items."
+ },
+ "inspectConfig": {
+ "$ref": "GooglePrivacyDlpV2beta1InspectConfig",
+ "description": "Configuration for the inspector."
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1DeidentifyContentRequest"
}
},
"icons": {
@@ -2036,6 +2083,155 @@
"title": "DLP API",
"ownerName": "Google",
"resources": {
+ "riskAnalysis": {
+ "resources": {
+ "operations": {
+ "methods": {
+ "cancel": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "GoogleProtobufEmpty"
+ },
+ "parameters": {
+ "name": {
+ "pattern": "^riskAnalysis/operations/[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource to be cancelled.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/riskAnalysis/operations/{operationsId}:cancel",
+ "id": "dlp.riskAnalysis.operations.cancel",
+ "path": "v2beta1/{+name}:cancel",
+ "request": {
+ "$ref": "GoogleLongrunningCancelOperationRequest"
+ },
+ "description": "Cancels an operation. Use the `inspect.operations.get` to check whether the cancellation succeeded or the operation completed despite cancellation."
+ },
+ "delete": {
+ "description": "This method is not supported and the server returns `UNIMPLEMENTED`.",
+ "response": {
+ "$ref": "GoogleProtobufEmpty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "pattern": "^riskAnalysis/operations/[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource to be deleted.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/riskAnalysis/operations/{operationsId}",
+ "path": "v2beta1/{+name}",
+ "id": "dlp.riskAnalysis.operations.delete"
+ },
+ "list": {
+ "description": "Fetches the list of long running operations.",
+ "response": {
+ "$ref": "GoogleLongrunningListOperationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "description": "The name of the operation's parent resource.",
+ "required": true,
+ "type": "string",
+ "pattern": "^riskAnalysis/operations$",
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The list page size. The maximum allowed value is 256 and the default is 100.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "filter": {
+ "location": "query",
+ "description": "Filters by `done`. That is, `done=true` or `done=false`.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/riskAnalysis/operations",
+ "path": "v2beta1/{+name}",
+ "id": "dlp.riskAnalysis.operations.list"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "GoogleLongrunningOperation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^riskAnalysis/operations/[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v2beta1/riskAnalysis/operations/{operationsId}",
+ "id": "dlp.riskAnalysis.operations.get",
+ "path": "v2beta1/{+name}",
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
+ }
+ }
+ }
+ }
+ },
+ "dataSource": {
+ "methods": {
+ "analyze": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "GoogleLongrunningOperation"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/dataSource:analyze",
+ "id": "dlp.dataSource.analyze",
+ "path": "v2beta1/dataSource:analyze",
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta1AnalyzeDataSourceRiskRequest"
+ },
+ "description": "Schedules a job to compute risk analysis metrics over content in a Google\nCloud Platform repository."
+ }
+ }
+ },
"inspect": {
"resources": {
"results": {
@@ -2056,9 +2252,9 @@
],
"parameters": {
"filter": {
+ "location": "query",
"description": "Restricts findings to items that match. Supports info_type and likelihood.\n\nExamples:\n\n- info_type=EMAIL_ADDRESS\n- info_type=PHONE_NUMBER,EMAIL_ADDRESS\n- likelihood=VERY_LIKELY\n- likelihood=VERY_LIKELY,LIKELY\n- info_type=EMAIL_ADDRESS,likelihood=VERY_LIKELY,LIKELY",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"name": {
"description": "Identifier of the results set returned as metadata of\nthe longrunning operation created by a call to InspectDataSource.\nShould be in the format of `inspect/results/{id}`.",
@@ -2090,20 +2286,17 @@
"operations": {
"methods": {
"cancel": {
- "flatPath": "v2beta1/inspect/operations/{operationsId}:cancel",
- "id": "dlp.inspect.operations.cancel",
- "path": "v2beta1/{+name}:cancel",
"request": {
"$ref": "GoogleLongrunningCancelOperationRequest"
},
"description": "Cancels an operation. Use the `inspect.operations.get` to check whether the cancellation succeeded or the operation completed despite cancellation.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "GoogleProtobufEmpty"
},
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
"parameters": {
"name": {
"pattern": "^inspect/operations/[^/]+$",
@@ -2115,48 +2308,44 @@
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ]
+ ],
+ "flatPath": "v2beta1/inspect/operations/{operationsId}:cancel",
+ "path": "v2beta1/{+name}:cancel",
+ "id": "dlp.inspect.operations.cancel"
},
"delete": {
- "id": "dlp.inspect.operations.delete",
- "path": "v2beta1/{+name}",
- "description": "This method is not supported and the server returns `UNIMPLEMENTED`.",
"httpMethod": "DELETE",
- "response": {
- "$ref": "GoogleProtobufEmpty"
- },
"parameterOrder": [
"name"
],
+ "response": {
+ "$ref": "GoogleProtobufEmpty"
+ },
"parameters": {
"name": {
- "location": "path",
"description": "The name of the operation resource to be deleted.",
"required": true,
"type": "string",
- "pattern": "^inspect/operations/[^/]+$"
+ "pattern": "^inspect/operations/[^/]+$",
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v2beta1/inspect/operations/{operationsId}"
+ "flatPath": "v2beta1/inspect/operations/{operationsId}",
+ "id": "dlp.inspect.operations.delete",
+ "path": "v2beta1/{+name}",
+ "description": "This method is not supported and the server returns `UNIMPLEMENTED`."
},
"list": {
- "flatPath": "v2beta1/inspect/operations",
- "path": "v2beta1/{+name}",
- "id": "dlp.inspect.operations.list",
- "description": "Fetches the list of long running operations.",
+ "httpMethod": "GET",
"response": {
"$ref": "GoogleLongrunningListOperationsResponse"
},
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"filter": {
"description": "Filters by `done`. That is, `done=true` or `done=false`.",
@@ -2164,11 +2353,11 @@
"location": "query"
},
"name": {
- "location": "path",
"description": "The name of the operation's parent resource.",
"required": true,
"type": "string",
- "pattern": "^inspect/operations$"
+ "pattern": "^inspect/operations$",
+ "location": "path"
},
"pageToken": {
"location": "query",
@@ -2181,46 +2370,53 @@
"format": "int32",
"type": "integer"
}
- }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/inspect/operations",
+ "id": "dlp.inspect.operations.list",
+ "path": "v2beta1/{+name}",
+ "description": "Fetches the list of long running operations."
},
"get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "GoogleLongrunningOperation"
},
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
"parameters": {
"name": {
+ "pattern": "^inspect/operations/[^/]+$",
+ "location": "path",
"description": "The name of the operation resource.",
"required": true,
- "type": "string",
- "pattern": "^inspect/operations/[^/]+$",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/inspect/operations/{operationsId}",
- "id": "dlp.inspect.operations.get",
"path": "v2beta1/{+name}",
+ "id": "dlp.inspect.operations.get",
"description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
},
"create": {
- "httpMethod": "POST",
- "parameterOrder": [],
"response": {
"$ref": "GoogleLongrunningOperation"
},
+ "parameterOrder": [],
+ "httpMethod": "POST",
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/inspect/operations",
- "id": "dlp.inspect.operations.create",
"path": "v2beta1/inspect/operations",
+ "id": "dlp.inspect.operations.create",
"request": {
"$ref": "GooglePrivacyDlpV2beta1CreateInspectOperationRequest"
},
@@ -2232,29 +2428,7 @@
},
"content": {
"methods": {
- "deidentify": {
- "response": {
- "$ref": "GooglePrivacyDlpV2beta1DeidentifyContentResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/content:deidentify",
- "path": "v2beta1/content:deidentify",
- "id": "dlp.content.deidentify",
- "request": {
- "$ref": "GooglePrivacyDlpV2beta1DeidentifyContentRequest"
- },
- "description": "De-identifies potentially sensitive info from a list of strings.\nThis method has limits on input size and output size."
- },
"inspect": {
- "request": {
- "$ref": "GooglePrivacyDlpV2beta1InspectContentRequest"
- },
- "description": "Finds potentially sensitive info in a list of strings.\nThis method has limits on input size, processing time, and output size.",
"response": {
"$ref": "GooglePrivacyDlpV2beta1InspectContentResponse"
},
@@ -2266,9 +2440,17 @@
],
"flatPath": "v2beta1/content:inspect",
"path": "v2beta1/content:inspect",
- "id": "dlp.content.inspect"
+ "id": "dlp.content.inspect",
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta1InspectContentRequest"
+ },
+ "description": "Finds potentially sensitive info in a list of strings.\nThis method has limits on input size, processing time, and output size."
},
"redact": {
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta1RedactContentRequest"
+ },
+ "description": "Redacts potentially sensitive info from a list of strings.\nThis method has limits on input size, processing time, and output size.",
"httpMethod": "POST",
"parameterOrder": [],
"response": {
@@ -2280,15 +2462,52 @@
],
"flatPath": "v2beta1/content:redact",
"id": "dlp.content.redact",
- "path": "v2beta1/content:redact",
+ "path": "v2beta1/content:redact"
+ },
+ "deidentify": {
+ "path": "v2beta1/content:deidentify",
+ "id": "dlp.content.deidentify",
+ "description": "De-identifies potentially sensitive info from a list of strings.\nThis method has limits on input size and output size.",
"request": {
- "$ref": "GooglePrivacyDlpV2beta1RedactContentRequest"
+ "$ref": "GooglePrivacyDlpV2beta1DeidentifyContentRequest"
},
- "description": "Redacts potentially sensitive info from a list of strings.\nThis method has limits on input size, processing time, and output size."
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta1DeidentifyContentResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v2beta1/content:deidentify"
}
}
},
"rootCategories": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta1ListRootCategoriesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "languageCode": {
+ "description": "Optional language code for localized friendly category names.\nIf omitted or if localized strings are not available,\nen-US strings will be returned.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v2beta1/rootCategories",
+ "path": "v2beta1/rootCategories",
+ "id": "dlp.rootCategories.list",
+ "description": "Returns the list of root categories of sensitive information."
+ }
+ },
"resources": {
"infoTypes": {
"methods": {
@@ -2306,16 +2525,16 @@
],
"parameters": {
"category": {
- "pattern": "^[^/]+$",
- "location": "path",
"description": "Category name as returned by ListRootCategories.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^[^/]+$",
+ "location": "path"
},
"languageCode": {
+ "location": "query",
"description": "Optional BCP-47 language code for localized info type friendly\nnames. If omitted, or if localized strings are not available,\nen-US strings will be returned.",
- "type": "string",
- "location": "query"
+ "type": "string"
}
},
"flatPath": "v2beta1/rootCategories/{rootCategoriesId}/infoTypes",
@@ -2324,185 +2543,39 @@
}
}
}
- },
- "methods": {
- "list": {
- "response": {
- "$ref": "GooglePrivacyDlpV2beta1ListRootCategoriesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "languageCode": {
- "location": "query",
- "description": "Optional language code for localized friendly category names.\nIf omitted or if localized strings are not available,\nen-US strings will be returned.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/rootCategories",
- "path": "v2beta1/rootCategories",
- "id": "dlp.rootCategories.list",
- "description": "Returns the list of root categories of sensitive information."
- }
- }
- },
- "riskAnalysis": {
- "resources": {
- "operations": {
- "methods": {
- "list": {
- "flatPath": "v2beta1/riskAnalysis/operations",
- "id": "dlp.riskAnalysis.operations.list",
- "path": "v2beta1/{+name}",
- "description": "Fetches the list of long running operations.",
- "httpMethod": "GET",
- "response": {
- "$ref": "GoogleLongrunningListOperationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "pattern": "^riskAnalysis/operations$",
- "location": "path",
- "description": "The name of the operation's parent resource.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "The list page size. The maximum allowed value is 256 and the default is 100.",
- "format": "int32",
- "type": "integer"
- },
- "filter": {
- "location": "query",
- "description": "Filters by `done`. That is, `done=true` or `done=false`.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "get": {
- "response": {
- "$ref": "GoogleLongrunningOperation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string",
- "pattern": "^riskAnalysis/operations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/riskAnalysis/operations/{operationsId}",
- "path": "v2beta1/{+name}",
- "id": "dlp.riskAnalysis.operations.get",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
- },
- "cancel": {
- "request": {
- "$ref": "GoogleLongrunningCancelOperationRequest"
- },
- "description": "Cancels an operation. Use the `inspect.operations.get` to check whether the cancellation succeeded or the operation completed despite cancellation.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "GoogleProtobufEmpty"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation resource to be cancelled.",
- "required": true,
- "type": "string",
- "pattern": "^riskAnalysis/operations/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/riskAnalysis/operations/{operationsId}:cancel",
- "id": "dlp.riskAnalysis.operations.cancel",
- "path": "v2beta1/{+name}:cancel"
- },
- "delete": {
- "description": "This method is not supported and the server returns `UNIMPLEMENTED`.",
- "response": {
- "$ref": "GoogleProtobufEmpty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "description": "The name of the operation resource to be deleted.",
- "required": true,
- "type": "string",
- "pattern": "^riskAnalysis/operations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/riskAnalysis/operations/{operationsId}",
- "path": "v2beta1/{+name}",
- "id": "dlp.riskAnalysis.operations.delete"
- }
- }
- }
- }
- },
- "dataSource": {
- "methods": {
- "analyze": {
- "response": {
- "$ref": "GoogleLongrunningOperation"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/dataSource:analyze",
- "path": "v2beta1/dataSource:analyze",
- "id": "dlp.dataSource.analyze",
- "request": {
- "$ref": "GooglePrivacyDlpV2beta1AnalyzeDataSourceRiskRequest"
- },
- "description": "Schedules a job to compute risk analysis metrics over content in a Google\nCloud Platform repository."
- }
}
}
},
"parameters": {
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query"
+ },
"alt": {
- "description": "Data format for response.",
- "default": "json",
"enum": [
"json",
"media",
@@ -2514,18 +2587,20 @@
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
- "location": "query"
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
},
"access_token": {
"location": "query",
"description": "OAuth access token.",
"type": "string"
},
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
"quotaUser": {
"location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
@@ -2537,53 +2612,25 @@
"default": "true",
"location": "query"
},
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
"oauth_token": {
"location": "query",
"description": "OAuth 2.0 token for the current user.",
"type": "string"
},
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
"location": "query"
},
"prettyPrint": {
- "location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
+ "default": "true",
"location": "query"
}
},
diff --git a/dlp/v2beta1/dlp-gen.go b/dlp/v2beta1/dlp-gen.go
index 05891a5..f18172a 100644
--- a/dlp/v2beta1/dlp-gen.go
+++ b/dlp/v2beta1/dlp-gen.go
@@ -1224,6 +1224,42 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// GooglePrivacyDlpV2beta1CustomInfoType: Custom information type
+// provided by the user. Used to find domain-specific
+// sensitive information configurable to the data in question.
+type GooglePrivacyDlpV2beta1CustomInfoType struct {
+ // Dictionary: Dictionary-based custom info type.
+ Dictionary *GooglePrivacyDlpV2beta1Dictionary `json:"dictionary,omitempty"`
+
+ // InfoType: Info type configuration. All custom info types must have
+ // configurations
+ // that do not conflict with built-in info types or other custom info
+ // types.
+ InfoType *GooglePrivacyDlpV2beta1InfoType `json:"infoType,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Dictionary") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Dictionary") to include in
+ // API requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *GooglePrivacyDlpV2beta1CustomInfoType) MarshalJSON() ([]byte, error) {
+ type noMethod GooglePrivacyDlpV2beta1CustomInfoType
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// GooglePrivacyDlpV2beta1DatastoreKey: Record key for a finding in
// Cloud Datastore.
type GooglePrivacyDlpV2beta1DatastoreKey struct {
@@ -1441,6 +1477,38 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// GooglePrivacyDlpV2beta1Dictionary: Custom information type based on a
+// dictionary of words or phrases. This can
+// be used to match sensitive information specific to the data, such as
+// a list
+// of employee IDs or job titles.
+type GooglePrivacyDlpV2beta1Dictionary struct {
+ // WordList: List of words or phrases to search for.
+ WordList *GooglePrivacyDlpV2beta1WordList `json:"wordList,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "WordList") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "WordList") to include in
+ // API requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *GooglePrivacyDlpV2beta1Dictionary) MarshalJSON() ([]byte, error) {
+ type noMethod GooglePrivacyDlpV2beta1Dictionary
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// GooglePrivacyDlpV2beta1EntityId: An entity in a dataset is a field or
// set of fields that correspond to a
// single person. For example, in medical records the `EntityId` might
@@ -2052,6 +2120,9 @@
// currently
// used.
type GooglePrivacyDlpV2beta1InspectConfig struct {
+ // CustomInfoTypes: Custom info types provided by the user.
+ CustomInfoTypes []*GooglePrivacyDlpV2beta1CustomInfoType `json:"customInfoTypes,omitempty"`
+
// ExcludeTypes: When true, excludes type information of the findings.
ExcludeTypes bool `json:"excludeTypes,omitempty"`
@@ -2087,7 +2158,7 @@
// "VERY_LIKELY" - Many matching elements.
MinLikelihood string `json:"minLikelihood,omitempty"`
- // ForceSendFields is a list of field names (e.g. "ExcludeTypes") to
+ // ForceSendFields is a list of field names (e.g. "CustomInfoTypes") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
@@ -2095,12 +2166,13 @@
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
- // NullFields is a list of field names (e.g. "ExcludeTypes") to include
- // in API requests with the JSON null value. By default, fields with
- // empty values are omitted from API requests. However, any field with
- // an empty value appearing in NullFields will be sent to the server as
- // null. It is an error if a field in this list has a non-empty value.
- // This may be used to include null fields in Patch requests.
+ // NullFields is a list of field names (e.g. "CustomInfoTypes") to
+ // include in API requests with the JSON null value. By default, fields
+ // with empty values are omitted from API requests. However, any field
+ // with an empty value appearing in NullFields will be sent to the
+ // server as null. It is an error if a field in this list has a
+ // non-empty value. This may be used to include null fields in Patch
+ // requests.
NullFields []string `json:"-"`
}
@@ -4078,6 +4150,39 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// GooglePrivacyDlpV2beta1WordList: Message defining a list of words or
+// phrases to search for in the data.
+type GooglePrivacyDlpV2beta1WordList struct {
+ // Words: Words or phrases defining the dictionary. No word can be
+ // shorter than 3
+ // characters in length. To match, there must be whitespace or
+ // punctuation
+ // around the targeted string. [required]
+ Words []string `json:"words,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Words") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Words") to include in API
+ // requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *GooglePrivacyDlpV2beta1WordList) MarshalJSON() ([]byte, error) {
+ type noMethod GooglePrivacyDlpV2beta1WordList
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// GoogleProtobufEmpty: A generic empty message that you can re-use to
// avoid defining duplicated
// empty messages in your APIs. A typical example is to use it as the
diff --git a/firebasedynamiclinks/v1/firebasedynamiclinks-api.json b/firebasedynamiclinks/v1/firebasedynamiclinks-api.json
index 0ada776..28ca1ad 100644
--- a/firebasedynamiclinks/v1/firebasedynamiclinks-api.json
+++ b/firebasedynamiclinks/v1/firebasedynamiclinks-api.json
@@ -1,15 +1,386 @@
{
+ "batchPath": "batch",
+ "title": "Firebase Dynamic Links API",
+ "ownerName": "Google",
+ "resources": {
+ "shortLinks": {
+ "methods": {
+ "create": {
+ "flatPath": "v1/shortLinks",
+ "path": "v1/shortLinks",
+ "id": "firebasedynamiclinks.shortLinks.create",
+ "request": {
+ "$ref": "CreateShortDynamicLinkRequest"
+ },
+ "description": "Creates a short Dynamic Link given either a valid long Dynamic Link or\ndetails such as Dynamic Link domain, Android and iOS app information.\nThe created short Dynamic Link will not expire.\n\nRepeated calls with the same long Dynamic Link or Dynamic Link information\nwill produce the same short Dynamic Link.\n\nThe Dynamic Link domain in the request must be owned by requester's\nFirebase project.",
+ "response": {
+ "$ref": "CreateShortDynamicLinkResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/firebase"
+ ]
+ }
+ }
+ },
+ "v1": {
+ "methods": {
+ "getLinkStats": {
+ "description": "Fetches analytics stats of a short Dynamic Link for a given\nduration. Metrics include number of clicks, redirects, installs,\napp first opens, and app reopens.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "DynamicLinkStats"
+ },
+ "parameterOrder": [
+ "dynamicLink"
+ ],
+ "parameters": {
+ "durationDays": {
+ "location": "query",
+ "description": "The span of time requested in days.",
+ "format": "int64",
+ "type": "string"
+ },
+ "dynamicLink": {
+ "location": "path",
+ "description": "Dynamic Link URL. e.g. https://abcd.app.goo.gl/wxyz",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/firebase"
+ ],
+ "flatPath": "v1/{dynamicLink}/linkStats",
+ "id": "firebasedynamiclinks.getLinkStats",
+ "path": "v1/{dynamicLink}/linkStats"
+ },
+ "installAttribution": {
+ "flatPath": "v1/installAttribution",
+ "path": "v1/installAttribution",
+ "id": "firebasedynamiclinks.installAttribution",
+ "description": "Get iOS strong/weak-match info for post-install attribution.",
+ "request": {
+ "$ref": "GetIosPostInstallAttributionRequest"
+ },
+ "response": {
+ "$ref": "GetIosPostInstallAttributionResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/firebase"
+ ],
+ "parameters": {}
+ }
+ }
+ }
+ },
+ "parameters": {
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://firebasedynamiclinks-ipv6.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Programmatically creates and manages Firebase Dynamic Links.",
+ "servicePath": "",
"basePath": "",
- "revision": "20171005",
+ "revision": "20171011",
"documentationLink": "https://firebase.google.com/docs/dynamic-links/",
"id": "firebasedynamiclinks:v1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "CreateShortDynamicLinkResponse": {
- "description": "Response to create a short Dynamic Link.",
+ "NavigationInfo": {
+ "description": "Information of navigation behavior.",
"type": "object",
"properties": {
+ "enableForcedRedirect": {
+ "description": "If this option is on, FDL click will be forced to redirect rather than\nshow an interstitial page.",
+ "type": "boolean"
+ }
+ },
+ "id": "NavigationInfo"
+ },
+ "IosInfo": {
+ "description": "iOS related attributes to the Dynamic Link..",
+ "type": "object",
+ "properties": {
+ "iosIpadFallbackLink": {
+ "description": "If specified, this overrides the ios_fallback_link value on iPads.",
+ "type": "string"
+ },
+ "iosIpadBundleId": {
+ "description": "iPad bundle ID of the app.",
+ "type": "string"
+ },
+ "iosCustomScheme": {
+ "description": "Custom (destination) scheme to use for iOS. By default, we’ll use the\nbundle ID as the custom scheme. Developer can override this behavior using\nthis param.",
+ "type": "string"
+ },
+ "iosBundleId": {
+ "description": "iOS bundle ID of the app.",
+ "type": "string"
+ },
+ "iosFallbackLink": {
+ "description": "Link to open on iOS if the app is not installed.",
+ "type": "string"
+ },
+ "iosAppStoreId": {
+ "description": "iOS App Store ID.",
+ "type": "string"
+ }
+ },
+ "id": "IosInfo"
+ },
+ "AnalyticsInfo": {
+ "description": "Tracking parameters supported by Dynamic Link.",
+ "type": "object",
+ "properties": {
+ "itunesConnectAnalytics": {
+ "$ref": "ITunesConnectAnalytics",
+ "description": "iTunes Connect App Analytics."
+ },
+ "googlePlayAnalytics": {
+ "description": "Google Play Campaign Measurements.",
+ "$ref": "GooglePlayAnalytics"
+ }
+ },
+ "id": "AnalyticsInfo"
+ },
+ "CreateShortDynamicLinkRequest": {
+ "description": "Request to create a short Dynamic Link.",
+ "type": "object",
+ "properties": {
+ "dynamicLinkInfo": {
+ "$ref": "DynamicLinkInfo",
+ "description": "Information about the Dynamic Link to be shortened.\n[Learn more](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically)."
+ },
+ "longDynamicLink": {
+ "description": "Full long Dynamic Link URL with desired query parameters specified.\nFor example,\n\"https://sample.app.goo.gl/?link=http://www.google.com&apn=com.sample\",\n[Learn more](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically).",
+ "type": "string"
+ },
+ "suffix": {
+ "$ref": "Suffix",
+ "description": "Short Dynamic Link suffix. Optional."
+ }
+ },
+ "id": "CreateShortDynamicLinkRequest"
+ },
+ "DesktopInfo": {
+ "description": "Desktop related attributes to the Dynamic Link.",
+ "type": "object",
+ "properties": {
+ "desktopFallbackLink": {
+ "description": "Link to open on desktop.",
+ "type": "string"
+ }
+ },
+ "id": "DesktopInfo"
+ },
+ "DynamicLinkEventStat": {
+ "description": "Dynamic Link event stat.",
+ "type": "object",
+ "properties": {
+ "count": {
+ "description": "The number of times this event occurred.",
+ "format": "int64",
+ "type": "string"
+ },
+ "event": {
+ "enumDescriptions": [
+ "Unspecified type.",
+ "Indicates that an FDL is clicked by users.",
+ "Indicates that an FDL redirects users to fallback link.",
+ "Indicates that an FDL triggers an app install from Play store, currently\nit's impossible to get stats from App store.",
+ "Indicates that the app is opened for the first time after an install\ntriggered by FDLs",
+ "Indicates that the app is opened via an FDL for non-first time."
+ ],
+ "enum": [
+ "DYNAMIC_LINK_EVENT_UNSPECIFIED",
+ "CLICK",
+ "REDIRECT",
+ "APP_INSTALL",
+ "APP_FIRST_OPEN",
+ "APP_RE_OPEN"
+ ],
+ "description": "Link event.",
+ "type": "string"
+ },
+ "platform": {
+ "enum": [
+ "DYNAMIC_LINK_PLATFORM_UNSPECIFIED",
+ "ANDROID",
+ "IOS",
+ "DESKTOP"
+ ],
+ "description": "Requested platform.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified platform.",
+ "Represents Android platform.\nAll apps and browsers on Android are classfied in this category.",
+ "Represents iOS platform.\nAll apps and browsers on iOS are classfied in this category.",
+ "Represents desktop.\nNote: other platforms like Windows, Blackberry, Amazon fall into this\ncategory."
+ ]
+ }
+ },
+ "id": "DynamicLinkEventStat"
+ },
+ "GetIosPostInstallAttributionRequest": {
+ "properties": {
+ "uniqueMatchLinkToCheck": {
+ "description": "Possible unique matched link that server need to check before performing\nfingerprint match. If passed link is short server need to expand the link.\nIf link is long server need to vslidate the link.",
+ "type": "string"
+ },
+ "appInstallationTime": {
+ "description": "App installation epoch time (https://en.wikipedia.org/wiki/Unix_time).\nThis is a client signal for a more accurate weak match.",
+ "format": "int64",
+ "type": "string"
+ },
+ "iosVersion": {
+ "description": "iOS version, ie: 9.3.5.\nConsider adding \"build\".",
+ "type": "string"
+ },
+ "retrievalMethod": {
+ "enumDescriptions": [
+ "Unknown method.",
+ "iSDK performs a server lookup by device fingerprint in the background\nwhen app is first-opened; no API called by developer.",
+ "iSDK performs a server lookup by device fingerprint upon a dev API call.",
+ "iSDK performs a strong match only if weak match is found upon a dev\nAPI call."
+ ],
+ "enum": [
+ "UNKNOWN_PAYLOAD_RETRIEVAL_METHOD",
+ "IMPLICIT_WEAK_MATCH",
+ "EXPLICIT_WEAK_MATCH",
+ "EXPLICIT_STRONG_AFTER_WEAK_MATCH"
+ ],
+ "description": "App post install attribution retrieval information. Disambiguates\nmechanism (iSDK or developer invoked) to retrieve payload from\nclicked link.",
+ "type": "string"
+ },
+ "visualStyle": {
+ "enum": [
+ "UNKNOWN_VISUAL_STYLE",
+ "DEFAULT_STYLE",
+ "CUSTOM_STYLE"
+ ],
+ "description": "Strong match page information. Disambiguates between default UI and\ncustom page to present when strong match succeeds/fails to find cookie.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown style.",
+ "Default style.",
+ "Custom style."
+ ]
+ },
+ "sdkVersion": {
+ "description": "Google SDK version.",
+ "type": "string"
+ },
+ "bundleId": {
+ "description": "APP bundle ID.",
+ "type": "string"
+ },
+ "device": {
+ "description": "Device information.",
+ "$ref": "DeviceInfo"
+ }
+ },
+ "id": "GetIosPostInstallAttributionRequest",
+ "description": "Request for iSDK to execute strong match flow for post-install attribution.\nThis is meant for iOS requests only. Requests from other platforms will\nnot be honored.",
+ "type": "object"
+ },
+ "CreateShortDynamicLinkResponse": {
+ "properties": {
+ "shortLink": {
+ "description": "Short Dynamic Link value. e.g. https://abcd.app.goo.gl/wxyz",
+ "type": "string"
+ },
"previewLink": {
"description": "Preivew link to show the link flow chart.",
"type": "string"
@@ -20,46 +391,40 @@
"items": {
"$ref": "DynamicLinkWarning"
}
- },
- "shortLink": {
- "description": "Short Dynamic Link value. e.g. https://abcd.app.goo.gl/wxyz",
- "type": "string"
}
},
- "id": "CreateShortDynamicLinkResponse"
+ "id": "CreateShortDynamicLinkResponse",
+ "description": "Response to create a short Dynamic Link.",
+ "type": "object"
},
"Suffix": {
+ "description": "Short Dynamic Link suffix.",
"type": "object",
"properties": {
"option": {
+ "enumDescriptions": [
+ "The suffix option is not specified, performs as NOT_GUESSABLE .",
+ "Short Dynamic Link suffix is a base62 [0-9A-Za-z] encoded string of\na random generated 96 bit random number, which has a length of 17 chars.\nFor example, \"nlAR8U4SlKRZw1cb2\".\nIt prevents other people from guessing and crawling short Dynamic Links\nthat contain personal identifiable information.",
+ "Short Dynamic Link suffix is a base62 [0-9A-Za-z] string starting with a\nlength of 4 chars. the length will increase when all the space is\noccupied."
+ ],
"enum": [
"OPTION_UNSPECIFIED",
"UNGUESSABLE",
"SHORT"
],
"description": "Suffix option.",
- "type": "string",
- "enumDescriptions": [
- "The suffix option is not specified, performs as NOT_GUESSABLE .",
- "Short Dynamic Link suffix is a base62 [0-9A-Za-z] encoded string of\na random generated 96 bit random number, which has a length of 17 chars.\nFor example, \"nlAR8U4SlKRZw1cb2\".\nIt prevents other people from guessing and crawling short Dynamic Links\nthat contain personal identifiable information.",
- "Short Dynamic Link suffix is a base62 [0-9A-Za-z] string starting with a\nlength of 4 chars. the length will increase when all the space is\noccupied."
- ]
+ "type": "string"
}
},
- "id": "Suffix",
- "description": "Short Dynamic Link suffix."
+ "id": "Suffix"
},
"GooglePlayAnalytics": {
"description": "Parameters for Google Play Campaign Measurements.\n[Learn more](https://developers.google.com/analytics/devguides/collection/android/v4/campaigns#campaign-params)",
"type": "object",
"properties": {
- "utmMedium": {
- "description": "Campaign medium; used to identify a medium such as email or cost-per-click.",
- "type": "string"
- },
"utmTerm": {
- "type": "string",
- "description": "Campaign term; used with paid search to supply the keywords for ads."
+ "description": "Campaign term; used with paid search to supply the keywords for ads.",
+ "type": "string"
},
"utmSource": {
"description": "Campaign source; used to identify a search engine, newsletter, or other\nsource.",
@@ -70,27 +435,33 @@
"type": "string"
},
"utmCampaign": {
- "type": "string",
- "description": "Campaign name; used for keyword analysis to identify a specific product\npromotion or strategic campaign."
+ "description": "Campaign name; used for keyword analysis to identify a specific product\npromotion or strategic campaign.",
+ "type": "string"
},
"utmContent": {
"description": "Campaign content; used for A/B testing and content-targeted ads to\ndifferentiate ads or links that point to the same URL.",
"type": "string"
+ },
+ "utmMedium": {
+ "description": "Campaign medium; used to identify a medium such as email or cost-per-click.",
+ "type": "string"
}
},
"id": "GooglePlayAnalytics"
},
"DynamicLinkInfo": {
- "description": "Information about a Dynamic Link.",
- "type": "object",
"properties": {
"dynamicLinkDomain": {
"description": "Dynamic Links domain that the project owns, e.g. abcd.app.goo.gl\n[Learn more](https://firebase.google.com/docs/dynamic-links/android/receive)\non how to set up Dynamic Link domain associated with your Firebase project.\n\nRequired.",
"type": "string"
},
+ "desktopInfo": {
+ "$ref": "DesktopInfo",
+ "description": "Desktop related information. See desktop related parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually)."
+ },
"link": {
- "type": "string",
- "description": "The link your app will open, You can specify any URL your app can handle.\nThis link must be a well-formatted URL, be properly URL-encoded, and use\nthe HTTP or HTTPS scheme. See 'link' parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually).\n\nRequired."
+ "description": "The link your app will open, You can specify any URL your app can handle.\nThis link must be a well-formatted URL, be properly URL-encoded, and use\nthe HTTP or HTTPS scheme. See 'link' parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually).\n\nRequired.",
+ "type": "string"
},
"iosInfo": {
"$ref": "IosInfo",
@@ -113,52 +484,31 @@
"description": "Parameters used for tracking. See all tracking parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually)."
}
},
- "id": "DynamicLinkInfo"
- },
- "ITunesConnectAnalytics": {
- "type": "object",
- "properties": {
- "ct": {
- "type": "string",
- "description": "Campaign text that developers can optionally add to any link in order to\ntrack sales from a specific marketing campaign."
- },
- "mt": {
- "type": "string",
- "description": "iTune media types, including music, podcasts, audiobooks and so on."
- },
- "pt": {
- "description": "Provider token that enables analytics for Dynamic Links from within iTunes\nConnect.",
- "type": "string"
- },
- "at": {
- "type": "string",
- "description": "Affiliate token used to create affiliate-coded links."
- }
- },
- "id": "ITunesConnectAnalytics",
- "description": "Parameters for iTunes Connect App Analytics."
+ "id": "DynamicLinkInfo",
+ "description": "Information about a Dynamic Link.",
+ "type": "object"
},
"DeviceInfo": {
"description": "Signals associated with the device making the request.",
"type": "object",
"properties": {
"screenResolutionWidth": {
- "type": "string",
"description": "Device display resolution width.",
- "format": "int64"
+ "format": "int64",
+ "type": "string"
},
"deviceModelName": {
"description": "Device model name.",
"type": "string"
},
"screenResolutionHeight": {
- "type": "string",
"description": "Device display resolution height.",
- "format": "int64"
+ "format": "int64",
+ "type": "string"
},
"languageCode": {
- "type": "string",
- "description": "Device language code setting."
+ "description": "Device language code setting.",
+ "type": "string"
},
"timezone": {
"description": "Device timezone setting.",
@@ -167,6 +517,29 @@
},
"id": "DeviceInfo"
},
+ "ITunesConnectAnalytics": {
+ "description": "Parameters for iTunes Connect App Analytics.",
+ "type": "object",
+ "properties": {
+ "at": {
+ "description": "Affiliate token used to create affiliate-coded links.",
+ "type": "string"
+ },
+ "ct": {
+ "description": "Campaign text that developers can optionally add to any link in order to\ntrack sales from a specific marketing campaign.",
+ "type": "string"
+ },
+ "mt": {
+ "description": "iTune media types, including music, podcasts, audiobooks and so on.",
+ "type": "string"
+ },
+ "pt": {
+ "description": "Provider token that enables analytics for Dynamic Links from within iTunes\nConnect.",
+ "type": "string"
+ }
+ },
+ "id": "ITunesConnectAnalytics"
+ },
"GetIosPostInstallAttributionResponse": {
"description": "Response for iSDK to execute strong match flow for post-install attribution.",
"type": "object",
@@ -176,8 +549,8 @@
"type": "string"
},
"isStrongMatchExecutable": {
- "type": "boolean",
- "description": "Instruction for iSDK to attemmpt to perform strong match. For instance,\nif browser does not support/allow cookie or outside of support browsers,\nthis will be false."
+ "description": "Instruction for iSDK to attemmpt to perform strong match. For instance,\nif browser does not support/allow cookie or outside of support browsers,\nthis will be false.",
+ "type": "boolean"
},
"appMinimumVersion": {
"description": "The minimum version for app, specified by dev through ?imv= parameter.\nReturn to iSDK to allow app to evaluate if current version meets this.",
@@ -188,10 +561,20 @@
"type": "string"
},
"invitationId": {
- "type": "string",
- "description": "Invitation ID attributed post-install via one of several techniques\n(fingerprint, copy unique)."
+ "description": "Invitation ID attributed post-install via one of several techniques\n(fingerprint, copy unique).",
+ "type": "string"
+ },
+ "externalBrowserDestinationLink": {
+ "description": "User-agent specific custom-scheme URIs for iSDK to open. This will be set\naccording to the user-agent tha the click was originally made in. There is\nno Safari-equivalent custom-scheme open URLs.\nie: googlechrome://www.example.com\nie: firefox://open-url?url=http://www.example.com\nie: opera-http://example.com",
+ "type": "string"
},
"attributionConfidence": {
+ "enumDescriptions": [
+ "Unset.",
+ "Weak confidence, more than one matching link found or link suspected to\nbe false positive",
+ "Default confidence, match based on fingerprint",
+ "Unique confidence, match based on \"unique match link to check\" or other\nmeans"
+ ],
"enum": [
"UNKNOWN_ATTRIBUTION_CONFIDENCE",
"WEAK",
@@ -199,16 +582,6 @@
"UNIQUE"
],
"description": "The confidence of the returned attribution.",
- "type": "string",
- "enumDescriptions": [
- "Unset.",
- "Weak confidence, more than one matching link found or link suspected to\nbe false positive",
- "Default confidence, match based on fingerprint",
- "Unique confidence, match based on \"unique match link to check\" or other\nmeans"
- ]
- },
- "externalBrowserDestinationLink": {
- "description": "User-agent specific custom-scheme URIs for iSDK to open. This will be set\naccording to the user-agent tha the click was originally made in. There is\nno Safari-equivalent custom-scheme open URLs.\nie: googlechrome://www.example.com\nie: firefox://open-url?url=http://www.example.com\nie: opera-http://example.com",
"type": "string"
},
"matchMessage": {
@@ -216,16 +589,16 @@
"type": "string"
},
"resolvedLink": {
- "type": "string",
- "description": "The entire FDL, expanded from a short link. It is the same as the\nrequested_link, if it is long. Parameters from this should not be\nused directly (ie: server can default utm_[campaign|medium|source]\nto a value when requested_link lack them, server determine the best\nfallback_link when requested_link specifies \u003e1 fallback links)."
+ "description": "The entire FDL, expanded from a short link. It is the same as the\nrequested_link, if it is long. Parameters from this should not be\nused directly (ie: server can default utm_[campaign|medium|source]\nto a value when requested_link lack them, server determine the best\nfallback_link when requested_link specifies \u003e1 fallback links).",
+ "type": "string"
},
"utmCampaign": {
- "type": "string",
- "description": "Scion campaign value to be propagated by iSDK to Scion at post-install."
+ "description": "Scion campaign value to be propagated by iSDK to Scion at post-install.",
+ "type": "string"
},
"fallbackLink": {
- "type": "string",
- "description": "The link to navigate to update the app if min version is not met.\nThis is either (in order): 1) fallback link (from ?ifl= parameter, if\nspecified by developer) or 2) AppStore URL (from ?isi= parameter, if\nspecified), or 3) the payload link (from required link= parameter)."
+ "description": "The link to navigate to update the app if min version is not met.\nThis is either (in order): 1) fallback link (from ?ifl= parameter, if\nspecified by developer) or 2) AppStore URL (from ?isi= parameter, if\nspecified), or 3) the payload link (from required link= parameter).",
+ "type": "string"
},
"requestedLink": {
"description": "Entire FDL (short or long) attributed post-install via one of several\ntechniques (fingerprint, copy unique).",
@@ -243,21 +616,22 @@
"type": "object",
"properties": {
"socialDescription": {
- "type": "string",
- "description": "A short description of the link. Optional."
+ "description": "A short description of the link. Optional.",
+ "type": "string"
},
"socialTitle": {
- "type": "string",
- "description": "Title to be displayed. Optional."
+ "description": "Title to be displayed. Optional.",
+ "type": "string"
},
"socialImageLink": {
- "type": "string",
- "description": "An image url string. Optional."
+ "description": "An image url string. Optional.",
+ "type": "string"
}
},
"id": "SocialMetaTagInfo"
},
"DynamicLinkStats": {
+ "description": "Analytics stats of a Dynamic Link for a given timeframe.",
"type": "object",
"properties": {
"linkEventStats": {
@@ -268,45 +642,11 @@
}
}
},
- "id": "DynamicLinkStats",
- "description": "Analytics stats of a Dynamic Link for a given timeframe."
+ "id": "DynamicLinkStats"
},
"DynamicLinkWarning": {
- "type": "object",
"properties": {
"warningCode": {
- "type": "string",
- "enumDescriptions": [
- "Unknown code.",
- "The Android package does not match any in developer's DevConsole project.",
- "The Android minimum version code has to be a valid integer.",
- "Android package min version param is not needed, e.g. when\n'apn' is missing.",
- "Android link is not a valid URI.",
- "Android link param is not needed, e.g. when param 'al' and 'link' have\nthe same value..",
- "Android fallback link is not a valid URI.",
- "Android fallback link has an invalid (non http/https) URI scheme.",
- "The iOS bundle ID does not match any in developer's DevConsole project.",
- "The iPad bundle ID does not match any in developer's DevConsole project.",
- "iOS URL scheme is not needed, e.g. when 'ibi' are 'ipbi' are all missing.",
- "iOS app store ID format is incorrect, e.g. not numeric.",
- "iOS app store ID is not needed.",
- "iOS fallback link is not a valid URI.",
- "iOS fallback link has an invalid (non http/https) URI scheme.",
- "iPad fallback link is not a valid URI.",
- "iPad fallback link has an invalid (non http/https) URI scheme.",
- "Debug param format is incorrect.",
- "isAd param format is incorrect.",
- "Indicates a certain param is deprecated.",
- "Indicates certain paramater is not recognized.",
- "Indicates certain paramater is too long.",
- "Social meta tag image link is not a valid URI.",
- "Social meta tag image link has an invalid (non http/https) URI scheme.",
- "",
- "",
- "Dynamic Link URL length is too long.",
- "Dynamic Link URL contains fragments.",
- "The iOS bundle ID does not match with the given iOS store ID."
- ],
"enum": [
"CODE_UNSPECIFIED",
"NOT_IN_PROJECT_ANDROID_PACKAGE_NAME",
@@ -338,7 +678,39 @@
"LINK_WITH_FRAGMENTS",
"NOT_MATCHING_IOS_BUNDLE_ID_AND_STORE_ID"
],
- "description": "The warning code."
+ "description": "The warning code.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown code.",
+ "The Android package does not match any in developer's DevConsole project.",
+ "The Android minimum version code has to be a valid integer.",
+ "Android package min version param is not needed, e.g. when\n'apn' is missing.",
+ "Android link is not a valid URI.",
+ "Android link param is not needed, e.g. when param 'al' and 'link' have\nthe same value..",
+ "Android fallback link is not a valid URI.",
+ "Android fallback link has an invalid (non http/https) URI scheme.",
+ "The iOS bundle ID does not match any in developer's DevConsole project.",
+ "The iPad bundle ID does not match any in developer's DevConsole project.",
+ "iOS URL scheme is not needed, e.g. when 'ibi' are 'ipbi' are all missing.",
+ "iOS app store ID format is incorrect, e.g. not numeric.",
+ "iOS app store ID is not needed.",
+ "iOS fallback link is not a valid URI.",
+ "iOS fallback link has an invalid (non http/https) URI scheme.",
+ "iPad fallback link is not a valid URI.",
+ "iPad fallback link has an invalid (non http/https) URI scheme.",
+ "Debug param format is incorrect.",
+ "isAd param format is incorrect.",
+ "Indicates a certain param is deprecated.",
+ "Indicates certain paramater is not recognized.",
+ "Indicates certain paramater is too long.",
+ "Social meta tag image link is not a valid URI.",
+ "Social meta tag image link has an invalid (non http/https) URI scheme.",
+ "",
+ "",
+ "Dynamic Link URL length is too long.",
+ "Dynamic Link URL contains fragments.",
+ "The iOS bundle ID does not match with the given iOS store ID."
+ ]
},
"warningMessage": {
"description": "The warning message to help developers improve their requests.",
@@ -350,9 +722,11 @@
}
},
"id": "DynamicLinkWarning",
- "description": "Dynamic Links warning messages."
+ "description": "Dynamic Links warning messages.",
+ "type": "object"
},
"AndroidInfo": {
+ "description": "Android related attributes to the Dynamic Link.",
"type": "object",
"properties": {
"androidPackageName": {
@@ -360,8 +734,8 @@
"type": "string"
},
"androidMinPackageVersionCode": {
- "type": "string",
- "description": "Minimum version code for the Android app. If the installed app’s version\ncode is lower, then the user is taken to the Play Store."
+ "description": "Minimum version code for the Android app. If the installed app’s version\ncode is lower, then the user is taken to the Play Store.",
+ "type": "string"
},
"androidLink": {
"description": "If specified, this overrides the ‘link’ parameter on Android.",
@@ -372,201 +746,14 @@
"type": "string"
}
},
- "id": "AndroidInfo",
- "description": "Android related attributes to the Dynamic Link."
- },
- "NavigationInfo": {
- "type": "object",
- "properties": {
- "enableForcedRedirect": {
- "description": "If this option is on, FDL click will be forced to redirect rather than\nshow an interstitial page.",
- "type": "boolean"
- }
- },
- "id": "NavigationInfo",
- "description": "Information of navigation behavior."
- },
- "IosInfo": {
- "description": "iOS related attributes to the Dynamic Link..",
- "type": "object",
- "properties": {
- "iosFallbackLink": {
- "description": "Link to open on iOS if the app is not installed.",
- "type": "string"
- },
- "iosAppStoreId": {
- "type": "string",
- "description": "iOS App Store ID."
- },
- "iosIpadFallbackLink": {
- "description": "If specified, this overrides the ios_fallback_link value on iPads.",
- "type": "string"
- },
- "iosIpadBundleId": {
- "type": "string",
- "description": "iPad bundle ID of the app."
- },
- "iosCustomScheme": {
- "type": "string",
- "description": "Custom (destination) scheme to use for iOS. By default, we’ll use the\nbundle ID as the custom scheme. Developer can override this behavior using\nthis param."
- },
- "iosBundleId": {
- "description": "iOS bundle ID of the app.",
- "type": "string"
- }
- },
- "id": "IosInfo"
- },
- "AnalyticsInfo": {
- "type": "object",
- "properties": {
- "googlePlayAnalytics": {
- "$ref": "GooglePlayAnalytics",
- "description": "Google Play Campaign Measurements."
- },
- "itunesConnectAnalytics": {
- "$ref": "ITunesConnectAnalytics",
- "description": "iTunes Connect App Analytics."
- }
- },
- "id": "AnalyticsInfo",
- "description": "Tracking parameters supported by Dynamic Link."
- },
- "CreateShortDynamicLinkRequest": {
- "type": "object",
- "properties": {
- "dynamicLinkInfo": {
- "$ref": "DynamicLinkInfo",
- "description": "Information about the Dynamic Link to be shortened.\n[Learn more](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically)."
- },
- "longDynamicLink": {
- "description": "Full long Dynamic Link URL with desired query parameters specified.\nFor example,\n\"https://sample.app.goo.gl/?link=http://www.google.com&apn=com.sample\",\n[Learn more](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically).",
- "type": "string"
- },
- "suffix": {
- "$ref": "Suffix",
- "description": "Short Dynamic Link suffix. Optional."
- }
- },
- "id": "CreateShortDynamicLinkRequest",
- "description": "Request to create a short Dynamic Link."
- },
- "DynamicLinkEventStat": {
- "type": "object",
- "properties": {
- "platform": {
- "enum": [
- "DYNAMIC_LINK_PLATFORM_UNSPECIFIED",
- "ANDROID",
- "IOS",
- "DESKTOP"
- ],
- "description": "Requested platform.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified platform.",
- "Represents Android platform.\nAll apps and browsers on Android are classfied in this category.",
- "Represents iOS platform.\nAll apps and browsers on iOS are classfied in this category.",
- "Represents desktop.\nNote: other platforms like Windows, Blackberry, Amazon fall into this\ncategory."
- ]
- },
- "count": {
- "type": "string",
- "description": "The number of times this event occurred.",
- "format": "int64"
- },
- "event": {
- "enum": [
- "DYNAMIC_LINK_EVENT_UNSPECIFIED",
- "CLICK",
- "REDIRECT",
- "APP_INSTALL",
- "APP_FIRST_OPEN",
- "APP_RE_OPEN"
- ],
- "description": "Link event.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified type.",
- "Indicates that an FDL is clicked by users.",
- "Indicates that an FDL redirects users to fallback link.",
- "Indicates that an FDL triggers an app install from Play store, currently\nit's impossible to get stats from App store.",
- "Indicates that the app is opened for the first time after an install\ntriggered by FDLs",
- "Indicates that the app is opened via an FDL for non-first time."
- ]
- }
- },
- "id": "DynamicLinkEventStat",
- "description": "Dynamic Link event stat."
- },
- "GetIosPostInstallAttributionRequest": {
- "description": "Request for iSDK to execute strong match flow for post-install attribution.\nThis is meant for iOS requests only. Requests from other platforms will\nnot be honored.",
- "type": "object",
- "properties": {
- "bundleId": {
- "description": "APP bundle ID.",
- "type": "string"
- },
- "device": {
- "$ref": "DeviceInfo",
- "description": "Device information."
- },
- "uniqueMatchLinkToCheck": {
- "type": "string",
- "description": "Possible unique matched link that server need to check before performing\nfingerprint match. If passed link is short server need to expand the link.\nIf link is long server need to vslidate the link."
- },
- "appInstallationTime": {
- "type": "string",
- "description": "App installation epoch time (https://en.wikipedia.org/wiki/Unix_time).\nThis is a client signal for a more accurate weak match.",
- "format": "int64"
- },
- "iosVersion": {
- "description": "iOS version, ie: 9.3.5.\nConsider adding \"build\".",
- "type": "string"
- },
- "visualStyle": {
- "type": "string",
- "enumDescriptions": [
- "Unknown style.",
- "Default style.",
- "Custom style."
- ],
- "enum": [
- "UNKNOWN_VISUAL_STYLE",
- "DEFAULT_STYLE",
- "CUSTOM_STYLE"
- ],
- "description": "Strong match page information. Disambiguates between default UI and\ncustom page to present when strong match succeeds/fails to find cookie."
- },
- "retrievalMethod": {
- "enum": [
- "UNKNOWN_PAYLOAD_RETRIEVAL_METHOD",
- "IMPLICIT_WEAK_MATCH",
- "EXPLICIT_WEAK_MATCH",
- "EXPLICIT_STRONG_AFTER_WEAK_MATCH"
- ],
- "description": "App post install attribution retrieval information. Disambiguates\nmechanism (iSDK or developer invoked) to retrieve payload from\nclicked link.",
- "type": "string",
- "enumDescriptions": [
- "Unknown method.",
- "iSDK performs a server lookup by device fingerprint in the background\nwhen app is first-opened; no API called by developer.",
- "iSDK performs a server lookup by device fingerprint upon a dev API call.",
- "iSDK performs a strong match only if weak match is found upon a dev\nAPI call."
- ]
- },
- "sdkVersion": {
- "type": "string",
- "description": "Google SDK version."
- }
- },
- "id": "GetIosPostInstallAttributionRequest"
+ "id": "AndroidInfo"
}
},
- "icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
"protocol": "rest",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
"canonicalName": "Firebase Dynamic Links",
"auth": {
"oauth2": {
@@ -579,177 +766,5 @@
},
"rootUrl": "https://firebasedynamiclinks-ipv6.googleapis.com/",
"ownerDomain": "google.com",
- "name": "firebasedynamiclinks",
- "batchPath": "batch",
- "title": "Firebase Dynamic Links API",
- "ownerName": "Google",
- "resources": {
- "shortLinks": {
- "methods": {
- "create": {
- "description": "Creates a short Dynamic Link given either a valid long Dynamic Link or\ndetails such as Dynamic Link domain, Android and iOS app information.\nThe created short Dynamic Link will not expire.\n\nRepeated calls with the same long Dynamic Link or Dynamic Link information\nwill produce the same short Dynamic Link.\n\nThe Dynamic Link domain in the request must be owned by requester's\nFirebase project.",
- "request": {
- "$ref": "CreateShortDynamicLinkRequest"
- },
- "response": {
- "$ref": "CreateShortDynamicLinkResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/firebase"
- ],
- "parameters": {},
- "flatPath": "v1/shortLinks",
- "path": "v1/shortLinks",
- "id": "firebasedynamiclinks.shortLinks.create"
- }
- }
- },
- "v1": {
- "methods": {
- "getLinkStats": {
- "flatPath": "v1/{dynamicLink}/linkStats",
- "path": "v1/{dynamicLink}/linkStats",
- "id": "firebasedynamiclinks.getLinkStats",
- "description": "Fetches analytics stats of a short Dynamic Link for a given\nduration. Metrics include number of clicks, redirects, installs,\napp first opens, and app reopens.",
- "response": {
- "$ref": "DynamicLinkStats"
- },
- "parameterOrder": [
- "dynamicLink"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/firebase"
- ],
- "parameters": {
- "durationDays": {
- "type": "string",
- "location": "query",
- "description": "The span of time requested in days.",
- "format": "int64"
- },
- "dynamicLink": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Dynamic Link URL. e.g. https://abcd.app.goo.gl/wxyz"
- }
- }
- },
- "installAttribution": {
- "response": {
- "$ref": "GetIosPostInstallAttributionResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/firebase"
- ],
- "parameters": {},
- "flatPath": "v1/installAttribution",
- "path": "v1/installAttribution",
- "id": "firebasedynamiclinks.installAttribution",
- "description": "Get iOS strong/weak-match info for post-install attribution.",
- "request": {
- "$ref": "GetIosPostInstallAttributionRequest"
- }
- }
- }
- }
- },
- "parameters": {
- "upload_protocol": {
- "type": "string",
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
- },
- "prettyPrint": {
- "type": "boolean",
- "default": "true",
- "location": "query",
- "description": "Returns response with indentations and line breaks."
- },
- "fields": {
- "type": "string",
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response."
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "callback": {
- "type": "string",
- "location": "query",
- "description": "JSONP"
- },
- "$.xgafv": {
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ]
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "access_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth access token."
- },
- "key": {
- "type": "string",
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "type": "boolean",
- "default": "true",
- "location": "query",
- "description": "Pretty-print response."
- },
- "bearer_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth bearer token."
- },
- "oauth_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
- }
- },
- "version": "v1",
- "baseUrl": "https://firebasedynamiclinks-ipv6.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Programmatically creates and manages Firebase Dynamic Links.",
- "servicePath": ""
+ "name": "firebasedynamiclinks"
}
diff --git a/firebasedynamiclinks/v1/firebasedynamiclinks-gen.go b/firebasedynamiclinks/v1/firebasedynamiclinks-gen.go
index 2e197e7..40f7ef4 100644
--- a/firebasedynamiclinks/v1/firebasedynamiclinks-gen.go
+++ b/firebasedynamiclinks/v1/firebasedynamiclinks-gen.go
@@ -258,6 +258,35 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// DesktopInfo: Desktop related attributes to the Dynamic Link.
+type DesktopInfo struct {
+ // DesktopFallbackLink: Link to open on desktop.
+ DesktopFallbackLink string `json:"desktopFallbackLink,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "DesktopFallbackLink")
+ // to unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "DesktopFallbackLink") to
+ // include in API requests with the JSON null value. By default, fields
+ // with empty values are omitted from API requests. However, any field
+ // with an empty value appearing in NullFields will be sent to the
+ // server as null. It is an error if a field in this list has a
+ // non-empty value. This may be used to include null fields in Patch
+ // requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *DesktopInfo) MarshalJSON() ([]byte, error) {
+ type noMethod DesktopInfo
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// DeviceInfo: Signals associated with the device making the request.
type DeviceInfo struct {
// DeviceModelName: Device model name.
@@ -374,6 +403,13 @@
// ate-manually).
AndroidInfo *AndroidInfo `json:"androidInfo,omitempty"`
+ // DesktopInfo: Desktop related information. See desktop related
+ // parameters in
+ // the
+ // [documentation](https://firebase.google.com/docs/dynamic-links/cre
+ // ate-manually).
+ DesktopInfo *DesktopInfo `json:"desktopInfo,omitempty"`
+
// DynamicLinkDomain: Dynamic Links domain that the project owns, e.g.
// abcd.app.goo.gl
// [Learn
diff --git a/firebaseremoteconfig/v1/firebaseremoteconfig-api.json b/firebaseremoteconfig/v1/firebaseremoteconfig-api.json
index b47be1a..7dc133c 100644
--- a/firebaseremoteconfig/v1/firebaseremoteconfig-api.json
+++ b/firebaseremoteconfig/v1/firebaseremoteconfig-api.json
@@ -11,13 +11,13 @@
"projects": {
"methods": {
"updateRemoteConfig": {
- "response": {
- "$ref": "RemoteConfig"
- },
+ "httpMethod": "PUT",
"parameterOrder": [
"project"
],
- "httpMethod": "PUT",
+ "response": {
+ "$ref": "RemoteConfig"
+ },
"parameters": {
"validateOnly": {
"location": "query",
@@ -25,22 +25,23 @@
"type": "boolean"
},
"project": {
+ "type": "string",
+ "required": true,
"pattern": "^projects/[^/]+$",
"location": "path",
- "description": "The GMP project identifier. Required.\nSee note at the beginning of this file regarding project ids.",
- "type": "string",
- "required": true
+ "description": "The GMP project identifier. Required.\nSee note at the beginning of this file regarding project ids."
}
},
"flatPath": "v1/projects/{projectsId}/remoteConfig",
- "id": "firebaseremoteconfig.projects.updateRemoteConfig",
"path": "v1/{+project}/remoteConfig",
+ "id": "firebaseremoteconfig.projects.updateRemoteConfig",
"description": "Update a RemoteConfig. We treat this as an always-existing\nresource (when it is not found in our data store, we treat it as version\n0, a template with zero conditions and zero parameters). Hence there are\nno Create or Delete operations. Returns the updated template when\nsuccessful (and the updated eTag as a response header), or an error if\nthings go wrong.\nPossible error messages:\n* VALIDATION_ERROR (HTTP status 400) with additional details if the\ntemplate being passed in can not be validated.\n* AUTHENTICATION_ERROR (HTTP status 401) if the request can not be\nauthenticate (e.g. no access token, or invalid access token).\n* AUTHORIZATION_ERROR (HTTP status 403) if the request can not be\nauthorized (e.g. the user has no access to the specified project id).\n* VERSION_MISMATCH (HTTP status 412) when trying to update when the\nexpected eTag (passed in via the \"If-match\" header) is not specified, or\nis specified but does does not match the current eTag.\n* Internal error (HTTP status 500) for Database problems or other internal\nerrors.",
"request": {
"$ref": "RemoteConfig"
}
},
"getRemoteConfig": {
+ "flatPath": "v1/projects/{projectsId}/remoteConfig",
"id": "firebaseremoteconfig.projects.getRemoteConfig",
"path": "v1/{+project}/remoteConfig",
"description": "Get the latest version Remote Configuration for a project.\nReturns the RemoteConfig as the payload, and also the eTag as a\nresponse header.",
@@ -53,59 +54,20 @@
"httpMethod": "GET",
"parameters": {
"project": {
- "pattern": "^projects/[^/]+$",
"location": "path",
"description": "The GMP project identifier. Required.\nSee note at the beginning of this file regarding project ids.",
"type": "string",
- "required": true
+ "required": true,
+ "pattern": "^projects/[^/]+$"
}
- },
- "flatPath": "v1/projects/{projectsId}/remoteConfig"
+ }
}
}
}
},
"parameters": {
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
"alt": {
+ "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -118,8 +80,7 @@
"json",
"media",
"proto"
- ],
- "type": "string"
+ ]
},
"access_token": {
"location": "query",
@@ -127,20 +88,20 @@
"type": "string"
},
"key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
"location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string"
},
- "pp": {
+ "quotaUser": {
+ "type": "string",
"location": "query",
- "description": "Pretty-print response.",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
+ },
+ "pp": {
"default": "true",
- "type": "boolean"
+ "type": "boolean",
+ "location": "query",
+ "description": "Pretty-print response."
},
"bearer_token": {
"location": "query",
@@ -148,9 +109,48 @@
"type": "string"
},
"oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user."
+ },
+ "upload_protocol": {
+ "type": "string",
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "uploadType": {
+ "type": "string",
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
+ },
+ "fields": {
+ "type": "string",
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response."
+ },
+ "$.xgafv": {
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format."
+ },
+ "callback": {
+ "type": "string",
+ "location": "query",
+ "description": "JSONP"
}
},
"version": "v1",
@@ -165,86 +165,32 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "RemoteConfigParameterValue": {
- "description": "A RemoteConfigParameter's \"value\" (either the default value, or the value\nassociated with a condition name) is either a string, or the\n\"use_in_app_default\" indicator (which means to leave out the parameter from\nthe returned \u003ckey, value\u003e map that is the output of the parameter fetch).\nWe represent the \"use_in_app_default\" as a bool, but (when using the boolean\ninstead of the string) it should always be \u003ccode\u003etrue\u003c/code\u003e.",
- "type": "object",
- "properties": {
- "useInAppDefault": {
- "description": "if true, omit the parameter from the map of fetched parameter values",
- "type": "boolean"
- },
- "value": {
- "description": "the string to set the parameter to",
- "type": "string"
- }
- },
- "id": "RemoteConfigParameterValue"
- },
- "RemoteConfig": {
- "description": "*\nThe RemoteConfig consists of a list of conditions (which can be\nthought of as named \"if\" statements) and a map of parameters (parameter key\nto a stucture containing an optional default value, as well as a optional\nsubmap of (condition name to value when that condition is true).",
- "type": "object",
- "properties": {
- "parameters": {
- "additionalProperties": {
- "$ref": "RemoteConfigParameter"
- },
- "description": "Map of parameter keys to their optional default values and optional submap\nof (condition name : value). Order doesn't affect semantics, and so is\nsorted by the server. The 'key' values of the params must be unique.",
- "type": "object"
- },
- "conditions": {
- "description": "The list of named conditions. The order *does* affect the semantics.\nThe condition_name values of these entries must be unique.\n\nThe resolved value of a config parameter P is determined as follow:\n* Let Y be the set of values from the submap of P that refer to conditions\n that evaluate to \u003ccode\u003etrue\u003c/code\u003e.\n* If Y is non empty, the value is taken from the specific submap in Y whose\n condition_name is the earliest in this condition list.\n* Else, if P has a default value option (condition_name is empty) then\n the value is taken from that option.\n* Else, parameter P has no value and is omitted from the config result.\n\nExample: parameter key \"p1\", default value \"v1\", submap specified as\n{\"c1\": v2, \"c2\": v3} where \"c1\" and \"c2\" are names of conditions in the\ncondition list (where \"c1\" in this example appears before \"c2\"). The\nvalue of p1 would be v2 as long as c1 is true. Otherwise, if c2 is true,\np1 would evaluate to v3, and if c1 and c2 are both false, p1 would evaluate\nto v1. If no default value was specified, and c1 and c2 were both false,\nno value for p1 would be generated.",
- "items": {
- "$ref": "RemoteConfigCondition"
- },
- "type": "array"
- }
- },
- "id": "RemoteConfig"
- },
"RemoteConfigParameter": {
"description": "While default_value and conditional_values are each optional, at least one of\nthe two is required - otherwise, the parameter is meaningless (and an\nexception will be thrown by the validation logic).",
"type": "object",
"properties": {
- "defaultValue": {
- "$ref": "RemoteConfigParameterValue",
- "description": "Optional - value to set the parameter to, when none of the named conditions\nevaluate to \u003ccode\u003etrue\u003c/code\u003e."
- },
"conditionalValues": {
+ "type": "object",
"additionalProperties": {
"$ref": "RemoteConfigParameterValue"
},
- "description": "Optional - a map of (condition_name, value). The condition_name of the\nhighest priority (the one listed first in the conditions array) determines\nthe value of this parameter.",
- "type": "object"
+ "description": "Optional - a map of (condition_name, value). The condition_name of the\nhighest priority (the one listed first in the conditions array) determines\nthe value of this parameter."
+ },
+ "defaultValue": {
+ "$ref": "RemoteConfigParameterValue",
+ "description": "Optional - value to set the parameter to, when none of the named conditions\nevaluate to \u003ccode\u003etrue\u003c/code\u003e."
}
},
"id": "RemoteConfigParameter"
},
"RemoteConfigCondition": {
+ "type": "object",
"properties": {
- "name": {
- "description": "Required.\nA non empty and unique name of this condition.",
- "type": "string"
- },
"expression": {
"description": "Required.",
"type": "string"
},
"tagColor": {
- "enum": [
- "CONDITION_DISPLAY_COLOR_UNSPECIFIED",
- "BLUE",
- "BROWN",
- "CYAN",
- "DEEP_ORANGE",
- "GREEN",
- "INDIGO",
- "LIME",
- "ORANGE",
- "PINK",
- "PURPLE",
- "TEAL"
- ],
- "description": "Optional.\nThe display (tag) color of this condition. This serves as part of a tag\n(in the future, we may add tag text as well as tag color, but that is not\nyet implemented in the UI).\nThis value has no affect on the semantics of the delivered config and it\nis ignored by the backend, except for passing it through write/read\nrequests.\nNot having this value or having the \"CONDITION_DISPLAY_COLOR_UNSPECIFIED\"\nvalue (0) have the same meaning: Let the UI choose any valid color when\ndisplaying the condition.",
"type": "string",
"enumDescriptions": [
"",
@@ -259,17 +205,71 @@
"Pink",
"Purple",
"Teal"
- ]
+ ],
+ "enum": [
+ "CONDITION_DISPLAY_COLOR_UNSPECIFIED",
+ "BLUE",
+ "BROWN",
+ "CYAN",
+ "DEEP_ORANGE",
+ "GREEN",
+ "INDIGO",
+ "LIME",
+ "ORANGE",
+ "PINK",
+ "PURPLE",
+ "TEAL"
+ ],
+ "description": "Optional.\nThe display (tag) color of this condition. This serves as part of a tag\n(in the future, we may add tag text as well as tag color, but that is not\nyet implemented in the UI).\nThis value has no affect on the semantics of the delivered config and it\nis ignored by the backend, except for passing it through write/read\nrequests.\nNot having this value or having the \"CONDITION_DISPLAY_COLOR_UNSPECIFIED\"\nvalue (0) have the same meaning: Let the UI choose any valid color when\ndisplaying the condition."
+ },
+ "name": {
+ "description": "Required.\nA non empty and unique name of this condition.",
+ "type": "string"
}
},
"id": "RemoteConfigCondition",
- "description": "A single RemoteConfig Condition. A list of these (because order matters) are\npart of a single RemoteConfig template.",
- "type": "object"
+ "description": "A single RemoteConfig Condition. A list of these (because order matters) are\npart of a single RemoteConfig template."
+ },
+ "RemoteConfigParameterValue": {
+ "type": "object",
+ "properties": {
+ "useInAppDefault": {
+ "type": "boolean",
+ "description": "if true, omit the parameter from the map of fetched parameter values"
+ },
+ "value": {
+ "description": "the string to set the parameter to",
+ "type": "string"
+ }
+ },
+ "id": "RemoteConfigParameterValue",
+ "description": "A RemoteConfigParameter's \"value\" (either the default value, or the value\nassociated with a condition name) is either a string, or the\n\"use_in_app_default\" indicator (which means to leave out the parameter from\nthe returned \u003ckey, value\u003e map that is the output of the parameter fetch).\nWe represent the \"use_in_app_default\" as a bool, but (when using the boolean\ninstead of the string) it should always be \u003ccode\u003etrue\u003c/code\u003e."
+ },
+ "RemoteConfig": {
+ "type": "object",
+ "properties": {
+ "parameters": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "RemoteConfigParameter"
+ },
+ "description": "Map of parameter keys to their optional default values and optional submap\nof (condition name : value). Order doesn't affect semantics, and so is\nsorted by the server. The 'key' values of the params must be unique."
+ },
+ "conditions": {
+ "description": "The list of named conditions. The order *does* affect the semantics.\nThe condition_name values of these entries must be unique.\n\nThe resolved value of a config parameter P is determined as follow:\n* Let Y be the set of values from the submap of P that refer to conditions\n that evaluate to \u003ccode\u003etrue\u003c/code\u003e.\n* If Y is non empty, the value is taken from the specific submap in Y whose\n condition_name is the earliest in this condition list.\n* Else, if P has a default value option (condition_name is empty) then\n the value is taken from that option.\n* Else, parameter P has no value and is omitted from the config result.\n\nExample: parameter key \"p1\", default value \"v1\", submap specified as\n{\"c1\": v2, \"c2\": v3} where \"c1\" and \"c2\" are names of conditions in the\ncondition list (where \"c1\" in this example appears before \"c2\"). The\nvalue of p1 would be v2 as long as c1 is true. Otherwise, if c2 is true,\np1 would evaluate to v3, and if c1 and c2 are both false, p1 would evaluate\nto v1. If no default value was specified, and c1 and c2 were both false,\nno value for p1 would be generated.",
+ "items": {
+ "$ref": "RemoteConfigCondition"
+ },
+ "type": "array"
+ }
+ },
+ "id": "RemoteConfig",
+ "description": "*\nThe RemoteConfig consists of a list of conditions (which can be\nthought of as named \"if\" statements) and a map of parameters (parameter key\nto a stucture containing an optional default value, as well as a optional\nsubmap of (condition name to value when that condition is true)."
}
},
+ "protocol": "rest",
"icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
- "protocol": "rest"
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ }
}
diff --git a/firebaserules/v1/firebaserules-api.json b/firebaserules/v1/firebaserules-api.json
index 7b0ebf2..c4494a6 100644
--- a/firebaserules/v1/firebaserules-api.json
+++ b/firebaserules/v1/firebaserules-api.json
@@ -1,26 +1,22 @@
{
- "ownerDomain": "google.com",
- "name": "firebaserules",
- "batchPath": "batch",
"title": "Firebase Rules API",
"ownerName": "Google",
"resources": {
"projects": {
"methods": {
"test": {
- "id": "firebaserules.projects.test",
- "path": "v1/{+name}:test",
- "description": "Test `Source` for syntactic and semantic correctness. Issues present, if\nany, will be returned to the caller with a description, severity, and\nsource location.\n\nThe test method may be executed with `Source` or a `Ruleset` name.\nPassing `Source` is useful for unit testing new rules. Passing a `Ruleset`\nname is useful for regression testing an existing rule.\n\nThe following is an example of `Source` that permits users to upload images\nto a bucket bearing their user id and matching the correct metadata:\n\n_*Example*_\n\n // Users are allowed to subscribe and unsubscribe to the blog.\n service firebase.storage {\n match /users/{userId}/images/{imageName} {\n allow write: if userId == request.auth.uid\n && (imageName.matches('*.png$')\n || imageName.matches('*.jpg$'))\n && resource.mimeType.matches('^image/')\n }\n }",
- "request": {
- "$ref": "TestRulesetRequest"
- },
- "response": {
- "$ref": "TestRulesetResponse"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"name"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "TestRulesetResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/firebase",
+ "https://www.googleapis.com/auth/firebase.readonly"
+ ],
"parameters": {
"name": {
"pattern": "^projects/.+$",
@@ -30,46 +26,18 @@
"required": true
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/firebase",
- "https://www.googleapis.com/auth/firebase.readonly"
- ],
- "flatPath": "v1/projects/{projectsId}:test"
+ "flatPath": "v1/projects/{projectsId}:test",
+ "path": "v1/{+name}:test",
+ "id": "firebaserules.projects.test",
+ "request": {
+ "$ref": "TestRulesetRequest"
+ },
+ "description": "Test `Source` for syntactic and semantic correctness. Issues present, if\nany, will be returned to the caller with a description, severity, and\nsource location.\n\nThe test method may be executed with `Source` or a `Ruleset` name.\nPassing `Source` is useful for unit testing new rules. Passing a `Ruleset`\nname is useful for regression testing an existing rule.\n\nThe following is an example of `Source` that permits users to upload images\nto a bucket bearing their user id and matching the correct metadata:\n\n_*Example*_\n\n // Users are allowed to subscribe and unsubscribe to the blog.\n service firebase.storage {\n match /users/{userId}/images/{imageName} {\n allow write: if userId == request.auth.uid\n && (imageName.matches('*.png$')\n || imageName.matches('*.jpg$'))\n && resource.mimeType.matches('^image/')\n }\n }"
}
},
"resources": {
"rulesets": {
"methods": {
- "create": {
- "response": {
- "$ref": "Ruleset"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/firebase"
- ],
- "parameters": {
- "name": {
- "description": "Resource name for Project which owns this `Ruleset`.\n\nFormat: `projects/{project_id}`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/rulesets",
- "id": "firebaserules.projects.rulesets.create",
- "path": "v1/{+name}/rulesets",
- "request": {
- "$ref": "Ruleset"
- },
- "description": "Create a `Ruleset` from `Source`.\n\nThe `Ruleset` is given a unique generated name which is returned to the\ncaller. `Source` containing syntactic or semantics errors will result in an\nerror response indicating the first error encountered. For a detailed view\nof `Source` issues, use TestRuleset."
- },
"delete": {
"response": {
"$ref": "Empty"
@@ -97,20 +65,24 @@
"description": "Delete a `Ruleset` by resource name.\n\nIf the `Ruleset` is referenced by a `Release` the operation will fail."
},
"list": {
- "description": "List `Ruleset` metadata only and optionally filter the results by `Ruleset`\nname.\n\nThe full `Source` contents of a `Ruleset` may be retrieved with\nGetRuleset.",
- "httpMethod": "GET",
"response": {
"$ref": "ListRulesetsResponse"
},
"parameterOrder": [
"name"
],
+ "httpMethod": "GET",
"parameters": {
- "pageToken": {
- "description": "Next page token for loading the next batch of `Ruleset` instances.",
+ "filter": {
+ "description": "`Ruleset` filter. The list method supports filters with restrictions on\n`Ruleset.name`.\n\nFilters on `Ruleset.create_time` should use the `date` function which\nparses strings that conform to the RFC 3339 date/time specifications.\n\nExample: `create_time \u003e date(\"2017-01-01\") AND name=UUID-*`",
"type": "string",
"location": "query"
},
+ "pageToken": {
+ "location": "query",
+ "description": "Next page token for loading the next batch of `Ruleset` instances.",
+ "type": "string"
+ },
"name": {
"pattern": "^projects/[^/]+$",
"location": "path",
@@ -119,14 +91,9 @@
"required": true
},
"pageSize": {
- "location": "query",
"format": "int32",
"description": "Page size to load. Maximum of 100. Defaults to 10.\nNote: `page_size` is just a hint and the service may choose to load less\nthan `page_size` due to the size of the output. To traverse all of the\nreleases, caller should iterate until the `page_token` is empty.",
- "type": "integer"
- },
- "filter": {
- "description": "`Ruleset` filter. The list method supports filters with restrictions on\n`Ruleset.name`.\n\nFilters on `Ruleset.create_time` should use the `date` function which\nparses strings that conform to the RFC 3339 date/time specifications.\n\nExample: `create_time \u003e date(\"2017-01-01\") AND name=UUID-*`",
- "type": "string",
+ "type": "integer",
"location": "query"
}
},
@@ -136,17 +103,18 @@
"https://www.googleapis.com/auth/firebase.readonly"
],
"flatPath": "v1/projects/{projectsId}/rulesets",
+ "id": "firebaserules.projects.rulesets.list",
"path": "v1/{+name}/rulesets",
- "id": "firebaserules.projects.rulesets.list"
+ "description": "List `Ruleset` metadata only and optionally filter the results by `Ruleset`\nname.\n\nThe full `Source` contents of a `Ruleset` may be retrieved with\nGetRuleset."
},
"get": {
+ "httpMethod": "GET",
"response": {
"$ref": "Ruleset"
},
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
"parameters": {
"name": {
"pattern": "^projects/[^/]+/rulesets/[^/]+$",
@@ -162,83 +130,54 @@
"https://www.googleapis.com/auth/firebase.readonly"
],
"flatPath": "v1/projects/{projectsId}/rulesets/{rulesetsId}",
- "id": "firebaserules.projects.rulesets.get",
"path": "v1/{+name}",
+ "id": "firebaserules.projects.rulesets.get",
"description": "Get a `Ruleset` by name including the full `Source` contents."
+ },
+ "create": {
+ "id": "firebaserules.projects.rulesets.create",
+ "path": "v1/{+name}/rulesets",
+ "request": {
+ "$ref": "Ruleset"
+ },
+ "description": "Create a `Ruleset` from `Source`.\n\nThe `Ruleset` is given a unique generated name which is returned to the\ncaller. `Source` containing syntactic or semantics errors will result in an\nerror response indicating the first error encountered. For a detailed view\nof `Source` issues, use TestRuleset.",
+ "response": {
+ "$ref": "Ruleset"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/firebase"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Resource name for Project which owns this `Ruleset`.\n\nFormat: `projects/{project_id}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/rulesets"
}
}
},
"releases": {
"methods": {
- "get": {
- "id": "firebaserules.projects.releases.get",
- "path": "v1/{+name}",
- "description": "Get a `Release` by name.",
- "response": {
- "$ref": "Release"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/firebase",
- "https://www.googleapis.com/auth/firebase.readonly"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/releases/.+$",
- "location": "path",
- "description": "Resource name of the `Release`.\n\nFormat: `projects/{project_id}/releases/{release_id}`",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/projects/{projectsId}/releases/{releasesId}"
- },
- "update": {
- "id": "firebaserules.projects.releases.update",
- "path": "v1/{+name}",
- "description": "Update a `Release`.\n\nOnly updates to the `ruleset_name` and `test_suite_name` fields will be\nhonored. `Release` rename is not supported. To create a `Release` use the\nCreateRelease method.",
- "request": {
- "$ref": "Release"
- },
- "response": {
- "$ref": "Release"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "name": {
- "description": "Resource name for the `Release`.\n\n`Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`\nwhich affords developers a great deal of flexibility in mapping the name\nto the style that best fits their existing development practices. For\nexample, a name could refer to an environment, an app, a version, or some\ncombination of three.\n\nIn the table below, for the project name `projects/foo`, the following\nrelative release paths show how flat and structured names might be chosen\nto match a desired development / deployment strategy.\n\nUse Case | Flat Name | Structured Name\n-------------|---------------------|----------------\nEnvironments | releases/qa | releases/qa\nApps | releases/app1_qa | releases/app1/qa\nVersions | releases/app1_v2_qa | releases/app1/v2/qa\n\nThe delimiter between the release name path elements can be almost anything\nand it should work equally well with the release name list filter, but in\nmany ways the structured paths provide a clearer picture of the\nrelationship between `Release` instances.\n\nFormat: `projects/{project_id}/releases/{release_id}`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/releases/.+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/firebase"
- ],
- "flatPath": "v1/projects/{projectsId}/releases/{releasesId}"
- },
"getExecutable": {
+ "path": "v1/{+name}:getExecutable",
+ "id": "firebaserules.projects.releases.getExecutable",
+ "description": "Get the `Release` executable to use when enforcing rules.",
+ "httpMethod": "GET",
"response": {
"$ref": "GetReleaseExecutableResponse"
},
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/firebase",
- "https://www.googleapis.com/auth/firebase.readonly"
- ],
"parameters": {
"name": {
"pattern": "^projects/[^/]+/releases/.+$",
@@ -248,32 +187,34 @@
"required": true
},
"executableVersion": {
- "location": "query",
"enum": [
"RELEASE_EXECUTABLE_VERSION_UNSPECIFIED",
"FIREBASE_RULES_EXECUTABLE_V1",
"FIREBASE_RULES_EXECUTABLE_V2"
],
"description": "The requested runtime executable version.\nDefaults to FIREBASE_RULES_EXECUTABLE_V1",
- "type": "string"
+ "type": "string",
+ "location": "query"
}
},
- "flatPath": "v1/projects/{projectsId}/releases/{releasesId}:getExecutable",
- "id": "firebaserules.projects.releases.getExecutable",
- "path": "v1/{+name}:getExecutable",
- "description": "Get the `Release` executable to use when enforcing rules."
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/firebase",
+ "https://www.googleapis.com/auth/firebase.readonly"
+ ],
+ "flatPath": "v1/projects/{projectsId}/releases/{releasesId}:getExecutable"
},
"delete": {
- "id": "firebaserules.projects.releases.delete",
"path": "v1/{+name}",
+ "id": "firebaserules.projects.releases.delete",
"description": "Delete a `Release` by resource name.",
+ "httpMethod": "DELETE",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"name"
],
- "httpMethod": "DELETE",
"parameters": {
"name": {
"pattern": "^projects/[^/]+/releases/.+$",
@@ -290,13 +231,13 @@
"flatPath": "v1/projects/{projectsId}/releases/{releasesId}"
},
"list": {
+ "parameterOrder": [
+ "name"
+ ],
"httpMethod": "GET",
"response": {
"$ref": "ListReleasesResponse"
},
- "parameterOrder": [
- "name"
- ],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase",
@@ -328,13 +269,11 @@
}
},
"flatPath": "v1/projects/{projectsId}/releases",
- "path": "v1/{+name}/releases",
"id": "firebaserules.projects.releases.list",
+ "path": "v1/{+name}/releases",
"description": "List the `Release` values for a project. This list may optionally be\nfiltered by `Release` name, `Ruleset` name, `TestSuite` name, or any\ncombination thereof."
},
"create": {
- "path": "v1/{+name}/releases",
- "id": "firebaserules.projects.releases.create",
"description": "Create a `Release`.\n\nRelease names should reflect the developer's deployment practices. For\nexample, the release name may include the environment name, application\nname, application version, or any other name meaningful to the developer.\nOnce a `Release` refers to a `Ruleset`, the rules can be enforced by\nFirebase Rules-enabled services.\n\nMore than one `Release` may be 'live' concurrently. Consider the following\nthree `Release` names for `projects/foo` and the `Ruleset` to which they\nrefer.\n\nRelease Name | Ruleset Name\n--------------------------------|-------------\nprojects/foo/releases/prod | projects/foo/rulesets/uuid123\nprojects/foo/releases/prod/beta | projects/foo/rulesets/uuid123\nprojects/foo/releases/prod/v23 | projects/foo/rulesets/uuid456\n\nThe table reflects the `Ruleset` rollout in progress. The `prod` and\n`prod/beta` releases refer to the same `Ruleset`. However, `prod/v23`\nrefers to a new `Ruleset`. The `Ruleset` reference for a `Release` may be\nupdated using the UpdateRelease method.",
"request": {
"$ref": "Release"
@@ -348,18 +287,76 @@
},
"parameters": {
"name": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
"description": "Resource name for the project which owns this `Release`.\n\nFormat: `projects/{project_id}`",
"type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
+ "required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
],
- "flatPath": "v1/projects/{projectsId}/releases"
+ "flatPath": "v1/projects/{projectsId}/releases",
+ "path": "v1/{+name}/releases",
+ "id": "firebaserules.projects.releases.create"
+ },
+ "get": {
+ "response": {
+ "$ref": "Release"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/firebase",
+ "https://www.googleapis.com/auth/firebase.readonly"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/releases/.+$",
+ "location": "path",
+ "description": "Resource name of the `Release`.\n\nFormat: `projects/{project_id}/releases/{release_id}`",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/releases/{releasesId}",
+ "id": "firebaserules.projects.releases.get",
+ "path": "v1/{+name}",
+ "description": "Get a `Release` by name."
+ },
+ "update": {
+ "response": {
+ "$ref": "Release"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/firebase"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Resource name for the `Release`.\n\n`Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`\nwhich affords developers a great deal of flexibility in mapping the name\nto the style that best fits their existing development practices. For\nexample, a name could refer to an environment, an app, a version, or some\ncombination of three.\n\nIn the table below, for the project name `projects/foo`, the following\nrelative release paths show how flat and structured names might be chosen\nto match a desired development / deployment strategy.\n\nUse Case | Flat Name | Structured Name\n-------------|---------------------|----------------\nEnvironments | releases/qa | releases/qa\nApps | releases/app1_qa | releases/app1/qa\nVersions | releases/app1_v2_qa | releases/app1/v2/qa\n\nThe delimiter between the release name path elements can be almost anything\nand it should work equally well with the release name list filter, but in\nmany ways the structured paths provide a clearer picture of the\nrelationship between `Release` instances.\n\nFormat: `projects/{project_id}/releases/{release_id}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/releases/.+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/releases/{releasesId}",
+ "id": "firebaserules.projects.releases.update",
+ "path": "v1/{+name}",
+ "request": {
+ "$ref": "Release"
+ },
+ "description": "Update a `Release`.\n\nOnly updates to the `ruleset_name` and `test_suite_name` fields will be\nhonored. `Release` rename is not supported. To create a `Release` use the\nCreateRelease method."
}
}
}
@@ -367,48 +364,17 @@
}
},
"parameters": {
- "access_token": {
- "description": "OAuth access token.",
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
"location": "query"
},
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
"default": "true",
"type": "boolean",
"location": "query"
},
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
- },
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
@@ -433,11 +399,13 @@
"type": "string"
},
"callback": {
+ "location": "query",
"description": "JSONP",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"alt": {
+ "description": "Data format for response.",
+ "default": "json",
"enum": [
"json",
"media",
@@ -449,23 +417,158 @@
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
+ "location": "query"
+ },
+ "access_token": {
"location": "query",
- "description": "Data format for response.",
- "default": "json"
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
}
},
"version": "v1",
"baseUrl": "https://firebaserules.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Creates and manages rules that determine when a Firebase Rules-enabled service should permit a request.\n",
"servicePath": "",
+ "description": "Creates and manages rules that determine when a Firebase Rules-enabled service should permit a request.\n",
+ "kind": "discovery#restDescription",
"basePath": "",
- "id": "firebaserules:v1",
"revision": "20170925",
"documentationLink": "https://firebase.google.com/docs/storage/security",
+ "id": "firebaserules:v1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "Arg": {
+ "properties": {
+ "anyValue": {
+ "description": "Argument matches any value provided.",
+ "$ref": "Empty"
+ },
+ "exactValue": {
+ "description": "Argument exactly matches value provided.",
+ "type": "any"
+ }
+ },
+ "id": "Arg",
+ "description": "Arg matchers for the mock function.",
+ "type": "object"
+ },
+ "TestSuite": {
+ "description": "`TestSuite` is a collection of `TestCase` instances that validate the logical\ncorrectness of a `Ruleset`. The `TestSuite` may be referenced in-line within\na `TestRuleset` invocation or as part of a `Release` object as a pre-release\ncheck.",
+ "type": "object",
+ "properties": {
+ "testCases": {
+ "description": "Collection of test cases associated with the `TestSuite`.",
+ "items": {
+ "$ref": "TestCase"
+ },
+ "type": "array"
+ }
+ },
+ "id": "TestSuite"
+ },
+ "Empty": {
+ "properties": {},
+ "id": "Empty",
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object"
+ },
+ "FunctionMock": {
+ "properties": {
+ "function": {
+ "description": "The name of the function.\n\nThe function name must match one provided by a service declaration.",
+ "type": "string"
+ },
+ "result": {
+ "$ref": "Result",
+ "description": "The mock result of the function call."
+ },
+ "args": {
+ "description": "The list of `Arg` values to match. The order in which the arguments are\nprovided is the order in which they must appear in the function\ninvocation.",
+ "items": {
+ "$ref": "Arg"
+ },
+ "type": "array"
+ }
+ },
+ "id": "FunctionMock",
+ "description": "Mock function definition.\n\nMocks must refer to a function declared by the target service. The type of\nthe function args and result will be inferred at test time. If either the\narg or result values are not compatible with function type declaration, the\nrequest will be considered invalid.\n\nMore than one `FunctionMock` may be provided for a given function name so\nlong as the `Arg` matchers are distinct. There may be only one function\nfor a given overload where all `Arg` values are `Arg.any_value`.",
+ "type": "object"
+ },
+ "GetReleaseExecutableResponse": {
+ "properties": {
+ "updateTime": {
+ "format": "google-datetime",
+ "description": "Timestamp for the most recent `Release.update_time`.",
+ "type": "string"
+ },
+ "rulesetName": {
+ "description": "`Ruleset` name associated with the `Release` executable.",
+ "type": "string"
+ },
+ "language": {
+ "enumDescriptions": [
+ "Language unspecified. Defaults to FIREBASE_RULES.",
+ "Firebase Rules language.",
+ "Event Flow triggers."
+ ],
+ "enum": [
+ "LANGUAGE_UNSPECIFIED",
+ "FIREBASE_RULES",
+ "EVENT_FLOW_TRIGGERS"
+ ],
+ "description": "`Language` used to generate the executable bytes.",
+ "type": "string"
+ },
+ "executableVersion": {
+ "enumDescriptions": [
+ "Executable format unspecified.\nDefaults to FIREBASE_RULES_EXECUTABLE_V1",
+ "Firebase Rules syntax 'rules2' executable versions:\nCustom AST for use with Java clients.",
+ "CEL-based executable for use with C++ clients."
+ ],
+ "enum": [
+ "RELEASE_EXECUTABLE_VERSION_UNSPECIFIED",
+ "FIREBASE_RULES_EXECUTABLE_V1",
+ "FIREBASE_RULES_EXECUTABLE_V2"
+ ],
+ "description": "The Rules runtime version of the executable.",
+ "type": "string"
+ },
+ "executable": {
+ "format": "byte",
+ "description": "Executable view of the `Ruleset` referenced by the `Release`.",
+ "type": "string"
+ }
+ },
+ "id": "GetReleaseExecutableResponse",
+ "description": "The response for FirebaseRulesService.GetReleaseExecutable",
+ "type": "object"
+ },
"Source": {
"description": "`Source` is one or more `File` messages comprising a logical set of rules.",
"type": "object",
@@ -483,8 +586,8 @@
"Result": {
"properties": {
"undefined": {
- "$ref": "Empty",
- "description": "The result is undefined, meaning the result could not be computed."
+ "description": "The result is undefined, meaning the result could not be computed.",
+ "$ref": "Empty"
},
"value": {
"description": "The result is an actual value. The type of the value must match that\nof the type declared by the service.",
@@ -496,14 +599,7 @@
"type": "object"
},
"SourcePosition": {
- "description": "Position in the `Source` content including its line, column number, and an\nindex of the `File` in the `Source` message. Used for debug purposes.",
- "type": "object",
"properties": {
- "line": {
- "format": "int32",
- "description": "Line number of the source fragment. 1-based.",
- "type": "integer"
- },
"column": {
"format": "int32",
"description": "First column on the source line associated with the source fragment.",
@@ -512,11 +608,20 @@
"fileName": {
"description": "Name of the `File`.",
"type": "string"
+ },
+ "line": {
+ "format": "int32",
+ "description": "Line number of the source fragment. 1-based.",
+ "type": "integer"
}
},
- "id": "SourcePosition"
+ "id": "SourcePosition",
+ "description": "Position in the `Source` content including its line, column number, and an\nindex of the `File` in the `Source` message. Used for debug purposes.",
+ "type": "object"
},
"TestCase": {
+ "description": "`TestCase` messages provide the request context and an expectation as to\nwhether the given context will be allowed or denied. Test cases may specify\nthe `request`, `resource`, and `function_mocks` to mock a function call to\na service-provided function.\n\nThe `request` object represents context present at request-time.\n\nThe `resource` is the value of the target resource as it appears in\npersistent storage before the request is executed.",
+ "type": "object",
"properties": {
"functionMocks": {
"description": "Optional function mocks for service-defined functions. If not set, any\nservice defined function is expected to return an error, which may or may\nnot influence the test outcome.",
@@ -530,32 +635,74 @@
"type": "any"
},
"expectation": {
- "enumDescriptions": [
- "Unspecified expectation.",
- "Expect an allowed result.",
- "Expect a denied result."
- ],
"enum": [
"EXPECTATION_UNSPECIFIED",
"ALLOW",
"DENY"
],
"description": "Test expectation.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified expectation.",
+ "Expect an allowed result.",
+ "Expect a denied result."
+ ]
},
"request": {
"description": "Request context.\n\nThe exact format of the request context is service-dependent. See the\nappropriate service documentation for information about the supported\nfields and types on the request. Minimally, all services support the\nfollowing fields and types:\n\nRequest field | Type\n---------------|-----------------\nauth.uid | `string`\nauth.token | `map\u003cstring, string\u003e`\nheaders | `map\u003cstring, string\u003e`\nmethod | `string`\nparams | `map\u003cstring, string\u003e`\npath | `string`\ntime | `google.protobuf.Timestamp`\n\nIf the request value is not well-formed for the service, the request will\nbe rejected as an invalid argument.",
"type": "any"
}
},
- "id": "TestCase",
- "description": "`TestCase` messages provide the request context and an expectation as to\nwhether the given context will be allowed or denied. Test cases may specify\nthe `request`, `resource`, and `function_mocks` to mock a function call to\na service-provided function.\n\nThe `request` object represents context present at request-time.\n\nThe `resource` is the value of the target resource as it appears in\npersistent storage before the request is executed.",
+ "id": "TestCase"
+ },
+ "Issue": {
+ "properties": {
+ "sourcePosition": {
+ "$ref": "SourcePosition",
+ "description": "Position of the issue in the `Source`."
+ },
+ "severity": {
+ "enum": [
+ "SEVERITY_UNSPECIFIED",
+ "DEPRECATION",
+ "WARNING",
+ "ERROR"
+ ],
+ "description": "The severity of the issue.",
+ "type": "string",
+ "enumDescriptions": [
+ "An unspecified severity.",
+ "Deprecation issue for statements and method that may no longer be\nsupported or maintained.",
+ "Warnings such as: unused variables.",
+ "Errors such as: unmatched curly braces or variable redefinition."
+ ]
+ },
+ "description": {
+ "description": "Short error description.",
+ "type": "string"
+ }
+ },
+ "id": "Issue",
+ "description": "Issues include warnings, errors, and deprecation notices.",
"type": "object"
},
- "Ruleset": {
- "description": "`Ruleset` is an immutable copy of `Source` with a globally unique identifier\nand a creation time.",
+ "TestRulesetRequest": {
+ "description": "The request for FirebaseRulesService.TestRuleset.",
"type": "object",
"properties": {
+ "testSuite": {
+ "description": "Inline `TestSuite` to run.",
+ "$ref": "TestSuite"
+ },
+ "source": {
+ "$ref": "Source",
+ "description": "Optional `Source` to be checked for correctness.\n\nThis field must not be set when the resource name refers to a `Ruleset`."
+ }
+ },
+ "id": "TestRulesetRequest"
+ },
+ "Ruleset": {
+ "properties": {
"createTime": {
"format": "google-datetime",
"description": "Time the `Ruleset` was created.\nOutput only.",
@@ -570,55 +717,13 @@
"$ref": "Source"
}
},
- "id": "Ruleset"
- },
- "TestRulesetRequest": {
- "description": "The request for FirebaseRulesService.TestRuleset.",
- "type": "object",
- "properties": {
- "testSuite": {
- "$ref": "TestSuite",
- "description": "Inline `TestSuite` to run."
- },
- "source": {
- "$ref": "Source",
- "description": "Optional `Source` to be checked for correctness.\n\nThis field must not be set when the resource name refers to a `Ruleset`."
- }
- },
- "id": "TestRulesetRequest"
- },
- "Issue": {
- "description": "Issues include warnings, errors, and deprecation notices.",
- "type": "object",
- "properties": {
- "sourcePosition": {
- "description": "Position of the issue in the `Source`.",
- "$ref": "SourcePosition"
- },
- "severity": {
- "enumDescriptions": [
- "An unspecified severity.",
- "Deprecation issue for statements and method that may no longer be\nsupported or maintained.",
- "Warnings such as: unused variables.",
- "Errors such as: unmatched curly braces or variable redefinition."
- ],
- "enum": [
- "SEVERITY_UNSPECIFIED",
- "DEPRECATION",
- "WARNING",
- "ERROR"
- ],
- "description": "The severity of the issue.",
- "type": "string"
- },
- "description": {
- "description": "Short error description.",
- "type": "string"
- }
- },
- "id": "Issue"
+ "id": "Ruleset",
+ "description": "`Ruleset` is an immutable copy of `Source` with a globally unique identifier\nand a creation time.",
+ "type": "object"
},
"FunctionCall": {
+ "description": "Represents a service-defined function call that was invoked during test\nexecution.",
+ "type": "object",
"properties": {
"args": {
"description": "The arguments that were provided to the function.",
@@ -632,17 +737,30 @@
"type": "string"
}
},
- "id": "FunctionCall",
- "description": "Represents a service-defined function call that was invoked during test\nexecution.",
- "type": "object"
+ "id": "FunctionCall"
+ },
+ "ListReleasesResponse": {
+ "description": "The response for FirebaseRulesService.ListReleases.",
+ "type": "object",
+ "properties": {
+ "releases": {
+ "description": "List of `Release` instances.",
+ "items": {
+ "$ref": "Release"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "The pagination token to retrieve the next page of results. If the value is\nempty, no further results remain.",
+ "type": "string"
+ }
+ },
+ "id": "ListReleasesResponse"
},
"File": {
+ "description": "`File` containing source content.",
+ "type": "object",
"properties": {
- "fingerprint": {
- "format": "byte",
- "description": "Fingerprint (e.g. github sha) associated with the `File`.",
- "type": "string"
- },
"name": {
"description": "File name.",
"type": "string"
@@ -650,37 +768,19 @@
"content": {
"description": "Textual Content.",
"type": "string"
- }
- },
- "id": "File",
- "description": "`File` containing source content.",
- "type": "object"
- },
- "ListReleasesResponse": {
- "properties": {
- "nextPageToken": {
- "description": "The pagination token to retrieve the next page of results. If the value is\nempty, no further results remain.",
- "type": "string"
},
- "releases": {
- "description": "List of `Release` instances.",
- "items": {
- "$ref": "Release"
- },
- "type": "array"
+ "fingerprint": {
+ "format": "byte",
+ "description": "Fingerprint (e.g. github sha) associated with the `File`.",
+ "type": "string"
}
},
- "id": "ListReleasesResponse",
- "description": "The response for FirebaseRulesService.ListReleases.",
- "type": "object"
+ "id": "File"
},
"Release": {
+ "description": "`Release` is a named reference to a `Ruleset`. Once a `Release` refers to a\n`Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.",
+ "type": "object",
"properties": {
- "createTime": {
- "format": "google-datetime",
- "description": "Time the release was created.\nOutput only.",
- "type": "string"
- },
"updateTime": {
"format": "google-datetime",
"description": "Time the release was updated.\nOutput only.",
@@ -693,29 +793,32 @@
"name": {
"description": "Resource name for the `Release`.\n\n`Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`\nwhich affords developers a great deal of flexibility in mapping the name\nto the style that best fits their existing development practices. For\nexample, a name could refer to an environment, an app, a version, or some\ncombination of three.\n\nIn the table below, for the project name `projects/foo`, the following\nrelative release paths show how flat and structured names might be chosen\nto match a desired development / deployment strategy.\n\nUse Case | Flat Name | Structured Name\n-------------|---------------------|----------------\nEnvironments | releases/qa | releases/qa\nApps | releases/app1_qa | releases/app1/qa\nVersions | releases/app1_v2_qa | releases/app1/v2/qa\n\nThe delimiter between the release name path elements can be almost anything\nand it should work equally well with the release name list filter, but in\nmany ways the structured paths provide a clearer picture of the\nrelationship between `Release` instances.\n\nFormat: `projects/{project_id}/releases/{release_id}`",
"type": "string"
+ },
+ "createTime": {
+ "format": "google-datetime",
+ "description": "Time the release was created.\nOutput only.",
+ "type": "string"
}
},
- "id": "Release",
- "description": "`Release` is a named reference to a `Ruleset`. Once a `Release` refers to a\n`Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.",
- "type": "object"
+ "id": "Release"
},
"TestRulesetResponse": {
"description": "The response for FirebaseRulesService.TestRuleset.",
"type": "object",
"properties": {
- "testResults": {
- "description": "The set of test results given the test cases in the `TestSuite`.\nThe results will appear in the same order as the test cases appear in the\n`TestSuite`.",
- "items": {
- "$ref": "TestResult"
- },
- "type": "array"
- },
"issues": {
"description": "Syntactic and semantic `Source` issues of varying severity. Issues of\n`ERROR` severity will prevent tests from executing.",
"items": {
"$ref": "Issue"
},
"type": "array"
+ },
+ "testResults": {
+ "description": "The set of test results given the test cases in the `TestSuite`.\nThe results will appear in the same order as the test cases appear in the\n`TestSuite`.",
+ "items": {
+ "$ref": "TestResult"
+ },
+ "type": "array"
}
},
"id": "TestRulesetResponse"
@@ -739,8 +842,6 @@
"id": "ListRulesetsResponse"
},
"TestResult": {
- "description": "Test result message containing the state of the test as well as a\ndescription and source position for test failures.",
- "type": "object",
"properties": {
"debugMessages": {
"description": "Debug messages related to test execution issues encountered during\nevaluation.\n\nDebug messages may be related to too many or too few invocations of\nfunction mocks or to runtime errors that occur during evaluation.\n\nFor example: ```Unable to read variable [name: \"resource\"]```",
@@ -750,22 +851,22 @@
"type": "array"
},
"state": {
- "enumDescriptions": [
- "Test state is not set.",
- "Test is a success.",
- "Test is a failure."
- ],
"enum": [
"STATE_UNSPECIFIED",
"SUCCESS",
"FAILURE"
],
"description": "State of the test.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Test state is not set.",
+ "Test is a success.",
+ "Test is a failure."
+ ]
},
"errorPosition": {
- "description": "Position in the `Source` or `Ruleset` where the principle runtime error\noccurs.\n\nEvaluation of an expression may result in an error. Rules are deny by\ndefault, so a `DENY` expectation when an error is generated is valid.\nWhen there is a `DENY` with an error, the `SourcePosition` is returned.\n\nE.g. `error_position { line: 19 column: 37 }`",
- "$ref": "SourcePosition"
+ "$ref": "SourcePosition",
+ "description": "Position in the `Source` or `Ruleset` where the principle runtime error\noccurs.\n\nEvaluation of an expression may result in an error. Rules are deny by\ndefault, so a `DENY` expectation when an error is generated is valid.\nWhen there is a `DENY` with an error, the `SourcePosition` is returned.\n\nE.g. `error_position { line: 19 column: 37 }`"
},
"functionCalls": {
"description": "The set of function calls made to service-defined methods.\n\nFunction calls are included in the order in which they are encountered\nduring evaluation, are provided for both mocked and unmocked functions,\nand included on the response regardless of the test `state`.",
@@ -775,113 +876,9 @@
"type": "array"
}
},
- "id": "TestResult"
- },
- "Arg": {
- "properties": {
- "anyValue": {
- "description": "Argument matches any value provided.",
- "$ref": "Empty"
- },
- "exactValue": {
- "description": "Argument exactly matches value provided.",
- "type": "any"
- }
- },
- "id": "Arg",
- "description": "Arg matchers for the mock function.",
+ "id": "TestResult",
+ "description": "Test result message containing the state of the test as well as a\ndescription and source position for test failures.",
"type": "object"
- },
- "TestSuite": {
- "properties": {
- "testCases": {
- "description": "Collection of test cases associated with the `TestSuite`.",
- "items": {
- "$ref": "TestCase"
- },
- "type": "array"
- }
- },
- "id": "TestSuite",
- "description": "`TestSuite` is a collection of `TestCase` instances that validate the logical\ncorrectness of a `Ruleset`. The `TestSuite` may be referenced in-line within\na `TestRuleset` invocation or as part of a `Release` object as a pre-release\ncheck.",
- "type": "object"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "FunctionMock": {
- "properties": {
- "args": {
- "description": "The list of `Arg` values to match. The order in which the arguments are\nprovided is the order in which they must appear in the function\ninvocation.",
- "items": {
- "$ref": "Arg"
- },
- "type": "array"
- },
- "function": {
- "description": "The name of the function.\n\nThe function name must match one provided by a service declaration.",
- "type": "string"
- },
- "result": {
- "$ref": "Result",
- "description": "The mock result of the function call."
- }
- },
- "id": "FunctionMock",
- "description": "Mock function definition.\n\nMocks must refer to a function declared by the target service. The type of\nthe function args and result will be inferred at test time. If either the\narg or result values are not compatible with function type declaration, the\nrequest will be considered invalid.\n\nMore than one `FunctionMock` may be provided for a given function name so\nlong as the `Arg` matchers are distinct. There may be only one function\nfor a given overload where all `Arg` values are `Arg.any_value`.",
- "type": "object"
- },
- "GetReleaseExecutableResponse": {
- "description": "The response for FirebaseRulesService.GetReleaseExecutable",
- "type": "object",
- "properties": {
- "executableVersion": {
- "enum": [
- "RELEASE_EXECUTABLE_VERSION_UNSPECIFIED",
- "FIREBASE_RULES_EXECUTABLE_V1",
- "FIREBASE_RULES_EXECUTABLE_V2"
- ],
- "description": "The Rules runtime version of the executable.",
- "type": "string",
- "enumDescriptions": [
- "Executable format unspecified.\nDefaults to FIREBASE_RULES_EXECUTABLE_V1",
- "Firebase Rules syntax 'rules2' executable versions:\nCustom AST for use with Java clients.",
- "CEL-based executable for use with C++ clients."
- ]
- },
- "executable": {
- "format": "byte",
- "description": "Executable view of the `Ruleset` referenced by the `Release`.",
- "type": "string"
- },
- "updateTime": {
- "format": "google-datetime",
- "description": "Timestamp for the most recent `Release.update_time`.",
- "type": "string"
- },
- "rulesetName": {
- "description": "`Ruleset` name associated with the `Release` executable.",
- "type": "string"
- },
- "language": {
- "enum": [
- "LANGUAGE_UNSPECIFIED",
- "FIREBASE_RULES",
- "EVENT_FLOW_TRIGGERS"
- ],
- "description": "`Language` used to generate the executable bytes.",
- "type": "string",
- "enumDescriptions": [
- "Language unspecified. Defaults to FIREBASE_RULES.",
- "Firebase Rules language.",
- "Event Flow triggers."
- ]
- }
- },
- "id": "GetReleaseExecutableResponse"
}
},
"protocol": "rest",
@@ -905,5 +902,8 @@
}
}
},
- "rootUrl": "https://firebaserules.googleapis.com/"
+ "rootUrl": "https://firebaserules.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "firebaserules",
+ "batchPath": "batch"
}
diff --git a/firestore/v1beta1/firestore-api.json b/firestore/v1beta1/firestore-api.json
index adba510..ff0521a 100644
--- a/firestore/v1beta1/firestore-api.json
+++ b/firestore/v1beta1/firestore-api.json
@@ -1,22 +1,755 @@
{
+ "canonicalName": "Firestore",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/datastore": {
+ "description": "View and manage your Google Cloud Datastore data"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://firestore.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "firestore",
+ "batchPath": "batch",
+ "title": "Google Cloud Firestore API",
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "resources": {
+ "databases": {
+ "resources": {
+ "indexes": {
+ "methods": {
+ "create": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "description": "The name of the database this index will apply to. For example:\n`projects/{project_id}/databases/{database_id}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/databases/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/indexes",
+ "id": "firestore.projects.databases.indexes.create",
+ "path": "v1beta1/{+parent}/indexes",
+ "description": "Creates the specified index.\nA newly created index's initial state is `CREATING`. On completion of the\nreturned google.longrunning.Operation, the state will be `READY`.\nIf the index already exists, the call will return an `ALREADY_EXISTS`\nstatus.\n\nDuring creation, the process could result in an error, in which case the\nindex will move to the `ERROR` state. The process can be recovered by\nfixing the data that caused the error, removing the index with\ndelete, then re-creating the index with\ncreate.\n\nIndexes with a single field cannot be created.",
+ "request": {
+ "$ref": "Index"
+ }
+ },
+ "delete": {
+ "id": "firestore.projects.databases.indexes.delete",
+ "path": "v1beta1/{+name}",
+ "description": "Deletes an index.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "description": "The index name. For example:\n`projects/{project_id}/databases/{database_id}/indexes/{index_id}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/databases/[^/]+/indexes/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/indexes/{indexesId}"
+ },
+ "get": {
+ "description": "Gets an index.",
+ "response": {
+ "$ref": "Index"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/databases/[^/]+/indexes/[^/]+$",
+ "location": "path",
+ "description": "The name of the index. For example:\n`projects/{project_id}/databases/{database_id}/indexes/{index_id}`",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/indexes/{indexesId}",
+ "id": "firestore.projects.databases.indexes.get",
+ "path": "v1beta1/{+name}"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListIndexesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "The standard List page token.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The standard List page size.",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "description": "The database name. For example:\n`projects/{project_id}/databases/{database_id}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/databases/[^/]+$",
+ "location": "path"
+ },
+ "filter": {
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/indexes",
+ "path": "v1beta1/{+parent}/indexes",
+ "id": "firestore.projects.databases.indexes.list",
+ "description": "Lists the indexes that match the specified filters."
+ }
+ }
+ },
+ "documents": {
+ "methods": {
+ "write": {
+ "path": "v1beta1/{+database}/documents:write",
+ "id": "firestore.projects.databases.documents.write",
+ "description": "Streams batches of document updates and deletes, in order.",
+ "request": {
+ "$ref": "WriteRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "database"
+ ],
+ "response": {
+ "$ref": "WriteResponse"
+ },
+ "parameters": {
+ "database": {
+ "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.\nThis is only required in the first message.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/databases/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:write"
+ },
+ "beginTransaction": {
+ "path": "v1beta1/{+database}/documents:beginTransaction",
+ "id": "firestore.projects.databases.documents.beginTransaction",
+ "request": {
+ "$ref": "BeginTransactionRequest"
+ },
+ "description": "Starts a new transaction.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "database"
+ ],
+ "response": {
+ "$ref": "BeginTransactionResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "parameters": {
+ "database": {
+ "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/databases/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:beginTransaction"
+ },
+ "batchGet": {
+ "request": {
+ "$ref": "BatchGetDocumentsRequest"
+ },
+ "description": "Gets multiple documents.\n\nDocuments returned by this method are not guaranteed to be returned in the\nsame order that they were requested.",
+ "response": {
+ "$ref": "BatchGetDocumentsResponse"
+ },
+ "parameterOrder": [
+ "database"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "parameters": {
+ "database": {
+ "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/databases/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:batchGet",
+ "id": "firestore.projects.databases.documents.batchGet",
+ "path": "v1beta1/{+database}/documents:batchGet"
+ },
+ "list": {
+ "response": {
+ "$ref": "ListDocumentsResponse"
+ },
+ "parameterOrder": [
+ "parent",
+ "collectionId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "parameters": {
+ "showMissing": {
+ "location": "query",
+ "description": "If the list should show missing documents. A missing document is a\ndocument that does not exist but has sub-documents. These documents will\nbe returned with a key but will not have fields, Document.create_time,\nor Document.update_time set.\n\nRequests with `show_missing` may not specify `where` or\n`order_by`.",
+ "type": "boolean"
+ },
+ "mask.fieldPaths": {
+ "description": "The list of field paths in the mask. See Document.fields for a field\npath syntax reference.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The `next_page_token` value returned from a previous List request, if any.",
+ "type": "string"
+ },
+ "collectionId": {
+ "description": "The collection ID, relative to `parent`, to list. For example: `chatrooms`\nor `messages`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The maximum number of documents to return.",
+ "type": "integer",
+ "location": "query"
+ },
+ "transaction": {
+ "location": "query",
+ "format": "byte",
+ "description": "Reads documents in a transaction.",
+ "type": "string"
+ },
+ "parent": {
+ "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$",
+ "location": "path",
+ "description": "The parent resource name. In the format:\n`projects/{project_id}/databases/{database_id}/documents` or\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.\nFor example:\n`projects/my-project/databases/my-database/documents` or\n`projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`",
+ "type": "string",
+ "required": true
+ },
+ "readTime": {
+ "format": "google-datetime",
+ "description": "Reads documents as they were at the given time.\nThis may not be older than 60 seconds.",
+ "type": "string",
+ "location": "query"
+ },
+ "orderBy": {
+ "location": "query",
+ "description": "The order to sort results by. For example: `priority desc, name`.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}/{collectionId}",
+ "id": "firestore.projects.databases.documents.list",
+ "path": "v1beta1/{+parent}/{collectionId}",
+ "description": "Lists documents."
+ },
+ "runQuery": {
+ "path": "v1beta1/{+parent}:runQuery",
+ "id": "firestore.projects.databases.documents.runQuery",
+ "description": "Runs a query.",
+ "request": {
+ "$ref": "RunQueryRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "RunQueryResponse"
+ },
+ "parameters": {
+ "parent": {
+ "description": "The parent resource name. In the format:\n`projects/{project_id}/databases/{database_id}/documents` or\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.\nFor example:\n`projects/my-project/databases/my-database/documents` or\n`projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}:runQuery"
+ },
+ "createDocument": {
+ "request": {
+ "$ref": "Document"
+ },
+ "description": "Creates a new document.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent",
+ "collectionId"
+ ],
+ "response": {
+ "$ref": "Document"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "parameters": {
+ "mask.fieldPaths": {
+ "description": "The list of field paths in the mask. See Document.fields for a field\npath syntax reference.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
+ "collectionId": {
+ "description": "The collection ID, relative to `parent`, to list. For example: `chatrooms`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "documentId": {
+ "description": "The client-assigned document ID to use for this document.\n\nOptional. If not specified, an ID will be assigned by the service.",
+ "type": "string",
+ "location": "query"
+ },
+ "parent": {
+ "description": "The parent resource. For example:\n`projects/{project_id}/databases/{database_id}/documents` or\n`projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/databases/[^/]+/documents/.+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{collectionId}",
+ "path": "v1beta1/{+parent}/{collectionId}",
+ "id": "firestore.projects.databases.documents.createDocument"
+ },
+ "get": {
+ "id": "firestore.projects.databases.documents.get",
+ "path": "v1beta1/{+name}",
+ "description": "Gets a single document.",
+ "response": {
+ "$ref": "Document"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "parameters": {
+ "transaction": {
+ "location": "query",
+ "format": "byte",
+ "description": "Reads the document in a transaction.",
+ "type": "string"
+ },
+ "readTime": {
+ "location": "query",
+ "format": "google-datetime",
+ "description": "Reads the version of the document at the given time.\nThis may not be older than 60 seconds.",
+ "type": "string"
+ },
+ "mask.fieldPaths": {
+ "repeated": true,
+ "location": "query",
+ "description": "The list of field paths in the mask. See Document.fields for a field\npath syntax reference.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The resource name of the Document to get. In the format:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}"
+ },
+ "patch": {
+ "request": {
+ "$ref": "Document"
+ },
+ "description": "Updates or inserts a document.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Document"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "parameters": {
+ "currentDocument.exists": {
+ "description": "When set to `true`, the target document must exist.\nWhen set to `false`, the target document must not exist.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "mask.fieldPaths": {
+ "description": "The list of field paths in the mask. See Document.fields for a field\npath syntax reference.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
+ "updateMask.fieldPaths": {
+ "repeated": true,
+ "location": "query",
+ "description": "The list of field paths in the mask. See Document.fields for a field\npath syntax reference.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The resource name of the document, for example\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$",
+ "location": "path"
+ },
+ "currentDocument.updateTime": {
+ "format": "google-datetime",
+ "description": "When set, the target document must exist and have been last updated at\nthat time.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}",
+ "path": "v1beta1/{+name}",
+ "id": "firestore.projects.databases.documents.patch"
+ },
+ "listen": {
+ "path": "v1beta1/{+database}/documents:listen",
+ "id": "firestore.projects.databases.documents.listen",
+ "description": "Listens to changes.",
+ "request": {
+ "$ref": "ListenRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "database"
+ ],
+ "response": {
+ "$ref": "ListenResponse"
+ },
+ "parameters": {
+ "database": {
+ "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/databases/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:listen"
+ },
+ "delete": {
+ "description": "Deletes a document.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The resource name of the Document to delete. In the format:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$",
+ "location": "path"
+ },
+ "currentDocument.updateTime": {
+ "format": "google-datetime",
+ "description": "When set, the target document must exist and have been last updated at\nthat time.",
+ "type": "string",
+ "location": "query"
+ },
+ "currentDocument.exists": {
+ "location": "query",
+ "description": "When set to `true`, the target document must exist.\nWhen set to `false`, the target document must not exist.",
+ "type": "boolean"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}",
+ "path": "v1beta1/{+name}",
+ "id": "firestore.projects.databases.documents.delete"
+ },
+ "listCollectionIds": {
+ "id": "firestore.projects.databases.documents.listCollectionIds",
+ "path": "v1beta1/{+parent}:listCollectionIds",
+ "description": "Lists all the collection IDs underneath a document.",
+ "response": {
+ "$ref": "ListCollectionIdsResponse"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$",
+ "location": "path",
+ "description": "The parent document. In the format:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.\nFor example:\n`projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`",
+ "type": "string",
+ "required": true
+ },
+ "pageToken": {
+ "description": "A page token. Must be a value from\nListCollectionIdsResponse.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The maximum number of results to return.",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}:listCollectionIds"
+ },
+ "commit": {
+ "path": "v1beta1/{+database}/documents:commit",
+ "id": "firestore.projects.databases.documents.commit",
+ "request": {
+ "$ref": "CommitRequest"
+ },
+ "description": "Commits a transaction, while optionally updating documents.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "database"
+ ],
+ "response": {
+ "$ref": "CommitResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "parameters": {
+ "database": {
+ "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/databases/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:commit"
+ },
+ "rollback": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "database"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "parameters": {
+ "database": {
+ "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/databases/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:rollback",
+ "id": "firestore.projects.databases.documents.rollback",
+ "path": "v1beta1/{+database}/documents:rollback",
+ "request": {
+ "$ref": "RollbackRequest"
+ },
+ "description": "Rolls back a transaction."
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query"
+ }
+ },
+ "version": "v1beta1",
+ "baseUrl": "https://firestore.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "",
+ "servicePath": "",
+ "basePath": "",
+ "id": "firestore:v1beta1",
"revision": "0",
"documentationLink": "https://cloud.google.com/firestore",
- "id": "firestore:v1beta1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "BeginTransactionResponse": {
- "description": "The response for Firestore.BeginTransaction.",
- "type": "object",
- "properties": {
- "transaction": {
- "format": "byte",
- "description": "The transaction that was started.",
- "type": "string"
- }
- },
- "id": "BeginTransactionResponse"
- },
"IndexField": {
"description": "A field of an index.",
"type": "object",
@@ -46,15 +779,6 @@
"description": "The response for Firestore.RunQuery.",
"type": "object",
"properties": {
- "transaction": {
- "format": "byte",
- "description": "The transaction that was started as part of this request.\nCan only be set in the first response, and only if\nRunQueryRequest.new_transaction was set in the request.\nIf set, no other fields will be set in this response.",
- "type": "string"
- },
- "document": {
- "description": "A query result.\nNot set when reporting partial progress.",
- "$ref": "Document"
- },
"readTime": {
"format": "google-datetime",
"description": "The time at which the document was read. This may be monotonically\nincreasing; in this case, the previous documents in the result stream are\nguaranteed not to have changed between their `read_time` and this one.\n\nIf the query returns no results, a response with `read_time` and no\n`document` will be sent, and this represents the time at which the query\nwas run.",
@@ -64,21 +788,19 @@
"format": "int32",
"description": "The number of results that have been skipped due to an offset between\nthe last response and the current response.",
"type": "integer"
+ },
+ "transaction": {
+ "format": "byte",
+ "description": "The transaction that was started as part of this request.\nCan only be set in the first response, and only if\nRunQueryRequest.new_transaction was set in the request.\nIf set, no other fields will be set in this response.",
+ "type": "string"
+ },
+ "document": {
+ "$ref": "Document",
+ "description": "A query result.\nNot set when reporting partial progress."
}
},
"id": "RunQueryResponse"
},
- "BeginTransactionRequest": {
- "description": "The request for Firestore.BeginTransaction.",
- "type": "object",
- "properties": {
- "options": {
- "description": "The options for the transaction.\nDefaults to a read-write transaction.",
- "$ref": "TransactionOptions"
- }
- },
- "id": "BeginTransactionRequest"
- },
"CommitRequest": {
"description": "The request for Firestore.Commit.",
"type": "object",
@@ -98,11 +820,27 @@
},
"id": "CommitRequest"
},
+ "BeginTransactionRequest": {
+ "description": "The request for Firestore.BeginTransaction.",
+ "type": "object",
+ "properties": {
+ "options": {
+ "description": "The options for the transaction.\nDefaults to a read-write transaction.",
+ "$ref": "TransactionOptions"
+ }
+ },
+ "id": "BeginTransactionRequest"
+ },
"ListenRequest": {
"properties": {
+ "removeTarget": {
+ "format": "int32",
+ "description": "The ID of a target to remove from this stream.",
+ "type": "integer"
+ },
"addTarget": {
- "$ref": "Target",
- "description": "A target to add to this stream."
+ "description": "A target to add to this stream.",
+ "$ref": "Target"
},
"labels": {
"additionalProperties": {
@@ -110,11 +848,6 @@
},
"description": "Labels associated with this target change.",
"type": "object"
- },
- "removeTarget": {
- "format": "int32",
- "description": "The ID of a target to remove from this stream.",
- "type": "integer"
}
},
"id": "ListenRequest",
@@ -139,8 +872,6 @@
"type": "object"
},
"CollectionSelector": {
- "description": "A selection of a collection, such as `messages as m1`.",
- "type": "object",
"properties": {
"allDescendants": {
"description": "When false, selects only collections that are immediate children of\nthe `parent` specified in the containing `RunQueryRequest`.\nWhen true, selects all descendant collections.",
@@ -151,9 +882,13 @@
"type": "string"
}
},
- "id": "CollectionSelector"
+ "id": "CollectionSelector",
+ "description": "A selection of a collection, such as `messages as m1`.",
+ "type": "object"
},
"ArrayValue": {
+ "description": "An array value.",
+ "type": "object",
"properties": {
"values": {
"description": "Values in the array.",
@@ -163,15 +898,17 @@
"type": "array"
}
},
- "id": "ArrayValue",
- "description": "An array value.",
- "type": "object"
+ "id": "ArrayValue"
},
"Index": {
- "description": "An index definition.",
- "type": "object",
"properties": {
"state": {
+ "enumDescriptions": [
+ "The state is unspecified.",
+ "The index is being created.\nThere is an active long-running operation for the index.\nThe index is updated when writing a document.\nSome index data may exist.",
+ "The index is ready to be used.\nThe index is updated when writing a document.\nThe index is fully populated from all stored documents it applies to.",
+ "The index was being created, but something went wrong.\nThere is no active long-running operation for the index,\nand the most recently finished long-running operation failed.\nThe index is not updated when writing a document.\nSome index data may exist."
+ ],
"enum": [
"STATE_UNSPECIFIED",
"CREATING",
@@ -179,13 +916,7 @@
"ERROR"
],
"description": "The state of the index.\nThe state is read-only.\n@OutputOnly",
- "type": "string",
- "enumDescriptions": [
- "The state is unspecified.",
- "The index is being created.\nThere is an active long-running operation for the index.\nThe index is updated when writing a document.\nSome index data may exist.",
- "The index is ready to be used.\nThe index is updated when writing a document.\nThe index is fully populated from all stored documents it applies to.",
- "The index was being created, but something went wrong.\nThere is no active long-running operation for the index,\nand the most recently finished long-running operation failed.\nThe index is not updated when writing a document.\nSome index data may exist."
- ]
+ "type": "string"
},
"fields": {
"description": "The fields to index.",
@@ -203,12 +934,18 @@
"type": "string"
}
},
- "id": "Index"
+ "id": "Index",
+ "description": "An index definition.",
+ "type": "object"
},
"StructuredQuery": {
"description": "A Firestore query.",
"type": "object",
"properties": {
+ "where": {
+ "description": "The filter to apply.",
+ "$ref": "Filter"
+ },
"orderBy": {
"description": "The order to apply to the query results.\n\nFirestore guarantees a stable ordering through the following rules:\n\n * Any field required to appear in `order_by`, that is not already\n specified in `order_by`, is appended to the order in field name order\n by default.\n * If an order on `__name__` is not specified, it is appended by default.\n\nFields are appended with the same sort direction as the last order\nspecified, or 'ASCENDING' if no order was specified. For example:\n\n * `SELECT * FROM Foo ORDER BY A` becomes\n `SELECT * FROM Foo ORDER BY A, __name__`\n * `SELECT * FROM Foo ORDER BY A DESC` becomes\n `SELECT * FROM Foo ORDER BY A DESC, __name__ DESC`\n * `SELECT * FROM Foo WHERE A \u003e 1` becomes\n `SELECT * FROM Foo WHERE A \u003e 1 ORDER BY A, __name__`",
"items": {
@@ -217,8 +954,8 @@
"type": "array"
},
"select": {
- "description": "The projection to return.",
- "$ref": "Projection"
+ "$ref": "Projection",
+ "description": "The projection to return."
},
"limit": {
"format": "int32",
@@ -238,16 +975,12 @@
"type": "integer"
},
"endAt": {
- "description": "A end point for the query results.",
- "$ref": "Cursor"
+ "$ref": "Cursor",
+ "description": "A end point for the query results."
},
"startAt": {
- "$ref": "Cursor",
- "description": "A starting point for the query results."
- },
- "where": {
- "$ref": "Filter",
- "description": "The filter to apply."
+ "description": "A starting point for the query results.",
+ "$ref": "Cursor"
}
},
"id": "StructuredQuery"
@@ -256,23 +989,23 @@
"description": "A filter with a single operand.",
"type": "object",
"properties": {
- "field": {
- "description": "The field to which to apply the operator.",
- "$ref": "FieldReference"
- },
"op": {
- "enumDescriptions": [
- "Unspecified. This value must not be used.",
- "Test if a field is equal to NaN.",
- "Test if an exprestion evaluates to Null."
- ],
"enum": [
"OPERATOR_UNSPECIFIED",
"IS_NAN",
"IS_NULL"
],
"description": "The unary operator to apply.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified. This value must not be used.",
+ "Test if a field is equal to NaN.",
+ "Test if an exprestion evaluates to Null."
+ ]
+ },
+ "field": {
+ "$ref": "FieldReference",
+ "description": "The field to which to apply the operator."
}
},
"id": "UnaryFilter"
@@ -288,16 +1021,47 @@
"$ref": "CompositeFilter"
},
"fieldFilter": {
- "description": "A filter on a document field.",
- "$ref": "FieldFilter"
+ "$ref": "FieldFilter",
+ "description": "A filter on a document field."
}
},
"id": "Filter",
"description": "A filter.",
"type": "object"
},
- "WriteRequest": {
+ "BatchGetDocumentsResponse": {
"properties": {
+ "readTime": {
+ "format": "google-datetime",
+ "description": "The time at which the document was read.\nThis may be monotically increasing, in this case the previous documents in\nthe result stream are guaranteed not to have changed between their\nread_time and this one.",
+ "type": "string"
+ },
+ "missing": {
+ "description": "A document name that was requested but does not exist. In the format:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.",
+ "type": "string"
+ },
+ "found": {
+ "description": "A document that was requested.",
+ "$ref": "Document"
+ },
+ "transaction": {
+ "format": "byte",
+ "description": "The transaction that was started as part of this request.\nWill only be set in the first response, and only if\nBatchGetDocumentsRequest.new_transaction was set in the request.",
+ "type": "string"
+ }
+ },
+ "id": "BatchGetDocumentsResponse",
+ "description": "The streamed response for Firestore.BatchGetDocuments.",
+ "type": "object"
+ },
+ "WriteRequest": {
+ "description": "The request for Firestore.Write.\n\nThe first request creates a stream, or resumes an existing one from a token.\n\nWhen creating a new stream, the server replies with a response containing\nonly an ID and a token, to use in the next request.\n\nWhen resuming a stream, the server first streams any responses later than the\ngiven token, then a response containing only an up-to-date token, to use in\nthe next request.",
+ "type": "object",
+ "properties": {
+ "streamId": {
+ "description": "The ID of the write stream to resume.\nThis may only be set in the first message. When left empty, a new write\nstream will be created.",
+ "type": "string"
+ },
"streamToken": {
"format": "byte",
"description": "A stream token that was previously sent by the server.\n\nThe client should set this field to the token from the most recent\nWriteResponse it has received. This acknowledges that the client has\nreceived responses up to this token. After sending this token, earlier\ntokens may not be used anymore.\n\nThe server may close the stream if there are too many unacknowledged\nresponses.\n\nLeave this field unset when creating a new stream. To resume a stream at\na specific point, set this field and the `stream_id` field.\n\nLeave this field unset when creating a new stream.",
@@ -316,48 +1080,17 @@
},
"description": "Labels associated with this write request.",
"type": "object"
- },
- "streamId": {
- "description": "The ID of the write stream to resume.\nThis may only be set in the first message. When left empty, a new write\nstream will be created.",
- "type": "string"
}
},
- "id": "WriteRequest",
- "description": "The request for Firestore.Write.\n\nThe first request creates a stream, or resumes an existing one from a token.\n\nWhen creating a new stream, the server replies with a response containing\nonly an ID and a token, to use in the next request.\n\nWhen resuming a stream, the server first streams any responses later than the\ngiven token, then a response containing only an up-to-date token, to use in\nthe next request.",
- "type": "object"
- },
- "BatchGetDocumentsResponse": {
- "description": "The streamed response for Firestore.BatchGetDocuments.",
- "type": "object",
- "properties": {
- "transaction": {
- "format": "byte",
- "description": "The transaction that was started as part of this request.\nWill only be set in the first response, and only if\nBatchGetDocumentsRequest.new_transaction was set in the request.",
- "type": "string"
- },
- "readTime": {
- "format": "google-datetime",
- "description": "The time at which the document was read.\nThis may be monotically increasing, in this case the previous documents in\nthe result stream are guaranteed not to have changed between their\nread_time and this one.",
- "type": "string"
- },
- "missing": {
- "description": "A document name that was requested but does not exist. In the format:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.",
- "type": "string"
- },
- "found": {
- "$ref": "Document",
- "description": "A document that was requested."
- }
- },
- "id": "BatchGetDocumentsResponse"
+ "id": "WriteRequest"
},
"Target": {
"description": "A specification of a set of documents to listen to.",
"type": "object",
"properties": {
"query": {
- "$ref": "QueryTarget",
- "description": "A target specified by a query."
+ "description": "A target specified by a query.",
+ "$ref": "QueryTarget"
},
"resumeToken": {
"format": "byte",
@@ -411,6 +1144,8 @@
"id": "RunQueryRequest"
},
"Precondition": {
+ "description": "A precondition on a document, used for conditional operations.",
+ "type": "object",
"properties": {
"updateTime": {
"format": "google-datetime",
@@ -422,15 +1157,13 @@
"type": "boolean"
}
},
- "id": "Precondition",
- "description": "A precondition on a document, used for conditional operations.",
- "type": "object"
+ "id": "Precondition"
},
"Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
"properties": {},
- "id": "Empty"
+ "id": "Empty",
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object"
},
"ListIndexesResponse": {
"properties": {
@@ -451,29 +1184,29 @@
"type": "object"
},
"TransactionOptions": {
- "description": "Options for creating a new transaction.",
- "type": "object",
"properties": {
"readWrite": {
"description": "The transaction can be used for both read and write operations.",
"$ref": "ReadWrite"
},
"readOnly": {
- "description": "The transaction can only be used for read operations.",
- "$ref": "ReadOnly"
+ "$ref": "ReadOnly",
+ "description": "The transaction can only be used for read operations."
}
},
- "id": "TransactionOptions"
+ "id": "TransactionOptions",
+ "description": "Options for creating a new transaction.",
+ "type": "object"
},
"FieldReference": {
+ "description": "A reference to a field, such as `max(messages.time) as max_time`.",
+ "type": "object",
"properties": {
"fieldPath": {
"type": "string"
}
},
- "id": "FieldReference",
- "description": "A reference to a field, such as `max(messages.time) as max_time`.",
- "type": "object"
+ "id": "FieldReference"
},
"ListenResponse": {
"description": "The response for Firestore.Listen.",
@@ -484,54 +1217,44 @@
"$ref": "DocumentChange"
},
"documentRemove": {
- "description": "A Document has been removed from a target (because it is no longer\nrelevant to that target).",
- "$ref": "DocumentRemove"
+ "$ref": "DocumentRemove",
+ "description": "A Document has been removed from a target (because it is no longer\nrelevant to that target)."
},
"targetChange": {
- "$ref": "TargetChange",
- "description": "Targets have changed."
+ "description": "Targets have changed.",
+ "$ref": "TargetChange"
},
"documentDelete": {
"$ref": "DocumentDelete",
"description": "A Document has been deleted."
},
"filter": {
- "$ref": "ExistenceFilter",
- "description": "A filter to apply to the set of documents previously returned for the\ngiven target.\n\nReturned when documents may have been removed from the given target, but\nthe exact documents are unknown."
+ "description": "A filter to apply to the set of documents previously returned for the\ngiven target.\n\nReturned when documents may have been removed from the given target, but\nthe exact documents are unknown.",
+ "$ref": "ExistenceFilter"
}
},
"id": "ListenResponse"
},
"ExistenceFilter": {
"properties": {
- "targetId": {
- "format": "int32",
- "description": "The target ID to which this filter applies.",
- "type": "integer"
- },
"count": {
"format": "int32",
"description": "The total count of documents that match target_id.\n\nIf different from the count of documents in the client that match, the\nclient must manually determine which documents no longer match the target.",
"type": "integer"
+ },
+ "targetId": {
+ "format": "int32",
+ "description": "The target ID to which this filter applies.",
+ "type": "integer"
}
},
"id": "ExistenceFilter",
"description": "A digest of all the documents that match a given target.",
"type": "object"
},
- "ReadOnly": {
- "description": "Options for a transaction that can only be used to read documents.",
- "type": "object",
- "properties": {
- "readTime": {
- "format": "google-datetime",
- "description": "Reads documents at the given time.\nThis may not be older than 60 seconds.",
- "type": "string"
- }
- },
- "id": "ReadOnly"
- },
"WriteResult": {
+ "description": "The result of applying a write.",
+ "type": "object",
"properties": {
"updateTime": {
"format": "google-datetime",
@@ -546,15 +1269,27 @@
"type": "array"
}
},
- "id": "WriteResult",
- "description": "The result of applying a write.",
+ "id": "WriteResult"
+ },
+ "ReadOnly": {
+ "properties": {
+ "readTime": {
+ "format": "google-datetime",
+ "description": "Reads documents at the given time.\nThis may not be older than 60 seconds.",
+ "type": "string"
+ }
+ },
+ "id": "ReadOnly",
+ "description": "Options for a transaction that can only be used to read documents.",
"type": "object"
},
"IndexOperationMetadata": {
+ "description": "Metadata for index operations. This metadata populates\nthe metadata field of google.longrunning.Operation.",
+ "type": "object",
"properties": {
"documentProgress": {
- "description": "Progress of the existing operation, measured in number of documents.",
- "$ref": "Progress"
+ "$ref": "Progress",
+ "description": "Progress of the existing operation, measured in number of documents."
},
"cancelled": {
"description": "True if the [google.longrunning.Operation] was cancelled. If the\ncancellation is in progress, cancelled will be true but\ngoogle.longrunning.Operation.done will be false.",
@@ -570,16 +1305,16 @@
"type": "string"
},
"operationType": {
+ "enumDescriptions": [
+ "Unspecified. Never set by server.",
+ "The operation is creating the index. Initiated from a `CreateIndex` call."
+ ],
"enum": [
"OPERATION_TYPE_UNSPECIFIED",
"CREATING_INDEX"
],
"description": "The type of index operation.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified. Never set by server.",
- "The operation is creating the index. Initiated from a `CreateIndex` call."
- ]
+ "type": "string"
},
"startTime": {
"format": "google-datetime",
@@ -587,44 +1322,10 @@
"type": "string"
}
},
- "id": "IndexOperationMetadata",
- "description": "Metadata for index operations. This metadata populates\nthe metadata field of google.longrunning.Operation.",
- "type": "object"
+ "id": "IndexOperationMetadata"
},
"Value": {
- "description": "A message that can hold any of the supported value types.",
- "type": "object",
"properties": {
- "mapValue": {
- "$ref": "MapValue",
- "description": "A map value."
- },
- "bytesValue": {
- "format": "byte",
- "description": "A bytes value.\n\nMust not exceed 1 MiB - 89 bytes.\nOnly the first 1,500 bytes are considered by queries.",
- "type": "string"
- },
- "geoPointValue": {
- "description": "A geo point value representing a point on the surface of Earth.",
- "$ref": "LatLng"
- },
- "integerValue": {
- "format": "int64",
- "description": "An integer value.",
- "type": "string"
- },
- "arrayValue": {
- "description": "An array value.\n\nCannot contain another array value.",
- "$ref": "ArrayValue"
- },
- "referenceValue": {
- "description": "A reference to a document. For example:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.",
- "type": "string"
- },
- "stringValue": {
- "description": "A string value.\n\nThe string, represented as UTF-8, must not exceed 1 MiB - 89 bytes.\nOnly the first 1,500 bytes of the UTF-8 representation are considered by\nqueries.",
- "type": "string"
- },
"doubleValue": {
"format": "double",
"description": "A double value.",
@@ -636,44 +1337,64 @@
"type": "string"
},
"nullValue": {
- "enumDescriptions": [
- "Null value."
- ],
"enum": [
"NULL_VALUE"
],
"description": "A null value.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Null value."
+ ]
},
"booleanValue": {
"description": "A boolean value.",
"type": "boolean"
- }
- },
- "id": "Value"
- },
- "Cursor": {
- "description": "A position in a query result set.",
- "type": "object",
- "properties": {
- "before": {
- "description": "If the position is just before or just after the given values, relative\nto the sort order defined by the query.",
- "type": "boolean"
},
- "values": {
- "description": "The values that represent a position, in the order they appear in\nthe order by clause of a query.\n\nCan contain fewer values than specified in the order by clause.",
- "items": {
- "$ref": "Value"
- },
- "type": "array"
+ "mapValue": {
+ "$ref": "MapValue",
+ "description": "A map value."
+ },
+ "geoPointValue": {
+ "description": "A geo point value representing a point on the surface of Earth.",
+ "$ref": "LatLng"
+ },
+ "bytesValue": {
+ "format": "byte",
+ "description": "A bytes value.\n\nMust not exceed 1 MiB - 89 bytes.\nOnly the first 1,500 bytes are considered by queries.",
+ "type": "string"
+ },
+ "integerValue": {
+ "format": "int64",
+ "description": "An integer value.",
+ "type": "string"
+ },
+ "arrayValue": {
+ "$ref": "ArrayValue",
+ "description": "An array value.\n\nCannot contain another array value."
+ },
+ "referenceValue": {
+ "description": "A reference to a document. For example:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.",
+ "type": "string"
+ },
+ "stringValue": {
+ "description": "A string value.\n\nThe string, represented as UTF-8, must not exceed 1 MiB - 89 bytes.\nOnly the first 1,500 bytes of the UTF-8 representation are considered by\nqueries.",
+ "type": "string"
}
},
- "id": "Cursor"
+ "id": "Value",
+ "description": "A message that can hold any of the supported value types.",
+ "type": "object"
},
"Write": {
- "description": "A write on a document.",
- "type": "object",
"properties": {
+ "update": {
+ "$ref": "Document",
+ "description": "A document to write."
+ },
+ "transform": {
+ "description": "Applies a tranformation to a document.\nAt most one `transform` per document is allowed in a given request.\nAn `update` cannot follow a `transform` on the same document in a given\nrequest.",
+ "$ref": "DocumentTransform"
+ },
"delete": {
"description": "A document name to delete. In the format:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.",
"type": "string"
@@ -683,21 +1404,35 @@
"$ref": "Precondition"
},
"updateMask": {
- "description": "The fields to update in this write.\n\nThis field can be set only when the operation is `update`.\nNone of the field paths in the mask may contain a reserved name.\nIf the document exists on the server and has fields not referenced in the\nmask, they are left unchanged.\nFields referenced in the mask, but not present in the input document, are\ndeleted from the document on the server.\nThe field paths in this mask must not contain a reserved field name.",
- "$ref": "DocumentMask"
- },
- "update": {
- "$ref": "Document",
- "description": "A document to write."
- },
- "transform": {
- "$ref": "DocumentTransform",
- "description": "Applies a tranformation to a document.\nAt most one `transform` per document is allowed in a given request.\nAn `update` cannot follow a `transform` on the same document in a given\nrequest."
+ "$ref": "DocumentMask",
+ "description": "The fields to update in this write.\n\nThis field can be set only when the operation is `update`.\nNone of the field paths in the mask may contain a reserved name.\nIf the document exists on the server and has fields not referenced in the\nmask, they are left unchanged.\nFields referenced in the mask, but not present in the input document, are\ndeleted from the document on the server.\nThe field paths in this mask must not contain a reserved field name."
}
},
- "id": "Write"
+ "id": "Write",
+ "description": "A write on a document.",
+ "type": "object"
+ },
+ "Cursor": {
+ "description": "A position in a query result set.",
+ "type": "object",
+ "properties": {
+ "values": {
+ "description": "The values that represent a position, in the order they appear in\nthe order by clause of a query.\n\nCan contain fewer values than specified in the order by clause.",
+ "items": {
+ "$ref": "Value"
+ },
+ "type": "array"
+ },
+ "before": {
+ "description": "If the position is just before or just after the given values, relative\nto the sort order defined by the query.",
+ "type": "boolean"
+ }
+ },
+ "id": "Cursor"
},
"ReadWrite": {
+ "description": "Options for a transaction that can be used to read and write documents.",
+ "type": "object",
"properties": {
"retryTransaction": {
"format": "byte",
@@ -705,25 +1440,12 @@
"type": "string"
}
},
- "id": "ReadWrite",
- "description": "Options for a transaction that can be used to read and write documents.",
- "type": "object"
+ "id": "ReadWrite"
},
"BatchGetDocumentsRequest": {
+ "description": "The request for Firestore.BatchGetDocuments.",
+ "type": "object",
"properties": {
- "readTime": {
- "format": "google-datetime",
- "description": "Reads documents as they were at the given time.\nThis may not be older than 60 seconds.",
- "type": "string"
- },
- "newTransaction": {
- "description": "Starts a new transaction and reads the documents.\nDefaults to a read-only transaction.\nThe new transaction ID will be returned as the first response in the\nstream.",
- "$ref": "TransactionOptions"
- },
- "mask": {
- "description": "The fields to return. If not set, returns all fields.\n\nIf a document has a field that is not present in this mask, that field will\nnot be returned in the response.",
- "$ref": "DocumentMask"
- },
"transaction": {
"format": "byte",
"description": "Reads documents in a transaction.",
@@ -735,38 +1457,37 @@
"type": "string"
},
"type": "array"
+ },
+ "readTime": {
+ "format": "google-datetime",
+ "description": "Reads documents as they were at the given time.\nThis may not be older than 60 seconds.",
+ "type": "string"
+ },
+ "newTransaction": {
+ "$ref": "TransactionOptions",
+ "description": "Starts a new transaction and reads the documents.\nDefaults to a read-only transaction.\nThe new transaction ID will be returned as the first response in the\nstream."
+ },
+ "mask": {
+ "description": "The fields to return. If not set, returns all fields.\n\nIf a document has a field that is not present in this mask, that field will\nnot be returned in the response.",
+ "$ref": "DocumentMask"
}
},
- "id": "BatchGetDocumentsRequest",
- "description": "The request for Firestore.BatchGetDocuments.",
- "type": "object"
+ "id": "BatchGetDocumentsRequest"
},
- "DocumentChange": {
- "description": "A Document has changed.\n\nMay be the result of multiple writes, including deletes, that\nultimately resulted in a new value for the Document.\n\nMultiple DocumentChange messages may be returned for the same logical\nchange, if multiple targets are affected.",
- "type": "object",
+ "QueryTarget": {
"properties": {
- "removedTargetIds": {
- "description": "A set of target IDs for targets that no longer match this document.",
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
+ "parent": {
+ "description": "The parent resource name. In the format:\n`projects/{project_id}/databases/{database_id}/documents` or\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.\nFor example:\n`projects/my-project/databases/my-database/documents` or\n`projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`",
+ "type": "string"
},
- "document": {
- "$ref": "Document",
- "description": "The new state of the Document.\n\nIf `mask` is set, contains only fields that were updated or added."
- },
- "targetIds": {
- "description": "A set of target IDs of targets that match this document.",
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
+ "structuredQuery": {
+ "description": "A structured query.",
+ "$ref": "StructuredQuery"
}
},
- "id": "DocumentChange"
+ "id": "QueryTarget",
+ "description": "A target specified by a query.",
+ "type": "object"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
@@ -803,23 +1524,39 @@
},
"id": "Operation"
},
- "QueryTarget": {
- "description": "A target specified by a query.",
+ "DocumentChange": {
+ "description": "A Document has changed.\n\nMay be the result of multiple writes, including deletes, that\nultimately resulted in a new value for the Document.\n\nMultiple DocumentChange messages may be returned for the same logical\nchange, if multiple targets are affected.",
"type": "object",
"properties": {
- "parent": {
- "description": "The parent resource name. In the format:\n`projects/{project_id}/databases/{database_id}/documents` or\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.\nFor example:\n`projects/my-project/databases/my-database/documents` or\n`projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`",
- "type": "string"
+ "removedTargetIds": {
+ "description": "A set of target IDs for targets that no longer match this document.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
},
- "structuredQuery": {
- "description": "A structured query.",
- "$ref": "StructuredQuery"
+ "document": {
+ "$ref": "Document",
+ "description": "The new state of the Document.\n\nIf `mask` is set, contains only fields that were updated or added."
+ },
+ "targetIds": {
+ "description": "A set of target IDs of targets that match this document.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
}
},
- "id": "QueryTarget"
+ "id": "DocumentChange"
},
"Status": {
"properties": {
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
@@ -835,10 +1572,6 @@
"format": "int32",
"description": "The status code, which should be an enum value of google.rpc.Code.",
"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",
@@ -932,23 +1665,21 @@
"description": "The response for Firestore.ListDocuments.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "The next page token.",
+ "type": "string"
+ },
"documents": {
"description": "The Documents found.",
"items": {
"$ref": "Document"
},
"type": "array"
- },
- "nextPageToken": {
- "description": "The next page token.",
- "type": "string"
}
},
"id": "ListDocumentsResponse"
},
"RollbackRequest": {
- "description": "The request for Firestore.Rollback.",
- "type": "object",
"properties": {
"transaction": {
"format": "byte",
@@ -956,7 +1687,9 @@
"type": "string"
}
},
- "id": "RollbackRequest"
+ "id": "RollbackRequest",
+ "description": "The request for Firestore.Rollback.",
+ "type": "object"
},
"CompositeFilter": {
"description": "A filter that merges multiple other filters using the given operator.",
@@ -985,6 +1718,8 @@
"id": "CompositeFilter"
},
"DocumentsTarget": {
+ "description": "A target specified by a set of documents names.",
+ "type": "object",
"properties": {
"documents": {
"description": "The names of the documents to retrieve. In the format:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.\nThe request will fail if any of the document is not a child resource of\nthe given `database`. Duplicate names will be elided.",
@@ -994,11 +1729,11 @@
"type": "array"
}
},
- "id": "DocumentsTarget",
- "description": "A target specified by a set of documents names.",
- "type": "object"
+ "id": "DocumentsTarget"
},
"DocumentMask": {
+ "description": "A set of field paths on a document.\nUsed to restrict a get or update operation on a document to a subset of its\nfields.\nThis is different from standard field masks, as this is always scoped to a\nDocument, and takes in account the dynamic nature of Value.",
+ "type": "object",
"properties": {
"fieldPaths": {
"description": "The list of field paths in the mask. See Document.fields for a field\npath syntax reference.",
@@ -1008,9 +1743,7 @@
"type": "array"
}
},
- "id": "DocumentMask",
- "description": "A set of field paths on a document.\nUsed to restrict a get or update operation on a document to a subset of its\nfields.\nThis is different from standard field masks, as this is always scoped to a\nDocument, and takes in account the dynamic nature of Value.",
- "type": "object"
+ "id": "DocumentMask"
},
"DocumentTransform": {
"description": "A transformation of a document.",
@@ -1031,6 +1764,8 @@
"id": "DocumentTransform"
},
"FieldTransform": {
+ "description": "A transformation of a field of the document.",
+ "type": "object",
"properties": {
"fieldPath": {
"description": "The path of the field. See Document.fields for the field path syntax\nreference.",
@@ -1049,13 +1784,9 @@
]
}
},
- "id": "FieldTransform",
- "description": "A transformation of a field of the document.",
- "type": "object"
+ "id": "FieldTransform"
},
"ListCollectionIdsResponse": {
- "description": "The response from Firestore.ListCollectionIds.",
- "type": "object",
"properties": {
"nextPageToken": {
"description": "A page token that may be used to continue the list.",
@@ -1069,7 +1800,9 @@
"type": "array"
}
},
- "id": "ListCollectionIdsResponse"
+ "id": "ListCollectionIdsResponse",
+ "description": "The response from Firestore.ListCollectionIds.",
+ "type": "object"
},
"CommitResponse": {
"properties": {
@@ -1090,44 +1823,8 @@
"description": "The response for Firestore.Commit.",
"type": "object"
},
- "Order": {
- "properties": {
- "field": {
- "$ref": "FieldReference",
- "description": "The field to order by."
- },
- "direction": {
- "enum": [
- "DIRECTION_UNSPECIFIED",
- "ASCENDING",
- "DESCENDING"
- ],
- "description": "The direction to order by. Defaults to `ASCENDING`.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified.",
- "Ascending.",
- "Descending."
- ]
- }
- },
- "id": "Order",
- "description": "An order on a field.",
- "type": "object"
- },
"WriteResponse": {
- "description": "The response for Firestore.Write.",
- "type": "object",
"properties": {
- "commitTime": {
- "format": "google-datetime",
- "description": "The time at which the commit occurred.",
- "type": "string"
- },
- "streamId": {
- "description": "The ID of the stream.\nOnly set on the first message, when a new stream was created.",
- "type": "string"
- },
"streamToken": {
"format": "byte",
"description": "A token that represents the position of this response in the stream.\nThis can be used by a client to resume the stream at this point.\n\nThis field is always set.",
@@ -1139,15 +1836,51 @@
"$ref": "WriteResult"
},
"type": "array"
+ },
+ "commitTime": {
+ "format": "google-datetime",
+ "description": "The time at which the commit occurred.",
+ "type": "string"
+ },
+ "streamId": {
+ "description": "The ID of the stream.\nOnly set on the first message, when a new stream was created.",
+ "type": "string"
}
},
- "id": "WriteResponse"
+ "id": "WriteResponse",
+ "description": "The response for Firestore.Write.",
+ "type": "object"
+ },
+ "Order": {
+ "properties": {
+ "field": {
+ "$ref": "FieldReference",
+ "description": "The field to order by."
+ },
+ "direction": {
+ "enumDescriptions": [
+ "Unspecified.",
+ "Ascending.",
+ "Descending."
+ ],
+ "enum": [
+ "DIRECTION_UNSPECIFIED",
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "description": "The direction to order by. Defaults to `ASCENDING`.",
+ "type": "string"
+ }
+ },
+ "id": "Order",
+ "description": "An order on a field.",
+ "type": "object"
},
"FieldFilter": {
"properties": {
"value": {
- "description": "The value to compare to.",
- "$ref": "Value"
+ "$ref": "Value",
+ "description": "The value to compare to."
},
"op": {
"enumDescriptions": [
@@ -1170,8 +1903,8 @@
"type": "string"
},
"field": {
- "description": "The field to filter by.",
- "$ref": "FieldReference"
+ "$ref": "FieldReference",
+ "description": "The field to filter by."
}
},
"id": "FieldFilter",
@@ -1179,8 +1912,6 @@
"type": "object"
},
"TargetChange": {
- "description": "Targets being watched have changed.",
- "type": "object",
"properties": {
"readTime": {
"format": "google-datetime",
@@ -1188,8 +1919,8 @@
"type": "string"
},
"cause": {
- "description": "The error that resulted in this change, if applicable.",
- "$ref": "Status"
+ "$ref": "Status",
+ "description": "The error that resulted in this change, if applicable."
},
"targetChangeType": {
"enumDescriptions": [
@@ -1223,7 +1954,9 @@
"type": "array"
}
},
- "id": "TargetChange"
+ "id": "TargetChange",
+ "description": "Targets being watched have changed.",
+ "type": "object"
},
"MapValue": {
"description": "A map value.",
@@ -1262,756 +1995,23 @@
"id": "DocumentDelete",
"description": "A Document has been deleted.\n\nMay be the result of multiple writes, including updates, the\nlast of which deleted the Document.\n\nMultiple DocumentDelete messages may be returned for the same logical\ndelete, if multiple targets are affected.",
"type": "object"
+ },
+ "BeginTransactionResponse": {
+ "description": "The response for Firestore.BeginTransaction.",
+ "type": "object",
+ "properties": {
+ "transaction": {
+ "format": "byte",
+ "description": "The transaction that was started.",
+ "type": "string"
+ }
+ },
+ "id": "BeginTransactionResponse"
}
},
- "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": "Firestore",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/datastore": {
- "description": "View and manage your Google Cloud Datastore data"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "rootUrl": "https://firestore.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "firestore",
- "batchPath": "batch",
- "title": "Google Cloud Firestore API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "databases": {
- "resources": {
- "documents": {
- "methods": {
- "write": {
- "request": {
- "$ref": "WriteRequest"
- },
- "description": "Streams batches of document updates and deletes, in order.",
- "response": {
- "$ref": "WriteResponse"
- },
- "parameterOrder": [
- "database"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "parameters": {
- "database": {
- "pattern": "^projects/[^/]+/databases/[^/]+$",
- "location": "path",
- "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.\nThis is only required in the first message.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:write",
- "id": "firestore.projects.databases.documents.write",
- "path": "v1beta1/{+database}/documents:write"
- },
- "batchGet": {
- "id": "firestore.projects.databases.documents.batchGet",
- "path": "v1beta1/{+database}/documents:batchGet",
- "description": "Gets multiple documents.\n\nDocuments returned by this method are not guaranteed to be returned in the\nsame order that they were requested.",
- "request": {
- "$ref": "BatchGetDocumentsRequest"
- },
- "response": {
- "$ref": "BatchGetDocumentsResponse"
- },
- "parameterOrder": [
- "database"
- ],
- "httpMethod": "POST",
- "parameters": {
- "database": {
- "pattern": "^projects/[^/]+/databases/[^/]+$",
- "location": "path",
- "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:batchGet"
- },
- "beginTransaction": {
- "response": {
- "$ref": "BeginTransactionResponse"
- },
- "parameterOrder": [
- "database"
- ],
- "httpMethod": "POST",
- "parameters": {
- "database": {
- "pattern": "^projects/[^/]+/databases/[^/]+$",
- "location": "path",
- "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:beginTransaction",
- "id": "firestore.projects.databases.documents.beginTransaction",
- "path": "v1beta1/{+database}/documents:beginTransaction",
- "description": "Starts a new transaction.",
- "request": {
- "$ref": "BeginTransactionRequest"
- }
- },
- "list": {
- "response": {
- "$ref": "ListDocumentsResponse"
- },
- "parameterOrder": [
- "parent",
- "collectionId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "description": "The `next_page_token` value returned from a previous List request, if any.",
- "type": "string",
- "location": "query"
- },
- "mask.fieldPaths": {
- "repeated": true,
- "location": "query",
- "description": "The list of field paths in the mask. See Document.fields for a field\npath syntax reference.",
- "type": "string"
- },
- "pageSize": {
- "format": "int32",
- "description": "The maximum number of documents to return.",
- "type": "integer",
- "location": "query"
- },
- "collectionId": {
- "location": "path",
- "description": "The collection ID, relative to `parent`, to list. For example: `chatrooms`\nor `messages`.",
- "type": "string",
- "required": true
- },
- "transaction": {
- "location": "query",
- "format": "byte",
- "description": "Reads documents in a transaction.",
- "type": "string"
- },
- "parent": {
- "description": "The parent resource name. In the format:\n`projects/{project_id}/databases/{database_id}/documents` or\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.\nFor example:\n`projects/my-project/databases/my-database/documents` or\n`projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$",
- "location": "path"
- },
- "orderBy": {
- "location": "query",
- "description": "The order to sort results by. For example: `priority desc, name`.",
- "type": "string"
- },
- "readTime": {
- "location": "query",
- "format": "google-datetime",
- "description": "Reads documents as they were at the given time.\nThis may not be older than 60 seconds.",
- "type": "string"
- },
- "showMissing": {
- "location": "query",
- "description": "If the list should show missing documents. A missing document is a\ndocument that does not exist but has sub-documents. These documents will\nbe returned with a key but will not have fields, Document.create_time,\nor Document.update_time set.\n\nRequests with `show_missing` may not specify `where` or\n`order_by`.",
- "type": "boolean"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}/{collectionId}",
- "id": "firestore.projects.databases.documents.list",
- "path": "v1beta1/{+parent}/{collectionId}",
- "description": "Lists documents."
- },
- "runQuery": {
- "request": {
- "$ref": "RunQueryRequest"
- },
- "description": "Runs a query.",
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "RunQueryResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "parameters": {
- "parent": {
- "description": "The parent resource name. In the format:\n`projects/{project_id}/databases/{database_id}/documents` or\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.\nFor example:\n`projects/my-project/databases/my-database/documents` or\n`projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}:runQuery",
- "path": "v1beta1/{+parent}:runQuery",
- "id": "firestore.projects.databases.documents.runQuery"
- },
- "createDocument": {
- "request": {
- "$ref": "Document"
- },
- "description": "Creates a new document.",
- "response": {
- "$ref": "Document"
- },
- "parameterOrder": [
- "parent",
- "collectionId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "parameters": {
- "documentId": {
- "location": "query",
- "description": "The client-assigned document ID to use for this document.\n\nOptional. If not specified, an ID will be assigned by the service.",
- "type": "string"
- },
- "parent": {
- "description": "The parent resource. For example:\n`projects/{project_id}/databases/{database_id}/documents` or\n`projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/databases/[^/]+/documents/.+$",
- "location": "path"
- },
- "mask.fieldPaths": {
- "repeated": true,
- "location": "query",
- "description": "The list of field paths in the mask. See Document.fields for a field\npath syntax reference.",
- "type": "string"
- },
- "collectionId": {
- "description": "The collection ID, relative to `parent`, to list. For example: `chatrooms`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{collectionId}",
- "id": "firestore.projects.databases.documents.createDocument",
- "path": "v1beta1/{+parent}/{collectionId}"
- },
- "listen": {
- "response": {
- "$ref": "ListenResponse"
- },
- "parameterOrder": [
- "database"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "parameters": {
- "database": {
- "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/databases/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:listen",
- "id": "firestore.projects.databases.documents.listen",
- "path": "v1beta1/{+database}/documents:listen",
- "request": {
- "$ref": "ListenRequest"
- },
- "description": "Listens to changes."
- },
- "patch": {
- "request": {
- "$ref": "Document"
- },
- "description": "Updates or inserts a document.",
- "response": {
- "$ref": "Document"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "parameters": {
- "currentDocument.exists": {
- "location": "query",
- "description": "When set to `true`, the target document must exist.\nWhen set to `false`, the target document must not exist.",
- "type": "boolean"
- },
- "mask.fieldPaths": {
- "description": "The list of field paths in the mask. See Document.fields for a field\npath syntax reference.",
- "type": "string",
- "repeated": true,
- "location": "query"
- },
- "updateMask.fieldPaths": {
- "description": "The list of field paths in the mask. See Document.fields for a field\npath syntax reference.",
- "type": "string",
- "repeated": true,
- "location": "query"
- },
- "name": {
- "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$",
- "location": "path",
- "description": "The resource name of the document, for example\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.",
- "type": "string",
- "required": true
- },
- "currentDocument.updateTime": {
- "location": "query",
- "format": "google-datetime",
- "description": "When set, the target document must exist and have been last updated at\nthat time.",
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}",
- "id": "firestore.projects.databases.documents.patch",
- "path": "v1beta1/{+name}"
- },
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Document"
- },
- "parameters": {
- "readTime": {
- "location": "query",
- "format": "google-datetime",
- "description": "Reads the version of the document at the given time.\nThis may not be older than 60 seconds.",
- "type": "string"
- },
- "mask.fieldPaths": {
- "repeated": true,
- "location": "query",
- "description": "The list of field paths in the mask. See Document.fields for a field\npath syntax reference.",
- "type": "string"
- },
- "name": {
- "description": "The resource name of the Document to get. In the format:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$",
- "location": "path"
- },
- "transaction": {
- "location": "query",
- "format": "byte",
- "description": "Reads the document in a transaction.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}",
- "path": "v1beta1/{+name}",
- "id": "firestore.projects.databases.documents.get",
- "description": "Gets a single document."
- },
- "delete": {
- "id": "firestore.projects.databases.documents.delete",
- "path": "v1beta1/{+name}",
- "description": "Deletes a document.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "description": "The resource name of the Document to delete. In the format:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$",
- "location": "path"
- },
- "currentDocument.updateTime": {
- "format": "google-datetime",
- "description": "When set, the target document must exist and have been last updated at\nthat time.",
- "type": "string",
- "location": "query"
- },
- "currentDocument.exists": {
- "description": "When set to `true`, the target document must exist.\nWhen set to `false`, the target document must not exist.",
- "type": "boolean",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}"
- },
- "commit": {
- "id": "firestore.projects.databases.documents.commit",
- "path": "v1beta1/{+database}/documents:commit",
- "request": {
- "$ref": "CommitRequest"
- },
- "description": "Commits a transaction, while optionally updating documents.",
- "response": {
- "$ref": "CommitResponse"
- },
- "parameterOrder": [
- "database"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "parameters": {
- "database": {
- "pattern": "^projects/[^/]+/databases/[^/]+$",
- "location": "path",
- "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:commit"
- },
- "listCollectionIds": {
- "path": "v1beta1/{+parent}:listCollectionIds",
- "id": "firestore.projects.databases.documents.listCollectionIds",
- "description": "Lists all the collection IDs underneath a document.",
- "httpMethod": "POST",
- "response": {
- "$ref": "ListCollectionIdsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "parameters": {
- "parent": {
- "description": "The parent document. In the format:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.\nFor example:\n`projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$",
- "location": "path"
- },
- "pageToken": {
- "description": "A page token. Must be a value from\nListCollectionIdsResponse.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The maximum number of results to return.",
- "type": "integer"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}:listCollectionIds"
- },
- "rollback": {
- "description": "Rolls back a transaction.",
- "request": {
- "$ref": "RollbackRequest"
- },
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "database"
- ],
- "httpMethod": "POST",
- "parameters": {
- "database": {
- "pattern": "^projects/[^/]+/databases/[^/]+$",
- "location": "path",
- "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:rollback",
- "id": "firestore.projects.databases.documents.rollback",
- "path": "v1beta1/{+database}/documents:rollback"
- }
- }
- },
- "indexes": {
- "methods": {
- "create": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+/databases/[^/]+$",
- "location": "path",
- "description": "The name of the database this index will apply to. For example:\n`projects/{project_id}/databases/{database_id}`",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/indexes",
- "id": "firestore.projects.databases.indexes.create",
- "path": "v1beta1/{+parent}/indexes",
- "request": {
- "$ref": "Index"
- },
- "description": "Creates the specified index.\nA newly created index's initial state is `CREATING`. On completion of the\nreturned google.longrunning.Operation, the state will be `READY`.\nIf the index already exists, the call will return an `ALREADY_EXISTS`\nstatus.\n\nDuring creation, the process could result in an error, in which case the\nindex will move to the `ERROR` state. The process can be recovered by\nfixing the data that caused the error, removing the index with\ndelete, then re-creating the index with\ncreate.\n\nIndexes with a single field cannot be created."
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "description": "The index name. For example:\n`projects/{project_id}/databases/{database_id}/indexes/{index_id}`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/databases/[^/]+/indexes/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/indexes/{indexesId}",
- "id": "firestore.projects.databases.indexes.delete",
- "path": "v1beta1/{+name}",
- "description": "Deletes an index."
- },
- "get": {
- "response": {
- "$ref": "Index"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/databases/[^/]+/indexes/[^/]+$",
- "location": "path",
- "description": "The name of the index. For example:\n`projects/{project_id}/databases/{database_id}/indexes/{index_id}`",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/indexes/{indexesId}",
- "id": "firestore.projects.databases.indexes.get",
- "path": "v1beta1/{+name}",
- "description": "Gets an index."
- },
- "list": {
- "description": "Lists the indexes that match the specified filters.",
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "ListIndexesResponse"
- },
- "parameters": {
- "pageToken": {
- "description": "The standard List page token.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The standard List page size.",
- "type": "integer"
- },
- "parent": {
- "description": "The database name. For example:\n`projects/{project_id}/databases/{database_id}`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/databases/[^/]+$",
- "location": "path"
- },
- "filter": {
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/indexes",
- "path": "v1beta1/{+parent}/indexes",
- "id": "firestore.projects.databases.indexes.list"
- }
- }
- }
- }
- }
- }
- }
- },
- "parameters": {
- "alt": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- }
- },
- "version": "v1beta1",
- "baseUrl": "https://firestore.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "",
- "servicePath": "",
- "basePath": ""
+ "protocol": "rest"
}
diff --git a/genomics/v1/genomics-api.json b/genomics/v1/genomics-api.json
index 149a7f1..6cc50d4 100644
--- a/genomics/v1/genomics-api.json
+++ b/genomics/v1/genomics-api.json
@@ -1,25 +1,396 @@
{
- "revision": "20171010",
- "documentationLink": "https://cloud.google.com/genomics",
+ "batchPath": "batch",
"id": "genomics:v1",
+ "documentationLink": "https://cloud.google.com/genomics",
+ "revision": "20171011",
"title": "Genomics API",
"ownerName": "Google",
"discoveryVersion": "v1",
"resources": {
- "datasets": {
+ "annotations": {
"methods": {
- "testIamPermissions": {
- "id": "genomics.datasets.testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
+ "create": {
+ "flatPath": "v1/annotations",
+ "path": "v1/annotations",
+ "id": "genomics.annotations.create",
"request": {
- "$ref": "TestIamPermissionsRequest"
+ "$ref": "Annotation"
},
- "description": "Returns permissions that a caller has on the specified resource.\nSee \u003ca href=\"/iam/docs/managing-policies#testing_permissions\"\u003eTesting\nPermissions\u003c/a\u003e for more information.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "description": "Creates a new annotation. Caller must have WRITE permission\nfor the associated annotation set.\n\nThe following fields are required:\n\n* annotationSetId\n* referenceName or\n referenceId\n\n### Transcripts\n\nFor annotations of type TRANSCRIPT, the following fields of\ntranscript must be provided:\n\n* exons.start\n* exons.end\n\nAll other fields may be optionally specified, unless documented as being\nserver-generated (for example, the `id` field). The annotated\nrange must be no longer than 100Mbp (mega base pairs). See the\nAnnotation resource\nfor additional restrictions on each field.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
"response": {
- "$ref": "TestIamPermissionsResponse"
+ "$ref": "Annotation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {}
+ },
+ "batchCreate": {
+ "request": {
+ "$ref": "BatchCreateAnnotationsRequest"
+ },
+ "description": "Creates one or more new annotations atomically. All annotations must\nbelong to the same annotation set. Caller must have WRITE\npermission for this annotation set. For optimal performance, batch\npositionally adjacent annotations together.\n\nIf the request has a systemic issue, such as an attempt to write to\nan inaccessible annotation set, the entire RPC will fail accordingly. For\nlesser data issues, when possible an error will be isolated to the\ncorresponding batch entry in the response; the remaining well formed\nannotations will be created normally.\n\nFor details on the requirements for each individual annotation resource,\nsee\nCreateAnnotation.",
+ "response": {
+ "$ref": "BatchCreateAnnotationsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {},
+ "flatPath": "v1/annotations:batchCreate",
+ "id": "genomics.annotations.batchCreate",
+ "path": "v1/annotations:batchCreate"
+ },
+ "search": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "SearchAnnotationsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {},
+ "flatPath": "v1/annotations/search",
+ "path": "v1/annotations/search",
+ "id": "genomics.annotations.search",
+ "request": {
+ "$ref": "SearchAnnotationsRequest"
+ },
+ "description": "Searches for annotations that match the given criteria. Results are\nordered by genomic coordinate (by reference sequence, then position).\nAnnotations with equivalent genomic coordinates are returned in an\nunspecified order. This order is consistent, such that two queries for the\nsame content (regardless of page size) yield annotations in the same order\nacross their respective streams of paginated responses. Caller must have\nREAD permission for the queried annotation sets."
+ },
+ "get": {
+ "response": {
+ "$ref": "Annotation"
},
"parameterOrder": [
- "resource"
+ "annotationId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "annotationId": {
+ "description": "The ID of the annotation to be retrieved.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/annotations/{annotationId}",
+ "id": "genomics.annotations.get",
+ "path": "v1/annotations/{annotationId}",
+ "description": "Gets an annotation. Caller must have READ permission\nfor the associated annotation set."
+ },
+ "update": {
+ "request": {
+ "$ref": "Annotation"
+ },
+ "description": "Updates an annotation. Caller must have\nWRITE permission for the associated dataset.",
+ "response": {
+ "$ref": "Annotation"
+ },
+ "parameterOrder": [
+ "annotationId"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "updateMask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "An optional mask specifying which fields to update. Mutable fields are\nname,\nvariant,\ntranscript, and\ninfo. If unspecified, all mutable\nfields will be updated.",
+ "type": "string"
+ },
+ "annotationId": {
+ "location": "path",
+ "description": "The ID of the annotation to be updated.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/annotations/{annotationId}",
+ "id": "genomics.annotations.update",
+ "path": "v1/annotations/{annotationId}"
+ },
+ "delete": {
+ "description": "Deletes an annotation. Caller must have WRITE permission for\nthe associated annotation set.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "annotationId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "annotationId": {
+ "description": "The ID of the annotation to be deleted.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/annotations/{annotationId}",
+ "id": "genomics.annotations.delete",
+ "path": "v1/annotations/{annotationId}"
+ }
+ }
+ },
+ "variantsets": {
+ "methods": {
+ "search": {
+ "description": "Returns a list of all variant sets matching search criteria.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchVariantSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L49).",
+ "request": {
+ "$ref": "SearchVariantSetsRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "SearchVariantSetsResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/variantsets/search",
+ "path": "v1/variantsets/search",
+ "id": "genomics.variantsets.search"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "variantSetId"
+ ],
+ "response": {
+ "$ref": "VariantSet"
+ },
+ "parameters": {
+ "variantSetId": {
+ "location": "path",
+ "description": "Required. The ID of the variant set.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/variantsets/{variantSetId}",
+ "path": "v1/variantsets/{variantSetId}",
+ "id": "genomics.variantsets.get",
+ "description": "Gets a variant set by ID.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
+ },
+ "patch": {
+ "request": {
+ "$ref": "VariantSet"
+ },
+ "description": "Updates a variant set using patch semantics.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "variantSetId"
+ ],
+ "response": {
+ "$ref": "VariantSet"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "updateMask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "An optional mask specifying which fields to update. Supported fields:\n\n* metadata.\n* name.\n* description.\n\nLeaving `updateMask` unset is equivalent to specifying all mutable\nfields.",
+ "type": "string"
+ },
+ "variantSetId": {
+ "description": "The ID of the variant to be updated (must already exist).",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/variantsets/{variantSetId}",
+ "path": "v1/variantsets/{variantSetId}",
+ "id": "genomics.variantsets.patch"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "variantSetId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "variantSetId": {
+ "location": "path",
+ "description": "The ID of the variant set to be deleted.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/variantsets/{variantSetId}",
+ "id": "genomics.variantsets.delete",
+ "path": "v1/variantsets/{variantSetId}",
+ "description": "Deletes a variant set including all variants, call sets, and calls within.\nThis is not reversible.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
+ },
+ "create": {
+ "response": {
+ "$ref": "VariantSet"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/variantsets",
+ "id": "genomics.variantsets.create",
+ "path": "v1/variantsets",
+ "description": "Creates a new variant set.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThe provided variant set must have a valid `datasetId` set - all other\nfields are optional. Note that the `id` field will be ignored, as this is\nassigned by the server.",
+ "request": {
+ "$ref": "VariantSet"
+ }
+ },
+ "export": {
+ "request": {
+ "$ref": "ExportVariantSetRequest"
+ },
+ "description": "Exports variant set data to an external destination.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "variantSetId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "variantSetId": {
+ "description": "Required. The ID of the variant set that contains variant data which\nshould be exported. The caller must have READ access to this variant set.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/variantsets/{variantSetId}:export",
+ "id": "genomics.variantsets.export",
+ "path": "v1/variantsets/{variantSetId}:export"
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "get": {
+ "flatPath": "v1/operations/{operationsId}",
+ "path": "v1/{+name}",
+ "id": "genomics.operations.get",
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource.",
+ "type": "string",
+ "required": true,
+ "pattern": "^operations/.+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ]
+ },
+ "list": {
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "The maximum number of results to return. If unspecified, defaults to\n256. The maximum value is 2048.",
+ "type": "integer"
+ },
+ "filter": {
+ "location": "query",
+ "description": "A string for filtering Operations.\nThe following filter fields are supported:\n\n* projectId: Required. Corresponds to\n OperationMetadata.projectId.\n* createTime: The time this job was created, in seconds from the\n [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `\u003e=` and/or `\u003c=`\n operators.\n* status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only\n one status may be specified.\n* labels.key where key is a label key.\n\nExamples:\n\n* `projectId = my-project AND createTime \u003e= 1432140000`\n* `projectId = my-project AND createTime \u003e= 1432140000 AND createTime \u003c= 1432150000 AND status = RUNNING`\n* `projectId = my-project AND labels.color = *`\n* `projectId = my-project AND labels.color = red`",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "location": "path",
+ "description": "The name of the operation's parent resource.",
+ "type": "string",
+ "required": true,
+ "pattern": "^operations$"
+ }
+ },
+ "flatPath": "v1/operations",
+ "id": "genomics.operations.list",
+ "path": "v1/{+name}",
+ "description": "Lists operations that match the specified filter in the request."
+ },
+ "cancel": {
+ "request": {
+ "$ref": "CancelOperationRequest"
+ },
+ "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
],
"httpMethod": "POST",
"scopes": [
@@ -27,15 +398,964 @@
"https://www.googleapis.com/auth/genomics"
],
"parameters": {
+ "name": {
+ "description": "The name of the operation resource to be cancelled.",
+ "type": "string",
+ "required": true,
+ "pattern": "^operations/.+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/operations/{operationsId}:cancel",
+ "id": "genomics.operations.cancel",
+ "path": "v1/{+name}:cancel"
+ }
+ }
+ },
+ "referencesets": {
+ "methods": {
+ "search": {
+ "flatPath": "v1/referencesets/search",
+ "path": "v1/referencesets/search",
+ "id": "genomics.referencesets.search",
+ "request": {
+ "$ref": "SearchReferenceSetsRequest"
+ },
+ "description": "Searches for reference sets which match the given criteria.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchReferenceSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L71)",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "SearchReferenceSetsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {}
+ },
+ "get": {
+ "description": "Gets a reference set.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.getReferenceSet](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L83).",
+ "response": {
+ "$ref": "ReferenceSet"
+ },
+ "parameterOrder": [
+ "referenceSetId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {
+ "referenceSetId": {
+ "description": "The ID of the reference set.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/referencesets/{referenceSetId}",
+ "id": "genomics.referencesets.get",
+ "path": "v1/referencesets/{referenceSetId}"
+ }
+ }
+ },
+ "callsets": {
+ "methods": {
+ "search": {
+ "response": {
+ "$ref": "SearchCallSetsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/callsets/search",
+ "id": "genomics.callsets.search",
+ "path": "v1/callsets/search",
+ "description": "Gets a list of call sets matching the criteria.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchCallSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L178).",
+ "request": {
+ "$ref": "SearchCallSetsRequest"
+ }
+ },
+ "get": {
+ "description": "Gets a call set by ID.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "callSetId"
+ ],
+ "response": {
+ "$ref": "CallSet"
+ },
+ "parameters": {
+ "callSetId": {
+ "description": "The ID of the call set.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/callsets/{callSetId}",
+ "path": "v1/callsets/{callSetId}",
+ "id": "genomics.callsets.get"
+ },
+ "patch": {
+ "flatPath": "v1/callsets/{callSetId}",
+ "id": "genomics.callsets.patch",
+ "path": "v1/callsets/{callSetId}",
+ "description": "Updates a call set.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics.",
+ "request": {
+ "$ref": "CallSet"
+ },
+ "response": {
+ "$ref": "CallSet"
+ },
+ "parameterOrder": [
+ "callSetId"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "updateMask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "An optional mask specifying which fields to update. At this time, the only\nmutable field is name. The only\nacceptable value is \"name\". If unspecified, all mutable fields will be\nupdated.",
+ "type": "string"
+ },
+ "callSetId": {
+ "location": "path",
+ "description": "The ID of the call set to be updated.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ]
+ },
+ "create": {
+ "response": {
+ "$ref": "CallSet"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {},
+ "flatPath": "v1/callsets",
+ "id": "genomics.callsets.create",
+ "path": "v1/callsets",
+ "request": {
+ "$ref": "CallSet"
+ },
+ "description": "Creates a new call set.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
+ },
+ "delete": {
+ "flatPath": "v1/callsets/{callSetId}",
+ "path": "v1/callsets/{callSetId}",
+ "id": "genomics.callsets.delete",
+ "description": "Deletes a call set.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "callSetId"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "callSetId": {
+ "location": "path",
+ "description": "The ID of the call set to be deleted.",
+ "type": "string",
+ "required": true
+ }
+ }
+ }
+ }
+ },
+ "reads": {
+ "methods": {
+ "search": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "SearchReadsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {},
+ "flatPath": "v1/reads/search",
+ "path": "v1/reads/search",
+ "id": "genomics.reads.search",
+ "request": {
+ "$ref": "SearchReadsRequest"
+ },
+ "description": "Gets a list of reads for one or more read group sets.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nReads search operates over a genomic coordinate space of reference sequence\n& position defined over the reference sequences to which the requested\nread group sets are aligned.\n\nIf a target positional range is specified, search returns all reads whose\nalignment to the reference genome overlap the range. A query which\nspecifies only read group set IDs yields all reads in those read group\nsets, including unmapped reads.\n\nAll reads returned (including reads on subsequent pages) are ordered by\ngenomic coordinate (by reference sequence, then position). Reads with\nequivalent genomic coordinates are returned in an unspecified order. This\norder is consistent, such that two queries for the same content (regardless\nof page size) yield reads in the same order across their respective streams\nof paginated responses.\n\nImplements\n[GlobalAllianceApi.searchReads](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/readmethods.avdl#L85)."
+ }
+ }
+ },
+ "readgroupsets": {
+ "methods": {
+ "search": {
+ "response": {
+ "$ref": "SearchReadGroupSetsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/readgroupsets/search",
+ "id": "genomics.readgroupsets.search",
+ "path": "v1/readgroupsets/search",
+ "description": "Searches for read group sets matching the criteria.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchReadGroupSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/readmethods.avdl#L135).",
+ "request": {
+ "$ref": "SearchReadGroupSetsRequest"
+ }
+ },
+ "get": {
+ "description": "Gets a read group set by ID.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "response": {
+ "$ref": "ReadGroupSet"
+ },
+ "parameterOrder": [
+ "readGroupSetId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "readGroupSetId": {
+ "description": "The ID of the read group set.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/readgroupsets/{readGroupSetId}",
+ "id": "genomics.readgroupsets.get",
+ "path": "v1/readgroupsets/{readGroupSetId}"
+ },
+ "patch": {
+ "request": {
+ "$ref": "ReadGroupSet"
+ },
+ "description": "Updates a read group set.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "readGroupSetId"
+ ],
+ "response": {
+ "$ref": "ReadGroupSet"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "readGroupSetId": {
+ "location": "path",
+ "description": "The ID of the read group set to be updated. The caller must have WRITE\npermissions to the dataset associated with this read group set.",
+ "type": "string",
+ "required": true
+ },
+ "updateMask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "An optional mask specifying which fields to update. Supported fields:\n\n* name.\n* referenceSetId.\n\nLeaving `updateMask` unset is equivalent to specifying all mutable\nfields.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/readgroupsets/{readGroupSetId}",
+ "path": "v1/readgroupsets/{readGroupSetId}",
+ "id": "genomics.readgroupsets.patch"
+ },
+ "delete": {
+ "description": "Deletes a read group set.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "readGroupSetId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "readGroupSetId": {
+ "location": "path",
+ "description": "The ID of the read group set to be deleted. The caller must have WRITE\npermissions to the dataset associated with this read group set.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/readgroupsets/{readGroupSetId}",
+ "id": "genomics.readgroupsets.delete",
+ "path": "v1/readgroupsets/{readGroupSetId}"
+ },
+ "import": {
+ "flatPath": "v1/readgroupsets:import",
+ "path": "v1/readgroupsets:import",
+ "id": "genomics.readgroupsets.import",
+ "request": {
+ "$ref": "ImportReadGroupSetsRequest"
+ },
+ "description": "Creates read group sets by asynchronously importing the provided\ninformation.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThe caller must have WRITE permissions to the dataset.\n\n## Notes on [BAM](https://samtools.github.io/hts-specs/SAMv1.pdf) import\n\n- Tags will be converted to strings - tag types are not preserved\n- Comments (`@CO`) in the input file header will not be preserved\n- Original header order of references (`@SQ`) will not be preserved\n- Any reverse stranded unmapped reads will be reverse complemented, and\ntheir qualities (also the \"BQ\" and \"OQ\" tags, if any) will be reversed\n- Unmapped reads will be stripped of positional information (reference name\nand position)",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/devstorage.read_write",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {}
+ },
+ "export": {
+ "description": "Exports a read group set to a BAM file in Google Cloud Storage.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nNote that currently there may be some differences between exported BAM\nfiles and the original BAM file at the time of import. See\nImportReadGroupSets\nfor caveats.",
+ "request": {
+ "$ref": "ExportReadGroupSetRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "readGroupSetId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "readGroupSetId": {
+ "location": "path",
+ "description": "Required. The ID of the read group set to export. The caller must have\nREAD access to this read group set.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/devstorage.read_write",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/readgroupsets/{readGroupSetId}:export",
+ "id": "genomics.readgroupsets.export",
+ "path": "v1/readgroupsets/{readGroupSetId}:export"
+ }
+ },
+ "resources": {
+ "coveragebuckets": {
+ "methods": {
+ "list": {
+ "description": "Lists fixed width coverage buckets for a read group set, each of which\ncorrespond to a range of a reference sequence. Each bucket summarizes\ncoverage information across its corresponding genomic range.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nCoverage is defined as the number of reads which are aligned to a given\nbase in the reference sequence. Coverage buckets are available at several\nprecomputed bucket widths, enabling retrieval of various coverage 'zoom\nlevels'. The caller must have READ permissions for the target read group\nset.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListCoverageBucketsResponse"
+ },
+ "parameterOrder": [
+ "readGroupSetId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {
+ "end": {
+ "location": "query",
+ "format": "int64",
+ "description": "The end position of the range on the reference, 0-based exclusive. If\nspecified, `referenceName` must also be specified. If unset or 0, defaults\nto the length of the reference.",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024. The maximum value is 2048.",
+ "type": "integer",
+ "location": "query"
+ },
+ "start": {
+ "format": "int64",
+ "description": "The start position of the range on the reference, 0-based inclusive. If\nspecified, `referenceName` must also be specified. Defaults to 0.",
+ "type": "string",
+ "location": "query"
+ },
+ "readGroupSetId": {
+ "location": "path",
+ "description": "Required. The ID of the read group set over which coverage is requested.",
+ "type": "string",
+ "required": true
+ },
+ "targetBucketWidth": {
+ "format": "int64",
+ "description": "The desired width of each reported coverage bucket in base pairs. This\nwill be rounded down to the nearest precomputed bucket width; the value\nof which is returned as `bucketWidth` in the response. Defaults\nto infinity (each bucket spans an entire reference sequence) or the length\nof the target range, if specified. The smallest precomputed\n`bucketWidth` is currently 2048 base pairs; this is subject to\nchange.",
+ "type": "string",
+ "location": "query"
+ },
+ "referenceName": {
+ "location": "query",
+ "description": "The name of the reference to query, within the reference set associated\nwith this query. Optional.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/readgroupsets/{readGroupSetId}/coveragebuckets",
+ "path": "v1/readgroupsets/{readGroupSetId}/coveragebuckets",
+ "id": "genomics.readgroupsets.coveragebuckets.list"
+ }
+ }
+ }
+ }
+ },
+ "annotationsets": {
+ "methods": {
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "annotationSetId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "annotationSetId": {
+ "description": "The ID of the annotation set to be deleted.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/annotationsets/{annotationSetId}",
+ "id": "genomics.annotationsets.delete",
+ "path": "v1/annotationsets/{annotationSetId}",
+ "description": "Deletes an annotation set. Caller must have WRITE permission\nfor the associated annotation set."
+ },
+ "search": {
+ "description": "Searches for annotation sets that match the given criteria. Annotation sets\nare returned in an unspecified order. This order is consistent, such that\ntwo queries for the same content (regardless of page size) yield annotation\nsets in the same order across their respective streams of paginated\nresponses. Caller must have READ permission for the queried datasets.",
+ "request": {
+ "$ref": "SearchAnnotationSetsRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "SearchAnnotationSetsResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/annotationsets/search",
+ "path": "v1/annotationsets/search",
+ "id": "genomics.annotationsets.search"
+ },
+ "get": {
+ "flatPath": "v1/annotationsets/{annotationSetId}",
+ "path": "v1/annotationsets/{annotationSetId}",
+ "id": "genomics.annotationsets.get",
+ "description": "Gets an annotation set. Caller must have READ permission for\nthe associated dataset.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "annotationSetId"
+ ],
+ "response": {
+ "$ref": "AnnotationSet"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {
+ "annotationSetId": {
+ "description": "The ID of the annotation set to be retrieved.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ }
+ },
+ "update": {
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "annotationSetId"
+ ],
+ "response": {
+ "$ref": "AnnotationSet"
+ },
+ "parameters": {
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "An optional mask specifying which fields to update. Mutable fields are\nname,\nsource_uri, and\ninfo. If unspecified, all\nmutable fields will be updated.",
+ "type": "string",
+ "location": "query"
+ },
+ "annotationSetId": {
+ "description": "The ID of the annotation set to be updated.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/annotationsets/{annotationSetId}",
+ "path": "v1/annotationsets/{annotationSetId}",
+ "id": "genomics.annotationsets.update",
+ "description": "Updates an annotation set. The update must respect all mutability\nrestrictions and other invariants described on the annotation set resource.\nCaller must have WRITE permission for the associated dataset.",
+ "request": {
+ "$ref": "AnnotationSet"
+ }
+ },
+ "create": {
+ "response": {
+ "$ref": "AnnotationSet"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {},
+ "flatPath": "v1/annotationsets",
+ "id": "genomics.annotationsets.create",
+ "path": "v1/annotationsets",
+ "request": {
+ "$ref": "AnnotationSet"
+ },
+ "description": "Creates a new annotation set. Caller must have WRITE permission for the\nassociated dataset.\n\nThe following fields are required:\n\n * datasetId\n * referenceSetId\n\nAll other fields may be optionally specified, unless documented as being\nserver-generated (for example, the `id` field)."
+ }
+ }
+ },
+ "variants": {
+ "methods": {
+ "create": {
+ "flatPath": "v1/variants",
+ "path": "v1/variants",
+ "id": "genomics.variants.create",
+ "request": {
+ "$ref": "Variant"
+ },
+ "description": "Creates a new variant.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Variant"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {}
+ },
+ "search": {
+ "request": {
+ "$ref": "SearchVariantsRequest"
+ },
+ "description": "Gets a list of variants matching the criteria.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchVariants](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L126).",
+ "response": {
+ "$ref": "SearchVariantsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {},
+ "flatPath": "v1/variants/search",
+ "id": "genomics.variants.search",
+ "path": "v1/variants/search"
+ },
+ "patch": {
+ "response": {
+ "$ref": "Variant"
+ },
+ "parameterOrder": [
+ "variantId"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "An optional mask specifying which fields to update. At this time, mutable\nfields are names and\ninfo. Acceptable values are \"names\" and\n\"info\". If unspecified, all mutable fields will be updated.",
+ "type": "string",
+ "location": "query"
+ },
+ "variantId": {
+ "location": "path",
+ "description": "The ID of the variant to be updated.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/variants/{variantId}",
+ "id": "genomics.variants.patch",
+ "path": "v1/variants/{variantId}",
+ "description": "Updates a variant.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics. Returns the modified variant without\nits calls.",
+ "request": {
+ "$ref": "Variant"
+ }
+ },
+ "get": {
+ "description": "Gets a variant by ID.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Variant"
+ },
+ "parameterOrder": [
+ "variantId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {
+ "variantId": {
+ "description": "The ID of the variant.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/variants/{variantId}",
+ "path": "v1/variants/{variantId}",
+ "id": "genomics.variants.get"
+ },
+ "delete": {
+ "description": "Deletes a variant.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "variantId"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "variantId": {
+ "location": "path",
+ "description": "The ID of the variant to be deleted.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/variants/{variantId}",
+ "id": "genomics.variants.delete",
+ "path": "v1/variants/{variantId}"
+ },
+ "merge": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {},
+ "flatPath": "v1/variants:merge",
+ "id": "genomics.variants.merge",
+ "path": "v1/variants:merge",
+ "request": {
+ "$ref": "MergeVariantsRequest"
+ },
+ "description": "Merges the given variants with existing variants.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nEach variant will be\nmerged with an existing variant that matches its reference sequence,\nstart, end, reference bases, and alternative bases. If no such variant\nexists, a new one will be created.\n\nWhen variants are merged, the call information from the new variant\nis added to the existing variant. Variant info fields are merged as\nspecified in the\ninfoMergeConfig\nfield of the MergeVariantsRequest.\n\nPlease exercise caution when using this method! It is easy to introduce\nmistakes in existing variants and difficult to back out of them. For\nexample,\nsuppose you were trying to merge a new variant with an existing one and\nboth\nvariants contain calls that belong to callsets with the same callset ID.\n\n // Existing variant - irrelevant fields trimmed for clarity\n {\n \"variantSetId\": \"10473108253681171589\",\n \"referenceName\": \"1\",\n \"start\": \"10582\",\n \"referenceBases\": \"G\",\n \"alternateBases\": [\n \"A\"\n ],\n \"calls\": [\n {\n \"callSetId\": \"10473108253681171589-0\",\n \"callSetName\": \"CALLSET0\",\n \"genotype\": [\n 0,\n 1\n ],\n }\n ]\n }\n\n // New variant with conflicting call information\n {\n \"variantSetId\": \"10473108253681171589\",\n \"referenceName\": \"1\",\n \"start\": \"10582\",\n \"referenceBases\": \"G\",\n \"alternateBases\": [\n \"A\"\n ],\n \"calls\": [\n {\n \"callSetId\": \"10473108253681171589-0\",\n \"callSetName\": \"CALLSET0\",\n \"genotype\": [\n 1,\n 1\n ],\n }\n ]\n }\n\nThe resulting merged variant would overwrite the existing calls with those\nfrom the new variant:\n\n {\n \"variantSetId\": \"10473108253681171589\",\n \"referenceName\": \"1\",\n \"start\": \"10582\",\n \"referenceBases\": \"G\",\n \"alternateBases\": [\n \"A\"\n ],\n \"calls\": [\n {\n \"callSetId\": \"10473108253681171589-0\",\n \"callSetName\": \"CALLSET0\",\n \"genotype\": [\n 1,\n 1\n ],\n }\n ]\n }\n\nThis may be the desired outcome, but it is up to the user to determine if\nif that is indeed the case."
+ },
+ "import": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/devstorage.read_write",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/variants:import",
+ "id": "genomics.variants.import",
+ "path": "v1/variants:import",
+ "description": "Creates variant data by asynchronously importing the provided information.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThe variants for import will be merged with any existing variant that\nmatches its reference sequence, start, end, reference bases, and\nalternative bases. If no such variant exists, a new one will be created.\n\nWhen variants are merged, the call information from the new variant\nis added to the existing variant, and Variant info fields are merged\nas specified in\ninfoMergeConfig.\nAs a special case, for single-sample VCF files, QUAL and FILTER fields will\nbe moved to the call level; these are sometimes interpreted in a\ncall-specific context.\nImported VCF headers are appended to the metadata already in a variant set.",
+ "request": {
+ "$ref": "ImportVariantsRequest"
+ }
+ }
+ }
+ },
+ "references": {
+ "methods": {
+ "search": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "SearchReferencesResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/references/search",
+ "path": "v1/references/search",
+ "id": "genomics.references.search",
+ "description": "Searches for references which match the given criteria.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchReferences](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L146).",
+ "request": {
+ "$ref": "SearchReferencesRequest"
+ }
+ },
+ "get": {
+ "response": {
+ "$ref": "Reference"
+ },
+ "parameterOrder": [
+ "referenceId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "referenceId": {
+ "description": "The ID of the reference.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/references/{referenceId}",
+ "id": "genomics.references.get",
+ "path": "v1/references/{referenceId}",
+ "description": "Gets a reference.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.getReference](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L158)."
+ }
+ },
+ "resources": {
+ "bases": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListBasesResponse"
+ },
+ "parameterOrder": [
+ "referenceId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "The maximum number of bases to return in a single page. If unspecified,\ndefaults to 200Kbp (kilo base pairs). The maximum value is 10Mbp (mega base\npairs).",
+ "type": "integer"
+ },
+ "start": {
+ "location": "query",
+ "format": "int64",
+ "description": "The start position (0-based) of this query. Defaults to 0.",
+ "type": "string"
+ },
+ "referenceId": {
+ "description": "The ID of the reference.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "end": {
+ "format": "int64",
+ "description": "The end position (0-based, exclusive) of this query. Defaults to the length\nof this reference.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/references/{referenceId}/bases",
+ "id": "genomics.references.bases.list",
+ "path": "v1/references/{referenceId}/bases",
+ "description": "Lists the bases in a reference, optionally restricted to a range.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.getReferenceBases](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L221)."
+ }
+ }
+ }
+ }
+ },
+ "datasets": {
+ "methods": {
+ "patch": {
+ "request": {
+ "$ref": "Dataset"
+ },
+ "description": "Updates a dataset.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "datasetId"
+ ],
+ "response": {
+ "$ref": "Dataset"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "An optional mask specifying which fields to update. At this time, the only\nmutable field is name. The only\nacceptable value is \"name\". If unspecified, all mutable fields will be\nupdated.",
+ "type": "string",
+ "location": "query"
+ },
+ "datasetId": {
+ "location": "path",
+ "description": "The ID of the dataset to be updated.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/datasets/{datasetId}",
+ "path": "v1/datasets/{datasetId}",
+ "id": "genomics.datasets.patch"
+ },
+ "get": {
+ "flatPath": "v1/datasets/{datasetId}",
+ "id": "genomics.datasets.get",
+ "path": "v1/datasets/{datasetId}",
+ "description": "Gets a dataset by ID.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "response": {
+ "$ref": "Dataset"
+ },
+ "parameterOrder": [
+ "datasetId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {
+ "datasetId": {
+ "location": "path",
+ "description": "The ID of the dataset.",
+ "type": "string",
+ "required": true
+ }
+ }
+ },
+ "undelete": {
+ "response": {
+ "$ref": "Dataset"
+ },
+ "parameterOrder": [
+ "datasetId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "datasetId": {
+ "location": "path",
+ "description": "The ID of the dataset to be undeleted.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/datasets/{datasetId}:undelete",
+ "id": "genomics.datasets.undelete",
+ "path": "v1/datasets/{datasetId}:undelete",
+ "description": "Undeletes a dataset by restoring a dataset which was deleted via this API.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis operation is only possible for a week after the deletion occurred.",
+ "request": {
+ "$ref": "UndeleteDatasetRequest"
+ }
+ },
+ "testIamPermissions": {
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified resource.\nSee \u003ca href=\"/iam/docs/managing-policies#testing_permissions\"\u003eTesting\nPermissions\u003c/a\u003e for more information.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
"resource": {
+ "description": "REQUIRED: The resource for which policy is being specified. Format is\n`datasets/\u003cdataset ID\u003e`.",
"type": "string",
"required": true,
"pattern": "^datasets/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which policy is being specified. Format is\n`datasets/\u003cdataset ID\u003e`."
+ "location": "path"
}
},
- "flatPath": "v1/datasets/{datasetsId}:testIamPermissions"
+ "flatPath": "v1/datasets/{datasetsId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "genomics.datasets.testIamPermissions"
},
"delete": {
"flatPath": "v1/datasets/{datasetId}",
@@ -78,6 +1398,11 @@
"https://www.googleapis.com/auth/genomics.readonly"
],
"parameters": {
+ "pageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
+ "type": "string",
+ "location": "query"
+ },
"pageSize": {
"format": "int32",
"description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 50. The maximum value is 1024.",
@@ -88,63 +1413,33 @@
"location": "query",
"description": "Required. The Google Cloud project ID to list datasets for.",
"type": "string"
- },
- "pageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
- "type": "string",
- "location": "query"
}
}
},
"create": {
- "httpMethod": "POST",
- "parameterOrder": [],
+ "description": "Creates a new dataset.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "request": {
+ "$ref": "Dataset"
+ },
"response": {
"$ref": "Dataset"
},
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
- "parameters": {},
"flatPath": "v1/datasets",
- "path": "v1/datasets",
"id": "genomics.datasets.create",
- "request": {
- "$ref": "Dataset"
- },
- "description": "Creates a new dataset.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
+ "path": "v1/datasets"
},
"setIamPolicy": {
- "description": "Sets the access control policy on the specified dataset. Replaces any\nexisting policy.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nSee \u003ca href=\"/iam/docs/managing-policies#setting_a_policy\"\u003eSetting a\nPolicy\u003c/a\u003e for more information.",
"request": {
"$ref": "SetIamPolicyRequest"
},
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which policy is being specified. Format is\n`datasets/\u003cdataset ID\u003e`.",
- "type": "string",
- "required": true,
- "pattern": "^datasets/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/datasets/{datasetsId}:setIamPolicy",
- "id": "genomics.datasets.setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy"
- },
- "getIamPolicy": {
+ "description": "Sets the access control policy on the specified dataset. Replaces any\nexisting policy.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nSee \u003ca href=\"/iam/docs/managing-policies#setting_a_policy\"\u003eSetting a\nPolicy\u003c/a\u003e for more information.",
"httpMethod": "POST",
"parameterOrder": [
"resource"
@@ -165,1367 +1460,58 @@
"pattern": "^datasets/[^/]+$"
}
},
+ "flatPath": "v1/datasets/{datasetsId}:setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "genomics.datasets.setIamPolicy"
+ },
+ "getIamPolicy": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which policy is being specified. Format is\n`datasets/\u003cdataset ID\u003e`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^datasets/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
"flatPath": "v1/datasets/{datasetsId}:getIamPolicy",
"path": "v1/{+resource}:getIamPolicy",
"id": "genomics.datasets.getIamPolicy",
+ "description": "Gets the access control policy for the dataset. This is empty if the\npolicy or resource does not exist.\n\nSee \u003ca href=\"/iam/docs/managing-policies#getting_a_policy\"\u003eGetting a\nPolicy\u003c/a\u003e for more information.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
"request": {
"$ref": "GetIamPolicyRequest"
- },
- "description": "Gets the access control policy for the dataset. This is empty if the\npolicy or resource does not exist.\n\nSee \u003ca href=\"/iam/docs/managing-policies#getting_a_policy\"\u003eGetting a\nPolicy\u003c/a\u003e for more information.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
- },
- "patch": {
- "response": {
- "$ref": "Dataset"
- },
- "parameterOrder": [
- "datasetId"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "datasetId": {
- "description": "The ID of the dataset to be updated.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "updateMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "An optional mask specifying which fields to update. At this time, the only\nmutable field is name. The only\nacceptable value is \"name\". If unspecified, all mutable fields will be\nupdated.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/datasets/{datasetId}",
- "id": "genomics.datasets.patch",
- "path": "v1/datasets/{datasetId}",
- "description": "Updates a dataset.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics.",
- "request": {
- "$ref": "Dataset"
}
- },
- "get": {
- "description": "Gets a dataset by ID.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "response": {
- "$ref": "Dataset"
- },
- "parameterOrder": [
- "datasetId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {
- "datasetId": {
- "description": "The ID of the dataset.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/datasets/{datasetId}",
- "id": "genomics.datasets.get",
- "path": "v1/datasets/{datasetId}"
- },
- "undelete": {
- "httpMethod": "POST",
- "parameterOrder": [
- "datasetId"
- ],
- "response": {
- "$ref": "Dataset"
- },
- "parameters": {
- "datasetId": {
- "description": "The ID of the dataset to be undeleted.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/datasets/{datasetId}:undelete",
- "path": "v1/datasets/{datasetId}:undelete",
- "id": "genomics.datasets.undelete",
- "description": "Undeletes a dataset by restoring a dataset which was deleted via this API.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis operation is only possible for a week after the deletion occurred.",
- "request": {
- "$ref": "UndeleteDatasetRequest"
- }
- }
- }
- },
- "variantsets": {
- "methods": {
- "export": {
- "request": {
- "$ref": "ExportVariantSetRequest"
- },
- "description": "Exports variant set data to an external destination.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "variantSetId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "variantSetId": {
- "location": "path",
- "description": "Required. The ID of the variant set that contains variant data which\nshould be exported. The caller must have READ access to this variant set.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/variantsets/{variantSetId}:export",
- "id": "genomics.variantsets.export",
- "path": "v1/variantsets/{variantSetId}:export"
- },
- "search": {
- "response": {
- "$ref": "SearchVariantSetsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "flatPath": "v1/variantsets/search",
- "id": "genomics.variantsets.search",
- "path": "v1/variantsets/search",
- "description": "Returns a list of all variant sets matching search criteria.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchVariantSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L49).",
- "request": {
- "$ref": "SearchVariantSetsRequest"
- }
- },
- "patch": {
- "response": {
- "$ref": "VariantSet"
- },
- "parameterOrder": [
- "variantSetId"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "updateMask": {
- "type": "string",
- "location": "query",
- "format": "google-fieldmask",
- "description": "An optional mask specifying which fields to update. Supported fields:\n\n* metadata.\n* name.\n* description.\n\nLeaving `updateMask` unset is equivalent to specifying all mutable\nfields."
- },
- "variantSetId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The ID of the variant to be updated (must already exist)."
- }
- },
- "flatPath": "v1/variantsets/{variantSetId}",
- "id": "genomics.variantsets.patch",
- "path": "v1/variantsets/{variantSetId}",
- "request": {
- "$ref": "VariantSet"
- },
- "description": "Updates a variant set using patch semantics.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
- },
- "get": {
- "description": "Gets a variant set by ID.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "httpMethod": "GET",
- "response": {
- "$ref": "VariantSet"
- },
- "parameterOrder": [
- "variantSetId"
- ],
- "parameters": {
- "variantSetId": {
- "description": "Required. The ID of the variant set.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "flatPath": "v1/variantsets/{variantSetId}",
- "path": "v1/variantsets/{variantSetId}",
- "id": "genomics.variantsets.get"
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "variantSetId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "variantSetId": {
- "description": "The ID of the variant set to be deleted.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/variantsets/{variantSetId}",
- "id": "genomics.variantsets.delete",
- "path": "v1/variantsets/{variantSetId}",
- "description": "Deletes a variant set including all variants, call sets, and calls within.\nThis is not reversible.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "VariantSet"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {},
- "flatPath": "v1/variantsets",
- "path": "v1/variantsets",
- "id": "genomics.variantsets.create",
- "request": {
- "$ref": "VariantSet"
- },
- "description": "Creates a new variant set.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThe provided variant set must have a valid `datasetId` set - all other\nfields are optional. Note that the `id` field will be ignored, as this is\nassigned by the server."
- }
- }
- },
- "annotations": {
- "methods": {
- "delete": {
- "description": "Deletes an annotation. Caller must have WRITE permission for\nthe associated annotation set.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "annotationId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "annotationId": {
- "description": "The ID of the annotation to be deleted.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/annotations/{annotationId}",
- "id": "genomics.annotations.delete",
- "path": "v1/annotations/{annotationId}"
- },
- "create": {
- "response": {
- "$ref": "Annotation"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/annotations",
- "id": "genomics.annotations.create",
- "path": "v1/annotations",
- "description": "Creates a new annotation. Caller must have WRITE permission\nfor the associated annotation set.\n\nThe following fields are required:\n\n* annotationSetId\n* referenceName or\n referenceId\n\n### Transcripts\n\nFor annotations of type TRANSCRIPT, the following fields of\ntranscript must be provided:\n\n* exons.start\n* exons.end\n\nAll other fields may be optionally specified, unless documented as being\nserver-generated (for example, the `id` field). The annotated\nrange must be no longer than 100Mbp (mega base pairs). See the\nAnnotation resource\nfor additional restrictions on each field.",
- "request": {
- "$ref": "Annotation"
- }
- },
- "batchCreate": {
- "flatPath": "v1/annotations:batchCreate",
- "path": "v1/annotations:batchCreate",
- "id": "genomics.annotations.batchCreate",
- "request": {
- "$ref": "BatchCreateAnnotationsRequest"
- },
- "description": "Creates one or more new annotations atomically. All annotations must\nbelong to the same annotation set. Caller must have WRITE\npermission for this annotation set. For optimal performance, batch\npositionally adjacent annotations together.\n\nIf the request has a systemic issue, such as an attempt to write to\nan inaccessible annotation set, the entire RPC will fail accordingly. For\nlesser data issues, when possible an error will be isolated to the\ncorresponding batch entry in the response; the remaining well formed\nannotations will be created normally.\n\nFor details on the requirements for each individual annotation resource,\nsee\nCreateAnnotation.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "BatchCreateAnnotationsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {}
- },
- "search": {
- "response": {
- "$ref": "SearchAnnotationsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {},
- "flatPath": "v1/annotations/search",
- "id": "genomics.annotations.search",
- "path": "v1/annotations/search",
- "request": {
- "$ref": "SearchAnnotationsRequest"
- },
- "description": "Searches for annotations that match the given criteria. Results are\nordered by genomic coordinate (by reference sequence, then position).\nAnnotations with equivalent genomic coordinates are returned in an\nunspecified order. This order is consistent, such that two queries for the\nsame content (regardless of page size) yield annotations in the same order\nacross their respective streams of paginated responses. Caller must have\nREAD permission for the queried annotation sets."
- },
- "get": {
- "description": "Gets an annotation. Caller must have READ permission\nfor the associated annotation set.",
- "response": {
- "$ref": "Annotation"
- },
- "parameterOrder": [
- "annotationId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {
- "annotationId": {
- "description": "The ID of the annotation to be retrieved.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/annotations/{annotationId}",
- "id": "genomics.annotations.get",
- "path": "v1/annotations/{annotationId}"
- },
- "update": {
- "description": "Updates an annotation. Caller must have\nWRITE permission for the associated dataset.",
- "request": {
- "$ref": "Annotation"
- },
- "response": {
- "$ref": "Annotation"
- },
- "parameterOrder": [
- "annotationId"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "updateMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "An optional mask specifying which fields to update. Mutable fields are\nname,\nvariant,\ntranscript, and\ninfo. If unspecified, all mutable\nfields will be updated.",
- "type": "string"
- },
- "annotationId": {
- "description": "The ID of the annotation to be updated.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/annotations/{annotationId}",
- "id": "genomics.annotations.update",
- "path": "v1/annotations/{annotationId}"
- }
- }
- },
- "operations": {
- "methods": {
- "cancel": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation resource to be cancelled.",
- "type": "string",
- "required": true,
- "pattern": "^operations/.+$"
- }
- },
- "flatPath": "v1/operations/{operationsId}:cancel",
- "path": "v1/{+name}:cancel",
- "id": "genomics.operations.cancel",
- "request": {
- "$ref": "CancelOperationRequest"
- },
- "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation."
- },
- "get": {
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation resource.",
- "type": "string",
- "required": true,
- "pattern": "^operations/.+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/operations/{operationsId}",
- "path": "v1/{+name}",
- "id": "genomics.operations.get"
- },
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "filter": {
- "description": "A string for filtering Operations.\nThe following filter fields are supported:\n\n* projectId: Required. Corresponds to\n OperationMetadata.projectId.\n* createTime: The time this job was created, in seconds from the\n [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `\u003e=` and/or `\u003c=`\n operators.\n* status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only\n one status may be specified.\n* labels.key where key is a label key.\n\nExamples:\n\n* `projectId = my-project AND createTime \u003e= 1432140000`\n* `projectId = my-project AND createTime \u003e= 1432140000 AND createTime \u003c= 1432150000 AND status = RUNNING`\n* `projectId = my-project AND labels.color = *`\n* `projectId = my-project AND labels.color = red`",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "description": "The name of the operation's parent resource.",
- "type": "string",
- "required": true,
- "pattern": "^operations$",
- "location": "path"
- },
- "pageSize": {
- "format": "int32",
- "description": "The maximum number of results to return. If unspecified, defaults to\n256. The maximum value is 2048.",
- "type": "integer",
- "location": "query"
- }
- },
- "flatPath": "v1/operations",
- "path": "v1/{+name}",
- "id": "genomics.operations.list",
- "description": "Lists operations that match the specified filter in the request."
- }
- }
- },
- "referencesets": {
- "methods": {
- "search": {
- "response": {
- "$ref": "SearchReferenceSetsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {},
- "flatPath": "v1/referencesets/search",
- "id": "genomics.referencesets.search",
- "path": "v1/referencesets/search",
- "request": {
- "$ref": "SearchReferenceSetsRequest"
- },
- "description": "Searches for reference sets which match the given criteria.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchReferenceSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L71)"
- },
- "get": {
- "flatPath": "v1/referencesets/{referenceSetId}",
- "id": "genomics.referencesets.get",
- "path": "v1/referencesets/{referenceSetId}",
- "description": "Gets a reference set.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.getReferenceSet](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L83).",
- "response": {
- "$ref": "ReferenceSet"
- },
- "parameterOrder": [
- "referenceSetId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "referenceSetId": {
- "location": "path",
- "description": "The ID of the reference set.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ]
- }
- }
- },
- "callsets": {
- "methods": {
- "delete": {
- "flatPath": "v1/callsets/{callSetId}",
- "path": "v1/callsets/{callSetId}",
- "id": "genomics.callsets.delete",
- "description": "Deletes a call set.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "callSetId"
- ],
- "parameters": {
- "callSetId": {
- "location": "path",
- "description": "The ID of the call set to be deleted.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ]
- },
- "search": {
- "response": {
- "$ref": "SearchCallSetsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "flatPath": "v1/callsets/search",
- "id": "genomics.callsets.search",
- "path": "v1/callsets/search",
- "description": "Gets a list of call sets matching the criteria.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchCallSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L178).",
- "request": {
- "$ref": "SearchCallSetsRequest"
- }
- },
- "get": {
- "id": "genomics.callsets.get",
- "path": "v1/callsets/{callSetId}",
- "description": "Gets a call set by ID.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "response": {
- "$ref": "CallSet"
- },
- "parameterOrder": [
- "callSetId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {
- "callSetId": {
- "location": "path",
- "description": "The ID of the call set.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/callsets/{callSetId}"
- },
- "patch": {
- "parameters": {
- "updateMask": {
- "format": "google-fieldmask",
- "description": "An optional mask specifying which fields to update. At this time, the only\nmutable field is name. The only\nacceptable value is \"name\". If unspecified, all mutable fields will be\nupdated.",
- "type": "string",
- "location": "query"
- },
- "callSetId": {
- "location": "path",
- "description": "The ID of the call set to be updated.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/callsets/{callSetId}",
- "path": "v1/callsets/{callSetId}",
- "id": "genomics.callsets.patch",
- "description": "Updates a call set.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics.",
- "request": {
- "$ref": "CallSet"
- },
- "httpMethod": "PATCH",
- "parameterOrder": [
- "callSetId"
- ],
- "response": {
- "$ref": "CallSet"
- }
- },
- "create": {
- "id": "genomics.callsets.create",
- "path": "v1/callsets",
- "request": {
- "$ref": "CallSet"
- },
- "description": "Creates a new call set.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "response": {
- "$ref": "CallSet"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {},
- "flatPath": "v1/callsets"
- }
- }
- },
- "reads": {
- "methods": {
- "search": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "SearchReadsResponse"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "flatPath": "v1/reads/search",
- "path": "v1/reads/search",
- "id": "genomics.reads.search",
- "description": "Gets a list of reads for one or more read group sets.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nReads search operates over a genomic coordinate space of reference sequence\n& position defined over the reference sequences to which the requested\nread group sets are aligned.\n\nIf a target positional range is specified, search returns all reads whose\nalignment to the reference genome overlap the range. A query which\nspecifies only read group set IDs yields all reads in those read group\nsets, including unmapped reads.\n\nAll reads returned (including reads on subsequent pages) are ordered by\ngenomic coordinate (by reference sequence, then position). Reads with\nequivalent genomic coordinates are returned in an unspecified order. This\norder is consistent, such that two queries for the same content (regardless\nof page size) yield reads in the same order across their respective streams\nof paginated responses.\n\nImplements\n[GlobalAllianceApi.searchReads](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/readmethods.avdl#L85).",
- "request": {
- "$ref": "SearchReadsRequest"
- }
- }
- }
- },
- "readgroupsets": {
- "resources": {
- "coveragebuckets": {
- "methods": {
- "list": {
- "description": "Lists fixed width coverage buckets for a read group set, each of which\ncorrespond to a range of a reference sequence. Each bucket summarizes\ncoverage information across its corresponding genomic range.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nCoverage is defined as the number of reads which are aligned to a given\nbase in the reference sequence. Coverage buckets are available at several\nprecomputed bucket widths, enabling retrieval of various coverage 'zoom\nlevels'. The caller must have READ permissions for the target read group\nset.",
- "response": {
- "$ref": "ListCoverageBucketsResponse"
- },
- "parameterOrder": [
- "readGroupSetId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "referenceName": {
- "description": "The name of the reference to query, within the reference set associated\nwith this query. Optional.",
- "type": "string",
- "location": "query"
- },
- "end": {
- "format": "int64",
- "description": "The end position of the range on the reference, 0-based exclusive. If\nspecified, `referenceName` must also be specified. If unset or 0, defaults\nto the length of the reference.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024. The maximum value is 2048.",
- "type": "integer"
- },
- "start": {
- "location": "query",
- "format": "int64",
- "description": "The start position of the range on the reference, 0-based inclusive. If\nspecified, `referenceName` must also be specified. Defaults to 0.",
- "type": "string"
- },
- "targetBucketWidth": {
- "type": "string",
- "location": "query",
- "format": "int64",
- "description": "The desired width of each reported coverage bucket in base pairs. This\nwill be rounded down to the nearest precomputed bucket width; the value\nof which is returned as `bucketWidth` in the response. Defaults\nto infinity (each bucket spans an entire reference sequence) or the length\nof the target range, if specified. The smallest precomputed\n`bucketWidth` is currently 2048 base pairs; this is subject to\nchange."
- },
- "readGroupSetId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Required. The ID of the read group set over which coverage is requested."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "flatPath": "v1/readgroupsets/{readGroupSetId}/coveragebuckets",
- "id": "genomics.readgroupsets.coveragebuckets.list",
- "path": "v1/readgroupsets/{readGroupSetId}/coveragebuckets"
- }
- }
- }
- },
- "methods": {
- "export": {
- "httpMethod": "POST",
- "parameterOrder": [
- "readGroupSetId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/devstorage.read_write",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "readGroupSetId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Required. The ID of the read group set to export. The caller must have\nREAD access to this read group set."
- }
- },
- "flatPath": "v1/readgroupsets/{readGroupSetId}:export",
- "path": "v1/readgroupsets/{readGroupSetId}:export",
- "id": "genomics.readgroupsets.export",
- "request": {
- "$ref": "ExportReadGroupSetRequest"
- },
- "description": "Exports a read group set to a BAM file in Google Cloud Storage.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nNote that currently there may be some differences between exported BAM\nfiles and the original BAM file at the time of import. See\nImportReadGroupSets\nfor caveats."
- },
- "search": {
- "response": {
- "$ref": "SearchReadGroupSetsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {},
- "flatPath": "v1/readgroupsets/search",
- "id": "genomics.readgroupsets.search",
- "path": "v1/readgroupsets/search",
- "request": {
- "$ref": "SearchReadGroupSetsRequest"
- },
- "description": "Searches for read group sets matching the criteria.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchReadGroupSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/readmethods.avdl#L135)."
- },
- "get": {
- "response": {
- "$ref": "ReadGroupSet"
- },
- "parameterOrder": [
- "readGroupSetId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {
- "readGroupSetId": {
- "description": "The ID of the read group set.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/readgroupsets/{readGroupSetId}",
- "id": "genomics.readgroupsets.get",
- "path": "v1/readgroupsets/{readGroupSetId}",
- "description": "Gets a read group set by ID.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
- },
- "patch": {
- "description": "Updates a read group set.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics.",
- "request": {
- "$ref": "ReadGroupSet"
- },
- "response": {
- "$ref": "ReadGroupSet"
- },
- "parameterOrder": [
- "readGroupSetId"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "readGroupSetId": {
- "location": "path",
- "description": "The ID of the read group set to be updated. The caller must have WRITE\npermissions to the dataset associated with this read group set.",
- "type": "string",
- "required": true
- },
- "updateMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "An optional mask specifying which fields to update. Supported fields:\n\n* name.\n* referenceSetId.\n\nLeaving `updateMask` unset is equivalent to specifying all mutable\nfields.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/readgroupsets/{readGroupSetId}",
- "id": "genomics.readgroupsets.patch",
- "path": "v1/readgroupsets/{readGroupSetId}"
- },
- "import": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/devstorage.read_write",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/readgroupsets:import",
- "path": "v1/readgroupsets:import",
- "id": "genomics.readgroupsets.import",
- "description": "Creates read group sets by asynchronously importing the provided\ninformation.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThe caller must have WRITE permissions to the dataset.\n\n## Notes on [BAM](https://samtools.github.io/hts-specs/SAMv1.pdf) import\n\n- Tags will be converted to strings - tag types are not preserved\n- Comments (`@CO`) in the input file header will not be preserved\n- Original header order of references (`@SQ`) will not be preserved\n- Any reverse stranded unmapped reads will be reverse complemented, and\ntheir qualities (also the \"BQ\" and \"OQ\" tags, if any) will be reversed\n- Unmapped reads will be stripped of positional information (reference name\nand position)",
- "request": {
- "$ref": "ImportReadGroupSetsRequest"
- }
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "readGroupSetId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "readGroupSetId": {
- "location": "path",
- "description": "The ID of the read group set to be deleted. The caller must have WRITE\npermissions to the dataset associated with this read group set.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/readgroupsets/{readGroupSetId}",
- "id": "genomics.readgroupsets.delete",
- "path": "v1/readgroupsets/{readGroupSetId}",
- "description": "Deletes a read group set.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
- }
- }
- },
- "variants": {
- "methods": {
- "delete": {
- "path": "v1/variants/{variantId}",
- "id": "genomics.variants.delete",
- "description": "Deletes a variant.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "variantId"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "variantId": {
- "description": "The ID of the variant to be deleted.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/variants/{variantId}"
- },
- "import": {
- "flatPath": "v1/variants:import",
- "id": "genomics.variants.import",
- "path": "v1/variants:import",
- "description": "Creates variant data by asynchronously importing the provided information.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThe variants for import will be merged with any existing variant that\nmatches its reference sequence, start, end, reference bases, and\nalternative bases. If no such variant exists, a new one will be created.\n\nWhen variants are merged, the call information from the new variant\nis added to the existing variant, and Variant info fields are merged\nas specified in\ninfoMergeConfig.\nAs a special case, for single-sample VCF files, QUAL and FILTER fields will\nbe moved to the call level; these are sometimes interpreted in a\ncall-specific context.\nImported VCF headers are appended to the metadata already in a variant set.",
- "request": {
- "$ref": "ImportVariantsRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/devstorage.read_write",
- "https://www.googleapis.com/auth/genomics"
- ]
- },
- "merge": {
- "path": "v1/variants:merge",
- "id": "genomics.variants.merge",
- "description": "Merges the given variants with existing variants.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nEach variant will be\nmerged with an existing variant that matches its reference sequence,\nstart, end, reference bases, and alternative bases. If no such variant\nexists, a new one will be created.\n\nWhen variants are merged, the call information from the new variant\nis added to the existing variant. Variant info fields are merged as\nspecified in the\ninfoMergeConfig\nfield of the MergeVariantsRequest.\n\nPlease exercise caution when using this method! It is easy to introduce\nmistakes in existing variants and difficult to back out of them. For\nexample,\nsuppose you were trying to merge a new variant with an existing one and\nboth\nvariants contain calls that belong to callsets with the same callset ID.\n\n // Existing variant - irrelevant fields trimmed for clarity\n {\n \"variantSetId\": \"10473108253681171589\",\n \"referenceName\": \"1\",\n \"start\": \"10582\",\n \"referenceBases\": \"G\",\n \"alternateBases\": [\n \"A\"\n ],\n \"calls\": [\n {\n \"callSetId\": \"10473108253681171589-0\",\n \"callSetName\": \"CALLSET0\",\n \"genotype\": [\n 0,\n 1\n ],\n }\n ]\n }\n\n // New variant with conflicting call information\n {\n \"variantSetId\": \"10473108253681171589\",\n \"referenceName\": \"1\",\n \"start\": \"10582\",\n \"referenceBases\": \"G\",\n \"alternateBases\": [\n \"A\"\n ],\n \"calls\": [\n {\n \"callSetId\": \"10473108253681171589-0\",\n \"callSetName\": \"CALLSET0\",\n \"genotype\": [\n 1,\n 1\n ],\n }\n ]\n }\n\nThe resulting merged variant would overwrite the existing calls with those\nfrom the new variant:\n\n {\n \"variantSetId\": \"10473108253681171589\",\n \"referenceName\": \"1\",\n \"start\": \"10582\",\n \"referenceBases\": \"G\",\n \"alternateBases\": [\n \"A\"\n ],\n \"calls\": [\n {\n \"callSetId\": \"10473108253681171589-0\",\n \"callSetName\": \"CALLSET0\",\n \"genotype\": [\n 1,\n 1\n ],\n }\n ]\n }\n\nThis may be the desired outcome, but it is up to the user to determine if\nif that is indeed the case.",
- "request": {
- "$ref": "MergeVariantsRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/variants:merge"
- },
- "create": {
- "path": "v1/variants",
- "id": "genomics.variants.create",
- "request": {
- "$ref": "Variant"
- },
- "description": "Creates a new variant.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Variant"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {},
- "flatPath": "v1/variants"
- },
- "search": {
- "description": "Gets a list of variants matching the criteria.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchVariants](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L126).",
- "request": {
- "$ref": "SearchVariantsRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "SearchVariantsResponse"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "flatPath": "v1/variants/search",
- "path": "v1/variants/search",
- "id": "genomics.variants.search"
- },
- "patch": {
- "response": {
- "$ref": "Variant"
- },
- "parameterOrder": [
- "variantId"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "updateMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "An optional mask specifying which fields to update. At this time, mutable\nfields are names and\ninfo. Acceptable values are \"names\" and\n\"info\". If unspecified, all mutable fields will be updated.",
- "type": "string"
- },
- "variantId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The ID of the variant to be updated."
- }
- },
- "flatPath": "v1/variants/{variantId}",
- "id": "genomics.variants.patch",
- "path": "v1/variants/{variantId}",
- "request": {
- "$ref": "Variant"
- },
- "description": "Updates a variant.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics. Returns the modified variant without\nits calls."
- },
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "variantId"
- ],
- "response": {
- "$ref": "Variant"
- },
- "parameters": {
- "variantId": {
- "description": "The ID of the variant.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "flatPath": "v1/variants/{variantId}",
- "path": "v1/variants/{variantId}",
- "id": "genomics.variants.get",
- "description": "Gets a variant by ID.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
- }
- }
- },
- "annotationsets": {
- "methods": {
- "delete": {
- "description": "Deletes an annotation set. Caller must have WRITE permission\nfor the associated annotation set.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "annotationSetId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "annotationSetId": {
- "description": "The ID of the annotation set to be deleted.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/annotationsets/{annotationSetId}",
- "id": "genomics.annotationsets.delete",
- "path": "v1/annotationsets/{annotationSetId}"
- },
- "search": {
- "description": "Searches for annotation sets that match the given criteria. Annotation sets\nare returned in an unspecified order. This order is consistent, such that\ntwo queries for the same content (regardless of page size) yield annotation\nsets in the same order across their respective streams of paginated\nresponses. Caller must have READ permission for the queried datasets.",
- "request": {
- "$ref": "SearchAnnotationSetsRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "SearchAnnotationSetsResponse"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "flatPath": "v1/annotationsets/search",
- "path": "v1/annotationsets/search",
- "id": "genomics.annotationsets.search"
- },
- "get": {
- "flatPath": "v1/annotationsets/{annotationSetId}",
- "path": "v1/annotationsets/{annotationSetId}",
- "id": "genomics.annotationsets.get",
- "description": "Gets an annotation set. Caller must have READ permission for\nthe associated dataset.",
- "httpMethod": "GET",
- "response": {
- "$ref": "AnnotationSet"
- },
- "parameterOrder": [
- "annotationSetId"
- ],
- "parameters": {
- "annotationSetId": {
- "location": "path",
- "description": "The ID of the annotation set to be retrieved.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ]
- },
- "update": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "annotationSetId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The ID of the annotation set to be updated."
- },
- "updateMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "An optional mask specifying which fields to update. Mutable fields are\nname,\nsource_uri, and\ninfo. If unspecified, all\nmutable fields will be updated.",
- "type": "string"
- }
- },
- "flatPath": "v1/annotationsets/{annotationSetId}",
- "id": "genomics.annotationsets.update",
- "path": "v1/annotationsets/{annotationSetId}",
- "request": {
- "$ref": "AnnotationSet"
- },
- "description": "Updates an annotation set. The update must respect all mutability\nrestrictions and other invariants described on the annotation set resource.\nCaller must have WRITE permission for the associated dataset.",
- "response": {
- "$ref": "AnnotationSet"
- },
- "parameterOrder": [
- "annotationSetId"
- ],
- "httpMethod": "PUT"
- },
- "create": {
- "response": {
- "$ref": "AnnotationSet"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/annotationsets",
- "id": "genomics.annotationsets.create",
- "path": "v1/annotationsets",
- "description": "Creates a new annotation set. Caller must have WRITE permission for the\nassociated dataset.\n\nThe following fields are required:\n\n * datasetId\n * referenceSetId\n\nAll other fields may be optionally specified, unless documented as being\nserver-generated (for example, the `id` field).",
- "request": {
- "$ref": "AnnotationSet"
- }
- }
- }
- },
- "references": {
- "resources": {
- "bases": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListBasesResponse"
- },
- "parameterOrder": [
- "referenceId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageSize": {
- "format": "int32",
- "description": "The maximum number of bases to return in a single page. If unspecified,\ndefaults to 200Kbp (kilo base pairs). The maximum value is 10Mbp (mega base\npairs).",
- "type": "integer",
- "location": "query"
- },
- "start": {
- "format": "int64",
- "description": "The start position (0-based) of this query. Defaults to 0.",
- "type": "string",
- "location": "query"
- },
- "referenceId": {
- "description": "The ID of the reference.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "end": {
- "location": "query",
- "format": "int64",
- "description": "The end position (0-based, exclusive) of this query. Defaults to the length\nof this reference.",
- "type": "string"
- },
- "pageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "flatPath": "v1/references/{referenceId}/bases",
- "id": "genomics.references.bases.list",
- "path": "v1/references/{referenceId}/bases",
- "description": "Lists the bases in a reference, optionally restricted to a range.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.getReferenceBases](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L221)."
- }
- }
- }
- },
- "methods": {
- "search": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "SearchReferencesResponse"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "flatPath": "v1/references/search",
- "path": "v1/references/search",
- "id": "genomics.references.search",
- "description": "Searches for references which match the given criteria.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchReferences](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L146).",
- "request": {
- "$ref": "SearchReferencesRequest"
- }
- },
- "get": {
- "description": "Gets a reference.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.getReference](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L158).",
- "response": {
- "$ref": "Reference"
- },
- "parameterOrder": [
- "referenceId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "referenceId": {
- "description": "The ID of the reference.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "flatPath": "v1/references/{referenceId}",
- "id": "genomics.references.get",
- "path": "v1/references/{referenceId}"
}
}
}
},
"parameters": {
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "quotaUser": {
- "type": "string",
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
- },
"pp": {
+ "location": "query",
"description": "Pretty-print response.",
"default": "true",
- "type": "boolean",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
+ "type": "boolean"
},
"bearer_token": {
- "type": "string",
"location": "query",
- "description": "OAuth bearer token."
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
@@ -1539,20 +1525,15 @@
"type": "boolean"
},
"fields": {
- "type": "string",
"location": "query",
- "description": "Selector specifying which fields to include in a partial response."
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
},
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
"$.xgafv": {
"enumDescriptions": [
"v1 error format",
@@ -1566,6 +1547,11 @@
"description": "V1 error format.",
"type": "string"
},
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
"alt": {
"description": "Data format for response.",
"default": "json",
@@ -1581,12 +1567,1051 @@
"Responses with Content-Type of application/x-protobuf"
],
"location": "query"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
}
},
"schemas": {
+ "ComputeEngine": {
+ "description": "Describes a Compute Engine resource that is being managed by a running\npipeline.",
+ "type": "object",
+ "properties": {
+ "instanceName": {
+ "description": "The instance on which the operation is running.",
+ "type": "string"
+ },
+ "zone": {
+ "description": "The availability zone in which the instance resides.",
+ "type": "string"
+ },
+ "diskNames": {
+ "description": "The names of the disks that were created for this pipeline.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "machineType": {
+ "description": "The machine type of the instance.",
+ "type": "string"
+ }
+ },
+ "id": "ComputeEngine"
+ },
+ "CoverageBucket": {
+ "description": "A bucket over which read coverage has been precomputed. A bucket corresponds\nto a specific range of the reference sequence.",
+ "type": "object",
+ "properties": {
+ "range": {
+ "$ref": "Range",
+ "description": "The genomic coordinate range spanned by this bucket."
+ },
+ "meanCoverage": {
+ "format": "float",
+ "description": "The average number of reads which are aligned to each individual\nreference base in this bucket.",
+ "type": "number"
+ }
+ },
+ "id": "CoverageBucket"
+ },
+ "ExternalId": {
+ "type": "object",
+ "properties": {
+ "sourceName": {
+ "description": "The name of the source of this data.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The id used by the source of this data.",
+ "type": "string"
+ }
+ },
+ "id": "ExternalId"
+ },
+ "SearchVariantSetsRequest": {
+ "description": "The search variant sets request.",
+ "type": "object",
+ "properties": {
+ "pageSize": {
+ "format": "int32",
+ "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024.",
+ "type": "integer"
+ },
+ "datasetIds": {
+ "description": "Exactly one dataset ID must be provided here. Only variant sets which\nbelong to this dataset will be returned.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "pageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
+ "type": "string"
+ }
+ },
+ "id": "SearchVariantSetsRequest"
+ },
+ "VariantSetMetadata": {
+ "description": "Metadata describes a single piece of variant call metadata.\nThese data include a top level key and either a single value string (value)\nor a list of key-value pairs (info.)\nValue and info are mutually exclusive.",
+ "type": "object",
+ "properties": {
+ "key": {
+ "description": "The top-level key.",
+ "type": "string"
+ },
+ "description": {
+ "description": "A textual description of this metadata.",
+ "type": "string"
+ },
+ "info": {
+ "description": "Remaining structured metadata key-value pairs. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
+ "type": "object",
+ "additionalProperties": {
+ "items": {
+ "type": "any"
+ },
+ "type": "array"
+ }
+ },
+ "type": {
+ "description": "The type of data. Possible types include: Integer, Float,\nFlag, Character, and String.",
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "INTEGER",
+ "FLOAT",
+ "FLAG",
+ "CHARACTER",
+ "STRING"
+ ]
+ },
+ "number": {
+ "description": "The number of values that can be included in a field described by this\nmetadata.",
+ "type": "string"
+ },
+ "id": {
+ "description": "User-provided ID field, not enforced by this API.\nTwo or more pieces of structured metadata with identical\nid and key fields are considered equivalent.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The value field for simple metadata",
+ "type": "string"
+ }
+ },
+ "id": "VariantSetMetadata"
+ },
+ "Reference": {
+ "description": "A reference is a canonical assembled DNA sequence, intended to act as a\nreference coordinate space for other genomic annotations. A single reference\nmight represent the human chromosome 1 or mitochandrial DNA, for instance. A\nreference belongs to one or more reference sets.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "type": "object",
+ "properties": {
+ "md5checksum": {
+ "description": "MD5 of the upper-case sequence excluding all whitespace characters (this\nis equivalent to SQ:M5 in SAM). This value is represented in lower case\nhexadecimal format.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The server-generated reference ID, unique across all references.",
+ "type": "string"
+ },
+ "length": {
+ "format": "int64",
+ "description": "The length of this reference's sequence.",
+ "type": "string"
+ },
+ "sourceAccessions": {
+ "description": "All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally\nwith a version number, for example `GCF_000001405.26`.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "ncbiTaxonId": {
+ "format": "int32",
+ "description": "ID from http://www.ncbi.nlm.nih.gov/taxonomy. For example, 9606 for human.",
+ "type": "integer"
+ },
+ "sourceUri": {
+ "description": "The URI from which the sequence was obtained. Typically specifies a FASTA\nformat file.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of this reference, for example `22`.",
+ "type": "string"
+ }
+ },
+ "id": "Reference"
+ },
+ "SearchReferenceSetsRequest": {
+ "type": "object",
+ "properties": {
+ "pageSize": {
+ "format": "int32",
+ "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024. The maximum value is 4096.",
+ "type": "integer"
+ },
+ "assemblyId": {
+ "description": "If present, return reference sets for which a substring of their\n`assemblyId` matches this string (case insensitive).",
+ "type": "string"
+ },
+ "md5checksums": {
+ "description": "If present, return reference sets for which the\nmd5checksum matches exactly.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "pageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
+ "type": "string"
+ },
+ "accessions": {
+ "description": "If present, return reference sets for which a prefix of any of\nsourceAccessions\nmatch any of these strings. Accession numbers typically have a main number\nand a version, for example `NC_000001.11`.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "SearchReferenceSetsRequest"
+ },
+ "SetIamPolicyRequest": {
+ "description": "Request message for `SetIamPolicy` method.",
+ "type": "object",
+ "properties": {
+ "policy": {
+ "$ref": "Policy",
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
+ }
+ },
+ "id": "SetIamPolicyRequest"
+ },
+ "MergeVariantsRequest": {
+ "type": "object",
+ "properties": {
+ "infoMergeConfig": {
+ "additionalProperties": {
+ "enum": [
+ "INFO_MERGE_OPERATION_UNSPECIFIED",
+ "IGNORE_NEW",
+ "MOVE_TO_CALLS"
+ ],
+ "type": "string"
+ },
+ "description": "A mapping between info field keys and the InfoMergeOperations to\nbe performed on them.",
+ "type": "object"
+ },
+ "variantSetId": {
+ "description": "The destination variant set.",
+ "type": "string"
+ },
+ "variants": {
+ "description": "The variants to be merged with existing variants.",
+ "items": {
+ "$ref": "Variant"
+ },
+ "type": "array"
+ }
+ },
+ "id": "MergeVariantsRequest"
+ },
+ "BatchCreateAnnotationsRequest": {
+ "type": "object",
+ "properties": {
+ "annotations": {
+ "description": "The annotations to be created. At most 4096 can be specified in a single\nrequest.",
+ "items": {
+ "$ref": "Annotation"
+ },
+ "type": "array"
+ },
+ "requestId": {
+ "description": "A unique request ID which enables the server to detect duplicated requests.\nIf provided, duplicated requests will result in the same response; if not\nprovided, duplicated requests may result in duplicated data. For a given\nannotation set, callers should not reuse `request_id`s when writing\ndifferent batches of annotations - behavior in this case is undefined.\nA common approach is to use a UUID. For batch jobs where worker crashes are\na possibility, consider using some unique variant of a worker or run ID.",
+ "type": "string"
+ }
+ },
+ "id": "BatchCreateAnnotationsRequest"
+ },
+ "Read": {
+ "description": "A read alignment describes a linear alignment of a string of DNA to a\nreference sequence, in addition to metadata\nabout the fragment (the molecule of DNA sequenced) and the read (the bases\nwhich were read by the sequencer). A read is equivalent to a line in a SAM\nfile. A read belongs to exactly one read group and exactly one\nread group set.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\n### Reverse-stranded reads\n\nMapped reads (reads having a non-null `alignment`) can be aligned to either\nthe forward or the reverse strand of their associated reference. Strandedness\nof a mapped read is encoded by `alignment.position.reverseStrand`.\n\nIf we consider the reference to be a forward-stranded coordinate space of\n`[0, reference.length)` with `0` as the left-most position and\n`reference.length` as the right-most position, reads are always aligned left\nto right. That is, `alignment.position.position` always refers to the\nleft-most reference coordinate and `alignment.cigar` describes the alignment\nof this read to the reference from left to right. All per-base fields such as\n`alignedSequence` and `alignedQuality` share this same left-to-right\norientation; this is true of reads which are aligned to either strand. For\nreverse-stranded reads, this means that `alignedSequence` is the reverse\ncomplement of the bases that were originally reported by the sequencing\nmachine.\n\n### Generating a reference-aligned sequence string\n\nWhen interacting with mapped reads, it's often useful to produce a string\nrepresenting the local alignment of the read to reference. The following\npseudocode demonstrates one way of doing this:\n\n out = \"\"\n offset = 0\n for c in read.alignment.cigar {\n switch c.operation {\n case \"ALIGNMENT_MATCH\", \"SEQUENCE_MATCH\", \"SEQUENCE_MISMATCH\":\n out += read.alignedSequence[offset:offset+c.operationLength]\n offset += c.operationLength\n break\n case \"CLIP_SOFT\", \"INSERT\":\n offset += c.operationLength\n break\n case \"PAD\":\n out += repeat(\"*\", c.operationLength)\n break\n case \"DELETE\":\n out += repeat(\"-\", c.operationLength)\n break\n case \"SKIP\":\n out += repeat(\" \", c.operationLength)\n break\n case \"CLIP_HARD\":\n break\n }\n }\n return out\n\n### Converting to SAM's CIGAR string\n\nThe following pseudocode generates a SAM CIGAR string from the\n`cigar` field. Note that this is a lossy conversion\n(`cigar.referenceSequence` is lost).\n\n cigarMap = {\n \"ALIGNMENT_MATCH\": \"M\",\n \"INSERT\": \"I\",\n \"DELETE\": \"D\",\n \"SKIP\": \"N\",\n \"CLIP_SOFT\": \"S\",\n \"CLIP_HARD\": \"H\",\n \"PAD\": \"P\",\n \"SEQUENCE_MATCH\": \"=\",\n \"SEQUENCE_MISMATCH\": \"X\",\n }\n cigarStr = \"\"\n for c in read.alignment.cigar {\n cigarStr += c.operationLength + cigarMap[c.operation]\n }\n return cigarStr",
+ "type": "object",
+ "properties": {
+ "fragmentLength": {
+ "format": "int32",
+ "description": "The observed length of the fragment, equivalent to TLEN in SAM.",
+ "type": "integer"
+ },
+ "failedVendorQualityChecks": {
+ "description": "Whether this read did not pass filters, such as platform or vendor quality\ncontrols (SAM flag 0x200).",
+ "type": "boolean"
+ },
+ "alignedQuality": {
+ "description": "The quality of the read sequence contained in this alignment record\n(equivalent to QUAL in SAM).\n`alignedSequence` and `alignedQuality` may be shorter than the full read\nsequence and quality. This will occur if the alignment is part of a\nchimeric alignment, or if the read was trimmed. When this occurs, the CIGAR\nfor this read will begin/end with a hard clip operator that will indicate\nthe length of the excised sequence.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "alignment": {
+ "description": "The linear alignment for this alignment record. This field is null for\nunmapped reads.",
+ "$ref": "LinearAlignment"
+ },
+ "numberReads": {
+ "format": "int32",
+ "description": "The number of reads in the fragment (extension to SAM flag 0x1).",
+ "type": "integer"
+ },
+ "id": {
+ "description": "The server-generated read ID, unique across all reads. This is different\nfrom the `fragmentName`.",
+ "type": "string"
+ },
+ "secondaryAlignment": {
+ "description": "Whether this alignment is secondary. Equivalent to SAM flag 0x100.\nA secondary alignment represents an alternative to the primary alignment\nfor this read. Aligners may return secondary alignments if a read can map\nambiguously to multiple coordinates in the genome. By convention, each read\nhas one and only one alignment where both `secondaryAlignment`\nand `supplementaryAlignment` are false.",
+ "type": "boolean"
+ },
+ "fragmentName": {
+ "description": "The fragment name. Equivalent to QNAME (query template name) in SAM.",
+ "type": "string"
+ },
+ "readGroupSetId": {
+ "description": "The ID of the read group set this read belongs to. A read belongs to\nexactly one read group set.",
+ "type": "string"
+ },
+ "duplicateFragment": {
+ "description": "The fragment is a PCR or optical duplicate (SAM flag 0x400).",
+ "type": "boolean"
+ },
+ "readNumber": {
+ "format": "int32",
+ "description": "The read number in sequencing. 0-based and less than numberReads. This\nfield replaces SAM flag 0x40 and 0x80.",
+ "type": "integer"
+ },
+ "alignedSequence": {
+ "description": "The bases of the read sequence contained in this alignment record,\n**without CIGAR operations applied** (equivalent to SEQ in SAM).\n`alignedSequence` and `alignedQuality` may be\nshorter than the full read sequence and quality. This will occur if the\nalignment is part of a chimeric alignment, or if the read was trimmed. When\nthis occurs, the CIGAR for this read will begin/end with a hard clip\noperator that will indicate the length of the excised sequence.",
+ "type": "string"
+ },
+ "readGroupId": {
+ "description": "The ID of the read group this read belongs to. A read belongs to exactly\none read group. This is a server-generated ID which is distinct from SAM's\nRG tag (for that value, see\nReadGroup.name).",
+ "type": "string"
+ },
+ "nextMatePosition": {
+ "$ref": "Position",
+ "description": "The mapping of the primary alignment of the\n`(readNumber+1)%numberReads` read in the fragment. It replaces\nmate position and mate strand in SAM."
+ },
+ "info": {
+ "description": "A map of additional read alignment information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
+ "type": "object",
+ "additionalProperties": {
+ "items": {
+ "type": "any"
+ },
+ "type": "array"
+ }
+ },
+ "properPlacement": {
+ "description": "The orientation and the distance between reads from the fragment are\nconsistent with the sequencing protocol (SAM flag 0x2).",
+ "type": "boolean"
+ },
+ "supplementaryAlignment": {
+ "description": "Whether this alignment is supplementary. Equivalent to SAM flag 0x800.\nSupplementary alignments are used in the representation of a chimeric\nalignment. In a chimeric alignment, a read is split into multiple\nlinear alignments that map to different reference contigs. The first\nlinear alignment in the read will be designated as the representative\nalignment; the remaining linear alignments will be designated as\nsupplementary alignments. These alignments may have different mapping\nquality scores. In each linear alignment in a chimeric alignment, the read\nwill be hard clipped. The `alignedSequence` and\n`alignedQuality` fields in the alignment record will only\nrepresent the bases for its respective linear alignment.",
+ "type": "boolean"
+ }
+ },
+ "id": "Read"
+ },
+ "ReferenceSet": {
+ "description": "A reference set is a set of references which typically comprise a reference\nassembly for a species, such as `GRCh38` which is representative\nof the human genome. A reference set defines a common coordinate space for\ncomparing reference-aligned experimental data. A reference set contains 1 or\nmore references.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "type": "object",
+ "properties": {
+ "referenceIds": {
+ "description": "The IDs of the reference objects that are part of this set.\n`Reference.md5checksum` must be unique within this set.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "md5checksum": {
+ "description": "Order-independent MD5 checksum which identifies this reference set. The\nchecksum is computed by sorting all lower case hexidecimal string\n`reference.md5checksum` (for all reference in this set) in\nascending lexicographic order, concatenating, and taking the MD5 of that\nvalue. The resulting value is represented in lower case hexadecimal format.",
+ "type": "string"
+ },
+ "assemblyId": {
+ "description": "Public id of this reference set, such as `GRCh37`.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The server-generated reference set ID, unique across all reference sets.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Free text description of this reference set.",
+ "type": "string"
+ },
+ "sourceAccessions": {
+ "description": "All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally\nwith a version number, for example `NC_000001.11`.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "sourceUri": {
+ "description": "The URI from which the references were obtained.",
+ "type": "string"
+ },
+ "ncbiTaxonId": {
+ "format": "int32",
+ "description": "ID from http://www.ncbi.nlm.nih.gov/taxonomy (for example, 9606 for human)\nindicating the species which this reference set is intended to model. Note\nthat contained references may specify a different `ncbiTaxonId`, as\nassemblies may contain reference sequences which do not belong to the\nmodeled species, for example EBV in a human reference genome.",
+ "type": "integer"
+ }
+ },
+ "id": "ReferenceSet"
+ },
+ "CigarUnit": {
+ "description": "A single CIGAR operation.",
+ "type": "object",
+ "properties": {
+ "operationLength": {
+ "format": "int64",
+ "description": "The number of genomic bases that the operation runs for. Required.",
+ "type": "string"
+ },
+ "operation": {
+ "enumDescriptions": [
+ "",
+ "An alignment match indicates that a sequence can be aligned to the\nreference without evidence of an INDEL. Unlike the\n`SEQUENCE_MATCH` and `SEQUENCE_MISMATCH` operators,\nthe `ALIGNMENT_MATCH` operator does not indicate whether the\nreference and read sequences are an exact match. This operator is\nequivalent to SAM's `M`.",
+ "The insert operator indicates that the read contains evidence of bases\nbeing inserted into the reference. This operator is equivalent to SAM's\n`I`.",
+ "The delete operator indicates that the read contains evidence of bases\nbeing deleted from the reference. This operator is equivalent to SAM's\n`D`.",
+ "The skip operator indicates that this read skips a long segment of the\nreference, but the bases have not been deleted. This operator is commonly\nused when working with RNA-seq data, where reads may skip long segments\nof the reference between exons. This operator is equivalent to SAM's\n`N`.",
+ "The soft clip operator indicates that bases at the start/end of a read\nhave not been considered during alignment. This may occur if the majority\nof a read maps, except for low quality bases at the start/end of a read.\nThis operator is equivalent to SAM's `S`. Bases that are soft\nclipped will still be stored in the read.",
+ "The hard clip operator indicates that bases at the start/end of a read\nhave been omitted from this alignment. This may occur if this linear\nalignment is part of a chimeric alignment, or if the read has been\ntrimmed (for example, during error correction or to trim poly-A tails for\nRNA-seq). This operator is equivalent to SAM's `H`.",
+ "The pad operator indicates that there is padding in an alignment. This\noperator is equivalent to SAM's `P`.",
+ "This operator indicates that this portion of the aligned sequence exactly\nmatches the reference. This operator is equivalent to SAM's `=`.",
+ "This operator indicates that this portion of the aligned sequence is an\nalignment match to the reference, but a sequence mismatch. This can\nindicate a SNP or a read error. This operator is equivalent to SAM's\n`X`."
+ ],
+ "enum": [
+ "OPERATION_UNSPECIFIED",
+ "ALIGNMENT_MATCH",
+ "INSERT",
+ "DELETE",
+ "SKIP",
+ "CLIP_SOFT",
+ "CLIP_HARD",
+ "PAD",
+ "SEQUENCE_MATCH",
+ "SEQUENCE_MISMATCH"
+ ],
+ "type": "string"
+ },
+ "referenceSequence": {
+ "description": "`referenceSequence` is only used at mismatches\n(`SEQUENCE_MISMATCH`) and deletions (`DELETE`).\nFilling this field replaces SAM's MD tag. If the relevant information is\nnot available, this field is unset.",
+ "type": "string"
+ }
+ },
+ "id": "CigarUnit"
+ },
+ "AnnotationSet": {
+ "description": "An annotation set is a logical grouping of annotations that share consistent\ntype information and provenance. Examples of annotation sets include 'all\ngenes from refseq', and 'all variant annotations from ClinVar'.",
+ "type": "object",
+ "properties": {
+ "sourceUri": {
+ "description": "The source URI describing the file from which this annotation set was\ngenerated, if any.",
+ "type": "string"
+ },
+ "datasetId": {
+ "description": "The dataset to which this annotation set belongs.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The display name for this annotation set.",
+ "type": "string"
+ },
+ "referenceSetId": {
+ "description": "The ID of the reference set that defines the coordinate space for this\nset's annotations.",
+ "type": "string"
+ },
+ "type": {
+ "enumDescriptions": [
+ "",
+ "A `GENERIC` annotation type should be used when no other annotation\ntype will suffice. This represents an untyped annotation of the reference\ngenome.",
+ "A `VARIANT` annotation type.",
+ "A `GENE` annotation type represents the existence of a gene at the\nassociated reference coordinates. The start coordinate is typically the\ngene's transcription start site and the end is typically the end of the\ngene's last exon.",
+ "A `TRANSCRIPT` annotation type represents the assertion that a\nparticular region of the reference genome may be transcribed as RNA."
+ ],
+ "enum": [
+ "ANNOTATION_TYPE_UNSPECIFIED",
+ "GENERIC",
+ "VARIANT",
+ "GENE",
+ "TRANSCRIPT"
+ ],
+ "description": "The type of annotations contained within this set.",
+ "type": "string"
+ },
+ "info": {
+ "additionalProperties": {
+ "items": {
+ "type": "any"
+ },
+ "type": "array"
+ },
+ "description": "A map of additional read alignment information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
+ "type": "object"
+ },
+ "id": {
+ "description": "The server-generated annotation set ID, unique across all annotation sets.",
+ "type": "string"
+ }
+ },
+ "id": "AnnotationSet"
+ },
+ "Transcript": {
+ "description": "A transcript represents the assertion that a particular region of the\nreference genome may be transcribed as RNA.",
+ "type": "object",
+ "properties": {
+ "geneId": {
+ "description": "The annotation ID of the gene from which this transcript is transcribed.",
+ "type": "string"
+ },
+ "exons": {
+ "description": "The \u003ca href=\"http://en.wikipedia.org/wiki/Exon\"\u003eexons\u003c/a\u003e that compose\nthis transcript. This field should be unset for genomes where transcript\nsplicing does not occur, for example prokaryotes.\n\nIntrons are regions of the transcript that are not included in the\nspliced RNA product. Though not explicitly modeled here, intron ranges can\nbe deduced; all regions of this transcript that are not exons are introns.\n\nExonic sequences do not necessarily code for a translational product\n(amino acids). Only the regions of exons bounded by the\ncodingSequence correspond\nto coding DNA sequence.\n\nExons are ordered by start position and may not overlap.",
+ "items": {
+ "$ref": "Exon"
+ },
+ "type": "array"
+ },
+ "codingSequence": {
+ "description": "The range of the coding sequence for this transcript, if any. To determine\nthe exact ranges of coding sequence, intersect this range with those of the\nexons, if any. If there are any\nexons, the\ncodingSequence must start\nand end within them.\n\nNote that in some cases, the reference genome will not exactly match the\nobserved mRNA transcript e.g. due to variance in the source genome from\nreference. In these cases,\nexon.frame will not necessarily\nmatch the expected reference reading frame and coding exon reference bases\ncannot necessarily be concatenated to produce the original transcript mRNA.",
+ "$ref": "CodingSequence"
+ }
+ },
+ "id": "Transcript"
+ },
+ "Experiment": {
+ "type": "object",
+ "properties": {
+ "platformUnit": {
+ "description": "The platform unit used as part of this experiment, for example\nflowcell-barcode.lane for Illumina or slide for SOLiD. Corresponds to the\n@RG PU field in the SAM spec.",
+ "type": "string"
+ },
+ "instrumentModel": {
+ "description": "The instrument model used as part of this experiment. This maps to\nsequencing technology in the SAM spec.",
+ "type": "string"
+ },
+ "libraryId": {
+ "description": "A client-supplied library identifier; a library is a collection of DNA\nfragments which have been prepared for sequencing from a sample. This\nfield is important for quality control as error or bias can be introduced\nduring sample preparation.",
+ "type": "string"
+ },
+ "sequencingCenter": {
+ "description": "The sequencing center used as part of this experiment.",
+ "type": "string"
+ }
+ },
+ "id": "Experiment"
+ },
+ "ListDatasetsResponse": {
+ "description": "The dataset list response.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
+ "type": "string"
+ },
+ "datasets": {
+ "description": "The list of matching Datasets.",
+ "items": {
+ "$ref": "Dataset"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListDatasetsResponse"
+ },
+ "TestIamPermissionsRequest": {
+ "description": "Request message for `TestIamPermissions` method.",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "description": "REQUIRED: The set of permissions to check for the 'resource'.\nPermissions with wildcards (such as '*' or 'storage.*') are not allowed.\nAllowed permissions are:\n\n* `genomics.datasets.create`\n* `genomics.datasets.delete`\n* `genomics.datasets.get`\n* `genomics.datasets.list`\n* `genomics.datasets.update`\n* `genomics.datasets.getIamPolicy`\n* `genomics.datasets.setIamPolicy`",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "TestIamPermissionsRequest"
+ },
+ "Exon": {
+ "type": "object",
+ "properties": {
+ "frame": {
+ "format": "int32",
+ "description": "The frame of this exon. Contains a value of 0, 1, or 2, which indicates\nthe offset of the first coding base of the exon within the reading frame\nof the coding DNA sequence, if any. This field is dependent on the\nstrandedness of this annotation (see\nAnnotation.reverse_strand).\nFor forward stranded annotations, this offset is relative to the\nexon.start. For reverse\nstrand annotations, this offset is relative to the\nexon.end `- 1`.\n\nUnset if this exon does not intersect the coding sequence. Upon creation\nof a transcript, the frame must be populated for all or none of the\ncoding exons.",
+ "type": "integer"
+ },
+ "end": {
+ "format": "int64",
+ "description": "The end position of the exon on this annotation's reference sequence,\n0-based exclusive. Note that this is relative to the reference start, and\n*not* the containing annotation start.",
+ "type": "string"
+ },
+ "start": {
+ "format": "int64",
+ "description": "The start position of the exon on this annotation's reference sequence,\n0-based inclusive. Note that this is relative to the reference start, and\n**not** the containing annotation start.",
+ "type": "string"
+ }
+ },
+ "id": "Exon"
+ },
+ "ExportReadGroupSetRequest": {
+ "description": "The read group set export request.",
+ "type": "object",
+ "properties": {
+ "projectId": {
+ "description": "Required. The Google Cloud project ID that owns this\nexport. The caller must have WRITE access to this project.",
+ "type": "string"
+ },
+ "referenceNames": {
+ "description": "The reference names to export. If this is not specified, all reference\nsequences, including unmapped reads, are exported.\nUse `*` to export only unmapped reads.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "exportUri": {
+ "description": "Required. A Google Cloud Storage URI for the exported BAM file.\nThe currently authenticated user must have write access to the new file.\nAn error will be returned if the URI already contains data.",
+ "type": "string"
+ }
+ },
+ "id": "ExportReadGroupSetRequest"
+ },
+ "CallSet": {
+ "description": "A call set is a collection of variant calls, typically for one sample. It\nbelongs to a variant set.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "type": "object",
+ "properties": {
+ "created": {
+ "format": "int64",
+ "description": "The date this call set was created in milliseconds from the epoch.",
+ "type": "string"
+ },
+ "sampleId": {
+ "description": "The sample ID this call set corresponds to.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The call set name.",
+ "type": "string"
+ },
+ "info": {
+ "description": "A map of additional call set information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
+ "type": "object",
+ "additionalProperties": {
+ "items": {
+ "type": "any"
+ },
+ "type": "array"
+ }
+ },
+ "variantSetIds": {
+ "description": "The IDs of the variant sets this call set belongs to. This field must\nhave exactly length one, as a call set belongs to a single variant set.\nThis field is repeated for compatibility with the\n[GA4GH 0.5.1\nAPI](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variants.avdl#L76).",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "The server-generated call set ID, unique across all call sets.",
+ "type": "string"
+ }
+ },
+ "id": "CallSet"
+ },
+ "SearchAnnotationSetsResponse": {
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
+ "type": "string"
+ },
+ "annotationSets": {
+ "description": "The matching annotation sets.",
+ "items": {
+ "$ref": "AnnotationSet"
+ },
+ "type": "array"
+ }
+ },
+ "id": "SearchAnnotationSetsResponse"
+ },
+ "ImportVariantsRequest": {
+ "description": "The variant data import request.",
+ "type": "object",
+ "properties": {
+ "format": {
+ "enumDescriptions": [
+ "",
+ "VCF (Variant Call Format). The VCF files may be gzip compressed. gVCF is\nalso supported. Disclaimer: gzip VCF imports are currently much slower\nthan equivalent uncompressed VCF imports. For this reason, uncompressed\nVCF is currently recommended for imports with more than 1GB combined\nuncompressed size, or for time sensitive imports.",
+ "Complete Genomics masterVarBeta format. The masterVarBeta files may\nbe bzip2 compressed."
+ ],
+ "enum": [
+ "FORMAT_UNSPECIFIED",
+ "FORMAT_VCF",
+ "FORMAT_COMPLETE_GENOMICS"
+ ],
+ "description": "The format of the variant data being imported. If unspecified, defaults to\nto `VCF`.",
+ "type": "string"
+ },
+ "infoMergeConfig": {
+ "additionalProperties": {
+ "enum": [
+ "INFO_MERGE_OPERATION_UNSPECIFIED",
+ "IGNORE_NEW",
+ "MOVE_TO_CALLS"
+ ],
+ "type": "string"
+ },
+ "description": "A mapping between info field keys and the InfoMergeOperations to\nbe performed on them. This is plumbed down to the MergeVariantRequests\ngenerated by the resulting import job.",
+ "type": "object"
+ },
+ "sourceUris": {
+ "description": "A list of URIs referencing variant files in Google Cloud Storage. URIs can\ninclude wildcards [as described\nhere](https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames).\nNote that recursive wildcards ('**') are not supported.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "variantSetId": {
+ "description": "Required. The variant set to which variant data should be imported.",
+ "type": "string"
+ },
+ "normalizeReferenceNames": {
+ "description": "Convert reference names to the canonical representation.\nhg19 haploytypes (those reference names containing \"_hap\")\nare not modified in any way.\nAll other reference names are modified according to the following rules:\nThe reference name is capitalized.\nThe \"chr\" prefix is dropped for all autosomes and sex chromsomes.\nFor example \"chr17\" becomes \"17\" and \"chrX\" becomes \"X\".\nAll mitochondrial chromosomes (\"chrM\", \"chrMT\", etc) become \"MT\".",
+ "type": "boolean"
+ }
+ },
+ "id": "ImportVariantsRequest"
+ },
+ "ListCoverageBucketsResponse": {
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
+ "type": "string"
+ },
+ "bucketWidth": {
+ "format": "int64",
+ "description": "The length of each coverage bucket in base pairs. Note that buckets at the\nend of a reference sequence may be shorter. This value is omitted if the\nbucket width is infinity (the default behaviour, with no range or\n`targetBucketWidth`).",
+ "type": "string"
+ },
+ "coverageBuckets": {
+ "description": "The coverage buckets. The list of buckets is sparse; a bucket with 0\noverlapping reads is not returned. A bucket never crosses more than one\nreference sequence. Each bucket has width `bucketWidth`, unless\nits end is the end of the reference sequence.",
+ "items": {
+ "$ref": "CoverageBucket"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListCoverageBucketsResponse"
+ },
+ "VariantAnnotation": {
+ "type": "object",
+ "properties": {
+ "transcriptIds": {
+ "description": "Google annotation IDs of the transcripts affected by this variant. These\nshould be provided when the variant is created.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "type": {
+ "enumDescriptions": [
+ "",
+ "`TYPE_OTHER` should be used when no other Type will suffice.\nFurther explanation of the variant type may be included in the\ninfo field.",
+ "`INSERTION` indicates an insertion.",
+ "`DELETION` indicates a deletion.",
+ "`SUBSTITUTION` indicates a block substitution of\ntwo or more nucleotides.",
+ "`SNP` indicates a single nucleotide polymorphism.",
+ "`STRUCTURAL` indicates a large structural variant,\nincluding chromosomal fusions, inversions, etc.",
+ "`CNV` indicates a variation in copy number."
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "TYPE_OTHER",
+ "INSERTION",
+ "DELETION",
+ "SUBSTITUTION",
+ "SNP",
+ "STRUCTURAL",
+ "CNV"
+ ],
+ "description": "Type has been adapted from ClinVar's list of variant types.",
+ "type": "string"
+ },
+ "alternateBases": {
+ "description": "The alternate allele for this variant. If multiple alternate alleles\nexist at this location, create a separate variant for each one, as they\nmay represent distinct conditions.",
+ "type": "string"
+ },
+ "geneId": {
+ "description": "Google annotation ID of the gene affected by this variant. This should\nbe provided when the variant is created.",
+ "type": "string"
+ },
+ "clinicalSignificance": {
+ "description": "Describes the clinical significance of a variant.\nIt is adapted from the ClinVar controlled vocabulary for clinical\nsignificance described at:\nhttp://www.ncbi.nlm.nih.gov/clinvar/docs/clinsig/",
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "`OTHER` should be used when no other clinical significance\nvalue will suffice.",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "`MULTIPLE_REPORTED` should be used when multiple clinical\nsignficances are reported for a variant. The original clinical\nsignificance values may be provided in the `info` field."
+ ],
+ "enum": [
+ "CLINICAL_SIGNIFICANCE_UNSPECIFIED",
+ "CLINICAL_SIGNIFICANCE_OTHER",
+ "UNCERTAIN",
+ "BENIGN",
+ "LIKELY_BENIGN",
+ "LIKELY_PATHOGENIC",
+ "PATHOGENIC",
+ "DRUG_RESPONSE",
+ "HISTOCOMPATIBILITY",
+ "CONFERS_SENSITIVITY",
+ "RISK_FACTOR",
+ "ASSOCIATION",
+ "PROTECTIVE",
+ "MULTIPLE_REPORTED"
+ ]
+ },
+ "conditions": {
+ "description": "The set of conditions associated with this variant.\nA condition describes the way a variant influences human health.",
+ "items": {
+ "$ref": "ClinicalCondition"
+ },
+ "type": "array"
+ },
+ "effect": {
+ "enumDescriptions": [
+ "",
+ "`EFFECT_OTHER` should be used when no other Effect\nwill suffice.",
+ "`FRAMESHIFT` indicates a mutation in which the insertion or\ndeletion of nucleotides resulted in a frameshift change.",
+ "`FRAME_PRESERVING_INDEL` indicates a mutation in which a\nmultiple of three nucleotides has been inserted or deleted, resulting\nin no change to the reading frame of the coding sequence.",
+ "`SYNONYMOUS_SNP` indicates a single nucleotide polymorphism\nmutation that results in no amino acid change.",
+ "`NONSYNONYMOUS_SNP` indicates a single nucleotide\npolymorphism mutation that results in an amino acid change.",
+ "`STOP_GAIN` indicates a mutation that leads to the creation\nof a stop codon at the variant site. Frameshift mutations creating\ndownstream stop codons do not count as `STOP_GAIN`.",
+ "`STOP_LOSS` indicates a mutation that eliminates a\nstop codon at the variant site.",
+ "`SPLICE_SITE_DISRUPTION` indicates that this variant is\nfound in a splice site for the associated transcript, and alters the\nnormal splicing pattern."
+ ],
+ "enum": [
+ "EFFECT_UNSPECIFIED",
+ "EFFECT_OTHER",
+ "FRAMESHIFT",
+ "FRAME_PRESERVING_INDEL",
+ "SYNONYMOUS_SNP",
+ "NONSYNONYMOUS_SNP",
+ "STOP_GAIN",
+ "STOP_LOSS",
+ "SPLICE_SITE_DISRUPTION"
+ ],
+ "description": "Effect of the variant on the coding sequence.",
+ "type": "string"
+ }
+ },
+ "id": "VariantAnnotation"
+ },
+ "ExportVariantSetRequest": {
+ "description": "The variant data export request.",
+ "type": "object",
+ "properties": {
+ "bigqueryTable": {
+ "description": "Required. The BigQuery table to export data to.\nIf the table doesn't exist, it will be created. If it already exists, it\nwill be overwritten.",
+ "type": "string"
+ },
+ "bigqueryDataset": {
+ "description": "Required. The BigQuery dataset to export data to. This dataset must already\nexist. Note that this is distinct from the Genomics concept of \"dataset\".",
+ "type": "string"
+ },
+ "format": {
+ "enumDescriptions": [
+ "",
+ "Export the data to Google BigQuery."
+ ],
+ "enum": [
+ "FORMAT_UNSPECIFIED",
+ "FORMAT_BIGQUERY"
+ ],
+ "description": "The format for the exported data.",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "Required. The Google Cloud project ID that owns the destination\nBigQuery dataset. The caller must have WRITE access to this project. This\nproject will also own the resulting export job.",
+ "type": "string"
+ },
+ "callSetIds": {
+ "description": "If provided, only variant call information from the specified call sets\nwill be exported. By default all variant calls are exported.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ExportVariantSetRequest"
+ },
+ "SearchAnnotationsRequest": {
+ "type": "object",
+ "properties": {
+ "pageSize": {
+ "format": "int32",
+ "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 256. The maximum value is 2048.",
+ "type": "integer"
+ },
+ "start": {
+ "format": "int64",
+ "description": "The start position of the range on the reference, 0-based inclusive. If\nspecified,\nreferenceId or\nreferenceName\nmust be specified. Defaults to 0.",
+ "type": "string"
+ },
+ "annotationSetIds": {
+ "description": "Required. The annotation sets to search within. The caller must have\n`READ` access to these annotation sets.\nAll queried annotation sets must have the same type.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "referenceName": {
+ "description": "The name of the reference to query, within the reference set associated\nwith this query.",
+ "type": "string"
+ },
+ "referenceId": {
+ "description": "The ID of the reference to query.",
+ "type": "string"
+ },
+ "end": {
+ "format": "int64",
+ "description": "The end position of the range on the reference, 0-based exclusive. If\nreferenceId or\nreferenceName\nmust be specified, Defaults to the length of the reference.",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
+ "type": "string"
+ }
+ },
+ "id": "SearchAnnotationsRequest"
+ },
+ "OperationEvent": {
+ "description": "An event that occurred during an Operation.",
+ "type": "object",
+ "properties": {
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Optional time of when event finished. An event can have a start time and no\nfinish time. If an event has a finish time, there must be a start time.",
+ "type": "string"
+ },
+ "startTime": {
+ "format": "google-datetime",
+ "description": "Optional time of when event started.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Required description of event.",
+ "type": "string"
+ }
+ },
+ "id": "OperationEvent"
+ },
+ "CodingSequence": {
+ "type": "object",
+ "properties": {
+ "end": {
+ "format": "int64",
+ "description": "The end of the coding sequence on this annotation's reference sequence,\n0-based exclusive. Note that this position is relative to the reference\nstart, and *not* the containing annotation start.",
+ "type": "string"
+ },
+ "start": {
+ "format": "int64",
+ "description": "The start of the coding sequence on this annotation's reference sequence,\n0-based inclusive. Note that this position is relative to the reference\nstart, and *not* the containing annotation start.",
+ "type": "string"
+ }
+ },
+ "id": "CodingSequence"
+ },
+ "TestIamPermissionsResponse": {
+ "description": "Response message for `TestIamPermissions` method.",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "TestIamPermissionsResponse"
+ },
+ "GetIamPolicyRequest": {
+ "description": "Request message for `GetIamPolicy` method.",
+ "type": "object",
+ "properties": {},
+ "id": "GetIamPolicyRequest"
+ },
+ "SearchReferencesResponse": {
+ "type": "object",
+ "properties": {
+ "references": {
+ "description": "The matching references.",
+ "items": {
+ "$ref": "Reference"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
+ "type": "string"
+ }
+ },
+ "id": "SearchReferencesResponse"
+ },
"SearchAnnotationSetsRequest": {
"type": "object",
"properties": {
+ "referenceSetId": {
+ "description": "If specified, only annotation sets associated with the given reference set\nare returned.",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 128. The maximum value is 1024.",
+ "type": "integer"
+ },
"datasetIds": {
"description": "Required. The dataset IDs to search within. Caller must have `READ` access\nto these datasets.",
"items": {
@@ -1618,25 +2643,11 @@
"name": {
"description": "Only return annotations sets for which a substring of the name matches this\nstring (case insensitive).",
"type": "string"
- },
- "referenceSetId": {
- "description": "If specified, only annotation sets associated with the given reference set\nare returned.",
- "type": "string"
- },
- "pageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
- "type": "string"
- },
- "pageSize": {
- "format": "int32",
- "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 128. The maximum value is 1024.",
- "type": "integer"
}
},
"id": "SearchAnnotationSetsRequest"
},
"SearchReadGroupSetsResponse": {
- "id": "SearchReadGroupSetsResponse",
"description": "The read group set search response.",
"type": "object",
"properties": {
@@ -1651,46 +2662,12 @@
},
"type": "array"
}
- }
- },
- "LinearAlignment": {
- "description": "A linear alignment can be represented by one CIGAR string. Describes the\nmapped position and local alignment of the read to the reference.",
- "type": "object",
- "properties": {
- "mappingQuality": {
- "format": "int32",
- "description": "The mapping quality of this alignment. Represents how likely\nthe read maps to this position as opposed to other locations.\n\nSpecifically, this is -10 log10 Pr(mapping position is wrong), rounded to\nthe nearest integer.",
- "type": "integer"
- },
- "cigar": {
- "description": "Represents the local alignment of this sequence (alignment matches, indels,\netc) against the reference.",
- "items": {
- "$ref": "CigarUnit"
- },
- "type": "array"
- },
- "position": {
- "description": "The position of this alignment.",
- "$ref": "Position"
- }
},
- "id": "LinearAlignment"
+ "id": "SearchReadGroupSetsResponse"
},
"SearchReferencesRequest": {
- "id": "SearchReferencesRequest",
"type": "object",
"properties": {
- "pageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
- "type": "string"
- },
- "accessions": {
- "description": "If present, return references for which a prefix of any of\nsourceAccessions match\nany of these strings. Accession numbers typically have a main number and a\nversion, for example `GCF_000001405.26`.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
"pageSize": {
"format": "int32",
"description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024. The maximum value is 4096.",
@@ -1701,18 +2678,58 @@
"type": "string"
},
"md5checksums": {
+ "description": "If present, return references for which the\nmd5checksum matches exactly.",
"items": {
"type": "string"
},
- "type": "array",
- "description": "If present, return references for which the\nmd5checksum matches exactly."
+ "type": "array"
+ },
+ "pageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
+ "type": "string"
+ },
+ "accessions": {
+ "description": "If present, return references for which a prefix of any of\nsourceAccessions match\nany of these strings. Accession numbers typically have a main number and a\nversion, for example `GCF_000001405.26`.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
- }
+ },
+ "id": "SearchReferencesRequest"
+ },
+ "LinearAlignment": {
+ "description": "A linear alignment can be represented by one CIGAR string. Describes the\nmapped position and local alignment of the read to the reference.",
+ "type": "object",
+ "properties": {
+ "cigar": {
+ "description": "Represents the local alignment of this sequence (alignment matches, indels,\netc) against the reference.",
+ "items": {
+ "$ref": "CigarUnit"
+ },
+ "type": "array"
+ },
+ "position": {
+ "$ref": "Position",
+ "description": "The position of this alignment."
+ },
+ "mappingQuality": {
+ "format": "int32",
+ "description": "The mapping quality of this alignment. Represents how likely\nthe read maps to this position as opposed to other locations.\n\nSpecifically, this is -10 log10 Pr(mapping position is wrong), rounded to\nthe nearest integer.",
+ "type": "integer"
+ }
+ },
+ "id": "LinearAlignment"
},
"Dataset": {
"description": "A Dataset is a collection of genomic data.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
"type": "object",
"properties": {
+ "createTime": {
+ "format": "google-datetime",
+ "description": "The time this dataset was created, in seconds from the epoch.",
+ "type": "string"
+ },
"name": {
"description": "The dataset name.",
"type": "string"
@@ -1724,11 +2741,6 @@
"id": {
"description": "The server-generated dataset ID, unique across all datasets.",
"type": "string"
- },
- "createTime": {
- "format": "google-datetime",
- "description": "The time this dataset was created, in seconds from the epoch.",
- "type": "string"
}
},
"id": "Dataset"
@@ -1751,6 +2763,26 @@
"description": "A read group is all the data that's processed the same way by the sequencer.",
"type": "object",
"properties": {
+ "predictedInsertSize": {
+ "format": "int32",
+ "description": "The predicted insert size of this read group. The insert size is the length\nthe sequenced DNA fragment from end-to-end, not including the adapters.",
+ "type": "integer"
+ },
+ "programs": {
+ "description": "The programs used to generate this read group. Programs are always\nidentical for all read groups within a read group set. For this reason,\nonly the first read group in a returned set will have this field\npopulated.",
+ "items": {
+ "$ref": "Program"
+ },
+ "type": "array"
+ },
+ "description": {
+ "description": "A free-form text description of this read group.",
+ "type": "string"
+ },
+ "sampleId": {
+ "description": "A client-supplied sample identifier for the reads in this read group.",
+ "type": "string"
+ },
"datasetId": {
"description": "The dataset to which this read group belongs.",
"type": "string"
@@ -1780,32 +2812,11 @@
"id": {
"description": "The server-generated read group ID, unique for all read groups.\nNote: This is different than the @RG ID field in the SAM spec. For that\nvalue, see name.",
"type": "string"
- },
- "programs": {
- "description": "The programs used to generate this read group. Programs are always\nidentical for all read groups within a read group set. For this reason,\nonly the first read group in a returned set will have this field\npopulated.",
- "items": {
- "$ref": "Program"
- },
- "type": "array"
- },
- "predictedInsertSize": {
- "format": "int32",
- "description": "The predicted insert size of this read group. The insert size is the length\nthe sequenced DNA fragment from end-to-end, not including the adapters.",
- "type": "integer"
- },
- "description": {
- "type": "string",
- "description": "A free-form text description of this read group."
- },
- "sampleId": {
- "type": "string",
- "description": "A client-supplied sample identifier for the reads in this read group."
}
},
"id": "ReadGroup"
},
"ReadGroupSet": {
- "id": "ReadGroupSet",
"description": "A read group set is a logical collection of read groups, which are\ncollections of reads produced by a sequencer. A read group set typically\nmodels reads corresponding to one sample, sequenced one way, and aligned one\nway.\n\n* A read group set belongs to one dataset.\n* A read group belongs to one read group set.\n* A read belongs to one read group.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
"type": "object",
"properties": {
@@ -1846,7 +2857,8 @@
"description": "The server-generated read group set ID, unique for all read group sets.",
"type": "string"
}
- }
+ },
+ "id": "ReadGroupSet"
},
"SearchVariantSetsResponse": {
"description": "The search variant sets response.",
@@ -1876,12 +2888,12 @@
"type": "object",
"properties": {
"annotation": {
- "description": "The created annotation, if creation was successful.",
- "$ref": "Annotation"
+ "$ref": "Annotation",
+ "description": "The created annotation, if creation was successful."
},
"status": {
- "description": "The creation status.",
- "$ref": "Status"
+ "$ref": "Status",
+ "description": "The creation status."
}
},
"id": "Entry"
@@ -1890,10 +2902,6 @@
"description": "An abstraction for referring to a genomic position, in relation to some\nalready known reference. For now, represents a genomic position as a\nreference name, a base number on that reference (0-based), and a\ndetermination of forward or reverse strand.",
"type": "object",
"properties": {
- "reverseStrand": {
- "type": "boolean",
- "description": "Whether this position is on the reverse strand, as opposed to the forward\nstrand."
- },
"position": {
"format": "int64",
"description": "The 0-based offset from the start of the forward strand for that reference.",
@@ -1902,6 +2910,10 @@
"referenceName": {
"description": "The name of the reference in whatever reference set is being used.",
"type": "string"
+ },
+ "reverseStrand": {
+ "description": "Whether this position is on the reverse strand, as opposed to the forward\nstrand.",
+ "type": "boolean"
}
},
"id": "Position"
@@ -1909,22 +2921,32 @@
"SearchReferenceSetsResponse": {
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
- "type": "string"
- },
"referenceSets": {
"description": "The matching references sets.",
"items": {
"$ref": "ReferenceSet"
},
"type": "array"
+ },
+ "nextPageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
+ "type": "string"
}
},
"id": "SearchReferenceSetsResponse"
},
"SearchCallSetsRequest": {
+ "description": "The call set search request.",
+ "type": "object",
"properties": {
+ "pageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Only return call sets for which a substring of the name matches this\nstring.",
+ "type": "string"
+ },
"pageSize": {
"format": "int32",
"description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024.",
@@ -1936,52 +2958,42 @@
"type": "string"
},
"type": "array"
- },
- "pageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
- "type": "string"
- },
- "name": {
- "description": "Only return call sets for which a substring of the name matches this\nstring.",
- "type": "string"
}
},
- "id": "SearchCallSetsRequest",
- "description": "The call set search request.",
- "type": "object"
+ "id": "SearchCallSetsRequest"
},
"ImportReadGroupSetsRequest": {
"description": "The read group set import request.",
"type": "object",
"properties": {
- "referenceSetId": {
- "description": "The reference set to which the imported read group sets are aligned to, if\nany. The reference names of this reference set must be a superset of those\nfound in the imported file headers. If no reference set id is provided, a\nbest effort is made to associate with a matching reference set.",
- "type": "string"
- },
- "partitionStrategy": {
- "enum": [
- "PARTITION_STRATEGY_UNSPECIFIED",
- "PER_FILE_PER_SAMPLE",
- "MERGE_ALL"
- ],
- "description": "The partition strategy describes how read groups are partitioned into read\ngroup sets.",
- "type": "string",
- "enumDescriptions": [
- "",
- "In most cases, this strategy yields one read group set per file. This is\nthe default behavior.\n\nAllocate one read group set per file per sample. For BAM files, read\ngroups are considered to share a sample if they have identical sample\nnames. Furthermore, all reads for each file which do not belong to a read\ngroup, if any, will be grouped into a single read group set per-file.",
- "Includes all read groups in all imported files into a single read group\nset. Requires that the headers for all imported files are equivalent. All\nreads which do not belong to a read group, if any, will be grouped into a\nseparate read group set."
- ]
- },
- "datasetId": {
- "description": "Required. The ID of the dataset these read group sets will belong to. The\ncaller must have WRITE permissions to this dataset.",
- "type": "string"
- },
"sourceUris": {
"description": "A list of URIs pointing at [BAM\nfiles](https://samtools.github.io/hts-specs/SAMv1.pdf)\nin Google Cloud Storage.\nThose URIs can include wildcards (*), but do not add or remove\nmatching files before import has completed.\n\nNote that Google Cloud Storage object listing is only eventually\nconsistent: files added may be not be immediately visible to\neveryone. Thus, if using a wildcard it is preferable not to start\nthe import immediately after the files are created.",
"items": {
"type": "string"
},
"type": "array"
+ },
+ "referenceSetId": {
+ "description": "The reference set to which the imported read group sets are aligned to, if\nany. The reference names of this reference set must be a superset of those\nfound in the imported file headers. If no reference set id is provided, a\nbest effort is made to associate with a matching reference set.",
+ "type": "string"
+ },
+ "partitionStrategy": {
+ "description": "The partition strategy describes how read groups are partitioned into read\ngroup sets.",
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "In most cases, this strategy yields one read group set per file. This is\nthe default behavior.\n\nAllocate one read group set per file per sample. For BAM files, read\ngroups are considered to share a sample if they have identical sample\nnames. Furthermore, all reads for each file which do not belong to a read\ngroup, if any, will be grouped into a single read group set per-file.",
+ "Includes all read groups in all imported files into a single read group\nset. Requires that the headers for all imported files are equivalent. All\nreads which do not belong to a read group, if any, will be grouped into a\nseparate read group set."
+ ],
+ "enum": [
+ "PARTITION_STRATEGY_UNSPECIFIED",
+ "PER_FILE_PER_SAMPLE",
+ "MERGE_ALL"
+ ]
+ },
+ "datasetId": {
+ "description": "Required. The ID of the dataset these read group sets will belong to. The\ncaller must have WRITE permissions to this dataset.",
+ "type": "string"
}
},
"id": "ImportReadGroupSetsRequest"
@@ -1990,6 +3002,13 @@
"description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
"type": "object",
"properties": {
+ "bindings": {
+ "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
+ "items": {
+ "$ref": "Binding"
+ },
+ "type": "array"
+ },
"etag": {
"format": "byte",
"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.",
@@ -1999,42 +3018,99 @@
"format": "int32",
"description": "Version of the `Policy`. The default version is 0.",
"type": "integer"
- },
- "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"
}
},
"id": "Policy"
},
- "SearchReadsRequest": {
- "id": "SearchReadsRequest",
- "description": "The read search request.",
+ "Annotation": {
+ "description": "An annotation describes a region of reference genome. The value of an\nannotation may be one of several canonical types, supplemented by arbitrary\ninfo tags. An annotation is not inherently associated with a specific\nsample or individual (though a client could choose to use annotations in\nthis way). Example canonical annotation types are `GENE` and\n`VARIANT`.",
"type": "object",
"properties": {
"referenceName": {
- "description": "The reference sequence name, for example `chr1`, `1`, or `chrX`. If set to\n`*`, only unmapped reads are returned. If unspecified, all reads (mapped\nand unmapped) are returned.",
+ "description": "The display name corresponding to the reference specified by\n`referenceId`, for example `chr1`, `1`, or `chrX`.",
"type": "string"
},
- "readGroupSetIds": {
- "description": "The IDs of the read groups sets within which to search for reads. All\nspecified read group sets must be aligned against a common set of reference\nsequences; this defines the genomic coordinates for the query. Must specify\none of `readGroupSetIds` or `readGroupIds`.",
- "items": {
- "type": "string"
+ "info": {
+ "additionalProperties": {
+ "items": {
+ "type": "any"
+ },
+ "type": "array"
},
- "type": "array"
+ "description": "A map of additional read alignment information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
+ "type": "object"
},
- "readGroupIds": {
- "description": "The IDs of the read groups within which to search for reads. All specified\nread groups must belong to the same read group sets. Must specify one of\n`readGroupSetIds` or `readGroupIds`.",
- "items": {
- "type": "string"
- },
- "type": "array"
+ "type": {
+ "enumDescriptions": [
+ "",
+ "A `GENERIC` annotation type should be used when no other annotation\ntype will suffice. This represents an untyped annotation of the reference\ngenome.",
+ "A `VARIANT` annotation type.",
+ "A `GENE` annotation type represents the existence of a gene at the\nassociated reference coordinates. The start coordinate is typically the\ngene's transcription start site and the end is typically the end of the\ngene's last exon.",
+ "A `TRANSCRIPT` annotation type represents the assertion that a\nparticular region of the reference genome may be transcribed as RNA."
+ ],
+ "enum": [
+ "ANNOTATION_TYPE_UNSPECIFIED",
+ "GENERIC",
+ "VARIANT",
+ "GENE",
+ "TRANSCRIPT"
+ ],
+ "description": "The data type for this annotation. Must match the containing annotation\nset's type.",
+ "type": "string"
},
"end": {
"format": "int64",
+ "description": "The end position of the range on the reference, 0-based exclusive.",
+ "type": "string"
+ },
+ "transcript": {
+ "description": "A transcript value represents the assertion that a particular region of\nthe reference genome may be transcribed as RNA. An alternative splicing\npattern would be represented as a separate transcript object. This field\nis only set for annotations of type `TRANSCRIPT`.",
+ "$ref": "Transcript"
+ },
+ "start": {
+ "format": "int64",
+ "description": "The start position of the range on the reference, 0-based inclusive.",
+ "type": "string"
+ },
+ "annotationSetId": {
+ "description": "The annotation set to which this annotation belongs.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The display name of this annotation.",
+ "type": "string"
+ },
+ "variant": {
+ "description": "A variant annotation, which describes the effect of a variant on the\ngenome, the coding sequence, and/or higher level consequences at the\norganism level e.g. pathogenicity. This field is only set for annotations\nof type `VARIANT`.",
+ "$ref": "VariantAnnotation"
+ },
+ "referenceId": {
+ "description": "The ID of the Google Genomics reference associated with this range.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The server-generated annotation ID, unique across all annotations.",
+ "type": "string"
+ },
+ "reverseStrand": {
+ "description": "Whether this range refers to the reverse strand, as opposed to the forward\nstrand. Note that regardless of this field, the start/end position of the\nrange always refer to the forward strand.",
+ "type": "boolean"
+ }
+ },
+ "id": "Annotation"
+ },
+ "CancelOperationRequest": {
+ "description": "The request message for Operations.CancelOperation.",
+ "type": "object",
+ "properties": {},
+ "id": "CancelOperationRequest"
+ },
+ "SearchReadsRequest": {
+ "description": "The read search request.",
+ "type": "object",
+ "properties": {
+ "end": {
+ "format": "int64",
"description": "The end position of the range on the reference, 0-based exclusive. If\nspecified, `referenceName` must also be specified.",
"type": "string"
},
@@ -2051,126 +3127,27 @@
"format": "int64",
"description": "The start position of the range on the reference, 0-based inclusive. If\nspecified, `referenceName` must also be specified.",
"type": "string"
- }
- }
- },
- "Annotation": {
- "type": "object",
- "properties": {
- "variant": {
- "description": "A variant annotation, which describes the effect of a variant on the\ngenome, the coding sequence, and/or higher level consequences at the\norganism level e.g. pathogenicity. This field is only set for annotations\nof type `VARIANT`.",
- "$ref": "VariantAnnotation"
- },
- "id": {
- "description": "The server-generated annotation ID, unique across all annotations.",
- "type": "string"
- },
- "referenceId": {
- "description": "The ID of the Google Genomics reference associated with this range.",
- "type": "string"
- },
- "reverseStrand": {
- "description": "Whether this range refers to the reverse strand, as opposed to the forward\nstrand. Note that regardless of this field, the start/end position of the\nrange always refer to the forward strand.",
- "type": "boolean"
},
"referenceName": {
- "description": "The display name corresponding to the reference specified by\n`referenceId`, for example `chr1`, `1`, or `chrX`.",
+ "description": "The reference sequence name, for example `chr1`, `1`, or `chrX`. If set to\n`*`, only unmapped reads are returned. If unspecified, all reads (mapped\nand unmapped) are returned.",
"type": "string"
},
- "type": {
- "description": "The data type for this annotation. Must match the containing annotation\nset's type.",
- "type": "string",
- "enumDescriptions": [
- "",
- "A `GENERIC` annotation type should be used when no other annotation\ntype will suffice. This represents an untyped annotation of the reference\ngenome.",
- "A `VARIANT` annotation type.",
- "A `GENE` annotation type represents the existence of a gene at the\nassociated reference coordinates. The start coordinate is typically the\ngene's transcription start site and the end is typically the end of the\ngene's last exon.",
- "A `TRANSCRIPT` annotation type represents the assertion that a\nparticular region of the reference genome may be transcribed as RNA."
- ],
- "enum": [
- "ANNOTATION_TYPE_UNSPECIFIED",
- "GENERIC",
- "VARIANT",
- "GENE",
- "TRANSCRIPT"
- ]
- },
- "info": {
- "additionalProperties": {
- "items": {
- "type": "any"
- },
- "type": "array"
+ "readGroupSetIds": {
+ "description": "The IDs of the read groups sets within which to search for reads. All\nspecified read group sets must be aligned against a common set of reference\nsequences; this defines the genomic coordinates for the query. Must specify\none of `readGroupSetIds` or `readGroupIds`.",
+ "items": {
+ "type": "string"
},
- "description": "A map of additional read alignment information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
- "type": "object"
+ "type": "array"
},
- "end": {
- "format": "int64",
- "description": "The end position of the range on the reference, 0-based exclusive.",
- "type": "string"
- },
- "transcript": {
- "$ref": "Transcript",
- "description": "A transcript value represents the assertion that a particular region of\nthe reference genome may be transcribed as RNA. An alternative splicing\npattern would be represented as a separate transcript object. This field\nis only set for annotations of type `TRANSCRIPT`."
- },
- "start": {
- "format": "int64",
- "description": "The start position of the range on the reference, 0-based inclusive.",
- "type": "string"
- },
- "annotationSetId": {
- "description": "The annotation set to which this annotation belongs.",
- "type": "string"
- },
- "name": {
- "description": "The display name of this annotation.",
- "type": "string"
+ "readGroupIds": {
+ "description": "The IDs of the read groups within which to search for reads. All specified\nread groups must belong to the same read group sets. Must specify one of\n`readGroupSetIds` or `readGroupIds`.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
},
- "id": "Annotation",
- "description": "An annotation describes a region of reference genome. The value of an\nannotation may be one of several canonical types, supplemented by arbitrary\ninfo tags. An annotation is not inherently associated with a specific\nsample or individual (though a client could choose to use annotations in\nthis way). Example canonical annotation types are `GENE` and\n`VARIANT`."
- },
- "CancelOperationRequest": {
- "description": "The request message for Operations.CancelOperation.",
- "type": "object",
- "properties": {},
- "id": "CancelOperationRequest"
- },
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`",
- "type": "string"
- },
- "error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure or cancellation."
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "An OperationMetadata object. This will always be returned with the Operation.",
- "type": "object"
- },
- "done": {
- "type": "boolean",
- "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable."
- },
- "response": {
- "description": "If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For pipelines and exports, an Empty response is returned.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- }
- },
- "id": "Operation"
+ "id": "SearchReadsRequest"
},
"RuntimeMetadata": {
"description": "Runtime metadata that will be populated in the\nruntimeMetadata\nfield of the Operation associated with a RunPipeline execution.",
@@ -2183,7 +3160,44 @@
},
"id": "RuntimeMetadata"
},
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object",
+ "properties": {
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ },
+ "response": {
+ "description": "If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For pipelines and exports, an Empty response is returned.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`",
+ "type": "string"
+ },
+ "error": {
+ "description": "The error result of the operation in case of failure or cancellation.",
+ "$ref": "Status"
+ },
+ "metadata": {
+ "description": "An OperationMetadata object. This will always be returned with the Operation.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ }
+ },
+ "id": "Operation"
+ },
"ImportReadGroupSetsResponse": {
+ "description": "The read group set import response.",
+ "type": "object",
"properties": {
"readGroupSetIds": {
"description": "IDs of the read group sets that were created.",
@@ -2193,9 +3207,7 @@
"type": "array"
}
},
- "id": "ImportReadGroupSetsResponse",
- "description": "The read group set import response.",
- "type": "object"
+ "id": "ImportReadGroupSetsResponse"
},
"VariantCall": {
"description": "A call represents the determination of genotype with respect to a particular\nvariant. It may include associated information such as quality and phasing.\nFor example, a call might assign a probability of 0.32 to the occurrence of\na SNP named rs1234 in a call set with the name NA12345.",
@@ -2206,14 +3218,14 @@
"type": "string"
},
"info": {
+ "description": "A map of additional variant call information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
+ "type": "object",
"additionalProperties": {
"items": {
"type": "any"
},
"type": "array"
- },
- "description": "A map of additional variant call information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
- "type": "object"
+ }
},
"callSetName": {
"description": "The name of the call set this variant call belongs to.",
@@ -2228,8 +3240,8 @@
"type": "array"
},
"callSetId": {
- "type": "string",
- "description": "The ID of the call set this variant call belongs to."
+ "description": "The ID of the call set this variant call belongs to.",
+ "type": "string"
},
"genotype": {
"description": "The genotype of this variant call. Each value represents either the value\nof the `referenceBases` field or a 1-based index into\n`alternateBases`. If a variant had a `referenceBases`\nvalue of `T` and an `alternateBases`\nvalue of `[\"A\", \"C\"]`, and the `genotype` was\n`[2, 1]`, that would mean the call\nrepresented the heterozygous value `CA` for this variant.\nIf the `genotype` was instead `[0, 1]`, the\nrepresented value would be `TA`. Ordering of the\ngenotype values is important if the `phaseset` is present.\nIf a genotype is not called (that is, a `.` is present in the\nGT string) -1 is returned.",
@@ -2263,18 +3275,18 @@
"ListBasesResponse": {
"type": "object",
"properties": {
- "sequence": {
- "description": "A substring of the bases that make up this reference.",
- "type": "string"
- },
"offset": {
"format": "int64",
"description": "The offset position (0-based) of the given `sequence` from the\nstart of this `Reference`. This value will differ for each page\nin a paginated request.",
"type": "string"
},
"nextPageToken": {
- "type": "string",
- "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results."
+ "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
+ "type": "string"
+ },
+ "sequence": {
+ "description": "A substring of the bases that make up this reference.",
+ "type": "string"
}
},
"id": "ListBasesResponse"
@@ -2283,15 +3295,6 @@
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
- "code": {
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
@@ -2302,6 +3305,15 @@
"type": "object"
},
"type": "array"
+ },
+ "code": {
+ "format": "int32",
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "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"
@@ -2325,27 +3337,27 @@
"id": "Binding"
},
"UndeleteDatasetRequest": {
- "id": "UndeleteDatasetRequest",
"type": "object",
- "properties": {}
+ "properties": {},
+ "id": "UndeleteDatasetRequest"
},
"Range": {
"description": "A 0-based half-open genomic coordinate range for search requests.",
"type": "object",
"properties": {
+ "end": {
+ "format": "int64",
+ "description": "The end position of the range on the reference, 0-based exclusive.",
+ "type": "string"
+ },
"referenceName": {
- "type": "string",
- "description": "The reference sequence name, for example `chr1`,\n`1`, or `chrX`."
+ "description": "The reference sequence name, for example `chr1`,\n`1`, or `chrX`.",
+ "type": "string"
},
"start": {
"format": "int64",
"description": "The start position of the range on the reference, 0-based inclusive.",
"type": "string"
- },
- "end": {
- "format": "int64",
- "description": "The end position of the range on the reference, 0-based exclusive.",
- "type": "string"
}
},
"id": "Range"
@@ -2354,6 +3366,14 @@
"description": "A variant set is a collection of call sets and variants. It contains summary\nstatistics of those contents. A variant set belongs to a dataset.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
"type": "object",
"properties": {
+ "description": {
+ "description": "A textual description of this variant set.",
+ "type": "string"
+ },
+ "datasetId": {
+ "description": "The dataset to which this variant set belongs.",
+ "type": "string"
+ },
"name": {
"description": "User-specified, mutable name.",
"type": "string"
@@ -2377,38 +3397,13 @@
"type": "array"
},
"id": {
- "type": "string",
- "description": "The server-generated variant set ID, unique across all variant sets."
- },
- "description": {
- "description": "A textual description of this variant set.",
- "type": "string"
- },
- "datasetId": {
- "description": "The dataset to which this variant set belongs.",
+ "description": "The server-generated variant set ID, unique across all variant sets.",
"type": "string"
}
},
"id": "VariantSet"
},
- "ReferenceBound": {
- "properties": {
- "referenceName": {
- "description": "The name of the reference associated with this reference bound.",
- "type": "string"
- },
- "upperBound": {
- "type": "string",
- "format": "int64",
- "description": "An upper bound (inclusive) on the starting coordinate of any\nvariant in the reference sequence."
- }
- },
- "id": "ReferenceBound",
- "description": "ReferenceBound records an upper bound for the starting coordinate of\nvariants in a particular reference.",
- "type": "object"
- },
"BatchCreateAnnotationsResponse": {
- "id": "BatchCreateAnnotationsResponse",
"type": "object",
"properties": {
"entries": {
@@ -2418,28 +3413,66 @@
},
"type": "array"
}
- }
+ },
+ "id": "BatchCreateAnnotationsResponse"
},
- "SearchCallSetsResponse": {
- "description": "The call set search response.",
+ "ReferenceBound": {
+ "description": "ReferenceBound records an upper bound for the starting coordinate of\nvariants in a particular reference.",
+ "type": "object",
+ "properties": {
+ "upperBound": {
+ "format": "int64",
+ "description": "An upper bound (inclusive) on the starting coordinate of any\nvariant in the reference sequence.",
+ "type": "string"
+ },
+ "referenceName": {
+ "description": "The name of the reference associated with this reference bound.",
+ "type": "string"
+ }
+ },
+ "id": "ReferenceBound"
+ },
+ "ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
"type": "object",
"properties": {
"nextPageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
+ "description": "The standard List next-page token.",
"type": "string"
},
- "callSets": {
- "description": "The list of matching call sets.",
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
"items": {
- "$ref": "CallSet"
+ "$ref": "Operation"
},
"type": "array"
}
},
- "id": "SearchCallSetsResponse"
+ "id": "ListOperationsResponse"
},
"Variant": {
+ "description": "A variant represents a change in DNA sequence relative to a reference\nsequence. For example, a variant could represent a SNP or an insertion.\nVariants belong to a variant set.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nEach of the calls on a variant represent a determination of genotype with\nrespect to that variant. For example, a call might assign probability of 0.32\nto the occurrence of a SNP named rs1234 in a sample named NA12345. A call\nbelongs to a call set, which contains related calls typically from one\nsample.",
+ "type": "object",
"properties": {
+ "created": {
+ "format": "int64",
+ "description": "The date this variant was created, in milliseconds from the epoch.",
+ "type": "string"
+ },
+ "start": {
+ "format": "int64",
+ "description": "The position at which this variant occurs (0-based).\nThis corresponds to the first base of the string of reference bases.",
+ "type": "string"
+ },
+ "quality": {
+ "format": "double",
+ "description": "A measure of how likely this variant is to be real.\nA higher value is better.",
+ "type": "number"
+ },
+ "id": {
+ "description": "The server-generated variant ID, unique across all variants.",
+ "type": "string"
+ },
"variantSetId": {
"description": "The ID of the variant set this variant belongs to.",
"type": "string"
@@ -2449,14 +3482,14 @@
"type": "string"
},
"info": {
- "description": "A map of additional variant information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
- "type": "object",
"additionalProperties": {
"items": {
"type": "any"
},
"type": "array"
- }
+ },
+ "description": "A map of additional variant information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
+ "type": "object"
},
"referenceBases": {
"description": "The reference bases for this variant. They start at the given\nposition.",
@@ -2476,11 +3509,6 @@
},
"type": "array"
},
- "end": {
- "format": "int64",
- "description": "The end position (0-based) of this variant. This corresponds to the first\nbase after the last base in the reference allele. So, the length of\nthe reference allele is (end - start). This is useful for variants\nthat don't explicitly give alternate bases, for example large deletions.",
- "type": "string"
- },
"filter": {
"description": "A list of filters (normally quality filters) this variant has failed.\n`PASS` indicates this variant has passed all filters.",
"items": {
@@ -2488,119 +3516,47 @@
},
"type": "array"
},
+ "end": {
+ "format": "int64",
+ "description": "The end position (0-based) of this variant. This corresponds to the first\nbase after the last base in the reference allele. So, the length of\nthe reference allele is (end - start). This is useful for variants\nthat don't explicitly give alternate bases, for example large deletions.",
+ "type": "string"
+ },
"calls": {
"description": "The variant calls for this particular variant. Each one represents the\ndetermination of genotype with respect to this variant.",
"items": {
"$ref": "VariantCall"
},
"type": "array"
- },
- "created": {
- "format": "int64",
- "description": "The date this variant was created, in milliseconds from the epoch.",
- "type": "string"
- },
- "start": {
- "format": "int64",
- "description": "The position at which this variant occurs (0-based).\nThis corresponds to the first base of the string of reference bases.",
- "type": "string"
- },
- "quality": {
- "format": "double",
- "description": "A measure of how likely this variant is to be real.\nA higher value is better.",
- "type": "number"
- },
- "id": {
- "description": "The server-generated variant ID, unique across all variants.",
- "type": "string"
}
},
- "id": "Variant",
- "description": "A variant represents a change in DNA sequence relative to a reference\nsequence. For example, a variant could represent a SNP or an insertion.\nVariants belong to a variant set.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nEach of the calls on a variant represent a determination of genotype with\nrespect to that variant. For example, a call might assign probability of 0.32\nto the occurrence of a SNP named rs1234 in a sample named NA12345. A call\nbelongs to a call set, which contains related calls typically from one\nsample.",
- "type": "object"
+ "id": "Variant"
},
- "ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
+ "SearchCallSetsResponse": {
+ "description": "The call set search response.",
"type": "object",
"properties": {
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
+ "callSets": {
+ "description": "The list of matching call sets.",
"items": {
- "$ref": "Operation"
+ "$ref": "CallSet"
},
"type": "array"
},
"nextPageToken": {
- "description": "The standard List next-page token.",
+ "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
"type": "string"
}
},
- "id": "ListOperationsResponse"
- },
- "OperationMetadata": {
- "id": "OperationMetadata",
- "description": "Metadata describing an Operation.",
- "type": "object",
- "properties": {
- "events": {
- "description": "Optional event messages that were generated during the job's execution.\nThis also contains any warnings that were generated during import\nor export.",
- "items": {
- "$ref": "OperationEvent"
- },
- "type": "array"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "The time at which the job stopped running.",
- "type": "string"
- },
- "startTime": {
- "type": "string",
- "format": "google-datetime",
- "description": "The time at which the job began to run."
- },
- "request": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "The original request that started the operation. Note that this will be in\ncurrent version of the API. If the operation was started with v1beta2 API\nand a GetOperation is performed on v1 API, a v1 request will be returned.",
- "type": "object"
- },
- "runtimeMetadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Runtime metadata on this Operation.",
- "type": "object"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optionally provided by the caller when submitting the request that creates\nthe operation.",
- "type": "object"
- },
- "createTime": {
- "format": "google-datetime",
- "description": "The time at which the job was submitted to the Genomics service.",
- "type": "string"
- },
- "projectId": {
- "description": "The Google Cloud Project in which the job is scoped.",
- "type": "string"
- },
- "clientId": {
- "description": "This field is deprecated. Use `labels` instead. Optionally provided by the\ncaller when submitting the request that creates the operation.",
- "type": "string"
- }
- }
+ "id": "SearchCallSetsResponse"
},
"SearchVariantsRequest": {
"description": "The variant search request.",
"type": "object",
"properties": {
+ "referenceName": {
+ "description": "Required. Only return variants in this reference sequence.",
+ "type": "string"
+ },
"variantSetIds": {
"description": "At most one variant set ID must be provided. Only variants from this\nvariant set will be returned. If omitted, a call set id must be included in\nthe request.",
"items": {
@@ -2635,21 +3591,77 @@
"type": "array"
},
"start": {
- "type": "string",
"format": "int64",
- "description": "The beginning of the window (0-based, inclusive) for which\noverlapping variants should be returned. If unspecified, defaults to 0."
+ "description": "The beginning of the window (0-based, inclusive) for which\noverlapping variants should be returned. If unspecified, defaults to 0.",
+ "type": "string"
},
"variantName": {
"description": "Only return variants which have exactly this name.",
"type": "string"
- },
- "referenceName": {
- "description": "Required. Only return variants in this reference sequence.",
- "type": "string"
}
},
"id": "SearchVariantsRequest"
},
+ "OperationMetadata": {
+ "description": "Metadata describing an Operation.",
+ "type": "object",
+ "properties": {
+ "endTime": {
+ "format": "google-datetime",
+ "description": "The time at which the job stopped running.",
+ "type": "string"
+ },
+ "events": {
+ "description": "Optional event messages that were generated during the job's execution.\nThis also contains any warnings that were generated during import\nor export.",
+ "items": {
+ "$ref": "OperationEvent"
+ },
+ "type": "array"
+ },
+ "startTime": {
+ "format": "google-datetime",
+ "description": "The time at which the job began to run.",
+ "type": "string"
+ },
+ "request": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The original request that started the operation. Note that this will be in\ncurrent version of the API. If the operation was started with v1beta2 API\nand a GetOperation is performed on v1 API, a v1 request will be returned.",
+ "type": "object"
+ },
+ "runtimeMetadata": {
+ "description": "Runtime metadata on this Operation.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "createTime": {
+ "format": "google-datetime",
+ "description": "The time at which the job was submitted to the Genomics service.",
+ "type": "string"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optionally provided by the caller when submitting the request that creates\nthe operation.",
+ "type": "object"
+ },
+ "projectId": {
+ "description": "The Google Cloud Project in which the job is scoped.",
+ "type": "string"
+ },
+ "clientId": {
+ "description": "This field is deprecated. Use `labels` instead. Optionally provided by the\ncaller when submitting the request that creates the operation.",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadata"
+ },
"SearchReadGroupSetsRequest": {
"description": "The read group set search request.",
"type": "object",
@@ -2697,6 +3709,10 @@
"ClinicalCondition": {
"type": "object",
"properties": {
+ "conceptId": {
+ "description": "The MedGen concept id associated with this gene.\nSearch for these IDs at http://www.ncbi.nlm.nih.gov/medgen/",
+ "type": "string"
+ },
"names": {
"description": "A set of names for the condition.",
"items": {
@@ -2714,15 +3730,12 @@
"$ref": "ExternalId"
},
"type": "array"
- },
- "conceptId": {
- "type": "string",
- "description": "The MedGen concept id associated with this gene.\nSearch for these IDs at http://www.ncbi.nlm.nih.gov/medgen/"
}
},
"id": "ClinicalCondition"
},
"SearchReadsResponse": {
+ "description": "The read search response.",
"type": "object",
"properties": {
"alignments": {
@@ -2737,12 +3750,15 @@
"type": "string"
}
},
- "id": "SearchReadsResponse",
- "description": "The read search response."
+ "id": "SearchReadsResponse"
},
"Program": {
"type": "object",
"properties": {
+ "name": {
+ "description": "The display name of the program. This is typically the colloquial name of\nthe tool used, for example 'bwa' or 'picard'.",
+ "type": "string"
+ },
"prevProgramId": {
"description": "The ID of the program run before this one.",
"type": "string"
@@ -2758,1030 +3774,15 @@
"id": {
"description": "The user specified locally unique ID of the program. Used along with\n`prevProgramId` to define an ordering between programs.",
"type": "string"
- },
- "name": {
- "description": "The display name of the program. This is typically the colloquial name of\nthe tool used, for example 'bwa' or 'picard'.",
- "type": "string"
}
},
"id": "Program"
- },
- "CoverageBucket": {
- "description": "A bucket over which read coverage has been precomputed. A bucket corresponds\nto a specific range of the reference sequence.",
- "type": "object",
- "properties": {
- "meanCoverage": {
- "format": "float",
- "description": "The average number of reads which are aligned to each individual\nreference base in this bucket.",
- "type": "number"
- },
- "range": {
- "description": "The genomic coordinate range spanned by this bucket.",
- "$ref": "Range"
- }
- },
- "id": "CoverageBucket"
- },
- "ComputeEngine": {
- "id": "ComputeEngine",
- "description": "Describes a Compute Engine resource that is being managed by a running\npipeline.",
- "type": "object",
- "properties": {
- "diskNames": {
- "description": "The names of the disks that were created for this pipeline.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "machineType": {
- "type": "string",
- "description": "The machine type of the instance."
- },
- "instanceName": {
- "description": "The instance on which the operation is running.",
- "type": "string"
- },
- "zone": {
- "description": "The availability zone in which the instance resides.",
- "type": "string"
- }
- }
- },
- "ExternalId": {
- "properties": {
- "id": {
- "description": "The id used by the source of this data.",
- "type": "string"
- },
- "sourceName": {
- "description": "The name of the source of this data.",
- "type": "string"
- }
- },
- "id": "ExternalId",
- "type": "object"
- },
- "Reference": {
- "description": "A reference is a canonical assembled DNA sequence, intended to act as a\nreference coordinate space for other genomic annotations. A single reference\nmight represent the human chromosome 1 or mitochandrial DNA, for instance. A\nreference belongs to one or more reference sets.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "type": "object",
- "properties": {
- "name": {
- "description": "The name of this reference, for example `22`.",
- "type": "string"
- },
- "md5checksum": {
- "description": "MD5 of the upper-case sequence excluding all whitespace characters (this\nis equivalent to SQ:M5 in SAM). This value is represented in lower case\nhexadecimal format.",
- "type": "string"
- },
- "id": {
- "type": "string",
- "description": "The server-generated reference ID, unique across all references."
- },
- "length": {
- "format": "int64",
- "description": "The length of this reference's sequence.",
- "type": "string"
- },
- "sourceAccessions": {
- "description": "All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally\nwith a version number, for example `GCF_000001405.26`.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "ncbiTaxonId": {
- "format": "int32",
- "description": "ID from http://www.ncbi.nlm.nih.gov/taxonomy. For example, 9606 for human.",
- "type": "integer"
- },
- "sourceUri": {
- "description": "The URI from which the sequence was obtained. Typically specifies a FASTA\nformat file.",
- "type": "string"
- }
- },
- "id": "Reference"
- },
- "VariantSetMetadata": {
- "description": "Metadata describes a single piece of variant call metadata.\nThese data include a top level key and either a single value string (value)\nor a list of key-value pairs (info.)\nValue and info are mutually exclusive.",
- "type": "object",
- "properties": {
- "info": {
- "additionalProperties": {
- "items": {
- "type": "any"
- },
- "type": "array"
- },
- "description": "Remaining structured metadata key-value pairs. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
- "type": "object"
- },
- "type": {
- "enum": [
- "TYPE_UNSPECIFIED",
- "INTEGER",
- "FLOAT",
- "FLAG",
- "CHARACTER",
- "STRING"
- ],
- "description": "The type of data. Possible types include: Integer, Float,\nFlag, Character, and String.",
- "type": "string",
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- ""
- ]
- },
- "value": {
- "description": "The value field for simple metadata",
- "type": "string"
- },
- "id": {
- "description": "User-provided ID field, not enforced by this API.\nTwo or more pieces of structured metadata with identical\nid and key fields are considered equivalent.",
- "type": "string"
- },
- "number": {
- "description": "The number of values that can be included in a field described by this\nmetadata.",
- "type": "string"
- },
- "key": {
- "description": "The top-level key.",
- "type": "string"
- },
- "description": {
- "description": "A textual description of this metadata.",
- "type": "string"
- }
- },
- "id": "VariantSetMetadata"
- },
- "SearchVariantSetsRequest": {
- "type": "object",
- "properties": {
- "pageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
- "type": "string"
- },
- "pageSize": {
- "format": "int32",
- "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024.",
- "type": "integer"
- },
- "datasetIds": {
- "description": "Exactly one dataset ID must be provided here. Only variant sets which\nbelong to this dataset will be returned.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "SearchVariantSetsRequest",
- "description": "The search variant sets request."
- },
- "SearchReferenceSetsRequest": {
- "type": "object",
- "properties": {
- "md5checksums": {
- "description": "If present, return reference sets for which the\nmd5checksum matches exactly.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "pageToken": {
- "type": "string",
- "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response."
- },
- "accessions": {
- "description": "If present, return reference sets for which a prefix of any of\nsourceAccessions\nmatch any of these strings. Accession numbers typically have a main number\nand a version, for example `NC_000001.11`.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "pageSize": {
- "format": "int32",
- "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024. The maximum value is 4096.",
- "type": "integer"
- },
- "assemblyId": {
- "description": "If present, return reference sets for which a substring of their\n`assemblyId` matches this string (case insensitive).",
- "type": "string"
- }
- },
- "id": "SearchReferenceSetsRequest"
- },
- "SetIamPolicyRequest": {
- "properties": {
- "policy": {
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.",
- "$ref": "Policy"
- }
- },
- "id": "SetIamPolicyRequest",
- "description": "Request message for `SetIamPolicy` method.",
- "type": "object"
- },
- "MergeVariantsRequest": {
- "type": "object",
- "properties": {
- "infoMergeConfig": {
- "type": "object",
- "additionalProperties": {
- "enum": [
- "INFO_MERGE_OPERATION_UNSPECIFIED",
- "IGNORE_NEW",
- "MOVE_TO_CALLS"
- ],
- "type": "string"
- },
- "description": "A mapping between info field keys and the InfoMergeOperations to\nbe performed on them."
- },
- "variantSetId": {
- "type": "string",
- "description": "The destination variant set."
- },
- "variants": {
- "description": "The variants to be merged with existing variants.",
- "items": {
- "$ref": "Variant"
- },
- "type": "array"
- }
- },
- "id": "MergeVariantsRequest"
- },
- "BatchCreateAnnotationsRequest": {
- "type": "object",
- "properties": {
- "annotations": {
- "description": "The annotations to be created. At most 4096 can be specified in a single\nrequest.",
- "items": {
- "$ref": "Annotation"
- },
- "type": "array"
- },
- "requestId": {
- "description": "A unique request ID which enables the server to detect duplicated requests.\nIf provided, duplicated requests will result in the same response; if not\nprovided, duplicated requests may result in duplicated data. For a given\nannotation set, callers should not reuse `request_id`s when writing\ndifferent batches of annotations - behavior in this case is undefined.\nA common approach is to use a UUID. For batch jobs where worker crashes are\na possibility, consider using some unique variant of a worker or run ID.",
- "type": "string"
- }
- },
- "id": "BatchCreateAnnotationsRequest"
- },
- "Read": {
- "description": "A read alignment describes a linear alignment of a string of DNA to a\nreference sequence, in addition to metadata\nabout the fragment (the molecule of DNA sequenced) and the read (the bases\nwhich were read by the sequencer). A read is equivalent to a line in a SAM\nfile. A read belongs to exactly one read group and exactly one\nread group set.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\n### Reverse-stranded reads\n\nMapped reads (reads having a non-null `alignment`) can be aligned to either\nthe forward or the reverse strand of their associated reference. Strandedness\nof a mapped read is encoded by `alignment.position.reverseStrand`.\n\nIf we consider the reference to be a forward-stranded coordinate space of\n`[0, reference.length)` with `0` as the left-most position and\n`reference.length` as the right-most position, reads are always aligned left\nto right. That is, `alignment.position.position` always refers to the\nleft-most reference coordinate and `alignment.cigar` describes the alignment\nof this read to the reference from left to right. All per-base fields such as\n`alignedSequence` and `alignedQuality` share this same left-to-right\norientation; this is true of reads which are aligned to either strand. For\nreverse-stranded reads, this means that `alignedSequence` is the reverse\ncomplement of the bases that were originally reported by the sequencing\nmachine.\n\n### Generating a reference-aligned sequence string\n\nWhen interacting with mapped reads, it's often useful to produce a string\nrepresenting the local alignment of the read to reference. The following\npseudocode demonstrates one way of doing this:\n\n out = \"\"\n offset = 0\n for c in read.alignment.cigar {\n switch c.operation {\n case \"ALIGNMENT_MATCH\", \"SEQUENCE_MATCH\", \"SEQUENCE_MISMATCH\":\n out += read.alignedSequence[offset:offset+c.operationLength]\n offset += c.operationLength\n break\n case \"CLIP_SOFT\", \"INSERT\":\n offset += c.operationLength\n break\n case \"PAD\":\n out += repeat(\"*\", c.operationLength)\n break\n case \"DELETE\":\n out += repeat(\"-\", c.operationLength)\n break\n case \"SKIP\":\n out += repeat(\" \", c.operationLength)\n break\n case \"CLIP_HARD\":\n break\n }\n }\n return out\n\n### Converting to SAM's CIGAR string\n\nThe following pseudocode generates a SAM CIGAR string from the\n`cigar` field. Note that this is a lossy conversion\n(`cigar.referenceSequence` is lost).\n\n cigarMap = {\n \"ALIGNMENT_MATCH\": \"M\",\n \"INSERT\": \"I\",\n \"DELETE\": \"D\",\n \"SKIP\": \"N\",\n \"CLIP_SOFT\": \"S\",\n \"CLIP_HARD\": \"H\",\n \"PAD\": \"P\",\n \"SEQUENCE_MATCH\": \"=\",\n \"SEQUENCE_MISMATCH\": \"X\",\n }\n cigarStr = \"\"\n for c in read.alignment.cigar {\n cigarStr += c.operationLength + cigarMap[c.operation]\n }\n return cigarStr",
- "type": "object",
- "properties": {
- "alignedSequence": {
- "description": "The bases of the read sequence contained in this alignment record,\n**without CIGAR operations applied** (equivalent to SEQ in SAM).\n`alignedSequence` and `alignedQuality` may be\nshorter than the full read sequence and quality. This will occur if the\nalignment is part of a chimeric alignment, or if the read was trimmed. When\nthis occurs, the CIGAR for this read will begin/end with a hard clip\noperator that will indicate the length of the excised sequence.",
- "type": "string"
- },
- "readGroupId": {
- "description": "The ID of the read group this read belongs to. A read belongs to exactly\none read group. This is a server-generated ID which is distinct from SAM's\nRG tag (for that value, see\nReadGroup.name).",
- "type": "string"
- },
- "info": {
- "description": "A map of additional read alignment information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
- "type": "object",
- "additionalProperties": {
- "items": {
- "type": "any"
- },
- "type": "array"
- }
- },
- "nextMatePosition": {
- "$ref": "Position",
- "description": "The mapping of the primary alignment of the\n`(readNumber+1)%numberReads` read in the fragment. It replaces\nmate position and mate strand in SAM."
- },
- "supplementaryAlignment": {
- "description": "Whether this alignment is supplementary. Equivalent to SAM flag 0x800.\nSupplementary alignments are used in the representation of a chimeric\nalignment. In a chimeric alignment, a read is split into multiple\nlinear alignments that map to different reference contigs. The first\nlinear alignment in the read will be designated as the representative\nalignment; the remaining linear alignments will be designated as\nsupplementary alignments. These alignments may have different mapping\nquality scores. In each linear alignment in a chimeric alignment, the read\nwill be hard clipped. The `alignedSequence` and\n`alignedQuality` fields in the alignment record will only\nrepresent the bases for its respective linear alignment.",
- "type": "boolean"
- },
- "properPlacement": {
- "description": "The orientation and the distance between reads from the fragment are\nconsistent with the sequencing protocol (SAM flag 0x2).",
- "type": "boolean"
- },
- "fragmentLength": {
- "format": "int32",
- "description": "The observed length of the fragment, equivalent to TLEN in SAM.",
- "type": "integer"
- },
- "failedVendorQualityChecks": {
- "description": "Whether this read did not pass filters, such as platform or vendor quality\ncontrols (SAM flag 0x200).",
- "type": "boolean"
- },
- "alignedQuality": {
- "description": "The quality of the read sequence contained in this alignment record\n(equivalent to QUAL in SAM).\n`alignedSequence` and `alignedQuality` may be shorter than the full read\nsequence and quality. This will occur if the alignment is part of a\nchimeric alignment, or if the read was trimmed. When this occurs, the CIGAR\nfor this read will begin/end with a hard clip operator that will indicate\nthe length of the excised sequence.",
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
- },
- "alignment": {
- "$ref": "LinearAlignment",
- "description": "The linear alignment for this alignment record. This field is null for\nunmapped reads."
- },
- "id": {
- "description": "The server-generated read ID, unique across all reads. This is different\nfrom the `fragmentName`.",
- "type": "string"
- },
- "numberReads": {
- "type": "integer",
- "format": "int32",
- "description": "The number of reads in the fragment (extension to SAM flag 0x1)."
- },
- "secondaryAlignment": {
- "description": "Whether this alignment is secondary. Equivalent to SAM flag 0x100.\nA secondary alignment represents an alternative to the primary alignment\nfor this read. Aligners may return secondary alignments if a read can map\nambiguously to multiple coordinates in the genome. By convention, each read\nhas one and only one alignment where both `secondaryAlignment`\nand `supplementaryAlignment` are false.",
- "type": "boolean"
- },
- "fragmentName": {
- "description": "The fragment name. Equivalent to QNAME (query template name) in SAM.",
- "type": "string"
- },
- "readGroupSetId": {
- "description": "The ID of the read group set this read belongs to. A read belongs to\nexactly one read group set.",
- "type": "string"
- },
- "duplicateFragment": {
- "description": "The fragment is a PCR or optical duplicate (SAM flag 0x400).",
- "type": "boolean"
- },
- "readNumber": {
- "format": "int32",
- "description": "The read number in sequencing. 0-based and less than numberReads. This\nfield replaces SAM flag 0x40 and 0x80.",
- "type": "integer"
- }
- },
- "id": "Read"
- },
- "ReferenceSet": {
- "description": "A reference set is a set of references which typically comprise a reference\nassembly for a species, such as `GRCh38` which is representative\nof the human genome. A reference set defines a common coordinate space for\ncomparing reference-aligned experimental data. A reference set contains 1 or\nmore references.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "type": "object",
- "properties": {
- "id": {
- "description": "The server-generated reference set ID, unique across all reference sets.",
- "type": "string"
- },
- "sourceAccessions": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally\nwith a version number, for example `NC_000001.11`."
- },
- "description": {
- "type": "string",
- "description": "Free text description of this reference set."
- },
- "sourceUri": {
- "description": "The URI from which the references were obtained.",
- "type": "string"
- },
- "ncbiTaxonId": {
- "format": "int32",
- "description": "ID from http://www.ncbi.nlm.nih.gov/taxonomy (for example, 9606 for human)\nindicating the species which this reference set is intended to model. Note\nthat contained references may specify a different `ncbiTaxonId`, as\nassemblies may contain reference sequences which do not belong to the\nmodeled species, for example EBV in a human reference genome.",
- "type": "integer"
- },
- "referenceIds": {
- "description": "The IDs of the reference objects that are part of this set.\n`Reference.md5checksum` must be unique within this set.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "assemblyId": {
- "description": "Public id of this reference set, such as `GRCh37`.",
- "type": "string"
- },
- "md5checksum": {
- "description": "Order-independent MD5 checksum which identifies this reference set. The\nchecksum is computed by sorting all lower case hexidecimal string\n`reference.md5checksum` (for all reference in this set) in\nascending lexicographic order, concatenating, and taking the MD5 of that\nvalue. The resulting value is represented in lower case hexadecimal format.",
- "type": "string"
- }
- },
- "id": "ReferenceSet"
- },
- "CigarUnit": {
- "description": "A single CIGAR operation.",
- "type": "object",
- "properties": {
- "operation": {
- "type": "string",
- "enumDescriptions": [
- "",
- "An alignment match indicates that a sequence can be aligned to the\nreference without evidence of an INDEL. Unlike the\n`SEQUENCE_MATCH` and `SEQUENCE_MISMATCH` operators,\nthe `ALIGNMENT_MATCH` operator does not indicate whether the\nreference and read sequences are an exact match. This operator is\nequivalent to SAM's `M`.",
- "The insert operator indicates that the read contains evidence of bases\nbeing inserted into the reference. This operator is equivalent to SAM's\n`I`.",
- "The delete operator indicates that the read contains evidence of bases\nbeing deleted from the reference. This operator is equivalent to SAM's\n`D`.",
- "The skip operator indicates that this read skips a long segment of the\nreference, but the bases have not been deleted. This operator is commonly\nused when working with RNA-seq data, where reads may skip long segments\nof the reference between exons. This operator is equivalent to SAM's\n`N`.",
- "The soft clip operator indicates that bases at the start/end of a read\nhave not been considered during alignment. This may occur if the majority\nof a read maps, except for low quality bases at the start/end of a read.\nThis operator is equivalent to SAM's `S`. Bases that are soft\nclipped will still be stored in the read.",
- "The hard clip operator indicates that bases at the start/end of a read\nhave been omitted from this alignment. This may occur if this linear\nalignment is part of a chimeric alignment, or if the read has been\ntrimmed (for example, during error correction or to trim poly-A tails for\nRNA-seq). This operator is equivalent to SAM's `H`.",
- "The pad operator indicates that there is padding in an alignment. This\noperator is equivalent to SAM's `P`.",
- "This operator indicates that this portion of the aligned sequence exactly\nmatches the reference. This operator is equivalent to SAM's `=`.",
- "This operator indicates that this portion of the aligned sequence is an\nalignment match to the reference, but a sequence mismatch. This can\nindicate a SNP or a read error. This operator is equivalent to SAM's\n`X`."
- ],
- "enum": [
- "OPERATION_UNSPECIFIED",
- "ALIGNMENT_MATCH",
- "INSERT",
- "DELETE",
- "SKIP",
- "CLIP_SOFT",
- "CLIP_HARD",
- "PAD",
- "SEQUENCE_MATCH",
- "SEQUENCE_MISMATCH"
- ]
- },
- "referenceSequence": {
- "description": "`referenceSequence` is only used at mismatches\n(`SEQUENCE_MISMATCH`) and deletions (`DELETE`).\nFilling this field replaces SAM's MD tag. If the relevant information is\nnot available, this field is unset.",
- "type": "string"
- },
- "operationLength": {
- "format": "int64",
- "description": "The number of genomic bases that the operation runs for. Required.",
- "type": "string"
- }
- },
- "id": "CigarUnit"
- },
- "AnnotationSet": {
- "id": "AnnotationSet",
- "description": "An annotation set is a logical grouping of annotations that share consistent\ntype information and provenance. Examples of annotation sets include 'all\ngenes from refseq', and 'all variant annotations from ClinVar'.",
- "type": "object",
- "properties": {
- "type": {
- "description": "The type of annotations contained within this set.",
- "type": "string",
- "enumDescriptions": [
- "",
- "A `GENERIC` annotation type should be used when no other annotation\ntype will suffice. This represents an untyped annotation of the reference\ngenome.",
- "A `VARIANT` annotation type.",
- "A `GENE` annotation type represents the existence of a gene at the\nassociated reference coordinates. The start coordinate is typically the\ngene's transcription start site and the end is typically the end of the\ngene's last exon.",
- "A `TRANSCRIPT` annotation type represents the assertion that a\nparticular region of the reference genome may be transcribed as RNA."
- ],
- "enum": [
- "ANNOTATION_TYPE_UNSPECIFIED",
- "GENERIC",
- "VARIANT",
- "GENE",
- "TRANSCRIPT"
- ]
- },
- "info": {
- "additionalProperties": {
- "items": {
- "type": "any"
- },
- "type": "array"
- },
- "description": "A map of additional read alignment information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
- "type": "object"
- },
- "id": {
- "type": "string",
- "description": "The server-generated annotation set ID, unique across all annotation sets."
- },
- "sourceUri": {
- "description": "The source URI describing the file from which this annotation set was\ngenerated, if any.",
- "type": "string"
- },
- "datasetId": {
- "type": "string",
- "description": "The dataset to which this annotation set belongs."
- },
- "name": {
- "description": "The display name for this annotation set.",
- "type": "string"
- },
- "referenceSetId": {
- "description": "The ID of the reference set that defines the coordinate space for this\nset's annotations.",
- "type": "string"
- }
- }
- },
- "Transcript": {
- "description": "A transcript represents the assertion that a particular region of the\nreference genome may be transcribed as RNA.",
- "type": "object",
- "properties": {
- "codingSequence": {
- "$ref": "CodingSequence",
- "description": "The range of the coding sequence for this transcript, if any. To determine\nthe exact ranges of coding sequence, intersect this range with those of the\nexons, if any. If there are any\nexons, the\ncodingSequence must start\nand end within them.\n\nNote that in some cases, the reference genome will not exactly match the\nobserved mRNA transcript e.g. due to variance in the source genome from\nreference. In these cases,\nexon.frame will not necessarily\nmatch the expected reference reading frame and coding exon reference bases\ncannot necessarily be concatenated to produce the original transcript mRNA."
- },
- "geneId": {
- "description": "The annotation ID of the gene from which this transcript is transcribed.",
- "type": "string"
- },
- "exons": {
- "description": "The \u003ca href=\"http://en.wikipedia.org/wiki/Exon\"\u003eexons\u003c/a\u003e that compose\nthis transcript. This field should be unset for genomes where transcript\nsplicing does not occur, for example prokaryotes.\n\nIntrons are regions of the transcript that are not included in the\nspliced RNA product. Though not explicitly modeled here, intron ranges can\nbe deduced; all regions of this transcript that are not exons are introns.\n\nExonic sequences do not necessarily code for a translational product\n(amino acids). Only the regions of exons bounded by the\ncodingSequence correspond\nto coding DNA sequence.\n\nExons are ordered by start position and may not overlap.",
- "items": {
- "$ref": "Exon"
- },
- "type": "array"
- }
- },
- "id": "Transcript"
- },
- "Experiment": {
- "type": "object",
- "properties": {
- "instrumentModel": {
- "description": "The instrument model used as part of this experiment. This maps to\nsequencing technology in the SAM spec.",
- "type": "string"
- },
- "libraryId": {
- "description": "A client-supplied library identifier; a library is a collection of DNA\nfragments which have been prepared for sequencing from a sample. This\nfield is important for quality control as error or bias can be introduced\nduring sample preparation.",
- "type": "string"
- },
- "sequencingCenter": {
- "description": "The sequencing center used as part of this experiment.",
- "type": "string"
- },
- "platformUnit": {
- "type": "string",
- "description": "The platform unit used as part of this experiment, for example\nflowcell-barcode.lane for Illumina or slide for SOLiD. Corresponds to the\n@RG PU field in the SAM spec."
- }
- },
- "id": "Experiment"
- },
- "ListDatasetsResponse": {
- "description": "The dataset list response.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
- "type": "string"
- },
- "datasets": {
- "description": "The list of matching Datasets.",
- "items": {
- "$ref": "Dataset"
- },
- "type": "array"
- }
- },
- "id": "ListDatasetsResponse"
- },
- "TestIamPermissionsRequest": {
- "id": "TestIamPermissionsRequest",
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "REQUIRED: The set of permissions to check for the 'resource'.\nPermissions with wildcards (such as '*' or 'storage.*') are not allowed.\nAllowed permissions are:\n\n* `genomics.datasets.create`\n* `genomics.datasets.delete`\n* `genomics.datasets.get`\n* `genomics.datasets.list`\n* `genomics.datasets.update`\n* `genomics.datasets.getIamPolicy`\n* `genomics.datasets.setIamPolicy`",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- }
- },
- "Exon": {
- "type": "object",
- "properties": {
- "start": {
- "format": "int64",
- "description": "The start position of the exon on this annotation's reference sequence,\n0-based inclusive. Note that this is relative to the reference start, and\n**not** the containing annotation start.",
- "type": "string"
- },
- "frame": {
- "format": "int32",
- "description": "The frame of this exon. Contains a value of 0, 1, or 2, which indicates\nthe offset of the first coding base of the exon within the reading frame\nof the coding DNA sequence, if any. This field is dependent on the\nstrandedness of this annotation (see\nAnnotation.reverse_strand).\nFor forward stranded annotations, this offset is relative to the\nexon.start. For reverse\nstrand annotations, this offset is relative to the\nexon.end `- 1`.\n\nUnset if this exon does not intersect the coding sequence. Upon creation\nof a transcript, the frame must be populated for all or none of the\ncoding exons.",
- "type": "integer"
- },
- "end": {
- "format": "int64",
- "description": "The end position of the exon on this annotation's reference sequence,\n0-based exclusive. Note that this is relative to the reference start, and\n*not* the containing annotation start.",
- "type": "string"
- }
- },
- "id": "Exon"
- },
- "ExportReadGroupSetRequest": {
- "description": "The read group set export request.",
- "type": "object",
- "properties": {
- "projectId": {
- "description": "Required. The Google Cloud project ID that owns this\nexport. The caller must have WRITE access to this project.",
- "type": "string"
- },
- "referenceNames": {
- "description": "The reference names to export. If this is not specified, all reference\nsequences, including unmapped reads, are exported.\nUse `*` to export only unmapped reads.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "exportUri": {
- "type": "string",
- "description": "Required. A Google Cloud Storage URI for the exported BAM file.\nThe currently authenticated user must have write access to the new file.\nAn error will be returned if the URI already contains data."
- }
- },
- "id": "ExportReadGroupSetRequest"
- },
- "CallSet": {
- "description": "A call set is a collection of variant calls, typically for one sample. It\nbelongs to a variant set.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "type": "object",
- "properties": {
- "created": {
- "format": "int64",
- "description": "The date this call set was created in milliseconds from the epoch.",
- "type": "string"
- },
- "sampleId": {
- "description": "The sample ID this call set corresponds to.",
- "type": "string"
- },
- "name": {
- "description": "The call set name.",
- "type": "string"
- },
- "info": {
- "additionalProperties": {
- "items": {
- "type": "any"
- },
- "type": "array"
- },
- "description": "A map of additional call set information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
- "type": "object"
- },
- "variantSetIds": {
- "description": "The IDs of the variant sets this call set belongs to. This field must\nhave exactly length one, as a call set belongs to a single variant set.\nThis field is repeated for compatibility with the\n[GA4GH 0.5.1\nAPI](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variants.avdl#L76).",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "id": {
- "description": "The server-generated call set ID, unique across all call sets.",
- "type": "string"
- }
- },
- "id": "CallSet"
- },
- "SearchAnnotationSetsResponse": {
- "type": "object",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results."
- },
- "annotationSets": {
- "items": {
- "$ref": "AnnotationSet"
- },
- "type": "array",
- "description": "The matching annotation sets."
- }
- },
- "id": "SearchAnnotationSetsResponse"
- },
- "ImportVariantsRequest": {
- "description": "The variant data import request.",
- "type": "object",
- "properties": {
- "infoMergeConfig": {
- "additionalProperties": {
- "enum": [
- "INFO_MERGE_OPERATION_UNSPECIFIED",
- "IGNORE_NEW",
- "MOVE_TO_CALLS"
- ],
- "type": "string"
- },
- "description": "A mapping between info field keys and the InfoMergeOperations to\nbe performed on them. This is plumbed down to the MergeVariantRequests\ngenerated by the resulting import job.",
- "type": "object"
- },
- "sourceUris": {
- "description": "A list of URIs referencing variant files in Google Cloud Storage. URIs can\ninclude wildcards [as described\nhere](https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames).\nNote that recursive wildcards ('**') are not supported.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "variantSetId": {
- "description": "Required. The variant set to which variant data should be imported.",
- "type": "string"
- },
- "normalizeReferenceNames": {
- "description": "Convert reference names to the canonical representation.\nhg19 haploytypes (those reference names containing \"_hap\")\nare not modified in any way.\nAll other reference names are modified according to the following rules:\nThe reference name is capitalized.\nThe \"chr\" prefix is dropped for all autosomes and sex chromsomes.\nFor example \"chr17\" becomes \"17\" and \"chrX\" becomes \"X\".\nAll mitochondrial chromosomes (\"chrM\", \"chrMT\", etc) become \"MT\".",
- "type": "boolean"
- },
- "format": {
- "enumDescriptions": [
- "",
- "VCF (Variant Call Format). The VCF files may be gzip compressed. gVCF is\nalso supported. Disclaimer: gzip VCF imports are currently much slower\nthan equivalent uncompressed VCF imports. For this reason, uncompressed\nVCF is currently recommended for imports with more than 1GB combined\nuncompressed size, or for time sensitive imports.",
- "Complete Genomics masterVarBeta format. The masterVarBeta files may\nbe bzip2 compressed."
- ],
- "enum": [
- "FORMAT_UNSPECIFIED",
- "FORMAT_VCF",
- "FORMAT_COMPLETE_GENOMICS"
- ],
- "description": "The format of the variant data being imported. If unspecified, defaults to\nto `VCF`.",
- "type": "string"
- }
- },
- "id": "ImportVariantsRequest"
- },
- "VariantAnnotation": {
- "type": "object",
- "properties": {
- "conditions": {
- "description": "The set of conditions associated with this variant.\nA condition describes the way a variant influences human health.",
- "items": {
- "$ref": "ClinicalCondition"
- },
- "type": "array"
- },
- "effect": {
- "enumDescriptions": [
- "",
- "`EFFECT_OTHER` should be used when no other Effect\nwill suffice.",
- "`FRAMESHIFT` indicates a mutation in which the insertion or\ndeletion of nucleotides resulted in a frameshift change.",
- "`FRAME_PRESERVING_INDEL` indicates a mutation in which a\nmultiple of three nucleotides has been inserted or deleted, resulting\nin no change to the reading frame of the coding sequence.",
- "`SYNONYMOUS_SNP` indicates a single nucleotide polymorphism\nmutation that results in no amino acid change.",
- "`NONSYNONYMOUS_SNP` indicates a single nucleotide\npolymorphism mutation that results in an amino acid change.",
- "`STOP_GAIN` indicates a mutation that leads to the creation\nof a stop codon at the variant site. Frameshift mutations creating\ndownstream stop codons do not count as `STOP_GAIN`.",
- "`STOP_LOSS` indicates a mutation that eliminates a\nstop codon at the variant site.",
- "`SPLICE_SITE_DISRUPTION` indicates that this variant is\nfound in a splice site for the associated transcript, and alters the\nnormal splicing pattern."
- ],
- "enum": [
- "EFFECT_UNSPECIFIED",
- "EFFECT_OTHER",
- "FRAMESHIFT",
- "FRAME_PRESERVING_INDEL",
- "SYNONYMOUS_SNP",
- "NONSYNONYMOUS_SNP",
- "STOP_GAIN",
- "STOP_LOSS",
- "SPLICE_SITE_DISRUPTION"
- ],
- "description": "Effect of the variant on the coding sequence.",
- "type": "string"
- },
- "transcriptIds": {
- "description": "Google annotation IDs of the transcripts affected by this variant. These\nshould be provided when the variant is created.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "type": {
- "enumDescriptions": [
- "",
- "`TYPE_OTHER` should be used when no other Type will suffice.\nFurther explanation of the variant type may be included in the\ninfo field.",
- "`INSERTION` indicates an insertion.",
- "`DELETION` indicates a deletion.",
- "`SUBSTITUTION` indicates a block substitution of\ntwo or more nucleotides.",
- "`SNP` indicates a single nucleotide polymorphism.",
- "`STRUCTURAL` indicates a large structural variant,\nincluding chromosomal fusions, inversions, etc.",
- "`CNV` indicates a variation in copy number."
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "TYPE_OTHER",
- "INSERTION",
- "DELETION",
- "SUBSTITUTION",
- "SNP",
- "STRUCTURAL",
- "CNV"
- ],
- "description": "Type has been adapted from ClinVar's list of variant types.",
- "type": "string"
- },
- "alternateBases": {
- "description": "The alternate allele for this variant. If multiple alternate alleles\nexist at this location, create a separate variant for each one, as they\nmay represent distinct conditions.",
- "type": "string"
- },
- "geneId": {
- "description": "Google annotation ID of the gene affected by this variant. This should\nbe provided when the variant is created.",
- "type": "string"
- },
- "clinicalSignificance": {
- "type": "string",
- "enumDescriptions": [
- "",
- "`OTHER` should be used when no other clinical significance\nvalue will suffice.",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "",
- "`MULTIPLE_REPORTED` should be used when multiple clinical\nsignficances are reported for a variant. The original clinical\nsignificance values may be provided in the `info` field."
- ],
- "enum": [
- "CLINICAL_SIGNIFICANCE_UNSPECIFIED",
- "CLINICAL_SIGNIFICANCE_OTHER",
- "UNCERTAIN",
- "BENIGN",
- "LIKELY_BENIGN",
- "LIKELY_PATHOGENIC",
- "PATHOGENIC",
- "DRUG_RESPONSE",
- "HISTOCOMPATIBILITY",
- "CONFERS_SENSITIVITY",
- "RISK_FACTOR",
- "ASSOCIATION",
- "PROTECTIVE",
- "MULTIPLE_REPORTED"
- ],
- "description": "Describes the clinical significance of a variant.\nIt is adapted from the ClinVar controlled vocabulary for clinical\nsignificance described at:\nhttp://www.ncbi.nlm.nih.gov/clinvar/docs/clinsig/"
- }
- },
- "id": "VariantAnnotation"
- },
- "ListCoverageBucketsResponse": {
- "type": "object",
- "properties": {
- "coverageBuckets": {
- "description": "The coverage buckets. The list of buckets is sparse; a bucket with 0\noverlapping reads is not returned. A bucket never crosses more than one\nreference sequence. Each bucket has width `bucketWidth`, unless\nits end is the end of the reference sequence.",
- "items": {
- "$ref": "CoverageBucket"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
- "type": "string"
- },
- "bucketWidth": {
- "format": "int64",
- "description": "The length of each coverage bucket in base pairs. Note that buckets at the\nend of a reference sequence may be shorter. This value is omitted if the\nbucket width is infinity (the default behaviour, with no range or\n`targetBucketWidth`).",
- "type": "string"
- }
- },
- "id": "ListCoverageBucketsResponse"
- },
- "ExportVariantSetRequest": {
- "description": "The variant data export request.",
- "type": "object",
- "properties": {
- "projectId": {
- "description": "Required. The Google Cloud project ID that owns the destination\nBigQuery dataset. The caller must have WRITE access to this project. This\nproject will also own the resulting export job.",
- "type": "string"
- },
- "callSetIds": {
- "description": "If provided, only variant call information from the specified call sets\nwill be exported. By default all variant calls are exported.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "bigqueryTable": {
- "description": "Required. The BigQuery table to export data to.\nIf the table doesn't exist, it will be created. If it already exists, it\nwill be overwritten.",
- "type": "string"
- },
- "bigqueryDataset": {
- "description": "Required. The BigQuery dataset to export data to. This dataset must already\nexist. Note that this is distinct from the Genomics concept of \"dataset\".",
- "type": "string"
- },
- "format": {
- "enumDescriptions": [
- "",
- "Export the data to Google BigQuery."
- ],
- "enum": [
- "FORMAT_UNSPECIFIED",
- "FORMAT_BIGQUERY"
- ],
- "description": "The format for the exported data.",
- "type": "string"
- }
- },
- "id": "ExportVariantSetRequest"
- },
- "SearchAnnotationsRequest": {
- "type": "object",
- "properties": {
- "pageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
- "type": "string"
- },
- "pageSize": {
- "format": "int32",
- "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 256. The maximum value is 2048.",
- "type": "integer"
- },
- "start": {
- "format": "int64",
- "description": "The start position of the range on the reference, 0-based inclusive. If\nspecified,\nreferenceId or\nreferenceName\nmust be specified. Defaults to 0.",
- "type": "string"
- },
- "annotationSetIds": {
- "description": "Required. The annotation sets to search within. The caller must have\n`READ` access to these annotation sets.\nAll queried annotation sets must have the same type.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "referenceName": {
- "type": "string",
- "description": "The name of the reference to query, within the reference set associated\nwith this query."
- },
- "referenceId": {
- "description": "The ID of the reference to query.",
- "type": "string"
- },
- "end": {
- "format": "int64",
- "description": "The end position of the range on the reference, 0-based exclusive. If\nreferenceId or\nreferenceName\nmust be specified, Defaults to the length of the reference.",
- "type": "string"
- }
- },
- "id": "SearchAnnotationsRequest"
- },
- "OperationEvent": {
- "description": "An event that occurred during an Operation.",
- "type": "object",
- "properties": {
- "description": {
- "description": "Required description of event.",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "Optional time of when event finished. An event can have a start time and no\nfinish time. If an event has a finish time, there must be a start time.",
- "type": "string"
- },
- "startTime": {
- "format": "google-datetime",
- "description": "Optional time of when event started.",
- "type": "string"
- }
- },
- "id": "OperationEvent"
- },
- "CodingSequence": {
- "type": "object",
- "properties": {
- "start": {
- "type": "string",
- "format": "int64",
- "description": "The start of the coding sequence on this annotation's reference sequence,\n0-based inclusive. Note that this position is relative to the reference\nstart, and *not* the containing annotation start."
- },
- "end": {
- "format": "int64",
- "description": "The end of the coding sequence on this annotation's reference sequence,\n0-based exclusive. Note that this position is relative to the reference\nstart, and *not* the containing annotation start.",
- "type": "string"
- }
- },
- "id": "CodingSequence"
- },
- "SearchReferencesResponse": {
- "type": "object",
- "properties": {
- "references": {
- "description": "The matching references.",
- "items": {
- "$ref": "Reference"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
- "type": "string"
- }
- },
- "id": "SearchReferencesResponse"
- },
- "GetIamPolicyRequest": {
- "description": "Request message for `GetIamPolicy` method.",
- "type": "object",
- "properties": {},
- "id": "GetIamPolicyRequest"
- },
- "TestIamPermissionsResponse": {
- "properties": {
- "permissions": {
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "TestIamPermissionsResponse",
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object"
}
},
"protocol": "rest",
"icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"version": "v1",
"baseUrl": "https://genomics.googleapis.com/",
@@ -3806,12 +3807,11 @@
}
}
},
- "kind": "discovery#restDescription",
"description": "Upload, process, query, and search Genomics data in the cloud.",
"servicePath": "",
+ "kind": "discovery#restDescription",
"rootUrl": "https://genomics.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
- "name": "genomics",
- "batchPath": "batch"
+ "name": "genomics"
}
diff --git a/genomics/v1alpha2/genomics-api.json b/genomics/v1alpha2/genomics-api.json
index 39fee9e..2047d9e 100644
--- a/genomics/v1alpha2/genomics-api.json
+++ b/genomics/v1alpha2/genomics-api.json
@@ -1,192 +1,47 @@
{
+ "rootUrl": "https://genomics.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "genomics",
"batchPath": "batch",
"id": "genomics:v1alpha2",
"documentationLink": "https://cloud.google.com/genomics",
- "revision": "20171010",
+ "revision": "20171011",
"title": "Genomics API",
"discoveryVersion": "v1",
"ownerName": "Google",
"resources": {
- "operations": {
- "methods": {
- "get": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation resource.",
- "type": "string",
- "required": true,
- "pattern": "^operations/.+$"
- }
- },
- "flatPath": "v1alpha2/operations/{operationsId}",
- "id": "genomics.operations.get",
- "path": "v1alpha2/{+name}",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
- },
- "list": {
- "description": "Lists operations that match the specified filter in the request.",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageSize": {
- "format": "int32",
- "description": "The maximum number of results to return. If unspecified, defaults to\n256. The maximum value is 2048.",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "description": "A string for filtering Operations.\nThe following filter fields are supported:\n\n* projectId: Required. Corresponds to\n OperationMetadata.projectId.\n* createTime: The time this job was created, in seconds from the\n [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `\u003e=` and/or `\u003c=`\n operators.\n* status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only\n one status may be specified.\n* labels.key where key is a label key.\n\nExamples:\n\n* `projectId = my-project AND createTime \u003e= 1432140000`\n* `projectId = my-project AND createTime \u003e= 1432140000 AND createTime \u003c= 1432150000 AND status = RUNNING`\n* `projectId = my-project AND labels.color = *`\n* `projectId = my-project AND labels.color = red`",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "name": {
- "description": "The name of the operation's parent resource.",
- "type": "string",
- "required": true,
- "pattern": "^operations$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1alpha2/operations",
- "id": "genomics.operations.list",
- "path": "v1alpha2/{+name}"
- },
- "cancel": {
- "flatPath": "v1alpha2/operations/{operationsId}:cancel",
- "id": "genomics.operations.cancel",
- "path": "v1alpha2/{+name}:cancel",
- "request": {
- "$ref": "CancelOperationRequest"
- },
- "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation resource to be cancelled.",
- "type": "string",
- "required": true,
- "pattern": "^operations/.+$"
- }
- }
- }
- }
- },
"pipelines": {
"methods": {
- "run": {
- "description": "Runs a pipeline. If `pipelineId` is specified in the request, then\nrun a saved pipeline. If `ephemeralPipeline` is specified, then run\nthat pipeline once without saving a copy.\n\nThe caller must have READ permission to the project where the pipeline\nis stored and WRITE permission to the project where the pipeline will be\nrun, as VMs will be created and storage will be used.\n\nIf a pipeline operation is still running after 6 days, it will be canceled.",
- "request": {
- "$ref": "RunPipelineRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1alpha2/pipelines:run",
- "id": "genomics.pipelines.run",
- "path": "v1alpha2/pipelines:run"
- },
- "get": {
- "description": "Retrieves a pipeline based on ID.\n\nCaller must have READ permission to the project.",
- "response": {
- "$ref": "Pipeline"
- },
- "parameterOrder": [
- "pipelineId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pipelineId": {
- "description": "Caller must have READ access to the project in which this pipeline\nis defined.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1alpha2/pipelines/{pipelineId}",
- "id": "genomics.pipelines.get",
- "path": "v1alpha2/pipelines/{pipelineId}"
- },
"setOperationStatus": {
- "request": {
- "$ref": "SetOperationStatusRequest"
- },
- "description": "Sets status of a given operation. Any new timestamps (as determined by\ndescription) are appended to TimestampEvents. Should only be called by VMs\ncreated by the Pipelines Service and not by end users.",
- "httpMethod": "PUT",
- "parameterOrder": [],
"response": {
"$ref": "Empty"
},
+ "parameterOrder": [],
+ "httpMethod": "PUT",
+ "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
- "parameters": {},
"flatPath": "v1alpha2/pipelines:setOperationStatus",
+ "id": "genomics.pipelines.setOperationStatus",
"path": "v1alpha2/pipelines:setOperationStatus",
- "id": "genomics.pipelines.setOperationStatus"
+ "description": "Sets status of a given operation. Any new timestamps (as determined by\ndescription) are appended to TimestampEvents. Should only be called by VMs\ncreated by the Pipelines Service and not by end users.",
+ "request": {
+ "$ref": "SetOperationStatusRequest"
+ }
},
"getControllerConfig": {
- "flatPath": "v1alpha2/pipelines:getControllerConfig",
- "id": "genomics.pipelines.getControllerConfig",
- "path": "v1alpha2/pipelines:getControllerConfig",
- "description": "Gets controller configuration information. Should only be called\nby VMs created by the Pipelines Service and not by end users.",
+ "httpMethod": "GET",
"response": {
"$ref": "ControllerConfig"
},
"parameterOrder": [],
- "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
"parameters": {
"operationId": {
"description": "The operation to retrieve controller configuration for.",
@@ -199,55 +54,50 @@
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ]
+ "flatPath": "v1alpha2/pipelines:getControllerConfig",
+ "path": "v1alpha2/pipelines:getControllerConfig",
+ "id": "genomics.pipelines.getControllerConfig",
+ "description": "Gets controller configuration information. Should only be called\nby VMs created by the Pipelines Service and not by end users."
},
"delete": {
"description": "Deletes a pipeline based on ID.\n\nCaller must have WRITE permission to the project.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "pipelineId"
- ],
"response": {
"$ref": "Empty"
},
- "parameters": {
- "pipelineId": {
- "description": "Caller must have WRITE access to the project in which this pipeline\nis defined.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
+ "parameterOrder": [
+ "pipelineId"
+ ],
+ "httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
+ "parameters": {
+ "pipelineId": {
+ "location": "path",
+ "description": "Caller must have WRITE access to the project in which this pipeline\nis defined.",
+ "type": "string",
+ "required": true
+ }
+ },
"flatPath": "v1alpha2/pipelines/{pipelineId}",
- "path": "v1alpha2/pipelines/{pipelineId}",
- "id": "genomics.pipelines.delete"
+ "id": "genomics.pipelines.delete",
+ "path": "v1alpha2/pipelines/{pipelineId}"
},
"list": {
+ "id": "genomics.pipelines.list",
+ "path": "v1alpha2/pipelines",
"description": "Lists pipelines.\n\nCaller must have READ permission to the project.",
- "httpMethod": "GET",
"response": {
"$ref": "ListPipelinesResponse"
},
"parameterOrder": [],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
"parameters": {
- "pageSize": {
- "format": "int32",
- "description": "Number of pipelines to return at once. Defaults to 256, and max\nis 2048.",
- "type": "integer",
- "location": "query"
- },
- "projectId": {
- "location": "query",
- "description": "Required. The name of the project to search for pipelines. Caller\nmust have READ access to this project.",
- "type": "string"
- },
"namePrefix": {
"location": "query",
"description": "Pipelines with names that match this prefix should be\nreturned. If unspecified, all pipelines in the project, up to\n`pageSize`, will be returned.",
@@ -257,69 +107,204 @@
"description": "Token to use to indicate where to start getting results.\nIf unspecified, returns the first page of results.",
"type": "string",
"location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Number of pipelines to return at once. Defaults to 256, and max\nis 2048.",
+ "type": "integer"
+ },
+ "projectId": {
+ "description": "Required. The name of the project to search for pipelines. Caller\nmust have READ access to this project.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1alpha2/pipelines"
+ },
+ "create": {
+ "id": "genomics.pipelines.create",
+ "path": "v1alpha2/pipelines",
+ "description": "Creates a pipeline that can be run later. Create takes a Pipeline that\nhas all fields other than `pipelineId` populated, and then returns\nthe same pipeline with `pipelineId` populated. This id can be used\nto run the pipeline.\n\nCaller must have WRITE permission to the project.",
+ "request": {
+ "$ref": "Pipeline"
+ },
+ "response": {
+ "$ref": "Pipeline"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1alpha2/pipelines"
+ },
+ "run": {
+ "path": "v1alpha2/pipelines:run",
+ "id": "genomics.pipelines.run",
+ "description": "Runs a pipeline. If `pipelineId` is specified in the request, then\nrun a saved pipeline. If `ephemeralPipeline` is specified, then run\nthat pipeline once without saving a copy.\n\nThe caller must have READ permission to the project where the pipeline\nis stored and WRITE permission to the project where the pipeline will be\nrun, as VMs will be created and storage will be used.\n\nIf a pipeline operation is still running after 6 days, it will be canceled.",
+ "request": {
+ "$ref": "RunPipelineRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1alpha2/pipelines:run"
+ },
+ "get": {
+ "description": "Retrieves a pipeline based on ID.\n\nCaller must have READ permission to the project.",
+ "response": {
+ "$ref": "Pipeline"
+ },
+ "parameterOrder": [
+ "pipelineId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pipelineId": {
+ "location": "path",
+ "description": "Caller must have READ access to the project in which this pipeline\nis defined.",
+ "type": "string",
+ "required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
- "flatPath": "v1alpha2/pipelines",
- "path": "v1alpha2/pipelines",
- "id": "genomics.pipelines.list"
- },
- "create": {
- "request": {
- "$ref": "Pipeline"
- },
- "description": "Creates a pipeline that can be run later. Create takes a Pipeline that\nhas all fields other than `pipelineId` populated, and then returns\nthe same pipeline with `pipelineId` populated. This id can be used\nto run the pipeline.\n\nCaller must have WRITE permission to the project.",
+ "flatPath": "v1alpha2/pipelines/{pipelineId}",
+ "id": "genomics.pipelines.get",
+ "path": "v1alpha2/pipelines/{pipelineId}"
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "cancel": {
"response": {
- "$ref": "Pipeline"
+ "$ref": "Empty"
},
- "parameterOrder": [],
+ "parameterOrder": [
+ "name"
+ ],
"httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be cancelled.",
+ "type": "string",
+ "required": true,
+ "pattern": "^operations/.+$",
+ "location": "path"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
- "parameters": {},
- "flatPath": "v1alpha2/pipelines",
- "id": "genomics.pipelines.create",
- "path": "v1alpha2/pipelines"
+ "flatPath": "v1alpha2/operations/{operationsId}:cancel",
+ "id": "genomics.operations.cancel",
+ "path": "v1alpha2/{+name}:cancel",
+ "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation.",
+ "request": {
+ "$ref": "CancelOperationRequest"
+ }
+ },
+ "get": {
+ "path": "v1alpha2/{+name}",
+ "id": "genomics.operations.get",
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "name": {
+ "pattern": "^operations/.+$",
+ "location": "path",
+ "description": "The name of the operation resource.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1alpha2/operations/{operationsId}"
+ },
+ "list": {
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "filter": {
+ "description": "A string for filtering Operations.\nThe following filter fields are supported:\n\n* projectId: Required. Corresponds to\n OperationMetadata.projectId.\n* createTime: The time this job was created, in seconds from the\n [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `\u003e=` and/or `\u003c=`\n operators.\n* status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only\n one status may be specified.\n* labels.key where key is a label key.\n\nExamples:\n\n* `projectId = my-project AND createTime \u003e= 1432140000`\n* `projectId = my-project AND createTime \u003e= 1432140000 AND createTime \u003c= 1432150000 AND status = RUNNING`\n* `projectId = my-project AND labels.color = *`\n* `projectId = my-project AND labels.color = red`",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "name": {
+ "pattern": "^operations$",
+ "location": "path",
+ "description": "The name of the operation's parent resource.",
+ "type": "string",
+ "required": true
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "The maximum number of results to return. If unspecified, defaults to\n256. The maximum value is 2048.",
+ "type": "integer"
+ }
+ },
+ "flatPath": "v1alpha2/operations",
+ "id": "genomics.operations.list",
+ "path": "v1alpha2/{+name}",
+ "description": "Lists operations that match the specified filter in the request."
}
}
}
},
"parameters": {
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
"upload_protocol": {
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string"
},
"prettyPrint": {
+ "location": "query",
"description": "Returns response with indentations and line breaks.",
"default": "true",
- "type": "boolean",
+ "type": "boolean"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
"location": "query"
},
"uploadType": {
@@ -327,15 +312,10 @@
"type": "string",
"location": "query"
},
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
"callback": {
- "location": "query",
"description": "JSONP",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"$.xgafv": {
"enumDescriptions": [
@@ -351,6 +331,11 @@
"type": "string"
},
"alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
@@ -359,37 +344,112 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
+ "default": "json"
},
"key": {
+ "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string",
"location": "query"
},
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
+ "pp": {
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean",
"location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
}
},
"schemas": {
- "PipelineParameter": {
- "description": "Parameters facilitate setting and delivering data into the\npipeline's execution environment. They are defined at create time,\nwith optional defaults, and can be overridden at run time.\n\nIf `localCopy` is unset, then the parameter specifies a string that\nis passed as-is into the pipeline, as the value of the environment\nvariable with the given name. A default value can be optionally\nspecified at create time. The default can be overridden at run time\nusing the inputs map. If no default is given, a value must be\nsupplied at runtime.\n\nIf `localCopy` is defined, then the parameter specifies a data\nsource or sink, both in Google Cloud Storage and on the Docker container\nwhere the pipeline computation is run. The service account associated with\nthe Pipeline (by\ndefault the project's Compute Engine service account) must have access to the\nGoogle Cloud Storage paths.\n\nAt run time, the Google Cloud Storage paths can be overridden if a default\nwas provided at create time, or must be set otherwise. The pipeline runner\nshould add a key/value pair to either the inputs or outputs map. The\nindicated data copies will be carried out before/after pipeline execution,\njust as if the corresponding arguments were provided to `gsutil cp`.\n\nFor example: Given the following `PipelineParameter`, specified\nin the `inputParameters` list:\n\n```\n{name: \"input_file\", localCopy: {path: \"file.txt\", disk: \"pd1\"}}\n```\n\nwhere `disk` is defined in the `PipelineResources` object as:\n\n```\n{name: \"pd1\", mountPoint: \"/mnt/disk/\"}\n```\n\nWe create a disk named `pd1`, mount it on the host VM, and map\n`/mnt/pd1` to `/mnt/disk` in the docker container. At\nruntime, an entry for `input_file` would be required in the inputs\nmap, such as:\n\n```\n inputs[\"input_file\"] = \"gs://my-bucket/bar.txt\"\n```\n\nThis would generate the following gsutil call:\n\n```\n gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt\n```\n\nThe file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the\nDocker container. Acceptable paths are:\n\n\u003ctable\u003e\n \u003cthead\u003e\n \u003ctr\u003e\u003cth\u003eGoogle Cloud storage path\u003c/th\u003e\u003cth\u003eLocal path\u003c/th\u003e\u003c/tr\u003e\n \u003c/thead\u003e\n \u003ctbody\u003e\n \u003ctr\u003e\u003ctd\u003efile\u003c/td\u003e\u003ctd\u003efile\u003c/td\u003e\u003c/tr\u003e\n \u003ctr\u003e\u003ctd\u003eglob\u003c/td\u003e\u003ctd\u003edirectory\u003c/td\u003e\u003c/tr\u003e\n \u003c/tbody\u003e\n\u003c/table\u003e\n\nFor outputs, the direction of the copy is reversed:\n\n```\n gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt\n```\n\nAcceptable paths are:\n\n\u003ctable\u003e\n \u003cthead\u003e\n \u003ctr\u003e\u003cth\u003eLocal path\u003c/th\u003e\u003cth\u003eGoogle Cloud Storage path\u003c/th\u003e\u003c/tr\u003e\n \u003c/thead\u003e\n \u003ctbody\u003e\n \u003ctr\u003e\u003ctd\u003efile\u003c/td\u003e\u003ctd\u003efile\u003c/td\u003e\u003c/tr\u003e\n \u003ctr\u003e\n \u003ctd\u003efile\u003c/td\u003e\n \u003ctd\u003edirectory - directory must already exist\u003c/td\u003e\n \u003c/tr\u003e\n \u003ctr\u003e\n \u003ctd\u003eglob\u003c/td\u003e\n \u003ctd\u003edirectory - directory will be created if it doesn't exist\u003c/td\u003e\u003c/tr\u003e\n \u003c/tbody\u003e\n\u003c/table\u003e\n\nOne restriction due to docker limitations, is that for outputs that are found\non the boot disk, the local path cannot be a glob and must be a file.",
- "type": "object",
+ "DockerExecutor": {
"properties": {
- "description": {
- "description": "Human-readable description.",
+ "cmd": {
+ "description": "Required. The command or newline delimited script to run. The command\nstring will be executed within a bash shell.\n\nIf the command exits with a non-zero exit code, output parameter\nde-localization will be skipped and the pipeline operation's\n`error` field will be populated.\n\nMaximum command string length is 16384.",
"type": "string"
},
- "localCopy": {
- "description": "If present, this parameter is marked for copying to and from the VM.\n`LocalCopy` indicates where on the VM the file should be. The value\ngiven to this parameter (either at runtime or using `defaultValue`)\nmust be the remote path where the file should be.",
- "$ref": "LocalCopy"
+ "imageName": {
+ "description": "Required. Image name from either Docker Hub or Google Container Registry.\nUsers that run pipelines must have READ access to the image.",
+ "type": "string"
+ }
+ },
+ "id": "DockerExecutor",
+ "description": "The Docker execuctor specification.",
+ "type": "object"
+ },
+ "Disk": {
+ "properties": {
+ "autoDelete": {
+ "description": "Deprecated. Disks created by the Pipelines API will be deleted at the end\nof the pipeline run, regardless of what this field is set to.",
+ "type": "boolean"
},
+ "sizeGb": {
+ "format": "int32",
+ "description": "The size of the disk. Defaults to 500 (GB).\nThis field is not applicable for local SSD.",
+ "type": "integer"
+ },
+ "mountPoint": {
+ "description": "Required at create time and cannot be overridden at run time.\nSpecifies the path in the docker container where files on\nthis disk should be located. For example, if `mountPoint`\nis `/mnt/disk`, and the parameter has `localPath`\n`inputs/file.txt`, the docker container can access the data at\n`/mnt/disk/inputs/file.txt`.",
+ "type": "string"
+ },
+ "readOnly": {
+ "description": "Specifies how a sourced-base persistent disk will be mounted. See\nhttps://cloud.google.com/compute/docs/disks/persistent-disks#use_multi_instances\nfor more details.\nCan only be set at create time.",
+ "type": "boolean"
+ },
+ "source": {
+ "description": "The full or partial URL of the persistent disk to attach. See\nhttps://cloud.google.com/compute/docs/reference/latest/instances#resource\nand\nhttps://cloud.google.com/compute/docs/disks/persistent-disks#snapshots\nfor more details.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Required. The name of the disk that can be used in the pipeline\nparameters. Must be 1 - 63 characters.\nThe name \"boot\" is reserved for system use.",
+ "type": "string"
+ },
+ "type": {
+ "enumDescriptions": [
+ "Default disk type. Use one of the other options below.",
+ "Specifies a Google Compute Engine persistent hard disk. See\nhttps://cloud.google.com/compute/docs/disks/#pdspecs for details.",
+ "Specifies a Google Compute Engine persistent solid-state disk. See\nhttps://cloud.google.com/compute/docs/disks/#pdspecs for details.",
+ "Specifies a Google Compute Engine local SSD.\nSee https://cloud.google.com/compute/docs/disks/local-ssd for details."
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "PERSISTENT_HDD",
+ "PERSISTENT_SSD",
+ "LOCAL_SSD"
+ ],
+ "description": "Required. The type of the disk to create.",
+ "type": "string"
+ }
+ },
+ "id": "Disk",
+ "description": "A Google Compute Engine disk resource specification.",
+ "type": "object"
+ },
+ "Empty": {
+ "properties": {},
+ "id": "Empty",
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object"
+ },
+ "PipelineParameter": {
+ "properties": {
"defaultValue": {
"description": "The default value for this parameter. Can be overridden at runtime.\nIf `localCopy` is present, then this must be a Google Cloud Storage path\nbeginning with `gs://`.",
"type": "string"
@@ -397,24 +457,32 @@
"name": {
"description": "Required. Name of the parameter - the pipeline runner uses this string\nas the key to the input and output maps in RunPipeline.",
"type": "string"
+ },
+ "description": {
+ "description": "Human-readable description.",
+ "type": "string"
+ },
+ "localCopy": {
+ "$ref": "LocalCopy",
+ "description": "If present, this parameter is marked for copying to and from the VM.\n`LocalCopy` indicates where on the VM the file should be. The value\ngiven to this parameter (either at runtime or using `defaultValue`)\nmust be the remote path where the file should be."
}
},
- "id": "PipelineParameter"
+ "id": "PipelineParameter",
+ "description": "Parameters facilitate setting and delivering data into the\npipeline's execution environment. They are defined at create time,\nwith optional defaults, and can be overridden at run time.\n\nIf `localCopy` is unset, then the parameter specifies a string that\nis passed as-is into the pipeline, as the value of the environment\nvariable with the given name. A default value can be optionally\nspecified at create time. The default can be overridden at run time\nusing the inputs map. If no default is given, a value must be\nsupplied at runtime.\n\nIf `localCopy` is defined, then the parameter specifies a data\nsource or sink, both in Google Cloud Storage and on the Docker container\nwhere the pipeline computation is run. The service account associated with\nthe Pipeline (by\ndefault the project's Compute Engine service account) must have access to the\nGoogle Cloud Storage paths.\n\nAt run time, the Google Cloud Storage paths can be overridden if a default\nwas provided at create time, or must be set otherwise. The pipeline runner\nshould add a key/value pair to either the inputs or outputs map. The\nindicated data copies will be carried out before/after pipeline execution,\njust as if the corresponding arguments were provided to `gsutil cp`.\n\nFor example: Given the following `PipelineParameter`, specified\nin the `inputParameters` list:\n\n```\n{name: \"input_file\", localCopy: {path: \"file.txt\", disk: \"pd1\"}}\n```\n\nwhere `disk` is defined in the `PipelineResources` object as:\n\n```\n{name: \"pd1\", mountPoint: \"/mnt/disk/\"}\n```\n\nWe create a disk named `pd1`, mount it on the host VM, and map\n`/mnt/pd1` to `/mnt/disk` in the docker container. At\nruntime, an entry for `input_file` would be required in the inputs\nmap, such as:\n\n```\n inputs[\"input_file\"] = \"gs://my-bucket/bar.txt\"\n```\n\nThis would generate the following gsutil call:\n\n```\n gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt\n```\n\nThe file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the\nDocker container. Acceptable paths are:\n\n\u003ctable\u003e\n \u003cthead\u003e\n \u003ctr\u003e\u003cth\u003eGoogle Cloud storage path\u003c/th\u003e\u003cth\u003eLocal path\u003c/th\u003e\u003c/tr\u003e\n \u003c/thead\u003e\n \u003ctbody\u003e\n \u003ctr\u003e\u003ctd\u003efile\u003c/td\u003e\u003ctd\u003efile\u003c/td\u003e\u003c/tr\u003e\n \u003ctr\u003e\u003ctd\u003eglob\u003c/td\u003e\u003ctd\u003edirectory\u003c/td\u003e\u003c/tr\u003e\n \u003c/tbody\u003e\n\u003c/table\u003e\n\nFor outputs, the direction of the copy is reversed:\n\n```\n gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt\n```\n\nAcceptable paths are:\n\n\u003ctable\u003e\n \u003cthead\u003e\n \u003ctr\u003e\u003cth\u003eLocal path\u003c/th\u003e\u003cth\u003eGoogle Cloud Storage path\u003c/th\u003e\u003c/tr\u003e\n \u003c/thead\u003e\n \u003ctbody\u003e\n \u003ctr\u003e\u003ctd\u003efile\u003c/td\u003e\u003ctd\u003efile\u003c/td\u003e\u003c/tr\u003e\n \u003ctr\u003e\n \u003ctd\u003efile\u003c/td\u003e\n \u003ctd\u003edirectory - directory must already exist\u003c/td\u003e\n \u003c/tr\u003e\n \u003ctr\u003e\n \u003ctd\u003eglob\u003c/td\u003e\n \u003ctd\u003edirectory - directory will be created if it doesn't exist\u003c/td\u003e\u003c/tr\u003e\n \u003c/tbody\u003e\n\u003c/table\u003e\n\nOne restriction due to docker limitations, is that for outputs that are found\non the boot disk, the local path cannot be a glob and must be a file.",
+ "type": "object"
},
"LoggingOptions": {
- "description": "The logging options for the pipeline run.",
- "type": "object",
"properties": {
"gcsPath": {
"description": "The location in Google Cloud Storage to which the pipeline logs\nwill be copied. Can be specified as a fully qualified directory\npath, in which case logs will be output with a unique identifier\nas the filename in that directory, or as a fully specified path,\nwhich must end in `.log`, in which case that path will be\nused, and the user must ensure that logs are not\noverwritten. Stdout and stderr logs from the run are also\ngenerated and output as `-stdout.log` and `-stderr.log`.",
"type": "string"
}
},
- "id": "LoggingOptions"
+ "id": "LoggingOptions",
+ "description": "The logging options for the pipeline run.",
+ "type": "object"
},
"RunPipelineRequest": {
- "description": "The request to run a pipeline. If `pipelineId` is specified, it\nrefers to a saved pipeline created with CreatePipeline and set as\nthe `pipelineId` of the returned Pipeline object. If\n`ephemeralPipeline` is specified, that pipeline is run once\nwith the given args and not saved. It is an error to specify both\n`pipelineId` and `ephemeralPipeline`. `pipelineArgs`\nmust be specified.",
- "type": "object",
"properties": {
"pipelineArgs": {
"$ref": "RunPipelineArgs",
@@ -429,7 +497,9 @@
"description": "A new pipeline object to run once and then delete."
}
},
- "id": "RunPipelineRequest"
+ "id": "RunPipelineRequest",
+ "description": "The request to run a pipeline. If `pipelineId` is specified, it\nrefers to a saved pipeline created with CreatePipeline and set as\nthe `pipelineId` of the returned Pipeline object. If\n`ephemeralPipeline` is specified, that pipeline is run once\nwith the given args and not saved. It is an error to specify both\n`pipelineId` and `ephemeralPipeline`. `pipelineArgs`\nmust be specified.",
+ "type": "object"
},
"CancelOperationRequest": {
"description": "The request message for Operations.CancelOperation.",
@@ -438,19 +508,17 @@
"id": "CancelOperationRequest"
},
"RuntimeMetadata": {
- "description": "Runtime metadata that will be populated in the\nruntimeMetadata\nfield of the Operation associated with a RunPipeline execution.",
- "type": "object",
"properties": {
"computeEngine": {
- "description": "Execution information specific to Google Compute Engine.",
- "$ref": "ComputeEngine"
+ "$ref": "ComputeEngine",
+ "description": "Execution information specific to Google Compute Engine."
}
},
- "id": "RuntimeMetadata"
+ "id": "RuntimeMetadata",
+ "description": "Runtime metadata that will be populated in the\nruntimeMetadata\nfield of the Operation associated with a RunPipeline execution.",
+ "type": "object"
},
"Operation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
"properties": {
"done": {
"description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
@@ -469,23 +537,23 @@
"type": "string"
},
"error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure or cancellation."
+ "description": "The error result of the operation in case of failure or cancellation.",
+ "$ref": "Status"
},
"metadata": {
- "description": "An OperationMetadata object. This will always be returned with the Operation.",
- "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- }
+ },
+ "description": "An OperationMetadata object. This will always be returned with the Operation.",
+ "type": "object"
}
},
- "id": "Operation"
+ "id": "Operation",
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object"
},
"ImportReadGroupSetsResponse": {
- "description": "The read group set import response.",
- "type": "object",
"properties": {
"readGroupSetIds": {
"description": "IDs of the read group sets that were created.",
@@ -495,17 +563,14 @@
"type": "array"
}
},
- "id": "ImportReadGroupSetsResponse"
+ "id": "ImportReadGroupSetsResponse",
+ "description": "The read group set import response.",
+ "type": "object"
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
- "code": {
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "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"
@@ -520,6 +585,11 @@
"type": "object"
},
"type": "array"
+ },
+ "code": {
+ "format": "int32",
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "type": "integer"
}
},
"id": "Status"
@@ -543,34 +613,21 @@
"id": "ServiceAccount"
},
"PipelineResources": {
- "description": "The system resources for the pipeline run.",
- "type": "object",
"properties": {
- "noAddress": {
- "description": "Whether to assign an external IP to the instance. This is an experimental\nfeature that may go away. Defaults to false.\nCorresponds to `--no_address` flag for [gcloud compute instances create]\n(https://cloud.google.com/sdk/gcloud/reference/compute/instances/create).\nIn order to use this, must be true for both create time and run time.\nCannot be true at run time if false at create time. If you need to ssh into\na private IP VM for debugging, you can ssh to a public VM and then ssh into\nthe private VM's Internal IP. If noAddress is set, this pipeline run may\nonly load docker images from Google Container Registry and not Docker Hub.\nBefore using this, you must\n[configure access to Google services from internal IPs](https://cloud.google.com/compute/docs/configure-private-google-access#configuring_access_to_google_services_from_internal_ips).",
- "type": "boolean"
- },
- "disks": {
- "description": "Disks to attach.",
- "items": {
- "$ref": "Disk"
- },
- "type": "array"
- },
"bootDiskSizeGb": {
"format": "int32",
"description": "The size of the boot disk. Defaults to 10 (GB).",
"type": "integer"
},
- "preemptible": {
- "description": "Whether to use preemptible VMs. Defaults to `false`. In order to use this,\nmust be true for both create time and run time. Cannot be true at run time\nif false at create time.",
- "type": "boolean"
- },
"minimumRamGb": {
"format": "double",
"description": "The minimum amount of RAM to use. Defaults to 3.75 (GB)",
"type": "number"
},
+ "preemptible": {
+ "description": "Whether to use preemptible VMs. Defaults to `false`. In order to use this,\nmust be true for both create time and run time. Cannot be true at run time\nif false at create time.",
+ "type": "boolean"
+ },
"zones": {
"description": "List of Google Compute Engine availability zones to which resource\ncreation will restricted. If empty, any zone may be chosen.",
"items": {
@@ -582,22 +639,27 @@
"format": "int32",
"description": "The minimum number of cores to use. Defaults to 1.",
"type": "integer"
+ },
+ "noAddress": {
+ "description": "Whether to assign an external IP to the instance. This is an experimental\nfeature that may go away. Defaults to false.\nCorresponds to `--no_address` flag for [gcloud compute instances create]\n(https://cloud.google.com/sdk/gcloud/reference/compute/instances/create).\nIn order to use this, must be true for both create time and run time.\nCannot be true at run time if false at create time. If you need to ssh into\na private IP VM for debugging, you can ssh to a public VM and then ssh into\nthe private VM's Internal IP. If noAddress is set, this pipeline run may\nonly load docker images from Google Container Registry and not Docker Hub.\nBefore using this, you must\n[configure access to Google services from internal IPs](https://cloud.google.com/compute/docs/configure-private-google-access#configuring_access_to_google_services_from_internal_ips).",
+ "type": "boolean"
+ },
+ "disks": {
+ "description": "Disks to attach.",
+ "items": {
+ "$ref": "Disk"
+ },
+ "type": "array"
}
},
- "id": "PipelineResources"
+ "id": "PipelineResources",
+ "description": "The system resources for the pipeline run.",
+ "type": "object"
},
"Pipeline": {
"description": "The pipeline object. Represents a transformation from a set of input\nparameters to a set of output parameters. The transformation is defined\nas a docker image and command to run within that image. Each pipeline\nis run on a Google Compute Engine VM. A pipeline can be created with the\n`create` method and then later run with the `run` method, or a pipeline can\nbe defined and run all at once with the `run` method.",
"type": "object",
"properties": {
- "docker": {
- "$ref": "DockerExecutor",
- "description": "Specifies the docker run information."
- },
- "description": {
- "description": "User-specified description.",
- "type": "string"
- },
"inputParameters": {
"description": "Input parameters of the pipeline.",
"items": {
@@ -606,27 +668,35 @@
"type": "array"
},
"resources": {
- "$ref": "PipelineResources",
- "description": "Required. Specifies resource requirements for the pipeline run.\nRequired fields:\n\n*\nminimumCpuCores\n\n*\nminimumRamGb"
+ "description": "Required. Specifies resource requirements for the pipeline run.\nRequired fields:\n\n*\nminimumCpuCores\n\n*\nminimumRamGb",
+ "$ref": "PipelineResources"
},
"name": {
"description": "Required. A user specified pipeline name that does not have to be unique.\nThis name can be used for filtering Pipelines in ListPipelines.",
"type": "string"
},
- "pipelineId": {
- "description": "Unique pipeline id that is generated by the service when CreatePipeline\nis called. Cannot be specified in the Pipeline used in the\nCreatePipelineRequest, and will be populated in the response to\nCreatePipeline and all subsequent Get and List calls. Indicates that the\nservice has registered this pipeline.",
- "type": "string"
- },
"projectId": {
"description": "Required. The project in which to create the pipeline. The caller must have\nWRITE access.",
"type": "string"
},
+ "pipelineId": {
+ "description": "Unique pipeline id that is generated by the service when CreatePipeline\nis called. Cannot be specified in the Pipeline used in the\nCreatePipelineRequest, and will be populated in the response to\nCreatePipeline and all subsequent Get and List calls. Indicates that the\nservice has registered this pipeline.",
+ "type": "string"
+ },
"outputParameters": {
"description": "Output parameters of the pipeline.",
"items": {
"$ref": "PipelineParameter"
},
"type": "array"
+ },
+ "description": {
+ "description": "User-specified description.",
+ "type": "string"
+ },
+ "docker": {
+ "$ref": "DockerExecutor",
+ "description": "Specifies the docker run information."
}
},
"id": "Pipeline"
@@ -635,6 +705,12 @@
"description": "Stores the information that the controller will fetch from the\nserver in order to run. Should only be used by VMs created by the\nPipelines Service and not by end users.",
"type": "object",
"properties": {
+ "vars": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "type": "object"
+ },
"image": {
"type": "string"
},
@@ -664,20 +740,17 @@
},
"cmd": {
"type": "string"
- },
- "vars": {
- "additionalProperties": {
- "type": "string"
- },
- "type": "object"
}
},
"id": "ControllerConfig"
},
"OperationEvent": {
- "description": "An event that occurred during an Operation.",
- "type": "object",
"properties": {
+ "startTime": {
+ "format": "google-datetime",
+ "description": "Optional time of when event started.",
+ "type": "string"
+ },
"description": {
"description": "Required description of event.",
"type": "string"
@@ -686,18 +759,13 @@
"format": "google-datetime",
"description": "Optional time of when event finished. An event can have a start time and no\nfinish time. If an event has a finish time, there must be a start time.",
"type": "string"
- },
- "startTime": {
- "format": "google-datetime",
- "description": "Optional time of when event started.",
- "type": "string"
}
},
- "id": "OperationEvent"
+ "id": "OperationEvent",
+ "description": "An event that occurred during an Operation.",
+ "type": "object"
},
"ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
@@ -711,7 +779,9 @@
"type": "array"
}
},
- "id": "ListOperationsResponse"
+ "id": "ListOperationsResponse",
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object"
},
"RepeatedString": {
"type": "object",
@@ -726,9 +796,40 @@
"id": "RepeatedString"
},
"OperationMetadata": {
- "description": "Metadata describing an Operation.",
- "type": "object",
"properties": {
+ "runtimeMetadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Runtime metadata on this Operation.",
+ "type": "object"
+ },
+ "createTime": {
+ "format": "google-datetime",
+ "description": "The time at which the job was submitted to the Genomics service.",
+ "type": "string"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optionally provided by the caller when submitting the request that creates\nthe operation.",
+ "type": "object"
+ },
+ "projectId": {
+ "description": "The Google Cloud Project in which the job is scoped.",
+ "type": "string"
+ },
+ "clientId": {
+ "description": "This field is deprecated. Use `labels` instead. Optionally provided by the\ncaller when submitting the request that creates the operation.",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "The time at which the job stopped running.",
+ "type": "string"
+ },
"events": {
"description": "Optional event messages that were generated during the job's execution.\nThis also contains any warnings that were generated during import\nor export.",
"items": {
@@ -736,11 +837,6 @@
},
"type": "array"
},
- "endTime": {
- "format": "google-datetime",
- "description": "The time at which the job stopped running.",
- "type": "string"
- },
"startTime": {
"format": "google-datetime",
"description": "The time at which the job began to run.",
@@ -753,68 +849,29 @@
},
"description": "The original request that started the operation. Note that this will be in\ncurrent version of the API. If the operation was started with v1beta2 API\nand a GetOperation is performed on v1 API, a v1 request will be returned.",
"type": "object"
- },
- "runtimeMetadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Runtime metadata on this Operation.",
- "type": "object"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optionally provided by the caller when submitting the request that creates\nthe operation.",
- "type": "object"
- },
- "createTime": {
- "format": "google-datetime",
- "description": "The time at which the job was submitted to the Genomics service.",
- "type": "string"
- },
- "projectId": {
- "description": "The Google Cloud Project in which the job is scoped.",
- "type": "string"
- },
- "clientId": {
- "description": "This field is deprecated. Use `labels` instead. Optionally provided by the\ncaller when submitting the request that creates the operation.",
- "type": "string"
}
},
- "id": "OperationMetadata"
+ "id": "OperationMetadata",
+ "description": "Metadata describing an Operation.",
+ "type": "object"
},
"RunPipelineArgs": {
- "description": "The pipeline run arguments.",
- "type": "object",
"properties": {
- "labels": {
- "description": "Labels to apply to this pipeline run. Labels will also be applied to\ncompute resources (VM, disks) created by this pipeline run. When listing\noperations, operations can filtered by labels.\nLabel keys may not be empty; label values may be empty. Non-empty labels\nmust be 1-63 characters long, and comply with [RFC1035]\n(https://www.ietf.org/rfc/rfc1035.txt).\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must be\na dash, lowercase letter, or digit, except the last character, which cannot\nbe a dash.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "logging": {
- "description": "Required. Logging options. Used by the service to communicate results\nto the user.",
- "$ref": "LoggingOptions"
- },
- "outputs": {
- "description": "Pipeline output arguments; keys are defined in the pipeline\ndocumentation. All output parameters of without default values\nmust be specified. If parameters with defaults are specified\nhere, the defaults will be overridden.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
+ "keepVmAliveOnFailureDuration": {
+ "format": "google-duration",
+ "description": "How long to keep the VM up after a failure (for example docker command\nfailed, copying input or output files failed, etc). While the VM is up, one\ncan ssh into the VM to debug. Default is 0; maximum allowed value is 1 day.",
+ "type": "string"
},
"resources": {
"$ref": "PipelineResources",
"description": "Specifies resource requirements/overrides for the pipeline run."
},
- "keepVmAliveOnFailureDuration": {
- "format": "google-duration",
- "description": "How long to keep the VM up after a failure (for example docker command\nfailed, copying input or output files failed, etc). While the VM is up, one\ncan ssh into the VM to debug. Default is 0; maximum allowed value is 1 day.",
- "type": "string"
+ "outputs": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Pipeline output arguments; keys are defined in the pipeline\ndocumentation. All output parameters of without default values\nmust be specified. If parameters with defaults are specified\nhere, the defaults will be overridden.",
+ "type": "object"
},
"projectId": {
"description": "Required. The project in which to run the pipeline. The caller must have\nWRITER access to all Google Cloud services and resources (e.g. Google\nCompute Engine) will be used.",
@@ -824,19 +881,32 @@
"description": "This field is deprecated. Use `labels` instead. Client-specified pipeline\noperation identifier.",
"type": "string"
},
- "serviceAccount": {
- "description": "The Google Cloud Service Account that will be used to access data and\nservices. By default, the compute service account associated with\n`projectId` is used.",
- "$ref": "ServiceAccount"
- },
"inputs": {
"additionalProperties": {
"type": "string"
},
"description": "Pipeline input arguments; keys are defined in the pipeline documentation.\nAll input parameters that do not have default values must be specified.\nIf parameters with defaults are specified here, the defaults will be\noverridden.",
"type": "object"
+ },
+ "serviceAccount": {
+ "$ref": "ServiceAccount",
+ "description": "The Google Cloud Service Account that will be used to access data and\nservices. By default, the compute service account associated with\n`projectId` is used."
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Labels to apply to this pipeline run. Labels will also be applied to\ncompute resources (VM, disks) created by this pipeline run. When listing\noperations, operations can filtered by labels.\nLabel keys may not be empty; label values may be empty. Non-empty labels\nmust be 1-63 characters long, and comply with [RFC1035]\n(https://www.ietf.org/rfc/rfc1035.txt).\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must be\na dash, lowercase letter, or digit, except the last character, which cannot\nbe a dash.",
+ "type": "object"
+ },
+ "logging": {
+ "description": "Required. Logging options. Used by the service to communicate results\nto the user.",
+ "$ref": "LoggingOptions"
}
},
- "id": "RunPipelineArgs"
+ "id": "RunPipelineArgs",
+ "description": "The pipeline run arguments.",
+ "type": "object"
},
"ListPipelinesResponse": {
"description": "The response of ListPipelines. Contains at most `pageSize`\npipelines. If it contains `pageSize` pipelines, and more pipelines\nexist, then `nextPageToken` will be populated and should be\nused as the `pageToken` argument to a subsequent ListPipelines\nrequest.",
@@ -871,7 +941,6 @@
"type": "string"
},
"errorCode": {
- "type": "string",
"enumDescriptions": [
"Not an error; returned on success\n\nHTTP Mapping: 200 OK",
"The operation was cancelled, typically by the caller.\n\nHTTP Mapping: 499 Client Closed Request",
@@ -909,7 +978,8 @@
"INTERNAL",
"UNAVAILABLE",
"DATA_LOSS"
- ]
+ ],
+ "type": "string"
},
"timestampEvents": {
"items": {
@@ -920,6 +990,32 @@
},
"id": "SetOperationStatusRequest"
},
+ "ComputeEngine": {
+ "description": "Describes a Compute Engine resource that is being managed by a running\npipeline.",
+ "type": "object",
+ "properties": {
+ "zone": {
+ "description": "The availability zone in which the instance resides.",
+ "type": "string"
+ },
+ "diskNames": {
+ "description": "The names of the disks that were created for this pipeline.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "machineType": {
+ "description": "The machine type of the instance.",
+ "type": "string"
+ },
+ "instanceName": {
+ "description": "The instance on which the operation is running.",
+ "type": "string"
+ }
+ },
+ "id": "ComputeEngine"
+ },
"ImportVariantsResponse": {
"description": "The variant data import response.",
"type": "object",
@@ -934,131 +1030,36 @@
},
"id": "ImportVariantsResponse"
},
- "ComputeEngine": {
- "description": "Describes a Compute Engine resource that is being managed by a running\npipeline.",
- "type": "object",
- "properties": {
- "instanceName": {
- "description": "The instance on which the operation is running.",
- "type": "string"
- },
- "zone": {
- "description": "The availability zone in which the instance resides.",
- "type": "string"
- },
- "diskNames": {
- "description": "The names of the disks that were created for this pipeline.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "machineType": {
- "description": "The machine type of the instance.",
- "type": "string"
- }
- },
- "id": "ComputeEngine"
- },
"TimestampEvent": {
"description": "Stores the list of events and times they occured for major events in job\nexecution.",
"type": "object",
"properties": {
+ "description": {
+ "description": "String indicating the type of event",
+ "type": "string"
+ },
"timestamp": {
"format": "google-datetime",
"description": "The time this event occured.",
"type": "string"
- },
- "description": {
- "description": "String indicating the type of event",
- "type": "string"
}
},
"id": "TimestampEvent"
},
"LocalCopy": {
- "description": "LocalCopy defines how a remote file should be copied to and from the VM.",
- "type": "object",
"properties": {
- "disk": {
- "description": "Required. The name of the disk where this parameter is\nlocated. Can be the name of one of the disks specified in the\nResources field, or \"boot\", which represents the Docker\ninstance's boot disk and has a mount point of `/`.",
- "type": "string"
- },
"path": {
"description": "Required. The path within the user's docker container where\nthis input should be localized to and from, relative to the specified\ndisk's mount point. For example: file.txt,",
"type": "string"
- }
- },
- "id": "LocalCopy"
- },
- "DockerExecutor": {
- "description": "The Docker execuctor specification.",
- "type": "object",
- "properties": {
- "cmd": {
- "description": "Required. The command or newline delimited script to run. The command\nstring will be executed within a bash shell.\n\nIf the command exits with a non-zero exit code, output parameter\nde-localization will be skipped and the pipeline operation's\n`error` field will be populated.\n\nMaximum command string length is 16384.",
- "type": "string"
},
- "imageName": {
- "description": "Required. Image name from either Docker Hub or Google Container Registry.\nUsers that run pipelines must have READ access to the image.",
+ "disk": {
+ "description": "Required. The name of the disk where this parameter is\nlocated. Can be the name of one of the disks specified in the\nResources field, or \"boot\", which represents the Docker\ninstance's boot disk and has a mount point of `/`.",
"type": "string"
}
},
- "id": "DockerExecutor"
- },
- "Disk": {
- "description": "A Google Compute Engine disk resource specification.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Required. The name of the disk that can be used in the pipeline\nparameters. Must be 1 - 63 characters.\nThe name \"boot\" is reserved for system use.",
- "type": "string"
- },
- "type": {
- "description": "Required. The type of the disk to create.",
- "type": "string",
- "enumDescriptions": [
- "Default disk type. Use one of the other options below.",
- "Specifies a Google Compute Engine persistent hard disk. See\nhttps://cloud.google.com/compute/docs/disks/#pdspecs for details.",
- "Specifies a Google Compute Engine persistent solid-state disk. See\nhttps://cloud.google.com/compute/docs/disks/#pdspecs for details.",
- "Specifies a Google Compute Engine local SSD.\nSee https://cloud.google.com/compute/docs/disks/local-ssd for details."
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "PERSISTENT_HDD",
- "PERSISTENT_SSD",
- "LOCAL_SSD"
- ]
- },
- "autoDelete": {
- "description": "Deprecated. Disks created by the Pipelines API will be deleted at the end\nof the pipeline run, regardless of what this field is set to.",
- "type": "boolean"
- },
- "sizeGb": {
- "format": "int32",
- "description": "The size of the disk. Defaults to 500 (GB).\nThis field is not applicable for local SSD.",
- "type": "integer"
- },
- "mountPoint": {
- "description": "Required at create time and cannot be overridden at run time.\nSpecifies the path in the docker container where files on\nthis disk should be located. For example, if `mountPoint`\nis `/mnt/disk`, and the parameter has `localPath`\n`inputs/file.txt`, the docker container can access the data at\n`/mnt/disk/inputs/file.txt`.",
- "type": "string"
- },
- "readOnly": {
- "description": "Specifies how a sourced-base persistent disk will be mounted. See\nhttps://cloud.google.com/compute/docs/disks/persistent-disks#use_multi_instances\nfor more details.\nCan only be set at create time.",
- "type": "boolean"
- },
- "source": {
- "description": "The full or partial URL of the persistent disk to attach. See\nhttps://cloud.google.com/compute/docs/reference/latest/instances#resource\nand\nhttps://cloud.google.com/compute/docs/disks/persistent-disks#snapshots\nfor more details.",
- "type": "string"
- }
- },
- "id": "Disk"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
+ "id": "LocalCopy",
+ "description": "LocalCopy defines how a remote file should be copied to and from the VM.",
+ "type": "object"
}
},
"protocol": "rest",
@@ -1071,20 +1072,19 @@
"auth": {
"oauth2": {
"scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
"https://www.googleapis.com/auth/genomics": {
"description": "View and manage Genomics data"
},
"https://www.googleapis.com/auth/compute": {
"description": "View and manage your Google Compute Engine resources"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
- "servicePath": "",
"description": "Upload, process, query, and search Genomics data in the cloud.",
"kind": "discovery#restDescription",
- "rootUrl": "https://genomics.googleapis.com/"
+ "servicePath": ""
}
diff --git a/iam/v1/iam-api.json b/iam/v1/iam-api.json
index 96fb85f..3e257e5 100644
--- a/iam/v1/iam-api.json
+++ b/iam/v1/iam-api.json
@@ -1,156 +1,26 @@
{
+ "canonicalName": "iam",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://iam.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "iam",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Google Identity and Access Management (IAM) API",
"ownerName": "Google",
"resources": {
- "projects": {
+ "organizations": {
"resources": {
"roles": {
"methods": {
- "create": {
- "response": {
- "$ref": "Role"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "description": "The resource name of the parent resource in one of the following formats:\n`organizations/{ORGANIZATION_ID}`\n`projects/{PROJECT_ID}`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/roles",
- "id": "iam.projects.roles.create",
- "path": "v1/{+parent}/roles",
- "request": {
- "$ref": "CreateRoleRequest"
- },
- "description": "Creates a new Role."
- },
- "undelete": {
- "request": {
- "$ref": "UndeleteRoleRequest"
- },
- "description": "Undelete a Role, bringing it back in its previous state.",
- "response": {
- "$ref": "Role"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The resource name of the role in one of the following formats:\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/roles/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/roles/{rolesId}:undelete",
- "id": "iam.projects.roles.undelete",
- "path": "v1/{+name}:undelete"
- },
- "get": {
- "response": {
- "$ref": "Role"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/roles/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/roles/{rolesId}",
- "id": "iam.projects.roles.get",
- "path": "v1/{+name}",
- "description": "Gets a Role definition."
- },
- "patch": {
- "path": "v1/{+name}",
- "id": "iam.projects.roles.patch",
- "description": "Updates a Role definition.",
- "request": {
- "$ref": "Role"
- },
- "httpMethod": "PATCH",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Role"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/roles/[^/]+$"
- },
- "updateMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "A mask describing which fields in the Role have changed.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/roles/{rolesId}"
- },
- "delete": {
- "flatPath": "v1/projects/{projectsId}/roles/{rolesId}",
- "path": "v1/{+name}",
- "id": "iam.projects.roles.delete",
- "description": "Soft deletes a role. The role is suspended and cannot be used to create new\nIAM Policy Bindings.\nThe Role will not be included in `ListRoles()` unless `show_deleted` is set\nin the `ListRolesRequest`. The Role contains the deleted boolean set.\nExisting Bindings remains, but are inactive. The Role can be undeleted\nwithin 7 days. After 7 days the Role is deleted and all Bindings associated\nwith the role are removed.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Role"
- },
- "parameters": {
- "etag": {
- "location": "query",
- "format": "byte",
- "description": "Used to perform a consistent read-modify-write.",
- "type": "string"
- },
- "name": {
- "description": "The resource name of the role in one of the following formats:\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/roles/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
"list": {
"response": {
"$ref": "ListRolesResponse"
@@ -163,11 +33,357 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "showDeleted": {
- "location": "query",
- "description": "Include Roles that have been deleted.",
- "type": "boolean"
+ "parent": {
+ "description": "The resource name of the parent resource in one of the following formats:\n`` (empty string) -- this refers to curated roles.\n`organizations/{ORGANIZATION_ID}`\n`projects/{PROJECT_ID}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
},
+ "showDeleted": {
+ "description": "Include Roles that have been deleted.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "pageToken": {
+ "description": "Optional pagination token returned in an earlier ListRolesResponse.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Optional limit on the number of roles to include in the response.",
+ "type": "integer"
+ },
+ "view": {
+ "location": "query",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "description": "Optional view for the returned Role objects.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/organizations/{organizationsId}/roles",
+ "id": "iam.organizations.roles.list",
+ "path": "v1/{+parent}/roles",
+ "description": "Lists the Roles defined on a resource."
+ },
+ "create": {
+ "request": {
+ "$ref": "CreateRoleRequest"
+ },
+ "description": "Creates a new Role.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "Role"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "pattern": "^organizations/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the parent resource in one of the following formats:\n`organizations/{ORGANIZATION_ID}`\n`projects/{PROJECT_ID}`",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/organizations/{organizationsId}/roles",
+ "path": "v1/{+parent}/roles",
+ "id": "iam.organizations.roles.create"
+ },
+ "patch": {
+ "id": "iam.organizations.roles.patch",
+ "path": "v1/{+name}",
+ "description": "Updates a Role definition.",
+ "request": {
+ "$ref": "Role"
+ },
+ "response": {
+ "$ref": "Role"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "A mask describing which fields in the Role have changed.",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "description": "The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+/roles/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}"
+ },
+ "undelete": {
+ "path": "v1/{+name}:undelete",
+ "id": "iam.organizations.roles.undelete",
+ "request": {
+ "$ref": "UndeleteRoleRequest"
+ },
+ "description": "Undelete a Role, bringing it back in its previous state.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Role"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The resource name of the role in one of the following formats:\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+/roles/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}:undelete"
+ },
+ "get": {
+ "id": "iam.organizations.roles.get",
+ "path": "v1/{+name}",
+ "description": "Gets a Role definition.",
+ "response": {
+ "$ref": "Role"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+/roles/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Role"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "etag": {
+ "location": "query",
+ "format": "byte",
+ "description": "Used to perform a consistent read-modify-write.",
+ "type": "string"
+ },
+ "name": {
+ "location": "path",
+ "description": "The resource name of the role in one of the following formats:\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+/roles/[^/]+$"
+ }
+ },
+ "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}",
+ "id": "iam.organizations.roles.delete",
+ "path": "v1/{+name}",
+ "description": "Soft deletes a role. The role is suspended and cannot be used to create new\nIAM Policy Bindings.\nThe Role will not be included in `ListRoles()` unless `show_deleted` is set\nin the `ListRolesRequest`. The Role contains the deleted boolean set.\nExisting Bindings remains, but are inactive. The Role can be undeleted\nwithin 7 days. After 7 days the Role is deleted and all Bindings associated\nwith the role are removed."
+ }
+ }
+ }
+ }
+ },
+ "projects": {
+ "resources": {
+ "roles": {
+ "methods": {
+ "create": {
+ "response": {
+ "$ref": "Role"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "description": "The resource name of the parent resource in one of the following formats:\n`organizations/{ORGANIZATION_ID}`\n`projects/{PROJECT_ID}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/roles",
+ "id": "iam.projects.roles.create",
+ "path": "v1/{+parent}/roles",
+ "description": "Creates a new Role.",
+ "request": {
+ "$ref": "CreateRoleRequest"
+ }
+ },
+ "patch": {
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Role"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "updateMask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "A mask describing which fields in the Role have changed.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/roles/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/roles/{rolesId}",
+ "path": "v1/{+name}",
+ "id": "iam.projects.roles.patch",
+ "request": {
+ "$ref": "Role"
+ },
+ "description": "Updates a Role definition."
+ },
+ "undelete": {
+ "response": {
+ "$ref": "Role"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "description": "The resource name of the role in one of the following formats:\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/roles/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/roles/{rolesId}:undelete",
+ "id": "iam.projects.roles.undelete",
+ "path": "v1/{+name}:undelete",
+ "description": "Undelete a Role, bringing it back in its previous state.",
+ "request": {
+ "$ref": "UndeleteRoleRequest"
+ }
+ },
+ "get": {
+ "response": {
+ "$ref": "Role"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "description": "The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/roles/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/roles/{rolesId}",
+ "id": "iam.projects.roles.get",
+ "path": "v1/{+name}",
+ "description": "Gets a Role definition."
+ },
+ "delete": {
+ "flatPath": "v1/projects/{projectsId}/roles/{rolesId}",
+ "id": "iam.projects.roles.delete",
+ "path": "v1/{+name}",
+ "description": "Soft deletes a role. The role is suspended and cannot be used to create new\nIAM Policy Bindings.\nThe Role will not be included in `ListRoles()` unless `show_deleted` is set\nin the `ListRolesRequest`. The Role contains the deleted boolean set.\nExisting Bindings remains, but are inactive. The Role can be undeleted\nwithin 7 days. After 7 days the Role is deleted and all Bindings associated\nwith the role are removed.",
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Role"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The resource name of the role in one of the following formats:\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/roles/[^/]+$"
+ },
+ "etag": {
+ "location": "query",
+ "format": "byte",
+ "description": "Used to perform a consistent read-modify-write.",
+ "type": "string"
+ }
+ }
+ },
+ "list": {
+ "description": "Lists the Roles defined on a resource.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListRolesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
"pageToken": {
"description": "Optional pagination token returned in an earlier ListRolesResponse.",
"type": "string",
@@ -180,48 +396,47 @@
"location": "query"
},
"view": {
- "description": "Optional view for the returned Role objects.",
- "type": "string",
"location": "query",
"enum": [
"BASIC",
"FULL"
- ]
+ ],
+ "description": "Optional view for the returned Role objects.",
+ "type": "string"
},
"parent": {
+ "pattern": "^projects/[^/]+$",
"location": "path",
"description": "The resource name of the parent resource in one of the following formats:\n`` (empty string) -- this refers to curated roles.\n`organizations/{ORGANIZATION_ID}`\n`projects/{PROJECT_ID}`",
"type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$"
+ "required": true
+ },
+ "showDeleted": {
+ "description": "Include Roles that have been deleted.",
+ "type": "boolean",
+ "location": "query"
}
},
"flatPath": "v1/projects/{projectsId}/roles",
- "id": "iam.projects.roles.list",
"path": "v1/{+parent}/roles",
- "description": "Lists the Roles defined on a resource."
+ "id": "iam.projects.roles.list"
}
}
},
"serviceAccounts": {
"methods": {
"update": {
- "id": "iam.projects.serviceAccounts.update",
- "path": "v1/{+name}",
+ "description": "Updates a ServiceAccount.\n\nCurrently, only the following fields are updatable:\n`display_name` .\nThe `etag` is mandatory.",
"request": {
"$ref": "ServiceAccount"
},
- "description": "Updates a ServiceAccount.\n\nCurrently, only the following fields are updatable:\n`display_name` .\nThe `etag` is mandatory.",
- "response": {
- "$ref": "ServiceAccount"
- },
+ "httpMethod": "PUT",
"parameterOrder": [
"name"
],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
+ "response": {
+ "$ref": "ServiceAccount"
+ },
"parameters": {
"name": {
"description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\n\nRequests using `-` as a wildcard for the `PROJECT_ID` will infer the\nproject from the `account` and the `ACCOUNT` value can be the `email`\naddress or the `unique_id` of the service account.\n\nIn responses the resource name will always be in the format\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.",
@@ -231,10 +446,14 @@
"location": "path"
}
},
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}",
+ "path": "v1/{+name}",
+ "id": "iam.projects.serviceAccounts.update"
},
"testIamPermissions": {
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:testIamPermissions",
"id": "iam.projects.serviceAccounts.testIamPermissions",
"path": "v1/{+resource}:testIamPermissions",
"request": {
@@ -253,16 +472,16 @@
],
"parameters": {
"resource": {
- "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
"location": "path",
"description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
"type": "string",
- "required": true
+ "required": true,
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$"
}
- }
+ },
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:testIamPermissions"
},
"delete": {
- "description": "Deletes a ServiceAccount.",
"response": {
"$ref": "Empty"
},
@@ -284,13 +503,46 @@
],
"flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}",
"id": "iam.projects.serviceAccounts.delete",
- "path": "v1/{+name}"
+ "path": "v1/{+name}",
+ "description": "Deletes a ServiceAccount."
+ },
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "ListServiceAccountsResponse"
+ },
+ "parameters": {
+ "pageSize": {
+ "format": "int32",
+ "description": "Optional limit on the number of service accounts to include in the\nresponse. Further accounts can subsequently be obtained by including the\nListServiceAccountsResponse.next_page_token\nin a subsequent request.",
+ "type": "integer",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional pagination token returned in an earlier\nListServiceAccountsResponse.next_page_token.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Required. The resource name of the project associated with the service\naccounts, such as `projects/my-project-123`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts",
+ "path": "v1/{+name}/serviceAccounts",
+ "id": "iam.projects.serviceAccounts.list",
+ "description": "Lists ServiceAccounts for a project."
},
"signBlob": {
- "request": {
- "$ref": "SignBlobRequest"
- },
- "description": "Signs a blob using a service account's system-managed private key.",
"response": {
"$ref": "SignBlobResponse"
},
@@ -312,84 +564,57 @@
},
"flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signBlob",
"id": "iam.projects.serviceAccounts.signBlob",
- "path": "v1/{+name}:signBlob"
- },
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "ListServiceAccountsResponse"
+ "path": "v1/{+name}:signBlob",
+ "request": {
+ "$ref": "SignBlobRequest"
},
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Optional pagination token returned in an earlier\nListServiceAccountsResponse.next_page_token.",
- "type": "string"
- },
- "name": {
- "description": "Required. The resource name of the project associated with the service\naccounts, such as `projects/my-project-123`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "pageSize": {
- "format": "int32",
- "description": "Optional limit on the number of service accounts to include in the\nresponse. Further accounts can subsequently be obtained by including the\nListServiceAccountsResponse.next_page_token\nin a subsequent request.",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/serviceAccounts",
- "path": "v1/{+name}/serviceAccounts",
- "id": "iam.projects.serviceAccounts.list",
- "description": "Lists ServiceAccounts for a project."
+ "description": "Signs a blob using a service account's system-managed private key."
},
"create": {
- "description": "Creates a ServiceAccount\nand returns it.",
+ "path": "v1/{+name}/serviceAccounts",
+ "id": "iam.projects.serviceAccounts.create",
"request": {
"$ref": "CreateServiceAccountRequest"
},
- "response": {
- "$ref": "ServiceAccount"
- },
+ "description": "Creates a ServiceAccount\nand returns it.",
+ "httpMethod": "POST",
"parameterOrder": [
"name"
],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Required. The resource name of the project associated with the service\naccounts, such as `projects/my-project-123`.",
- "type": "string",
- "required": true
- }
+ "response": {
+ "$ref": "ServiceAccount"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectsId}/serviceAccounts",
- "id": "iam.projects.serviceAccounts.create",
- "path": "v1/{+name}/serviceAccounts"
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Required. The resource name of the project associated with the service\naccounts, such as `projects/my-project-123`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts"
},
"signJwt": {
- "description": "Signs a JWT using a service account's system-managed private key.\n\nIf no expiry time (`exp`) is provided in the `SignJwtRequest`, IAM sets an\nan expiry time of one hour by default. If you request an expiry time of\nmore than one hour, the request will fail.",
+ "path": "v1/{+name}:signJwt",
+ "id": "iam.projects.serviceAccounts.signJwt",
"request": {
"$ref": "SignJwtRequest"
},
- "response": {
- "$ref": "SignJwtResponse"
- },
+ "description": "Signs a JWT using a service account's system-managed private key.\n\nIf no expiry time (`exp`) is provided in the `SignJwtRequest`, IAM sets an\nan expiry time of one hour by default. If you request an expiry time of\nmore than one hour, the request will fail.",
+ "httpMethod": "POST",
"parameterOrder": [
"name"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "SignJwtResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"name": {
"description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.",
@@ -399,24 +624,22 @@
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signJwt",
- "id": "iam.projects.serviceAccounts.signJwt",
- "path": "v1/{+name}:signJwt"
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signJwt"
},
"setIamPolicy": {
- "response": {
- "$ref": "Policy"
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "iam.projects.serviceAccounts.setIamPolicy",
+ "description": "Sets the IAM access control policy for a\nServiceAccount.",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
},
+ "httpMethod": "POST",
"parameterOrder": [
"resource"
],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
+ "response": {
+ "$ref": "Policy"
+ },
"parameters": {
"resource": {
"pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
@@ -426,15 +649,14 @@
"required": true
}
},
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:setIamPolicy",
- "id": "iam.projects.serviceAccounts.setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the IAM access control policy for a\nServiceAccount."
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:setIamPolicy"
},
"getIamPolicy": {
+ "id": "iam.projects.serviceAccounts.getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
"description": "Returns the IAM access control policy for a\nServiceAccount.",
"response": {
"$ref": "Policy"
@@ -455,11 +677,11 @@
"location": "path"
}
},
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:getIamPolicy",
- "id": "iam.projects.serviceAccounts.getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy"
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:getIamPolicy"
},
"get": {
+ "id": "iam.projects.serviceAccounts.get",
+ "path": "v1/{+name}",
"description": "Gets a ServiceAccount.",
"response": {
"$ref": "ServiceAccount"
@@ -470,56 +692,55 @@
"httpMethod": "GET",
"parameters": {
"name": {
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
+ "location": "path",
"description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.",
"type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
- "location": "path"
+ "required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}",
- "id": "iam.projects.serviceAccounts.get",
- "path": "v1/{+name}"
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}"
}
},
"resources": {
"keys": {
"methods": {
"delete": {
+ "description": "Deletes a ServiceAccountKey.",
"httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "Empty"
},
+ "parameterOrder": [
+ "name"
+ ],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
+ "location": "path",
"description": "The resource name of the service account key in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+/serviceAccounts/[^/]+/keys/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+/keys/[^/]+$"
}
},
"flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}",
"path": "v1/{+name}",
- "id": "iam.projects.serviceAccounts.keys.delete",
- "description": "Deletes a ServiceAccountKey."
+ "id": "iam.projects.serviceAccounts.keys.delete"
},
"get": {
- "parameterOrder": [
- "name"
- ],
+ "description": "Gets the ServiceAccountKey\nby key id.",
"response": {
"$ref": "ServiceAccountKey"
},
+ "parameterOrder": [
+ "name"
+ ],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
@@ -545,8 +766,7 @@
},
"flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}",
"id": "iam.projects.serviceAccounts.keys.get",
- "path": "v1/{+name}",
- "description": "Gets the ServiceAccountKey\nby key id."
+ "path": "v1/{+name}"
},
"list": {
"response": {
@@ -561,11 +781,11 @@
],
"parameters": {
"name": {
+ "location": "path",
"description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\n\nUsing `-` as a wildcard for the `PROJECT_ID`, will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$"
},
"keyTypes": {
"location": "query",
@@ -585,13 +805,10 @@
"description": "Lists ServiceAccountKeys."
},
"create": {
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys",
- "id": "iam.projects.serviceAccounts.keys.create",
- "path": "v1/{+name}/keys",
- "description": "Creates a ServiceAccountKey\nand returns it.",
"request": {
"$ref": "CreateServiceAccountKeyRequest"
},
+ "description": "Creates a ServiceAccountKey\nand returns it.",
"response": {
"$ref": "ServiceAccountKey"
},
@@ -599,18 +816,21 @@
"name"
],
"httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"name": {
- "location": "path",
"description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$"
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
+ "location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys",
+ "id": "iam.projects.serviceAccounts.keys.create",
+ "path": "v1/{+name}/keys"
}
}
}
@@ -621,22 +841,22 @@
"permissions": {
"methods": {
"queryTestablePermissions": {
+ "flatPath": "v1/permissions:queryTestablePermissions",
+ "path": "v1/permissions:queryTestablePermissions",
+ "id": "iam.permissions.queryTestablePermissions",
"description": "Lists the permissions testable on a resource.\nA permission is testable if it can be tested for an identity on a resource.",
"request": {
"$ref": "QueryTestablePermissionsRequest"
},
+ "httpMethod": "POST",
+ "parameterOrder": [],
"response": {
"$ref": "QueryTestablePermissionsResponse"
},
- "parameterOrder": [],
- "httpMethod": "POST",
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/permissions:queryTestablePermissions",
- "id": "iam.permissions.queryTestablePermissions",
- "path": "v1/permissions:queryTestablePermissions"
+ ]
}
}
},
@@ -661,51 +881,51 @@
"path": "v1/roles:queryGrantableRoles"
},
"get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "Role"
},
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
+ "location": "path",
"description": "The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
"type": "string",
"required": true,
- "pattern": "^roles/[^/]+$",
- "location": "path"
+ "pattern": "^roles/[^/]+$"
}
},
"flatPath": "v1/roles/{rolesId}",
- "path": "v1/{+name}",
"id": "iam.roles.get",
+ "path": "v1/{+name}",
"description": "Gets a Role definition."
},
"list": {
"description": "Lists the Roles defined on a resource.",
+ "parameterOrder": [],
+ "httpMethod": "GET",
"response": {
"$ref": "ListRolesResponse"
},
- "parameterOrder": [],
- "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"pageToken": {
+ "location": "query",
"description": "Optional pagination token returned in an earlier ListRolesResponse.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pageSize": {
+ "location": "query",
"format": "int32",
"description": "Optional limit on the number of roles to include in the response.",
- "type": "integer",
- "location": "query"
+ "type": "integer"
},
"view": {
"description": "Optional view for the returned Role objects.",
@@ -717,14 +937,14 @@
]
},
"parent": {
+ "location": "query",
"description": "The resource name of the parent resource in one of the following formats:\n`` (empty string) -- this refers to curated roles.\n`organizations/{ORGANIZATION_ID}`\n`projects/{PROJECT_ID}`",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"showDeleted": {
+ "location": "query",
"description": "Include Roles that have been deleted.",
- "type": "boolean",
- "location": "query"
+ "type": "boolean"
}
},
"flatPath": "v1/roles",
@@ -732,223 +952,9 @@
"path": "v1/roles"
}
}
- },
- "organizations": {
- "resources": {
- "roles": {
- "methods": {
- "delete": {
- "id": "iam.organizations.roles.delete",
- "path": "v1/{+name}",
- "description": "Soft deletes a role. The role is suspended and cannot be used to create new\nIAM Policy Bindings.\nThe Role will not be included in `ListRoles()` unless `show_deleted` is set\nin the `ListRolesRequest`. The Role contains the deleted boolean set.\nExisting Bindings remains, but are inactive. The Role can be undeleted\nwithin 7 days. After 7 days the Role is deleted and all Bindings associated\nwith the role are removed.",
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Role"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "etag": {
- "format": "byte",
- "description": "Used to perform a consistent read-modify-write.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "location": "path",
- "description": "The resource name of the role in one of the following formats:\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+/roles/[^/]+$"
- }
- },
- "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}"
- },
- "list": {
- "response": {
- "$ref": "ListRolesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "showDeleted": {
- "description": "Include Roles that have been deleted.",
- "type": "boolean",
- "location": "query"
- },
- "pageToken": {
- "description": "Optional pagination token returned in an earlier ListRolesResponse.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Optional limit on the number of roles to include in the response.",
- "type": "integer"
- },
- "view": {
- "enum": [
- "BASIC",
- "FULL"
- ],
- "description": "Optional view for the returned Role objects.",
- "type": "string",
- "location": "query"
- },
- "parent": {
- "description": "The resource name of the parent resource in one of the following formats:\n`` (empty string) -- this refers to curated roles.\n`organizations/{ORGANIZATION_ID}`\n`projects/{PROJECT_ID}`",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/organizations/{organizationsId}/roles",
- "id": "iam.organizations.roles.list",
- "path": "v1/{+parent}/roles",
- "description": "Lists the Roles defined on a resource."
- },
- "create": {
- "request": {
- "$ref": "CreateRoleRequest"
- },
- "description": "Creates a new Role.",
- "response": {
- "$ref": "Role"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "description": "The resource name of the parent resource in one of the following formats:\n`organizations/{ORGANIZATION_ID}`\n`projects/{PROJECT_ID}`",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/organizations/{organizationsId}/roles",
- "id": "iam.organizations.roles.create",
- "path": "v1/{+parent}/roles"
- },
- "undelete": {
- "path": "v1/{+name}:undelete",
- "id": "iam.organizations.roles.undelete",
- "description": "Undelete a Role, bringing it back in its previous state.",
- "request": {
- "$ref": "UndeleteRoleRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Role"
- },
- "parameters": {
- "name": {
- "pattern": "^organizations/[^/]+/roles/[^/]+$",
- "location": "path",
- "description": "The resource name of the role in one of the following formats:\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}:undelete"
- },
- "get": {
- "response": {
- "$ref": "Role"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+/roles/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}",
- "id": "iam.organizations.roles.get",
- "path": "v1/{+name}",
- "description": "Gets a Role definition."
- },
- "patch": {
- "id": "iam.organizations.roles.patch",
- "path": "v1/{+name}",
- "request": {
- "$ref": "Role"
- },
- "description": "Updates a Role definition.",
- "response": {
- "$ref": "Role"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "updateMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "A mask describing which fields in the Role have changed.",
- "type": "string"
- },
- "name": {
- "pattern": "^organizations/[^/]+/roles/[^/]+$",
- "location": "path",
- "description": "The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}"
- }
- }
- }
- }
}
},
"parameters": {
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
"upload_protocol": {
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
@@ -971,25 +977,24 @@
"location": "query"
},
"callback": {
+ "location": "query",
"description": "JSONP",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"$.xgafv": {
+ "enum": [
+ "1",
+ "2"
+ ],
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
+ "location": "query"
},
"alt": {
- "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -1002,27 +1007,38 @@
"json",
"media",
"proto"
- ]
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ ],
"type": "string"
},
- "access_token": {
- "description": "OAuth access token.",
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string",
"location": "query"
},
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
"quotaUser": {
+ "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pp": {
+ "location": "query",
"description": "Pretty-print response.",
"default": "true",
- "type": "boolean",
+ "type": "boolean"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
"location": "query"
}
},
@@ -1034,584 +1050,10 @@
"basePath": "",
"id": "iam:v1",
"documentationLink": "https://cloud.google.com/iam/",
- "revision": "20170929",
+ "revision": "20171006",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "CreateServiceAccountKeyRequest": {
- "properties": {
- "keyAlgorithm": {
- "description": "Which type of key and algorithm to use for the key.\nThe default is currently a 2K RSA key. However this may change in the\nfuture.",
- "type": "string",
- "enumDescriptions": [
- "An unspecified key algorithm.",
- "1k RSA Key.",
- "2k RSA Key."
- ],
- "enum": [
- "KEY_ALG_UNSPECIFIED",
- "KEY_ALG_RSA_1024",
- "KEY_ALG_RSA_2048"
- ]
- },
- "privateKeyType": {
- "description": "The output format of the private key. `GOOGLE_CREDENTIALS_FILE` is the\ndefault output format.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified. Equivalent to `TYPE_GOOGLE_CREDENTIALS_FILE`.",
- "PKCS12 format.\nThe password for the PKCS12 file is `notasecret`.\nFor more information, see https://tools.ietf.org/html/rfc7292.",
- "Google Credentials File format."
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "TYPE_PKCS12_FILE",
- "TYPE_GOOGLE_CREDENTIALS_FILE"
- ]
- }
- },
- "id": "CreateServiceAccountKeyRequest",
- "description": "The service account key create request.",
- "type": "object"
- },
- "TestIamPermissionsRequest": {
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "TestIamPermissionsRequest"
- },
- "SignJwtResponse": {
- "description": "The service account sign JWT response.",
- "type": "object",
- "properties": {
- "signedJwt": {
- "description": "The signed JWT.",
- "type": "string"
- },
- "keyId": {
- "description": "The id of the key used to sign the JWT.",
- "type": "string"
- }
- },
- "id": "SignJwtResponse"
- },
- "Policy": {
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
- "type": "object",
- "properties": {
- "bindings": {
- "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
- "items": {
- "$ref": "Binding"
- },
- "type": "array"
- },
- "etag": {
- "format": "byte",
- "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.",
- "type": "string"
- },
- "version": {
- "format": "int32",
- "description": "Version of the `Policy`. The default version is 0.",
- "type": "integer"
- }
- },
- "id": "Policy"
- },
- "ListRolesResponse": {
- "description": "The response containing the roles defined under a resource.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "To retrieve the next page of results, set\n`ListRolesRequest.page_token` to this value.",
- "type": "string"
- },
- "roles": {
- "description": "The Roles defined on this resource.",
- "items": {
- "$ref": "Role"
- },
- "type": "array"
- }
- },
- "id": "ListRolesResponse"
- },
- "AuditData": {
- "properties": {
- "policyDelta": {
- "$ref": "PolicyDelta",
- "description": "Policy delta between the original policy and the newly set policy."
- }
- },
- "id": "AuditData",
- "description": "Audit log information specific to Cloud IAM. This message is serialized\nas an `Any` type in the `ServiceData` message of an\n`AuditLog` message.",
- "type": "object"
- },
- "BindingDelta": {
- "description": "One delta entry for Binding. Each individual change (only one member in each\nentry) to a binding will be a separate entry.",
- "type": "object",
- "properties": {
- "role": {
- "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
- "type": "string"
- },
- "action": {
- "description": "The action that was performed on a Binding.\nRequired",
- "type": "string",
- "enumDescriptions": [
- "Unspecified.",
- "Addition of a Binding.",
- "Removal of a Binding."
- ],
- "enum": [
- "ACTION_UNSPECIFIED",
- "ADD",
- "REMOVE"
- ]
- },
- "condition": {
- "description": "The condition that is associated with this binding.\nThis field is GOOGLE_INTERNAL.\nThis field is not logged in IAM side because it's only for audit logging.\nOptional",
- "$ref": "Expr"
- },
- "member": {
- "description": "A single identity requesting access for a Cloud Platform resource.\nFollows the same format of Binding.members.\nRequired",
- "type": "string"
- }
- },
- "id": "BindingDelta"
- },
- "UndeleteRoleRequest": {
- "description": "The request to undelete an existing role.",
- "type": "object",
- "properties": {
- "etag": {
- "format": "byte",
- "description": "Used to perform a consistent read-modify-write.",
- "type": "string"
- }
- },
- "id": "UndeleteRoleRequest"
- },
- "CreateServiceAccountRequest": {
- "description": "The service account create request.",
- "type": "object",
- "properties": {
- "accountId": {
- "description": "Required. The account id that is used to generate the service account\nemail address and a stable unique id. It is unique within a project,\nmust be 6-30 characters long, and match the regular expression\n`[a-z]([-a-z0-9]*[a-z0-9])` to comply with RFC1035.",
- "type": "string"
- },
- "serviceAccount": {
- "description": "The ServiceAccount resource to create.\nCurrently, only the following values are user assignable:\n`display_name` .",
- "$ref": "ServiceAccount"
- }
- },
- "id": "CreateServiceAccountRequest"
- },
- "Role": {
- "description": "A role in the Identity and Access Management API.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The name of the role.\n\nWhen Role is used in CreateRole, the role name must not be set.\n\nWhen Role is used in output and other input such as UpdateRole, the role\nname is the complete path, e.g., roles/logging.viewer for curated roles\nand organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.",
- "type": "string"
- },
- "deleted": {
- "description": "The current deleted state of the role. This field is read only.\nIt will be ignored in calls to CreateRole and UpdateRole.",
- "type": "boolean"
- },
- "title": {
- "description": "Optional. A human-readable title for the role. Typically this\nis limited to 100 UTF-8 bytes.",
- "type": "string"
- },
- "includedPermissions": {
- "description": "The names of the permissions this role grants when bound in an IAM policy.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "description": {
- "description": "Optional. A human-readable description for the role.",
- "type": "string"
- },
- "etag": {
- "format": "byte",
- "description": "Used to perform a consistent read-modify-write.",
- "type": "string"
- },
- "stage": {
- "description": "The current launch stage of the role.",
- "type": "string",
- "enumDescriptions": [
- "The user has indicated this role is currently in an alpha phase.",
- "The user has indicated this role is currently in a beta phase.",
- "The user has indicated this role is generally available.",
- "The user has indicated this role is being deprecated.",
- "This role is disabled and will not contribute permissions to any members\nit is granted to in policies.",
- "The user has indicated this role is currently in an eap phase."
- ],
- "enum": [
- "ALPHA",
- "BETA",
- "GA",
- "DEPRECATED",
- "DISABLED",
- "EAP"
- ]
- }
- },
- "id": "Role"
- },
- "Binding": {
- "description": "Associates `members` with a `role`.",
- "type": "object",
- "properties": {
- "members": {
- "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "role": {
- "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
- "type": "string"
- }
- },
- "id": "Binding"
- },
- "QueryGrantableRolesRequest": {
- "properties": {
- "fullResourceName": {
- "description": "Required. The full resource name to query from the list of grantable roles.\n\nThe name follows the Google Cloud Platform resource format.\nFor example, a Cloud Platform project with id `my-project` will be named\n`//cloudresourcemanager.googleapis.com/projects/my-project`.",
- "type": "string"
- },
- "pageToken": {
- "description": "Optional pagination token returned in an earlier\nQueryGrantableRolesResponse.",
- "type": "string"
- },
- "pageSize": {
- "format": "int32",
- "description": "Optional limit on the number of roles to include in the response.",
- "type": "integer"
- },
- "view": {
- "enumDescriptions": [
- "Omits the `included_permissions` field.\nThis is the default value.",
- "Returns all fields."
- ],
- "enum": [
- "BASIC",
- "FULL"
- ],
- "type": "string"
- }
- },
- "id": "QueryGrantableRolesRequest",
- "description": "The grantable role query request.",
- "type": "object"
- },
- "ServiceAccount": {
- "description": "A service account in the Identity and Access Management API.\n\nTo create a service account, specify the `project_id` and the `account_id`\nfor the account. The `account_id` is unique within the project, and is used\nto generate the service account email address and a stable\n`unique_id`.\n\nIf the account already exists, the account's resource name is returned\nin util::Status's ResourceInfo.resource_name in the format of\nprojects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. The caller can\nuse the name in other methods to access the account.\n\nAll other methods can identify the service account using the format\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.",
- "type": "object",
- "properties": {
- "displayName": {
- "description": "Optional. A user-specified description of the service account. Must be\nfewer than 100 UTF-8 bytes.",
- "type": "string"
- },
- "etag": {
- "format": "byte",
- "description": "Used to perform a consistent read-modify-write.",
- "type": "string"
- },
- "name": {
- "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\n\nRequests using `-` as a wildcard for the `PROJECT_ID` will infer the\nproject from the `account` and the `ACCOUNT` value can be the `email`\naddress or the `unique_id` of the service account.\n\nIn responses the resource name will always be in the format\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.",
- "type": "string"
- },
- "email": {
- "description": "@OutputOnly The email address of the service account.",
- "type": "string"
- },
- "projectId": {
- "description": "@OutputOnly The id of the project that owns the service account.",
- "type": "string"
- },
- "oauth2ClientId": {
- "description": "@OutputOnly. The OAuth2 client id for the service account.\nThis is used in conjunction with the OAuth2 clientconfig API to make\nthree legged OAuth2 (3LO) flows to access the data of Google users.",
- "type": "string"
- },
- "uniqueId": {
- "description": "@OutputOnly The unique and stable id of the service account.",
- "type": "string"
- }
- },
- "id": "ServiceAccount"
- },
- "Expr": {
- "description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"",
- "type": "object",
- "properties": {
- "description": {
- "description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
- "type": "string"
- },
- "expression": {
- "description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
- "type": "string"
- },
- "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"
- }
- },
- "id": "Expr"
- },
- "CreateRoleRequest": {
- "description": "The request to create a new role.",
- "type": "object",
- "properties": {
- "roleId": {
- "description": "The role id to use for this role.",
- "type": "string"
- },
- "role": {
- "description": "The Role resource to create.",
- "$ref": "Role"
- }
- },
- "id": "CreateRoleRequest"
- },
- "ListServiceAccountKeysResponse": {
- "properties": {
- "keys": {
- "description": "The public keys for the service account.",
- "items": {
- "$ref": "ServiceAccountKey"
- },
- "type": "array"
- }
- },
- "id": "ListServiceAccountKeysResponse",
- "description": "The service account keys list response.",
- "type": "object"
- },
- "TestIamPermissionsResponse": {
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "TestIamPermissionsResponse"
- },
- "QueryTestablePermissionsRequest": {
- "description": "A request to get permissions which can be tested on a resource.",
- "type": "object",
- "properties": {
- "fullResourceName": {
- "description": "Required. The full resource name to query from the list of testable\npermissions.\n\nThe name follows the Google Cloud Platform resource format.\nFor example, a Cloud Platform project with id `my-project` will be named\n`//cloudresourcemanager.googleapis.com/projects/my-project`.",
- "type": "string"
- },
- "pageToken": {
- "description": "Optional pagination token returned in an earlier\nQueryTestablePermissionsRequest.",
- "type": "string"
- },
- "pageSize": {
- "format": "int32",
- "description": "Optional limit on the number of permissions to include in the response.",
- "type": "integer"
- }
- },
- "id": "QueryTestablePermissionsRequest"
- },
- "ServiceAccountKey": {
- "description": "Represents a service account key.\n\nA service account has two sets of key-pairs: user-managed, and\nsystem-managed.\n\nUser-managed key-pairs can be created and deleted by users. Users are\nresponsible for rotating these keys periodically to ensure security of\ntheir service accounts. Users retain the private key of these key-pairs,\nand Google retains ONLY the public key.\n\nSystem-managed key-pairs are managed automatically by Google, and rotated\ndaily without user intervention. The private key never leaves Google's\nservers to maximize security.\n\nPublic keys for all service accounts are also published at the OAuth2\nService Account API.",
- "type": "object",
- "properties": {
- "validAfterTime": {
- "format": "google-datetime",
- "description": "The key can be used after this timestamp.",
- "type": "string"
- },
- "privateKeyType": {
- "enum": [
- "TYPE_UNSPECIFIED",
- "TYPE_PKCS12_FILE",
- "TYPE_GOOGLE_CREDENTIALS_FILE"
- ],
- "description": "The output format for the private key.\nOnly provided in `CreateServiceAccountKey` responses, not\nin `GetServiceAccountKey` or `ListServiceAccountKey` responses.\n\nGoogle never exposes system-managed private keys, and never retains\nuser-managed private keys.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified. Equivalent to `TYPE_GOOGLE_CREDENTIALS_FILE`.",
- "PKCS12 format.\nThe password for the PKCS12 file is `notasecret`.\nFor more information, see https://tools.ietf.org/html/rfc7292.",
- "Google Credentials File format."
- ]
- },
- "privateKeyData": {
- "format": "byte",
- "description": "The private key data. Only provided in `CreateServiceAccountKey`\nresponses. Make sure to keep the private key data secure because it\nallows for the assertion of the service account identity.\nWhen decoded, the private key data can be used to authenticate with\nGoogle API client libraries and with\n\u003ca href=\"/sdk/gcloud/reference/auth/activate-service-account\"\u003egcloud\nauth activate-service-account\u003c/a\u003e.",
- "type": "string"
- },
- "publicKeyData": {
- "format": "byte",
- "description": "The public key data. Only provided in `GetServiceAccountKey` responses.",
- "type": "string"
- },
- "name": {
- "description": "The resource name of the service account key in the following format\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.",
- "type": "string"
- },
- "validBeforeTime": {
- "format": "google-datetime",
- "description": "The key can be used before this timestamp.",
- "type": "string"
- },
- "keyAlgorithm": {
- "enum": [
- "KEY_ALG_UNSPECIFIED",
- "KEY_ALG_RSA_1024",
- "KEY_ALG_RSA_2048"
- ],
- "description": "Specifies the algorithm (and possibly key size) for the key.",
- "type": "string",
- "enumDescriptions": [
- "An unspecified key algorithm.",
- "1k RSA Key.",
- "2k RSA Key."
- ]
- }
- },
- "id": "ServiceAccountKey"
- },
- "SignBlobResponse": {
- "description": "The service account sign blob response.",
- "type": "object",
- "properties": {
- "signature": {
- "format": "byte",
- "description": "The signed blob.",
- "type": "string"
- },
- "keyId": {
- "description": "The id of the key used to sign the blob.",
- "type": "string"
- }
- },
- "id": "SignBlobResponse"
- },
- "Permission": {
- "description": "A permission which can be included by a role.",
- "type": "object",
- "properties": {
- "onlyInPredefinedRoles": {
- "description": "This permission can ONLY be used in predefined roles.",
- "type": "boolean"
- },
- "title": {
- "description": "The title of this Permission.",
- "type": "string"
- },
- "description": {
- "description": "A brief description of what this Permission is used for.",
- "type": "string"
- },
- "customRolesSupportLevel": {
- "enumDescriptions": [
- "Permission is fully supported for custom role use.",
- "Permission is being tested to check custom role compatibility.",
- "Permission is not supported for custom role use."
- ],
- "enum": [
- "SUPPORTED",
- "TESTING",
- "NOT_SUPPORTED"
- ],
- "description": "The current custom role support level.",
- "type": "string"
- },
- "stage": {
- "enum": [
- "ALPHA",
- "BETA",
- "GA",
- "DEPRECATED"
- ],
- "description": "The current launch stage of the permission.",
- "type": "string",
- "enumDescriptions": [
- "The permission is currently in an alpha phase.",
- "The permission is currently in a beta phase.",
- "The permission is generally available.",
- "The permission is being deprecated."
- ]
- },
- "name": {
- "description": "The name of this Permission.",
- "type": "string"
- }
- },
- "id": "Permission"
- },
- "SignJwtRequest": {
- "description": "The service account sign JWT request.",
- "type": "object",
- "properties": {
- "payload": {
- "description": "The JWT payload to sign, a JSON JWT Claim set.",
- "type": "string"
- }
- },
- "id": "SignJwtRequest"
- },
- "PolicyDelta": {
- "description": "The difference delta between two policies.",
- "type": "object",
- "properties": {
- "bindingDeltas": {
- "description": "The delta for Bindings between two policies.",
- "items": {
- "$ref": "BindingDelta"
- },
- "type": "array"
- }
- },
- "id": "PolicyDelta"
- },
- "ListServiceAccountsResponse": {
- "properties": {
- "nextPageToken": {
- "description": "To retrieve the next page of results, set\nListServiceAccountsRequest.page_token\nto this value.",
- "type": "string"
- },
- "accounts": {
- "description": "The list of matching service accounts.",
- "items": {
- "$ref": "ServiceAccount"
- },
- "type": "array"
- }
- },
- "id": "ListServiceAccountsResponse",
- "description": "The service account list response.",
- "type": "object"
- },
"QueryGrantableRolesResponse": {
"description": "The grantable role query response.",
"type": "object",
@@ -1672,31 +1114,589 @@
"id": "QueryTestablePermissionsResponse"
},
"Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
"properties": {},
- "id": "Empty"
+ "id": "Empty",
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object"
+ },
+ "CreateServiceAccountKeyRequest": {
+ "properties": {
+ "keyAlgorithm": {
+ "description": "Which type of key and algorithm to use for the key.\nThe default is currently a 2K RSA key. However this may change in the\nfuture.",
+ "type": "string",
+ "enumDescriptions": [
+ "An unspecified key algorithm.",
+ "1k RSA Key.",
+ "2k RSA Key."
+ ],
+ "enum": [
+ "KEY_ALG_UNSPECIFIED",
+ "KEY_ALG_RSA_1024",
+ "KEY_ALG_RSA_2048"
+ ]
+ },
+ "privateKeyType": {
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "TYPE_PKCS12_FILE",
+ "TYPE_GOOGLE_CREDENTIALS_FILE"
+ ],
+ "description": "The output format of the private key. `GOOGLE_CREDENTIALS_FILE` is the\ndefault output format.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified. Equivalent to `TYPE_GOOGLE_CREDENTIALS_FILE`.",
+ "PKCS12 format.\nThe password for the PKCS12 file is `notasecret`.\nFor more information, see https://tools.ietf.org/html/rfc7292.",
+ "Google Credentials File format."
+ ]
+ }
+ },
+ "id": "CreateServiceAccountKeyRequest",
+ "description": "The service account key create request.",
+ "type": "object"
+ },
+ "TestIamPermissionsRequest": {
+ "properties": {
+ "permissions": {
+ "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "TestIamPermissionsRequest",
+ "description": "Request message for `TestIamPermissions` method.",
+ "type": "object"
+ },
+ "SignJwtResponse": {
+ "description": "The service account sign JWT response.",
+ "type": "object",
+ "properties": {
+ "signedJwt": {
+ "description": "The signed JWT.",
+ "type": "string"
+ },
+ "keyId": {
+ "description": "The id of the key used to sign the JWT.",
+ "type": "string"
+ }
+ },
+ "id": "SignJwtResponse"
+ },
+ "Policy": {
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
+ "type": "object",
+ "properties": {
+ "etag": {
+ "format": "byte",
+ "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.",
+ "type": "string"
+ },
+ "version": {
+ "format": "int32",
+ "description": "Version of the `Policy`. The default version is 0.",
+ "type": "integer"
+ },
+ "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"
+ }
+ },
+ "id": "Policy"
+ },
+ "ListRolesResponse": {
+ "description": "The response containing the roles defined under a resource.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "To retrieve the next page of results, set\n`ListRolesRequest.page_token` to this value.",
+ "type": "string"
+ },
+ "roles": {
+ "description": "The Roles defined on this resource.",
+ "items": {
+ "$ref": "Role"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListRolesResponse"
+ },
+ "AuditData": {
+ "description": "Audit log information specific to Cloud IAM. This message is serialized\nas an `Any` type in the `ServiceData` message of an\n`AuditLog` message.",
+ "type": "object",
+ "properties": {
+ "policyDelta": {
+ "$ref": "PolicyDelta",
+ "description": "Policy delta between the original policy and the newly set policy."
+ }
+ },
+ "id": "AuditData"
+ },
+ "BindingDelta": {
+ "properties": {
+ "action": {
+ "description": "The action that was performed on a Binding.\nRequired",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified.",
+ "Addition of a Binding.",
+ "Removal of a Binding."
+ ],
+ "enum": [
+ "ACTION_UNSPECIFIED",
+ "ADD",
+ "REMOVE"
+ ]
+ },
+ "condition": {
+ "description": "The condition that is associated with this binding.\nThis field is GOOGLE_INTERNAL.\nThis field is not logged in IAM side because it's only for audit logging.\nOptional",
+ "$ref": "Expr"
+ },
+ "member": {
+ "description": "A single identity requesting access for a Cloud Platform resource.\nFollows the same format of Binding.members.\nRequired",
+ "type": "string"
+ },
+ "role": {
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
+ "type": "string"
+ }
+ },
+ "id": "BindingDelta",
+ "description": "One delta entry for Binding. Each individual change (only one member in each\nentry) to a binding will be a separate entry.",
+ "type": "object"
+ },
+ "UndeleteRoleRequest": {
+ "description": "The request to undelete an existing role.",
+ "type": "object",
+ "properties": {
+ "etag": {
+ "format": "byte",
+ "description": "Used to perform a consistent read-modify-write.",
+ "type": "string"
+ }
+ },
+ "id": "UndeleteRoleRequest"
+ },
+ "CreateServiceAccountRequest": {
+ "description": "The service account create request.",
+ "type": "object",
+ "properties": {
+ "serviceAccount": {
+ "description": "The ServiceAccount resource to create.\nCurrently, only the following values are user assignable:\n`display_name` .",
+ "$ref": "ServiceAccount"
+ },
+ "accountId": {
+ "description": "Required. The account id that is used to generate the service account\nemail address and a stable unique id. It is unique within a project,\nmust be 6-30 characters long, and match the regular expression\n`[a-z]([-a-z0-9]*[a-z0-9])` to comply with RFC1035.",
+ "type": "string"
+ }
+ },
+ "id": "CreateServiceAccountRequest"
+ },
+ "Role": {
+ "description": "A role in the Identity and Access Management API.",
+ "type": "object",
+ "properties": {
+ "etag": {
+ "format": "byte",
+ "description": "Used to perform a consistent read-modify-write.",
+ "type": "string"
+ },
+ "stage": {
+ "enumDescriptions": [
+ "The user has indicated this role is currently in an alpha phase.",
+ "The user has indicated this role is currently in a beta phase.",
+ "The user has indicated this role is generally available.",
+ "The user has indicated this role is being deprecated.",
+ "This role is disabled and will not contribute permissions to any members\nit is granted to in policies.",
+ "The user has indicated this role is currently in an eap phase."
+ ],
+ "enum": [
+ "ALPHA",
+ "BETA",
+ "GA",
+ "DEPRECATED",
+ "DISABLED",
+ "EAP"
+ ],
+ "description": "The current launch stage of the role.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the role.\n\nWhen Role is used in CreateRole, the role name must not be set.\n\nWhen Role is used in output and other input such as UpdateRole, the role\nname is the complete path, e.g., roles/logging.viewer for curated roles\nand organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.",
+ "type": "string"
+ },
+ "deleted": {
+ "description": "The current deleted state of the role. This field is read only.\nIt will be ignored in calls to CreateRole and UpdateRole.",
+ "type": "boolean"
+ },
+ "title": {
+ "description": "Optional. A human-readable title for the role. Typically this\nis limited to 100 UTF-8 bytes.",
+ "type": "string"
+ },
+ "includedPermissions": {
+ "description": "The names of the permissions this role grants when bound in an IAM policy.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "description": {
+ "description": "Optional. A human-readable description for the role.",
+ "type": "string"
+ }
+ },
+ "id": "Role"
+ },
+ "Binding": {
+ "description": "Associates `members` with a `role`.",
+ "type": "object",
+ "properties": {
+ "members": {
+ "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "role": {
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
+ "type": "string"
+ }
+ },
+ "id": "Binding"
+ },
+ "QueryGrantableRolesRequest": {
+ "description": "The grantable role query request.",
+ "type": "object",
+ "properties": {
+ "fullResourceName": {
+ "description": "Required. The full resource name to query from the list of grantable roles.\n\nThe name follows the Google Cloud Platform resource format.\nFor example, a Cloud Platform project with id `my-project` will be named\n`//cloudresourcemanager.googleapis.com/projects/my-project`.",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Optional pagination token returned in an earlier\nQueryGrantableRolesResponse.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Optional limit on the number of roles to include in the response.",
+ "type": "integer"
+ },
+ "view": {
+ "enumDescriptions": [
+ "Omits the `included_permissions` field.\nThis is the default value.",
+ "Returns all fields."
+ ],
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "type": "string"
+ }
+ },
+ "id": "QueryGrantableRolesRequest"
+ },
+ "Expr": {
+ "description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "description": {
+ "description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
+ "type": "string"
+ },
+ "expression": {
+ "description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
+ "type": "string"
+ }
+ },
+ "id": "Expr"
+ },
+ "ServiceAccount": {
+ "description": "A service account in the Identity and Access Management API.\n\nTo create a service account, specify the `project_id` and the `account_id`\nfor the account. The `account_id` is unique within the project, and is used\nto generate the service account email address and a stable\n`unique_id`.\n\nIf the account already exists, the account's resource name is returned\nin util::Status's ResourceInfo.resource_name in the format of\nprojects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. The caller can\nuse the name in other methods to access the account.\n\nAll other methods can identify the service account using the format\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\n\nRequests using `-` as a wildcard for the `PROJECT_ID` will infer the\nproject from the `account` and the `ACCOUNT` value can be the `email`\naddress or the `unique_id` of the service account.\n\nIn responses the resource name will always be in the format\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.",
+ "type": "string"
+ },
+ "email": {
+ "description": "@OutputOnly The email address of the service account.",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "@OutputOnly The id of the project that owns the service account.",
+ "type": "string"
+ },
+ "uniqueId": {
+ "description": "@OutputOnly The unique and stable id of the service account.",
+ "type": "string"
+ },
+ "oauth2ClientId": {
+ "description": "@OutputOnly. The OAuth2 client id for the service account.\nThis is used in conjunction with the OAuth2 clientconfig API to make\nthree legged OAuth2 (3LO) flows to access the data of Google users.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Optional. A user-specified description of the service account. Must be\nfewer than 100 UTF-8 bytes.",
+ "type": "string"
+ },
+ "etag": {
+ "format": "byte",
+ "description": "Used to perform a consistent read-modify-write.",
+ "type": "string"
+ }
+ },
+ "id": "ServiceAccount"
+ },
+ "CreateRoleRequest": {
+ "description": "The request to create a new role.",
+ "type": "object",
+ "properties": {
+ "roleId": {
+ "description": "The role id to use for this role.",
+ "type": "string"
+ },
+ "role": {
+ "description": "The Role resource to create.",
+ "$ref": "Role"
+ }
+ },
+ "id": "CreateRoleRequest"
+ },
+ "QueryTestablePermissionsRequest": {
+ "description": "A request to get permissions which can be tested on a resource.",
+ "type": "object",
+ "properties": {
+ "pageSize": {
+ "format": "int32",
+ "description": "Optional limit on the number of permissions to include in the response.",
+ "type": "integer"
+ },
+ "fullResourceName": {
+ "description": "Required. The full resource name to query from the list of testable\npermissions.\n\nThe name follows the Google Cloud Platform resource format.\nFor example, a Cloud Platform project with id `my-project` will be named\n`//cloudresourcemanager.googleapis.com/projects/my-project`.",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Optional pagination token returned in an earlier\nQueryTestablePermissionsRequest.",
+ "type": "string"
+ }
+ },
+ "id": "QueryTestablePermissionsRequest"
+ },
+ "TestIamPermissionsResponse": {
+ "description": "Response message for `TestIamPermissions` method.",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "TestIamPermissionsResponse"
+ },
+ "ListServiceAccountKeysResponse": {
+ "properties": {
+ "keys": {
+ "description": "The public keys for the service account.",
+ "items": {
+ "$ref": "ServiceAccountKey"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListServiceAccountKeysResponse",
+ "description": "The service account keys list response.",
+ "type": "object"
+ },
+ "ServiceAccountKey": {
+ "properties": {
+ "privateKeyData": {
+ "format": "byte",
+ "description": "The private key data. Only provided in `CreateServiceAccountKey`\nresponses. Make sure to keep the private key data secure because it\nallows for the assertion of the service account identity.\nWhen decoded, the private key data can be used to authenticate with\nGoogle API client libraries and with\n\u003ca href=\"/sdk/gcloud/reference/auth/activate-service-account\"\u003egcloud\nauth activate-service-account\u003c/a\u003e.",
+ "type": "string"
+ },
+ "publicKeyData": {
+ "format": "byte",
+ "description": "The public key data. Only provided in `GetServiceAccountKey` responses.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The resource name of the service account key in the following format\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.",
+ "type": "string"
+ },
+ "validBeforeTime": {
+ "format": "google-datetime",
+ "description": "The key can be used before this timestamp.",
+ "type": "string"
+ },
+ "keyAlgorithm": {
+ "description": "Specifies the algorithm (and possibly key size) for the key.",
+ "type": "string",
+ "enumDescriptions": [
+ "An unspecified key algorithm.",
+ "1k RSA Key.",
+ "2k RSA Key."
+ ],
+ "enum": [
+ "KEY_ALG_UNSPECIFIED",
+ "KEY_ALG_RSA_1024",
+ "KEY_ALG_RSA_2048"
+ ]
+ },
+ "privateKeyType": {
+ "description": "The output format for the private key.\nOnly provided in `CreateServiceAccountKey` responses, not\nin `GetServiceAccountKey` or `ListServiceAccountKey` responses.\n\nGoogle never exposes system-managed private keys, and never retains\nuser-managed private keys.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified. Equivalent to `TYPE_GOOGLE_CREDENTIALS_FILE`.",
+ "PKCS12 format.\nThe password for the PKCS12 file is `notasecret`.\nFor more information, see https://tools.ietf.org/html/rfc7292.",
+ "Google Credentials File format."
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "TYPE_PKCS12_FILE",
+ "TYPE_GOOGLE_CREDENTIALS_FILE"
+ ]
+ },
+ "validAfterTime": {
+ "format": "google-datetime",
+ "description": "The key can be used after this timestamp.",
+ "type": "string"
+ }
+ },
+ "id": "ServiceAccountKey",
+ "description": "Represents a service account key.\n\nA service account has two sets of key-pairs: user-managed, and\nsystem-managed.\n\nUser-managed key-pairs can be created and deleted by users. Users are\nresponsible for rotating these keys periodically to ensure security of\ntheir service accounts. Users retain the private key of these key-pairs,\nand Google retains ONLY the public key.\n\nSystem-managed key-pairs are managed automatically by Google, and rotated\ndaily without user intervention. The private key never leaves Google's\nservers to maximize security.\n\nPublic keys for all service accounts are also published at the OAuth2\nService Account API.",
+ "type": "object"
+ },
+ "SignBlobResponse": {
+ "description": "The service account sign blob response.",
+ "type": "object",
+ "properties": {
+ "signature": {
+ "format": "byte",
+ "description": "The signed blob.",
+ "type": "string"
+ },
+ "keyId": {
+ "description": "The id of the key used to sign the blob.",
+ "type": "string"
+ }
+ },
+ "id": "SignBlobResponse"
+ },
+ "SignJwtRequest": {
+ "description": "The service account sign JWT request.",
+ "type": "object",
+ "properties": {
+ "payload": {
+ "description": "The JWT payload to sign, a JSON JWT Claim set.",
+ "type": "string"
+ }
+ },
+ "id": "SignJwtRequest"
+ },
+ "Permission": {
+ "properties": {
+ "description": {
+ "description": "A brief description of what this Permission is used for.",
+ "type": "string"
+ },
+ "customRolesSupportLevel": {
+ "description": "The current custom role support level.",
+ "type": "string",
+ "enumDescriptions": [
+ "Permission is fully supported for custom role use.",
+ "Permission is being tested to check custom role compatibility.",
+ "Permission is not supported for custom role use."
+ ],
+ "enum": [
+ "SUPPORTED",
+ "TESTING",
+ "NOT_SUPPORTED"
+ ]
+ },
+ "stage": {
+ "enumDescriptions": [
+ "The permission is currently in an alpha phase.",
+ "The permission is currently in a beta phase.",
+ "The permission is generally available.",
+ "The permission is being deprecated."
+ ],
+ "enum": [
+ "ALPHA",
+ "BETA",
+ "GA",
+ "DEPRECATED"
+ ],
+ "description": "The current launch stage of the permission.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of this Permission.",
+ "type": "string"
+ },
+ "onlyInPredefinedRoles": {
+ "description": "This permission can ONLY be used in predefined roles.",
+ "type": "boolean"
+ },
+ "title": {
+ "description": "The title of this Permission.",
+ "type": "string"
+ }
+ },
+ "id": "Permission",
+ "description": "A permission which can be included by a role.",
+ "type": "object"
+ },
+ "PolicyDelta": {
+ "description": "The difference delta between two policies.",
+ "type": "object",
+ "properties": {
+ "bindingDeltas": {
+ "description": "The delta for Bindings between two policies.",
+ "items": {
+ "$ref": "BindingDelta"
+ },
+ "type": "array"
+ }
+ },
+ "id": "PolicyDelta"
+ },
+ "ListServiceAccountsResponse": {
+ "description": "The service account list response.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "To retrieve the next page of results, set\nListServiceAccountsRequest.page_token\nto this value.",
+ "type": "string"
+ },
+ "accounts": {
+ "description": "The list of matching service accounts.",
+ "items": {
+ "$ref": "ServiceAccount"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListServiceAccountsResponse"
}
},
"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": "iam",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "rootUrl": "https://iam.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "iam",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Google Identity and Access Management (IAM) API"
+ }
}
diff --git a/kgsearch/v1/kgsearch-api.json b/kgsearch/v1/kgsearch-api.json
index a7b36b3..9089b93 100644
--- a/kgsearch/v1/kgsearch-api.json
+++ b/kgsearch/v1/kgsearch-api.json
@@ -1,35 +1,42 @@
{
- "batchPath": "batch",
- "id": "kgsearch:v1",
- "documentationLink": "https://developers.google.com/knowledge-graph/",
- "revision": "20170925",
- "title": "Knowledge Graph Search API",
- "ownerName": "Google",
"discoveryVersion": "v1",
+ "ownerName": "Google",
"version_module": true,
"resources": {
"entities": {
"methods": {
"search": {
"flatPath": "v1/entities:search",
- "id": "kgsearch.entities.search",
"path": "v1/entities:search",
+ "id": "kgsearch.entities.search",
"description": "Searches Knowledge Graph for entities that match the constraints.\nA list of matched entities will be returned in response, which will be in\nJSON-LD format and compatible with http://schema.org",
+ "httpMethod": "GET",
+ "parameterOrder": [],
"response": {
"$ref": "SearchResponse"
},
- "parameterOrder": [],
- "httpMethod": "GET",
"parameters": {
+ "ids": {
+ "location": "query",
+ "description": "The list of entity id to be used for search instead of query string.\nTo specify multiple ids in the HTTP request, repeat the parameter in the\nURL as in ...?ids=A&ids=B",
+ "type": "string",
+ "repeated": true
+ },
+ "limit": {
+ "type": "integer",
+ "location": "query",
+ "format": "int32",
+ "description": "Limits the number of entities to be returned."
+ },
"prefix": {
- "description": "Enables prefix match against names and aliases of entities",
"type": "boolean",
- "location": "query"
+ "location": "query",
+ "description": "Enables prefix match against names and aliases of entities"
},
"query": {
+ "type": "string",
"location": "query",
- "description": "The literal query string for search.",
- "type": "string"
+ "description": "The literal query string for search."
},
"types": {
"location": "query",
@@ -43,22 +50,10 @@
"type": "boolean"
},
"languages": {
+ "location": "query",
"description": "The list of language codes (defined in ISO 693) to run the query with,\ne.g. 'en'.",
"type": "string",
- "repeated": true,
- "location": "query"
- },
- "ids": {
- "description": "The list of entity id to be used for search instead of query string.\nTo specify multiple ids in the HTTP request, repeat the parameter in the\nURL as in ...?ids=A&ids=B",
- "type": "string",
- "repeated": true,
- "location": "query"
- },
- "limit": {
- "format": "int32",
- "description": "Limits the number of entities to be returned.",
- "type": "integer",
- "location": "query"
+ "repeated": true
}
}
}
@@ -66,25 +61,47 @@
}
},
"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.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "fields": {
+ "type": "string",
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response."
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
"$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
"location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ]
},
"callback": {
- "description": "JSONP",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "JSONP"
},
"alt": {
+ "default": "json",
"enum": [
"json",
"media",
@@ -97,23 +114,22 @@
"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"
+ "description": "Data format for response."
},
"key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
+ },
+ "access_token": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth access token."
},
"quotaUser": {
+ "type": "string",
"location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
},
"pp": {
"location": "query",
@@ -122,42 +138,24 @@
"type": "boolean"
},
"bearer_token": {
+ "location": "query",
"description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"oauth_token": {
"location": "query",
"description": "OAuth 2.0 token for the current user.",
"type": "string"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
- },
- "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"
}
},
"schemas": {
"SearchResponse": {
- "description": "Response message includes the context and a list of matching results\nwhich contain the detail of associated entities.",
"type": "object",
"properties": {
+ "@type": {
+ "type": "any",
+ "description": "The schema type of top-level JSON-LD object, e.g. ItemList."
+ },
"itemListElement": {
"description": "The item list of search results.",
"items": {
@@ -168,20 +166,17 @@
"@context": {
"description": "The local context applicable for the response. See more details at\nhttp://www.w3.org/TR/json-ld/#context-definitions.",
"type": "any"
- },
- "@type": {
- "description": "The schema type of top-level JSON-LD object, e.g. ItemList.",
- "type": "any"
}
},
- "id": "SearchResponse"
+ "id": "SearchResponse",
+ "description": "Response message includes the context and a list of matching results\nwhich contain the detail of associated entities."
}
},
- "protocol": "rest",
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
+ "protocol": "rest",
"version": "v1",
"baseUrl": "https://kgsearch.googleapis.com/",
"kind": "discovery#restDescription",
@@ -190,5 +185,10 @@
"rootUrl": "https://kgsearch.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
- "name": "kgsearch"
+ "name": "kgsearch",
+ "batchPath": "batch",
+ "revision": "20170925",
+ "documentationLink": "https://developers.google.com/knowledge-graph/",
+ "id": "kgsearch:v1",
+ "title": "Knowledge Graph Search API"
}
diff --git a/language/v1/language-api.json b/language/v1/language-api.json
index 037b670..b83006d 100644
--- a/language/v1/language-api.json
+++ b/language/v1/language-api.json
@@ -1,4 +1,18 @@
{
+ "canonicalName": "Cloud Natural Language",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-language": {
+ "description": "Apply machine learning models to reveal the structure and meaning of text"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://language.googleapis.com/",
"ownerDomain": "google.com",
"name": "language",
"batchPath": "batch",
@@ -8,65 +22,63 @@
"documents": {
"methods": {
"analyzeEntities": {
+ "flatPath": "v1/documents:analyzeEntities",
"id": "language.documents.analyzeEntities",
"path": "v1/documents:analyzeEntities",
- "description": "Finds named entities (currently proper names and common nouns) in the text\nalong with entity types, salience, mentions for each entity, and\nother properties.",
"request": {
"$ref": "AnalyzeEntitiesRequest"
},
+ "description": "Finds named entities (currently proper names and common nouns) in the text\nalong with entity types, salience, mentions for each entity, and\nother properties.",
"response": {
"$ref": "AnalyzeEntitiesResponse"
},
"parameterOrder": [],
"httpMethod": "POST",
- "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-language",
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/documents:analyzeEntities"
+ "parameters": {}
},
"analyzeSyntax": {
+ "response": {
+ "$ref": "AnalyzeSyntaxResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-language",
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {},
"flatPath": "v1/documents:analyzeSyntax",
- "path": "v1/documents:analyzeSyntax",
"id": "language.documents.analyzeSyntax",
+ "path": "v1/documents:analyzeSyntax",
"request": {
"$ref": "AnalyzeSyntaxRequest"
},
- "description": "Analyzes the syntax of the text and provides sentence boundaries and\ntokenization along with part of speech tags, dependency trees, and other\nproperties.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "AnalyzeSyntaxResponse"
- }
+ "description": "Analyzes the syntax of the text and provides sentence boundaries and\ntokenization along with part of speech tags, dependency trees, and other\nproperties."
},
"analyzeSentiment": {
- "httpMethod": "POST",
- "parameterOrder": [],
+ "id": "language.documents.analyzeSentiment",
+ "path": "v1/documents:analyzeSentiment",
+ "request": {
+ "$ref": "AnalyzeSentimentRequest"
+ },
+ "description": "Analyzes the sentiment of the provided text.",
"response": {
"$ref": "AnalyzeSentimentResponse"
},
+ "parameterOrder": [],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-language",
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {},
- "flatPath": "v1/documents:analyzeSentiment",
- "path": "v1/documents:analyzeSentiment",
- "id": "language.documents.analyzeSentiment",
- "request": {
- "$ref": "AnalyzeSentimentRequest"
- },
- "description": "Analyzes the sentiment of the provided text."
+ "flatPath": "v1/documents:analyzeSentiment"
},
"annotateText": {
- "id": "language.documents.annotateText",
- "path": "v1/documents:annotateText",
"request": {
"$ref": "AnnotateTextRequest"
},
@@ -81,45 +93,47 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {},
- "flatPath": "v1/documents:annotateText"
+ "flatPath": "v1/documents:annotateText",
+ "id": "language.documents.annotateText",
+ "path": "v1/documents:annotateText"
},
"analyzeEntitySentiment": {
+ "response": {
+ "$ref": "AnalyzeEntitySentimentResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-language",
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {},
"flatPath": "v1/documents:analyzeEntitySentiment",
- "path": "v1/documents:analyzeEntitySentiment",
"id": "language.documents.analyzeEntitySentiment",
+ "path": "v1/documents:analyzeEntitySentiment",
"request": {
"$ref": "AnalyzeEntitySentimentRequest"
},
- "description": "Finds entities, similar to AnalyzeEntities in the text and analyzes\nsentiment associated with each entity and its mentions.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "AnalyzeEntitySentimentResponse"
- }
+ "description": "Finds entities, similar to AnalyzeEntities in the text and analyzes\nsentiment associated with each entity and its mentions."
}
}
}
},
"parameters": {
"access_token": {
+ "location": "query",
"description": "OAuth access token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"key": {
+ "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"quotaUser": {
- "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pp": {
"location": "query",
@@ -133,30 +147,35 @@
"location": "query"
},
"oauth_token": {
- "location": "query",
"description": "OAuth 2.0 token for the current user.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "fields": {
"location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string"
},
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean"
+ },
"uploadType": {
+ "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "fields": {
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response."
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
},
"$.xgafv": {
"description": "V1 error format.",
@@ -171,17 +190,7 @@
"2"
]
},
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
"alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
@@ -190,552 +199,27 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json"
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
}
},
"version": "v1",
"baseUrl": "https://language.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Provides natural language understanding technologies to developers. Examples include sentiment analysis, entity recognition, entity sentiment analysis, and text annotations.",
"servicePath": "",
+ "description": "Provides natural language understanding technologies to developers. Examples include sentiment analysis, entity recognition, entity sentiment analysis, and text annotations.",
+ "kind": "discovery#restDescription",
"basePath": "",
- "revision": "20171003",
+ "revision": "20171009",
"documentationLink": "https://cloud.google.com/natural-language/",
"id": "language:v1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "Sentence": {
- "description": "Represents a sentence in the input document.",
- "type": "object",
- "properties": {
- "text": {
- "description": "The sentence text.",
- "$ref": "TextSpan"
- },
- "sentiment": {
- "description": "For calls to AnalyzeSentiment or if\nAnnotateTextRequest.Features.extract_document_sentiment is set to\ntrue, this field will contain the sentiment for the sentence.",
- "$ref": "Sentiment"
- }
- },
- "id": "Sentence"
- },
- "Document": {
- "id": "Document",
- "description": "################################################################ #\n\nRepresents the input to API methods.",
- "type": "object",
- "properties": {
- "gcsContentUri": {
- "description": "The Google Cloud Storage URI where the file content is located.\nThis URI must be of the form: gs://bucket_name/object_name. For more\ndetails, see https://cloud.google.com/storage/docs/reference-uris.\nNOTE: Cloud Storage object versioning is not supported.",
- "type": "string"
- },
- "language": {
- "description": "The language of the document (if not specified, the language is\nautomatically detected). Both ISO and BCP-47 language codes are\naccepted.\u003cbr\u003e\n[Language Support](/natural-language/docs/languages)\nlists currently supported languages for each API method.\nIf the language (either specified by the caller or automatically detected)\nis not supported by the called API method, an `INVALID_ARGUMENT` error\nis returned.",
- "type": "string"
- },
- "content": {
- "description": "The content of the input in string format.",
- "type": "string"
- },
- "type": {
- "description": "Required. If the type is not set or is `TYPE_UNSPECIFIED`,\nreturns an `INVALID_ARGUMENT` error.",
- "type": "string",
- "enumDescriptions": [
- "The content type is not specified.",
- "Plain text",
- "HTML"
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "PLAIN_TEXT",
- "HTML"
- ]
- }
- }
- },
- "AnalyzeEntitiesRequest": {
- "id": "AnalyzeEntitiesRequest",
- "description": "The entity analysis request message.",
- "type": "object",
- "properties": {
- "encodingType": {
- "enumDescriptions": [
- "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
- ],
- "enum": [
- "NONE",
- "UTF8",
- "UTF16",
- "UTF32"
- ],
- "description": "The encoding type used by the API to calculate offsets.",
- "type": "string"
- },
- "document": {
- "$ref": "Document",
- "description": "Input document."
- }
- }
- },
- "Sentiment": {
- "id": "Sentiment",
- "description": "Represents the feeling associated with the entire text or entities in\nthe text.",
- "type": "object",
- "properties": {
- "score": {
- "format": "float",
- "description": "Sentiment score between -1.0 (negative sentiment) and 1.0\n(positive sentiment).",
- "type": "number"
- },
- "magnitude": {
- "format": "float",
- "description": "A non-negative number in the [0, +inf) range, which represents\nthe absolute magnitude of sentiment regardless of score (positive or\nnegative).",
- "type": "number"
- }
- }
- },
- "AnalyzeEntitySentimentResponse": {
- "description": "The entity-level sentiment analysis response message.",
- "type": "object",
- "properties": {
- "language": {
- "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
- "type": "string"
- },
- "entities": {
- "description": "The recognized entities in the input document with associated sentiments.",
- "items": {
- "$ref": "Entity"
- },
- "type": "array"
- }
- },
- "id": "AnalyzeEntitySentimentResponse"
- },
- "AnalyzeEntitySentimentRequest": {
- "description": "The entity-level sentiment analysis request message.",
- "type": "object",
- "properties": {
- "encodingType": {
- "description": "The encoding type used by the API to calculate offsets.",
- "type": "string",
- "enumDescriptions": [
- "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
- ],
- "enum": [
- "NONE",
- "UTF8",
- "UTF16",
- "UTF32"
- ]
- },
- "document": {
- "$ref": "Document",
- "description": "Input document."
- }
- },
- "id": "AnalyzeEntitySentimentRequest"
- },
- "PartOfSpeech": {
- "description": "Represents part of speech information for a token. Parts of speech\nare as defined in\nhttp://www.lrec-conf.org/proceedings/lrec2012/pdf/274_Paper.pdf",
- "type": "object",
- "properties": {
- "proper": {
- "enumDescriptions": [
- "Proper is not applicable in the analyzed language or is not predicted.",
- "Proper",
- "Not proper"
- ],
- "enum": [
- "PROPER_UNKNOWN",
- "PROPER",
- "NOT_PROPER"
- ],
- "description": "The grammatical properness.",
- "type": "string"
- },
- "case": {
- "description": "The grammatical case.",
- "type": "string",
- "enumDescriptions": [
- "Case is not applicable in the analyzed language or is not predicted.",
- "Accusative",
- "Adverbial",
- "Complementive",
- "Dative",
- "Genitive",
- "Instrumental",
- "Locative",
- "Nominative",
- "Oblique",
- "Partitive",
- "Prepositional",
- "Reflexive",
- "Relative",
- "Vocative"
- ],
- "enum": [
- "CASE_UNKNOWN",
- "ACCUSATIVE",
- "ADVERBIAL",
- "COMPLEMENTIVE",
- "DATIVE",
- "GENITIVE",
- "INSTRUMENTAL",
- "LOCATIVE",
- "NOMINATIVE",
- "OBLIQUE",
- "PARTITIVE",
- "PREPOSITIONAL",
- "REFLEXIVE_CASE",
- "RELATIVE_CASE",
- "VOCATIVE"
- ]
- },
- "tense": {
- "enumDescriptions": [
- "Tense is not applicable in the analyzed language or is not predicted.",
- "Conditional",
- "Future",
- "Past",
- "Present",
- "Imperfect",
- "Pluperfect"
- ],
- "enum": [
- "TENSE_UNKNOWN",
- "CONDITIONAL_TENSE",
- "FUTURE",
- "PAST",
- "PRESENT",
- "IMPERFECT",
- "PLUPERFECT"
- ],
- "description": "The grammatical tense.",
- "type": "string"
- },
- "reciprocity": {
- "enumDescriptions": [
- "Reciprocity is not applicable in the analyzed language or is not\npredicted.",
- "Reciprocal",
- "Non-reciprocal"
- ],
- "enum": [
- "RECIPROCITY_UNKNOWN",
- "RECIPROCAL",
- "NON_RECIPROCAL"
- ],
- "description": "The grammatical reciprocity.",
- "type": "string"
- },
- "form": {
- "description": "The grammatical form.",
- "type": "string",
- "enumDescriptions": [
- "Form is not applicable in the analyzed language or is not predicted.",
- "Adnomial",
- "Auxiliary",
- "Complementizer",
- "Final ending",
- "Gerund",
- "Realis",
- "Irrealis",
- "Short form",
- "Long form",
- "Order form",
- "Specific form"
- ],
- "enum": [
- "FORM_UNKNOWN",
- "ADNOMIAL",
- "AUXILIARY",
- "COMPLEMENTIZER",
- "FINAL_ENDING",
- "GERUND",
- "REALIS",
- "IRREALIS",
- "SHORT",
- "LONG",
- "ORDER",
- "SPECIFIC"
- ]
- },
- "number": {
- "description": "The grammatical number.",
- "type": "string",
- "enumDescriptions": [
- "Number is not applicable in the analyzed language or is not predicted.",
- "Singular",
- "Plural",
- "Dual"
- ],
- "enum": [
- "NUMBER_UNKNOWN",
- "SINGULAR",
- "PLURAL",
- "DUAL"
- ]
- },
- "voice": {
- "description": "The grammatical voice.",
- "type": "string",
- "enumDescriptions": [
- "Voice is not applicable in the analyzed language or is not predicted.",
- "Active",
- "Causative",
- "Passive"
- ],
- "enum": [
- "VOICE_UNKNOWN",
- "ACTIVE",
- "CAUSATIVE",
- "PASSIVE"
- ]
- },
- "aspect": {
- "description": "The grammatical aspect.",
- "type": "string",
- "enumDescriptions": [
- "Aspect is not applicable in the analyzed language or is not predicted.",
- "Perfective",
- "Imperfective",
- "Progressive"
- ],
- "enum": [
- "ASPECT_UNKNOWN",
- "PERFECTIVE",
- "IMPERFECTIVE",
- "PROGRESSIVE"
- ]
- },
- "mood": {
- "description": "The grammatical mood.",
- "type": "string",
- "enumDescriptions": [
- "Mood is not applicable in the analyzed language or is not predicted.",
- "Conditional",
- "Imperative",
- "Indicative",
- "Interrogative",
- "Jussive",
- "Subjunctive"
- ],
- "enum": [
- "MOOD_UNKNOWN",
- "CONDITIONAL_MOOD",
- "IMPERATIVE",
- "INDICATIVE",
- "INTERROGATIVE",
- "JUSSIVE",
- "SUBJUNCTIVE"
- ]
- },
- "tag": {
- "description": "The part of speech tag.",
- "type": "string",
- "enumDescriptions": [
- "Unknown",
- "Adjective",
- "Adposition (preposition and postposition)",
- "Adverb",
- "Conjunction",
- "Determiner",
- "Noun (common and proper)",
- "Cardinal number",
- "Pronoun",
- "Particle or other function word",
- "Punctuation",
- "Verb (all tenses and modes)",
- "Other: foreign words, typos, abbreviations",
- "Affix"
- ],
- "enum": [
- "UNKNOWN",
- "ADJ",
- "ADP",
- "ADV",
- "CONJ",
- "DET",
- "NOUN",
- "NUM",
- "PRON",
- "PRT",
- "PUNCT",
- "VERB",
- "X",
- "AFFIX"
- ]
- },
- "gender": {
- "enumDescriptions": [
- "Gender is not applicable in the analyzed language or is not predicted.",
- "Feminine",
- "Masculine",
- "Neuter"
- ],
- "enum": [
- "GENDER_UNKNOWN",
- "FEMININE",
- "MASCULINE",
- "NEUTER"
- ],
- "description": "The grammatical gender.",
- "type": "string"
- },
- "person": {
- "enumDescriptions": [
- "Person is not applicable in the analyzed language or is not predicted.",
- "First",
- "Second",
- "Third",
- "Reflexive"
- ],
- "enum": [
- "PERSON_UNKNOWN",
- "FIRST",
- "SECOND",
- "THIRD",
- "REFLEXIVE_PERSON"
- ],
- "description": "The grammatical person.",
- "type": "string"
- }
- },
- "id": "PartOfSpeech"
- },
- "AnalyzeSyntaxRequest": {
- "id": "AnalyzeSyntaxRequest",
- "description": "The syntax analysis request message.",
- "type": "object",
- "properties": {
- "encodingType": {
- "enumDescriptions": [
- "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
- ],
- "enum": [
- "NONE",
- "UTF8",
- "UTF16",
- "UTF32"
- ],
- "description": "The encoding type used by the API to calculate offsets.",
- "type": "string"
- },
- "document": {
- "description": "Input document.",
- "$ref": "Document"
- }
- }
- },
- "AnalyzeSentimentResponse": {
- "description": "The sentiment analysis response message.",
- "type": "object",
- "properties": {
- "documentSentiment": {
- "description": "The overall sentiment of the input document.",
- "$ref": "Sentiment"
- },
- "language": {
- "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
- "type": "string"
- },
- "sentences": {
- "description": "The sentiment for all the sentences in the document.",
- "items": {
- "$ref": "Sentence"
- },
- "type": "array"
- }
- },
- "id": "AnalyzeSentimentResponse"
- },
- "AnalyzeEntitiesResponse": {
- "id": "AnalyzeEntitiesResponse",
- "description": "The entity analysis response message.",
- "type": "object",
- "properties": {
- "language": {
- "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
- "type": "string"
- },
- "entities": {
- "description": "The recognized entities in the input document.",
- "items": {
- "$ref": "Entity"
- },
- "type": "array"
- }
- }
- },
- "Entity": {
- "id": "Entity",
- "description": "Represents a phrase in the text that is a known entity, such as\na person, an organization, or location. The API associates information, such\nas salience and mentions, with entities.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The representative name for the entity.",
- "type": "string"
- },
- "type": {
- "enumDescriptions": [
- "Unknown",
- "Person",
- "Location",
- "Organization",
- "Event",
- "Work of art",
- "Consumer goods",
- "Other types"
- ],
- "enum": [
- "UNKNOWN",
- "PERSON",
- "LOCATION",
- "ORGANIZATION",
- "EVENT",
- "WORK_OF_ART",
- "CONSUMER_GOOD",
- "OTHER"
- ],
- "description": "The entity type.",
- "type": "string"
- },
- "metadata": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Metadata associated with the entity.\n\nCurrently, Wikipedia URLs and Knowledge Graph MIDs are provided, if\navailable. The associated keys are \"wikipedia_url\" and \"mid\", respectively.",
- "type": "object"
- },
- "salience": {
- "format": "float",
- "description": "The salience score associated with the entity in the [0, 1.0] range.\n\nThe salience score for an entity provides information about the\nimportance or centrality of that entity to the entire document text.\nScores closer to 0 are less salient, while scores closer to 1.0 are highly\nsalient.",
- "type": "number"
- },
- "sentiment": {
- "description": "For calls to AnalyzeEntitySentiment or if\nAnnotateTextRequest.Features.extract_entity_sentiment is set to\ntrue, this field will contain the aggregate sentiment expressed for this\nentity in the provided document.",
- "$ref": "Sentiment"
- },
- "mentions": {
- "description": "The mentions of this entity in the input document. The API currently\nsupports proper noun mentions.",
- "items": {
- "$ref": "EntityMention"
- },
- "type": "array"
- }
- }
- },
"AnalyzeSyntaxResponse": {
- "description": "The syntax analysis response message.",
"type": "object",
"properties": {
"language": {
@@ -757,13 +241,73 @@
"type": "array"
}
},
- "id": "AnalyzeSyntaxResponse"
+ "id": "AnalyzeSyntaxResponse",
+ "description": "The syntax analysis response message."
+ },
+ "Entity": {
+ "description": "Represents a phrase in the text that is a known entity, such as\na person, an organization, or location. The API associates information, such\nas salience and mentions, with entities.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The representative name for the entity.",
+ "type": "string"
+ },
+ "type": {
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown",
+ "Person",
+ "Location",
+ "Organization",
+ "Event",
+ "Work of art",
+ "Consumer goods",
+ "Other types"
+ ],
+ "enum": [
+ "UNKNOWN",
+ "PERSON",
+ "LOCATION",
+ "ORGANIZATION",
+ "EVENT",
+ "WORK_OF_ART",
+ "CONSUMER_GOOD",
+ "OTHER"
+ ],
+ "description": "The entity type."
+ },
+ "metadata": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Metadata associated with the entity.\n\nCurrently, Wikipedia URLs and Knowledge Graph MIDs are provided, if\navailable. The associated keys are \"wikipedia_url\" and \"mid\", respectively.",
+ "type": "object"
+ },
+ "salience": {
+ "format": "float",
+ "description": "The salience score associated with the entity in the [0, 1.0] range.\n\nThe salience score for an entity provides information about the\nimportance or centrality of that entity to the entire document text.\nScores closer to 0 are less salient, while scores closer to 1.0 are highly\nsalient.",
+ "type": "number"
+ },
+ "sentiment": {
+ "$ref": "Sentiment",
+ "description": "For calls to AnalyzeEntitySentiment or if\nAnnotateTextRequest.Features.extract_entity_sentiment is set to\ntrue, this field will contain the aggregate sentiment expressed for this\nentity in the provided document."
+ },
+ "mentions": {
+ "description": "The mentions of this entity in the input document. The API currently\nsupports proper noun mentions.",
+ "items": {
+ "$ref": "EntityMention"
+ },
+ "type": "array"
+ }
+ },
+ "id": "Entity"
},
"AnnotateTextRequest": {
- "description": "The request message for the text annotation API, which can perform multiple\nanalysis types (sentiment, entities, and syntax) in one call.",
"type": "object",
"properties": {
"encodingType": {
+ "description": "The encoding type used by the API to calculate offsets.",
+ "type": "string",
"enumDescriptions": [
"If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
"Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
@@ -775,9 +319,7 @@
"UTF8",
"UTF16",
"UTF32"
- ],
- "description": "The encoding type used by the API to calculate offsets.",
- "type": "string"
+ ]
},
"document": {
"description": "Input document.",
@@ -788,13 +330,15 @@
"$ref": "Features"
}
},
- "id": "AnnotateTextRequest"
+ "id": "AnnotateTextRequest",
+ "description": "The request message for the text annotation API, which can perform multiple\nanalysis types (sentiment, entities, and syntax) in one call."
},
"AnalyzeSentimentRequest": {
"description": "The sentiment analysis request message.",
"type": "object",
"properties": {
"encodingType": {
+ "type": "string",
"enumDescriptions": [
"If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
"Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
@@ -807,18 +351,16 @@
"UTF16",
"UTF32"
],
- "description": "The encoding type used by the API to calculate sentence offsets.",
- "type": "string"
+ "description": "The encoding type used by the API to calculate sentence offsets."
},
"document": {
- "description": "Input document.",
- "$ref": "Document"
+ "$ref": "Document",
+ "description": "Input document."
}
},
"id": "AnalyzeSentimentRequest"
},
"AnnotateTextResponse": {
- "description": "The text annotations response message.",
"type": "object",
"properties": {
"language": {
@@ -851,12 +393,10 @@
"description": "The overall sentiment for the document. Populated if the user enables\nAnnotateTextRequest.Features.extract_document_sentiment."
}
},
- "id": "AnnotateTextResponse"
+ "id": "AnnotateTextResponse",
+ "description": "The text annotations response message."
},
"DependencyEdge": {
- "id": "DependencyEdge",
- "description": "Represents dependency parse tree information for a token. (For more\ninformation on dependency labels, see\nhttp://www.aclweb.org/anthology/P13-2017",
- "type": "object",
"properties": {
"label": {
"enumDescriptions": [
@@ -1037,13 +577,35 @@
"description": "Represents the head of this token in the dependency tree.\nThis is the index of the token which has an arc going to this token.\nThe index is the position of the token in the array of tokens returned\nby the API method. If this token is a root token, then the\n`head_token_index` is its own index.",
"type": "integer"
}
+ },
+ "id": "DependencyEdge",
+ "description": "Represents dependency parse tree information for a token. (For more\ninformation on dependency labels, see\nhttp://www.aclweb.org/anthology/P13-2017",
+ "type": "object"
+ },
+ "TextSpan": {
+ "id": "TextSpan",
+ "description": "Represents an output piece of text.",
+ "type": "object",
+ "properties": {
+ "beginOffset": {
+ "format": "int32",
+ "description": "The API calculates the beginning offset of the content in the original\ndocument according to the EncodingType specified in the API request.",
+ "type": "integer"
+ },
+ "content": {
+ "type": "string",
+ "description": "The content of the output text."
+ }
}
},
"Token": {
- "id": "Token",
"description": "Represents the smallest syntactic building block of the text.",
"type": "object",
"properties": {
+ "partOfSpeech": {
+ "$ref": "PartOfSpeech",
+ "description": "Parts of speech tag for this token."
+ },
"dependencyEdge": {
"description": "Dependency tree parse for this token.",
"$ref": "DependencyEdge"
@@ -1055,34 +617,19 @@
"lemma": {
"description": "[Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.",
"type": "string"
- },
- "partOfSpeech": {
- "$ref": "PartOfSpeech",
- "description": "Parts of speech tag for this token."
- }
- }
- },
- "TextSpan": {
- "description": "Represents an output piece of text.",
- "type": "object",
- "properties": {
- "beginOffset": {
- "format": "int32",
- "description": "The API calculates the beginning offset of the content in the original\ndocument according to the EncodingType specified in the API request.",
- "type": "integer"
- },
- "content": {
- "description": "The content of the output text.",
- "type": "string"
}
},
- "id": "TextSpan"
+ "id": "Token"
},
"Status": {
- "id": "Status",
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
+ "code": {
+ "format": "int32",
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "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"
@@ -1090,26 +637,54 @@
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
- "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- }
+ },
+ "type": "object"
},
"type": "array"
- },
- "code": {
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer"
}
- }
+ },
+ "id": "Status"
+ },
+ "EntityMention": {
+ "description": "Represents a mention for an entity in the text. Currently, proper noun\nmentions are supported.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "enum": [
+ "TYPE_UNKNOWN",
+ "PROPER",
+ "COMMON"
+ ],
+ "description": "The type of the entity mention.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown",
+ "Proper name",
+ "Common noun (or noun compound)"
+ ]
+ },
+ "text": {
+ "$ref": "TextSpan",
+ "description": "The mention text."
+ },
+ "sentiment": {
+ "$ref": "Sentiment",
+ "description": "For calls to AnalyzeEntitySentiment or if\nAnnotateTextRequest.Features.extract_entity_sentiment is set to\ntrue, this field will contain the sentiment expressed for this mention of\nthe entity in the provided document."
+ }
+ },
+ "id": "EntityMention"
},
"Features": {
- "id": "Features",
"description": "All available features for sentiment, syntax, and semantic analysis.\nSetting each one to true will enable that specific analysis for the input.",
"type": "object",
"properties": {
+ "extractEntities": {
+ "description": "Extract entities.",
+ "type": "boolean"
+ },
"extractEntitySentiment": {
"description": "Extract entities and their associated sentiment.",
"type": "boolean"
@@ -1119,62 +694,487 @@
"type": "boolean"
},
"extractSyntax": {
- "description": "Extract syntax information.",
- "type": "boolean"
- },
- "extractEntities": {
- "description": "Extract entities.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "Extract syntax information."
}
- }
+ },
+ "id": "Features"
},
- "EntityMention": {
- "id": "EntityMention",
- "description": "Represents a mention for an entity in the text. Currently, proper noun\nmentions are supported.",
+ "Document": {
+ "description": "################################################################ #\n\nRepresents the input to API methods.",
"type": "object",
"properties": {
- "type": {
- "enumDescriptions": [
- "Unknown",
- "Proper name",
- "Common noun (or noun compound)"
- ],
- "enum": [
- "TYPE_UNKNOWN",
- "PROPER",
- "COMMON"
- ],
- "description": "The type of the entity mention.",
+ "gcsContentUri": {
+ "type": "string",
+ "description": "The Google Cloud Storage URI where the file content is located.\nThis URI must be of the form: gs://bucket_name/object_name. For more\ndetails, see https://cloud.google.com/storage/docs/reference-uris.\nNOTE: Cloud Storage object versioning is not supported."
+ },
+ "language": {
+ "description": "The language of the document (if not specified, the language is\nautomatically detected). Both ISO and BCP-47 language codes are\naccepted.\u003cbr\u003e\n[Language Support](/natural-language/docs/languages)\nlists currently supported languages for each API method.\nIf the language (either specified by the caller or automatically detected)\nis not supported by the called API method, an `INVALID_ARGUMENT` error\nis returned.",
"type": "string"
},
- "text": {
- "description": "The mention text.",
- "$ref": "TextSpan"
+ "content": {
+ "type": "string",
+ "description": "The content of the input in string format."
},
+ "type": {
+ "description": "Required. If the type is not set or is `TYPE_UNSPECIFIED`,\nreturns an `INVALID_ARGUMENT` error.",
+ "type": "string",
+ "enumDescriptions": [
+ "The content type is not specified.",
+ "Plain text",
+ "HTML"
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "PLAIN_TEXT",
+ "HTML"
+ ]
+ }
+ },
+ "id": "Document"
+ },
+ "Sentence": {
+ "description": "Represents a sentence in the input document.",
+ "type": "object",
+ "properties": {
"sentiment": {
"$ref": "Sentiment",
- "description": "For calls to AnalyzeEntitySentiment or if\nAnnotateTextRequest.Features.extract_entity_sentiment is set to\ntrue, this field will contain the sentiment expressed for this mention of\nthe entity in the provided document."
+ "description": "For calls to AnalyzeSentiment or if\nAnnotateTextRequest.Features.extract_document_sentiment is set to\ntrue, this field will contain the sentiment for the sentence."
+ },
+ "text": {
+ "description": "The sentence text.",
+ "$ref": "TextSpan"
}
- }
+ },
+ "id": "Sentence"
+ },
+ "Sentiment": {
+ "properties": {
+ "magnitude": {
+ "format": "float",
+ "description": "A non-negative number in the [0, +inf) range, which represents\nthe absolute magnitude of sentiment regardless of score (positive or\nnegative).",
+ "type": "number"
+ },
+ "score": {
+ "format": "float",
+ "description": "Sentiment score between -1.0 (negative sentiment) and 1.0\n(positive sentiment).",
+ "type": "number"
+ }
+ },
+ "id": "Sentiment",
+ "description": "Represents the feeling associated with the entire text or entities in\nthe text.",
+ "type": "object"
+ },
+ "AnalyzeEntitiesRequest": {
+ "description": "The entity analysis request message.",
+ "type": "object",
+ "properties": {
+ "encodingType": {
+ "description": "The encoding type used by the API to calculate offsets.",
+ "type": "string",
+ "enumDescriptions": [
+ "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
+ ],
+ "enum": [
+ "NONE",
+ "UTF8",
+ "UTF16",
+ "UTF32"
+ ]
+ },
+ "document": {
+ "$ref": "Document",
+ "description": "Input document."
+ }
+ },
+ "id": "AnalyzeEntitiesRequest"
+ },
+ "AnalyzeEntitySentimentResponse": {
+ "description": "The entity-level sentiment analysis response message.",
+ "type": "object",
+ "properties": {
+ "language": {
+ "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
+ "type": "string"
+ },
+ "entities": {
+ "items": {
+ "$ref": "Entity"
+ },
+ "type": "array",
+ "description": "The recognized entities in the input document with associated sentiments."
+ }
+ },
+ "id": "AnalyzeEntitySentimentResponse"
+ },
+ "AnalyzeEntitySentimentRequest": {
+ "description": "The entity-level sentiment analysis request message.",
+ "type": "object",
+ "properties": {
+ "document": {
+ "$ref": "Document",
+ "description": "Input document."
+ },
+ "encodingType": {
+ "enumDescriptions": [
+ "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
+ ],
+ "enum": [
+ "NONE",
+ "UTF8",
+ "UTF16",
+ "UTF32"
+ ],
+ "description": "The encoding type used by the API to calculate offsets.",
+ "type": "string"
+ }
+ },
+ "id": "AnalyzeEntitySentimentRequest"
+ },
+ "PartOfSpeech": {
+ "type": "object",
+ "properties": {
+ "case": {
+ "enumDescriptions": [
+ "Case is not applicable in the analyzed language or is not predicted.",
+ "Accusative",
+ "Adverbial",
+ "Complementive",
+ "Dative",
+ "Genitive",
+ "Instrumental",
+ "Locative",
+ "Nominative",
+ "Oblique",
+ "Partitive",
+ "Prepositional",
+ "Reflexive",
+ "Relative",
+ "Vocative"
+ ],
+ "enum": [
+ "CASE_UNKNOWN",
+ "ACCUSATIVE",
+ "ADVERBIAL",
+ "COMPLEMENTIVE",
+ "DATIVE",
+ "GENITIVE",
+ "INSTRUMENTAL",
+ "LOCATIVE",
+ "NOMINATIVE",
+ "OBLIQUE",
+ "PARTITIVE",
+ "PREPOSITIONAL",
+ "REFLEXIVE_CASE",
+ "RELATIVE_CASE",
+ "VOCATIVE"
+ ],
+ "description": "The grammatical case.",
+ "type": "string"
+ },
+ "tense": {
+ "enumDescriptions": [
+ "Tense is not applicable in the analyzed language or is not predicted.",
+ "Conditional",
+ "Future",
+ "Past",
+ "Present",
+ "Imperfect",
+ "Pluperfect"
+ ],
+ "enum": [
+ "TENSE_UNKNOWN",
+ "CONDITIONAL_TENSE",
+ "FUTURE",
+ "PAST",
+ "PRESENT",
+ "IMPERFECT",
+ "PLUPERFECT"
+ ],
+ "description": "The grammatical tense.",
+ "type": "string"
+ },
+ "reciprocity": {
+ "enum": [
+ "RECIPROCITY_UNKNOWN",
+ "RECIPROCAL",
+ "NON_RECIPROCAL"
+ ],
+ "description": "The grammatical reciprocity.",
+ "type": "string",
+ "enumDescriptions": [
+ "Reciprocity is not applicable in the analyzed language or is not\npredicted.",
+ "Reciprocal",
+ "Non-reciprocal"
+ ]
+ },
+ "form": {
+ "enumDescriptions": [
+ "Form is not applicable in the analyzed language or is not predicted.",
+ "Adnomial",
+ "Auxiliary",
+ "Complementizer",
+ "Final ending",
+ "Gerund",
+ "Realis",
+ "Irrealis",
+ "Short form",
+ "Long form",
+ "Order form",
+ "Specific form"
+ ],
+ "enum": [
+ "FORM_UNKNOWN",
+ "ADNOMIAL",
+ "AUXILIARY",
+ "COMPLEMENTIZER",
+ "FINAL_ENDING",
+ "GERUND",
+ "REALIS",
+ "IRREALIS",
+ "SHORT",
+ "LONG",
+ "ORDER",
+ "SPECIFIC"
+ ],
+ "description": "The grammatical form.",
+ "type": "string"
+ },
+ "number": {
+ "enumDescriptions": [
+ "Number is not applicable in the analyzed language or is not predicted.",
+ "Singular",
+ "Plural",
+ "Dual"
+ ],
+ "enum": [
+ "NUMBER_UNKNOWN",
+ "SINGULAR",
+ "PLURAL",
+ "DUAL"
+ ],
+ "description": "The grammatical number.",
+ "type": "string"
+ },
+ "voice": {
+ "enumDescriptions": [
+ "Voice is not applicable in the analyzed language or is not predicted.",
+ "Active",
+ "Causative",
+ "Passive"
+ ],
+ "enum": [
+ "VOICE_UNKNOWN",
+ "ACTIVE",
+ "CAUSATIVE",
+ "PASSIVE"
+ ],
+ "description": "The grammatical voice.",
+ "type": "string"
+ },
+ "aspect": {
+ "enumDescriptions": [
+ "Aspect is not applicable in the analyzed language or is not predicted.",
+ "Perfective",
+ "Imperfective",
+ "Progressive"
+ ],
+ "enum": [
+ "ASPECT_UNKNOWN",
+ "PERFECTIVE",
+ "IMPERFECTIVE",
+ "PROGRESSIVE"
+ ],
+ "description": "The grammatical aspect.",
+ "type": "string"
+ },
+ "mood": {
+ "enum": [
+ "MOOD_UNKNOWN",
+ "CONDITIONAL_MOOD",
+ "IMPERATIVE",
+ "INDICATIVE",
+ "INTERROGATIVE",
+ "JUSSIVE",
+ "SUBJUNCTIVE"
+ ],
+ "description": "The grammatical mood.",
+ "type": "string",
+ "enumDescriptions": [
+ "Mood is not applicable in the analyzed language or is not predicted.",
+ "Conditional",
+ "Imperative",
+ "Indicative",
+ "Interrogative",
+ "Jussive",
+ "Subjunctive"
+ ]
+ },
+ "tag": {
+ "description": "The part of speech tag.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown",
+ "Adjective",
+ "Adposition (preposition and postposition)",
+ "Adverb",
+ "Conjunction",
+ "Determiner",
+ "Noun (common and proper)",
+ "Cardinal number",
+ "Pronoun",
+ "Particle or other function word",
+ "Punctuation",
+ "Verb (all tenses and modes)",
+ "Other: foreign words, typos, abbreviations",
+ "Affix"
+ ],
+ "enum": [
+ "UNKNOWN",
+ "ADJ",
+ "ADP",
+ "ADV",
+ "CONJ",
+ "DET",
+ "NOUN",
+ "NUM",
+ "PRON",
+ "PRT",
+ "PUNCT",
+ "VERB",
+ "X",
+ "AFFIX"
+ ]
+ },
+ "gender": {
+ "description": "The grammatical gender.",
+ "type": "string",
+ "enumDescriptions": [
+ "Gender is not applicable in the analyzed language or is not predicted.",
+ "Feminine",
+ "Masculine",
+ "Neuter"
+ ],
+ "enum": [
+ "GENDER_UNKNOWN",
+ "FEMININE",
+ "MASCULINE",
+ "NEUTER"
+ ]
+ },
+ "person": {
+ "description": "The grammatical person.",
+ "type": "string",
+ "enumDescriptions": [
+ "Person is not applicable in the analyzed language or is not predicted.",
+ "First",
+ "Second",
+ "Third",
+ "Reflexive"
+ ],
+ "enum": [
+ "PERSON_UNKNOWN",
+ "FIRST",
+ "SECOND",
+ "THIRD",
+ "REFLEXIVE_PERSON"
+ ]
+ },
+ "proper": {
+ "enumDescriptions": [
+ "Proper is not applicable in the analyzed language or is not predicted.",
+ "Proper",
+ "Not proper"
+ ],
+ "enum": [
+ "PROPER_UNKNOWN",
+ "PROPER",
+ "NOT_PROPER"
+ ],
+ "description": "The grammatical properness.",
+ "type": "string"
+ }
+ },
+ "id": "PartOfSpeech",
+ "description": "Represents part of speech information for a token. Parts of speech\nare as defined in\nhttp://www.lrec-conf.org/proceedings/lrec2012/pdf/274_Paper.pdf"
+ },
+ "AnalyzeSyntaxRequest": {
+ "description": "The syntax analysis request message.",
+ "type": "object",
+ "properties": {
+ "encodingType": {
+ "enumDescriptions": [
+ "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
+ ],
+ "enum": [
+ "NONE",
+ "UTF8",
+ "UTF16",
+ "UTF32"
+ ],
+ "description": "The encoding type used by the API to calculate offsets.",
+ "type": "string"
+ },
+ "document": {
+ "description": "Input document.",
+ "$ref": "Document"
+ }
+ },
+ "id": "AnalyzeSyntaxRequest"
+ },
+ "AnalyzeSentimentResponse": {
+ "description": "The sentiment analysis response message.",
+ "type": "object",
+ "properties": {
+ "documentSentiment": {
+ "$ref": "Sentiment",
+ "description": "The overall sentiment of the input document."
+ },
+ "language": {
+ "type": "string",
+ "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details."
+ },
+ "sentences": {
+ "description": "The sentiment for all the sentences in the document.",
+ "items": {
+ "$ref": "Sentence"
+ },
+ "type": "array"
+ }
+ },
+ "id": "AnalyzeSentimentResponse"
+ },
+ "AnalyzeEntitiesResponse": {
+ "properties": {
+ "entities": {
+ "description": "The recognized entities in the input document.",
+ "items": {
+ "$ref": "Entity"
+ },
+ "type": "array"
+ },
+ "language": {
+ "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
+ "type": "string"
+ }
+ },
+ "id": "AnalyzeEntitiesResponse",
+ "description": "The entity analysis response message.",
+ "type": "object"
}
},
"icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
},
- "protocol": "rest",
- "canonicalName": "Cloud Natural Language",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-language": {
- "description": "Apply machine learning models to reveal the structure and meaning of text"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "rootUrl": "https://language.googleapis.com/"
+ "protocol": "rest"
}
diff --git a/language/v1beta1/language-api.json b/language/v1beta1/language-api.json
index e4fea58..fc8a421 100644
--- a/language/v1beta1/language-api.json
+++ b/language/v1beta1/language-api.json
@@ -1,20 +1,742 @@
{
+ "resources": {
+ "documents": {
+ "methods": {
+ "analyzeSentiment": {
+ "request": {
+ "$ref": "AnalyzeSentimentRequest"
+ },
+ "description": "Analyzes the sentiment of the provided text.",
+ "response": {
+ "$ref": "AnalyzeSentimentResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-language",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1beta1/documents:analyzeSentiment",
+ "id": "language.documents.analyzeSentiment",
+ "path": "v1beta1/documents:analyzeSentiment"
+ },
+ "annotateText": {
+ "flatPath": "v1beta1/documents:annotateText",
+ "id": "language.documents.annotateText",
+ "path": "v1beta1/documents:annotateText",
+ "description": "A convenience method that provides all the features that analyzeSentiment,\nanalyzeEntities, and analyzeSyntax provide in one call.",
+ "request": {
+ "$ref": "AnnotateTextRequest"
+ },
+ "response": {
+ "$ref": "AnnotateTextResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-language",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "analyzeEntities": {
+ "flatPath": "v1beta1/documents:analyzeEntities",
+ "id": "language.documents.analyzeEntities",
+ "path": "v1beta1/documents:analyzeEntities",
+ "request": {
+ "$ref": "AnalyzeEntitiesRequest"
+ },
+ "description": "Finds named entities (currently proper names and common nouns) in the text\nalong with entity types, salience, mentions for each entity, and\nother properties.",
+ "response": {
+ "$ref": "AnalyzeEntitiesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-language",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {}
+ },
+ "analyzeSyntax": {
+ "id": "language.documents.analyzeSyntax",
+ "path": "v1beta1/documents:analyzeSyntax",
+ "description": "Analyzes the syntax of the text and provides sentence boundaries and\ntokenization along with part of speech tags, dependency trees, and other\nproperties.",
+ "request": {
+ "$ref": "AnalyzeSyntaxRequest"
+ },
+ "response": {
+ "$ref": "AnalyzeSyntaxResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-language",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/documents:analyzeSyntax"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "alt": {
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ }
+ },
"version": "v1beta1",
"baseUrl": "https://language.googleapis.com/",
+ "servicePath": "",
"kind": "discovery#restDescription",
"description": "Provides natural language understanding technologies to developers. Examples include sentiment analysis, entity recognition, entity sentiment analysis, and text annotations.",
- "servicePath": "",
"basePath": "",
- "id": "language:v1beta1",
- "revision": "20171003",
+ "revision": "20171009",
"documentationLink": "https://cloud.google.com/natural-language/",
+ "id": "language:v1beta1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "AnnotateTextRequest": {
- "description": "The request message for the text annotation API, which can perform multiple\nanalysis types (sentiment, entities, and syntax) in one call.",
+ "EntityMention": {
"type": "object",
"properties": {
+ "type": {
+ "enum": [
+ "TYPE_UNKNOWN",
+ "PROPER",
+ "COMMON"
+ ],
+ "description": "The type of the entity mention.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown",
+ "Proper name",
+ "Common noun (or noun compound)"
+ ]
+ },
+ "text": {
+ "$ref": "TextSpan",
+ "description": "The mention text."
+ }
+ },
+ "id": "EntityMention",
+ "description": "Represents a mention for an entity in the text. Currently, proper noun\nmentions are supported."
+ },
+ "Features": {
+ "description": "All available features for sentiment, syntax, and semantic analysis.\nSetting each one to true will enable that specific analysis for the input.",
+ "type": "object",
+ "properties": {
+ "extractEntities": {
+ "description": "Extract entities.",
+ "type": "boolean"
+ },
+ "extractDocumentSentiment": {
+ "description": "Extract document-level sentiment.",
+ "type": "boolean"
+ },
+ "extractSyntax": {
+ "description": "Extract syntax information.",
+ "type": "boolean"
+ }
+ },
+ "id": "Features"
+ },
+ "Document": {
+ "properties": {
+ "gcsContentUri": {
+ "description": "The Google Cloud Storage URI where the file content is located.\nThis URI must be of the form: gs://bucket_name/object_name. For more\ndetails, see https://cloud.google.com/storage/docs/reference-uris.\nNOTE: Cloud Storage object versioning is not supported.",
+ "type": "string"
+ },
+ "language": {
+ "type": "string",
+ "description": "The language of the document (if not specified, the language is\nautomatically detected). Both ISO and BCP-47 language codes are\naccepted.\u003cbr\u003e\n[Language Support](/natural-language/docs/languages)\nlists currently supported languages for each API method.\nIf the language (either specified by the caller or automatically detected)\nis not supported by the called API method, an `INVALID_ARGUMENT` error\nis returned."
+ },
+ "content": {
+ "description": "The content of the input in string format.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Required. If the type is not set or is `TYPE_UNSPECIFIED`,\nreturns an `INVALID_ARGUMENT` error.",
+ "type": "string",
+ "enumDescriptions": [
+ "The content type is not specified.",
+ "Plain text",
+ "HTML"
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "PLAIN_TEXT",
+ "HTML"
+ ]
+ }
+ },
+ "id": "Document",
+ "description": "################################################################ #\n\nRepresents the input to API methods.",
+ "type": "object"
+ },
+ "Sentence": {
+ "description": "Represents a sentence in the input document.",
+ "type": "object",
+ "properties": {
+ "text": {
+ "description": "The sentence text.",
+ "$ref": "TextSpan"
+ },
+ "sentiment": {
+ "$ref": "Sentiment",
+ "description": "For calls to AnalyzeSentiment or if\nAnnotateTextRequest.Features.extract_document_sentiment is set to\ntrue, this field will contain the sentiment for the sentence."
+ }
+ },
+ "id": "Sentence"
+ },
+ "AnalyzeEntitiesRequest": {
+ "properties": {
+ "encodingType": {
+ "enum": [
+ "NONE",
+ "UTF8",
+ "UTF16",
+ "UTF32"
+ ],
+ "description": "The encoding type used by the API to calculate offsets.",
+ "type": "string",
+ "enumDescriptions": [
+ "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
+ ]
+ },
+ "document": {
+ "$ref": "Document",
+ "description": "Input document."
+ }
+ },
+ "id": "AnalyzeEntitiesRequest",
+ "description": "The entity analysis request message.",
+ "type": "object"
+ },
+ "Sentiment": {
+ "description": "Represents the feeling associated with the entire text or entities in\nthe text.",
+ "type": "object",
+ "properties": {
+ "score": {
+ "type": "number",
+ "format": "float",
+ "description": "Sentiment score between -1.0 (negative sentiment) and 1.0\n(positive sentiment)."
+ },
+ "polarity": {
+ "format": "float",
+ "description": "DEPRECATED FIELD - This field is being deprecated in\nfavor of score. Please refer to our documentation at\nhttps://cloud.google.com/natural-language/docs for more information.",
+ "type": "number"
+ },
+ "magnitude": {
+ "type": "number",
+ "format": "float",
+ "description": "A non-negative number in the [0, +inf) range, which represents\nthe absolute magnitude of sentiment regardless of score (positive or\nnegative)."
+ }
+ },
+ "id": "Sentiment"
+ },
+ "PartOfSpeech": {
+ "description": "Represents part of speech information for a token.",
+ "type": "object",
+ "properties": {
+ "form": {
+ "enum": [
+ "FORM_UNKNOWN",
+ "ADNOMIAL",
+ "AUXILIARY",
+ "COMPLEMENTIZER",
+ "FINAL_ENDING",
+ "GERUND",
+ "REALIS",
+ "IRREALIS",
+ "SHORT",
+ "LONG",
+ "ORDER",
+ "SPECIFIC"
+ ],
+ "description": "The grammatical form.",
+ "type": "string",
+ "enumDescriptions": [
+ "Form is not applicable in the analyzed language or is not predicted.",
+ "Adnomial",
+ "Auxiliary",
+ "Complementizer",
+ "Final ending",
+ "Gerund",
+ "Realis",
+ "Irrealis",
+ "Short form",
+ "Long form",
+ "Order form",
+ "Specific form"
+ ]
+ },
+ "number": {
+ "type": "string",
+ "enumDescriptions": [
+ "Number is not applicable in the analyzed language or is not predicted.",
+ "Singular",
+ "Plural",
+ "Dual"
+ ],
+ "enum": [
+ "NUMBER_UNKNOWN",
+ "SINGULAR",
+ "PLURAL",
+ "DUAL"
+ ],
+ "description": "The grammatical number."
+ },
+ "voice": {
+ "type": "string",
+ "enumDescriptions": [
+ "Voice is not applicable in the analyzed language or is not predicted.",
+ "Active",
+ "Causative",
+ "Passive"
+ ],
+ "enum": [
+ "VOICE_UNKNOWN",
+ "ACTIVE",
+ "CAUSATIVE",
+ "PASSIVE"
+ ],
+ "description": "The grammatical voice."
+ },
+ "aspect": {
+ "type": "string",
+ "enumDescriptions": [
+ "Aspect is not applicable in the analyzed language or is not predicted.",
+ "Perfective",
+ "Imperfective",
+ "Progressive"
+ ],
+ "enum": [
+ "ASPECT_UNKNOWN",
+ "PERFECTIVE",
+ "IMPERFECTIVE",
+ "PROGRESSIVE"
+ ],
+ "description": "The grammatical aspect."
+ },
+ "mood": {
+ "description": "The grammatical mood.",
+ "type": "string",
+ "enumDescriptions": [
+ "Mood is not applicable in the analyzed language or is not predicted.",
+ "Conditional",
+ "Imperative",
+ "Indicative",
+ "Interrogative",
+ "Jussive",
+ "Subjunctive"
+ ],
+ "enum": [
+ "MOOD_UNKNOWN",
+ "CONDITIONAL_MOOD",
+ "IMPERATIVE",
+ "INDICATIVE",
+ "INTERROGATIVE",
+ "JUSSIVE",
+ "SUBJUNCTIVE"
+ ]
+ },
+ "tag": {
+ "enumDescriptions": [
+ "Unknown",
+ "Adjective",
+ "Adposition (preposition and postposition)",
+ "Adverb",
+ "Conjunction",
+ "Determiner",
+ "Noun (common and proper)",
+ "Cardinal number",
+ "Pronoun",
+ "Particle or other function word",
+ "Punctuation",
+ "Verb (all tenses and modes)",
+ "Other: foreign words, typos, abbreviations",
+ "Affix"
+ ],
+ "enum": [
+ "UNKNOWN",
+ "ADJ",
+ "ADP",
+ "ADV",
+ "CONJ",
+ "DET",
+ "NOUN",
+ "NUM",
+ "PRON",
+ "PRT",
+ "PUNCT",
+ "VERB",
+ "X",
+ "AFFIX"
+ ],
+ "description": "The part of speech tag.",
+ "type": "string"
+ },
+ "gender": {
+ "enum": [
+ "GENDER_UNKNOWN",
+ "FEMININE",
+ "MASCULINE",
+ "NEUTER"
+ ],
+ "description": "The grammatical gender.",
+ "type": "string",
+ "enumDescriptions": [
+ "Gender is not applicable in the analyzed language or is not predicted.",
+ "Feminine",
+ "Masculine",
+ "Neuter"
+ ]
+ },
+ "person": {
+ "type": "string",
+ "enumDescriptions": [
+ "Person is not applicable in the analyzed language or is not predicted.",
+ "First",
+ "Second",
+ "Third",
+ "Reflexive"
+ ],
+ "enum": [
+ "PERSON_UNKNOWN",
+ "FIRST",
+ "SECOND",
+ "THIRD",
+ "REFLEXIVE_PERSON"
+ ],
+ "description": "The grammatical person."
+ },
+ "proper": {
+ "type": "string",
+ "enumDescriptions": [
+ "Proper is not applicable in the analyzed language or is not predicted.",
+ "Proper",
+ "Not proper"
+ ],
+ "enum": [
+ "PROPER_UNKNOWN",
+ "PROPER",
+ "NOT_PROPER"
+ ],
+ "description": "The grammatical properness."
+ },
+ "case": {
+ "description": "The grammatical case.",
+ "type": "string",
+ "enumDescriptions": [
+ "Case is not applicable in the analyzed language or is not predicted.",
+ "Accusative",
+ "Adverbial",
+ "Complementive",
+ "Dative",
+ "Genitive",
+ "Instrumental",
+ "Locative",
+ "Nominative",
+ "Oblique",
+ "Partitive",
+ "Prepositional",
+ "Reflexive",
+ "Relative",
+ "Vocative"
+ ],
+ "enum": [
+ "CASE_UNKNOWN",
+ "ACCUSATIVE",
+ "ADVERBIAL",
+ "COMPLEMENTIVE",
+ "DATIVE",
+ "GENITIVE",
+ "INSTRUMENTAL",
+ "LOCATIVE",
+ "NOMINATIVE",
+ "OBLIQUE",
+ "PARTITIVE",
+ "PREPOSITIONAL",
+ "REFLEXIVE_CASE",
+ "RELATIVE_CASE",
+ "VOCATIVE"
+ ]
+ },
+ "tense": {
+ "enum": [
+ "TENSE_UNKNOWN",
+ "CONDITIONAL_TENSE",
+ "FUTURE",
+ "PAST",
+ "PRESENT",
+ "IMPERFECT",
+ "PLUPERFECT"
+ ],
+ "description": "The grammatical tense.",
+ "type": "string",
+ "enumDescriptions": [
+ "Tense is not applicable in the analyzed language or is not predicted.",
+ "Conditional",
+ "Future",
+ "Past",
+ "Present",
+ "Imperfect",
+ "Pluperfect"
+ ]
+ },
+ "reciprocity": {
+ "description": "The grammatical reciprocity.",
+ "type": "string",
+ "enumDescriptions": [
+ "Reciprocity is not applicable in the analyzed language or is not\npredicted.",
+ "Reciprocal",
+ "Non-reciprocal"
+ ],
+ "enum": [
+ "RECIPROCITY_UNKNOWN",
+ "RECIPROCAL",
+ "NON_RECIPROCAL"
+ ]
+ }
+ },
+ "id": "PartOfSpeech"
+ },
+ "AnalyzeSyntaxRequest": {
+ "description": "The syntax analysis request message.",
+ "type": "object",
+ "properties": {
+ "document": {
+ "description": "Input document.",
+ "$ref": "Document"
+ },
+ "encodingType": {
+ "enum": [
+ "NONE",
+ "UTF8",
+ "UTF16",
+ "UTF32"
+ ],
+ "description": "The encoding type used by the API to calculate offsets.",
+ "type": "string",
+ "enumDescriptions": [
+ "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
+ ]
+ }
+ },
+ "id": "AnalyzeSyntaxRequest"
+ },
+ "AnalyzeSentimentResponse": {
+ "description": "The sentiment analysis response message.",
+ "type": "object",
+ "properties": {
+ "language": {
+ "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
+ "type": "string"
+ },
+ "sentences": {
+ "description": "The sentiment for all the sentences in the document.",
+ "items": {
+ "$ref": "Sentence"
+ },
+ "type": "array"
+ },
+ "documentSentiment": {
+ "$ref": "Sentiment",
+ "description": "The overall sentiment of the input document."
+ }
+ },
+ "id": "AnalyzeSentimentResponse"
+ },
+ "AnalyzeEntitiesResponse": {
+ "id": "AnalyzeEntitiesResponse",
+ "description": "The entity analysis response message.",
+ "type": "object",
+ "properties": {
+ "language": {
+ "type": "string",
+ "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details."
+ },
+ "entities": {
+ "description": "The recognized entities in the input document.",
+ "items": {
+ "$ref": "Entity"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "AnalyzeSyntaxResponse": {
+ "description": "The syntax analysis response message.",
+ "type": "object",
+ "properties": {
+ "language": {
+ "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
+ "type": "string"
+ },
+ "sentences": {
+ "description": "Sentences in the input document.",
+ "items": {
+ "$ref": "Sentence"
+ },
+ "type": "array"
+ },
+ "tokens": {
+ "description": "Tokens, along with their syntactic information, in the input document.",
+ "items": {
+ "$ref": "Token"
+ },
+ "type": "array"
+ }
+ },
+ "id": "AnalyzeSyntaxResponse"
+ },
+ "Entity": {
+ "description": "Represents a phrase in the text that is a known entity, such as\na person, an organization, or location. The API associates information, such\nas salience and mentions, with entities.",
+ "type": "object",
+ "properties": {
+ "salience": {
+ "type": "number",
+ "format": "float",
+ "description": "The salience score associated with the entity in the [0, 1.0] range.\n\nThe salience score for an entity provides information about the\nimportance or centrality of that entity to the entire document text.\nScores closer to 0 are less salient, while scores closer to 1.0 are highly\nsalient."
+ },
+ "metadata": {
+ "description": "Metadata associated with the entity.\n\nCurrently, Wikipedia URLs and Knowledge Graph MIDs are provided, if\navailable. The associated keys are \"wikipedia_url\" and \"mid\", respectively.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "type": {
+ "enum": [
+ "UNKNOWN",
+ "PERSON",
+ "LOCATION",
+ "ORGANIZATION",
+ "EVENT",
+ "WORK_OF_ART",
+ "CONSUMER_GOOD",
+ "OTHER"
+ ],
+ "description": "The entity type.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown",
+ "Person",
+ "Location",
+ "Organization",
+ "Event",
+ "Work of art",
+ "Consumer goods",
+ "Other types"
+ ]
+ },
+ "mentions": {
+ "description": "The mentions of this entity in the input document. The API currently\nsupports proper noun mentions.",
+ "items": {
+ "$ref": "EntityMention"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "The representative name for the entity.",
+ "type": "string"
+ }
+ },
+ "id": "Entity"
+ },
+ "AnnotateTextRequest": {
+ "properties": {
"encodingType": {
"enumDescriptions": [
"If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
@@ -32,44 +754,20 @@
"type": "string"
},
"document": {
- "$ref": "Document",
- "description": "Input document."
+ "description": "Input document.",
+ "$ref": "Document"
},
"features": {
- "description": "The enabled features.",
- "$ref": "Features"
+ "$ref": "Features",
+ "description": "The enabled features."
}
},
- "id": "AnnotateTextRequest"
- },
- "AnalyzeSentimentRequest": {
- "description": "The sentiment analysis request message.",
- "type": "object",
- "properties": {
- "encodingType": {
- "enumDescriptions": [
- "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
- ],
- "enum": [
- "NONE",
- "UTF8",
- "UTF16",
- "UTF32"
- ],
- "description": "The encoding type used by the API to calculate sentence offsets for the\nsentence sentiment.",
- "type": "string"
- },
- "document": {
- "$ref": "Document",
- "description": "Input document."
- }
- },
- "id": "AnalyzeSentimentRequest"
+ "id": "AnnotateTextRequest",
+ "description": "The request message for the text annotation API, which can perform multiple\nanalysis types (sentiment, entities, and syntax) in one call.",
+ "type": "object"
},
"AnnotateTextResponse": {
+ "description": "The text annotations response message.",
"type": "object",
"properties": {
"documentSentiment": {
@@ -102,18 +800,40 @@
"type": "array"
}
},
- "id": "AnnotateTextResponse",
- "description": "The text annotations response message."
+ "id": "AnnotateTextResponse"
+ },
+ "AnalyzeSentimentRequest": {
+ "description": "The sentiment analysis request message.",
+ "type": "object",
+ "properties": {
+ "encodingType": {
+ "enumDescriptions": [
+ "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
+ ],
+ "enum": [
+ "NONE",
+ "UTF8",
+ "UTF16",
+ "UTF32"
+ ],
+ "description": "The encoding type used by the API to calculate sentence offsets for the\nsentence sentiment.",
+ "type": "string"
+ },
+ "document": {
+ "description": "Input document.",
+ "$ref": "Document"
+ }
+ },
+ "id": "AnalyzeSentimentRequest"
},
"DependencyEdge": {
+ "id": "DependencyEdge",
"description": "Represents dependency parse tree information for a token.",
"type": "object",
"properties": {
- "headTokenIndex": {
- "format": "int32",
- "description": "Represents the head of this token in the dependency tree.\nThis is the index of the token which has an arc going to this token.\nThe index is the position of the token in the array of tokens returned\nby the API method. If this token is a root token, then the\n`head_token_index` is its own index.",
- "type": "integer"
- },
"label": {
"enumDescriptions": [
"Unknown",
@@ -287,9 +1007,13 @@
],
"description": "The parse label for the token.",
"type": "string"
+ },
+ "headTokenIndex": {
+ "format": "int32",
+ "description": "Represents the head of this token in the dependency tree.\nThis is the index of the token which has an arc going to this token.\nThe index is the position of the token in the array of tokens returned\nby the API method. If this token is a root token, then the\n`head_token_index` is its own index.",
+ "type": "integer"
}
- },
- "id": "DependencyEdge"
+ }
},
"TextSpan": {
"description": "Represents an output piece of text.",
@@ -308,624 +1032,70 @@
"id": "TextSpan"
},
"Token": {
+ "description": "Represents the smallest syntactic building block of the text.",
"type": "object",
"properties": {
+ "partOfSpeech": {
+ "$ref": "PartOfSpeech",
+ "description": "Parts of speech tag for this token."
+ },
"dependencyEdge": {
"$ref": "DependencyEdge",
"description": "Dependency tree parse for this token."
},
"text": {
- "$ref": "TextSpan",
- "description": "The token text."
+ "description": "The token text.",
+ "$ref": "TextSpan"
},
"lemma": {
"description": "[Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.",
"type": "string"
- },
- "partOfSpeech": {
- "$ref": "PartOfSpeech",
- "description": "Parts of speech tag for this token."
}
},
- "id": "Token",
- "description": "Represents the smallest syntactic building block of the text."
+ "id": "Token"
},
"Status": {
- "id": "Status",
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- },
- "type": "object"
+ }
},
"type": "array"
},
"code": {
+ "type": "integer",
"format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer"
- }
- }
- },
- "Features": {
- "description": "All available features for sentiment, syntax, and semantic analysis.\nSetting each one to true will enable that specific analysis for the input.",
- "type": "object",
- "properties": {
- "extractDocumentSentiment": {
- "type": "boolean",
- "description": "Extract document-level sentiment."
+ "description": "The status code, which should be an enum value of google.rpc.Code."
},
- "extractSyntax": {
- "description": "Extract syntax information.",
- "type": "boolean"
- },
- "extractEntities": {
- "description": "Extract entities.",
- "type": "boolean"
- }
- },
- "id": "Features"
- },
- "EntityMention": {
- "type": "object",
- "properties": {
- "type": {
- "enum": [
- "TYPE_UNKNOWN",
- "PROPER",
- "COMMON"
- ],
- "description": "The type of the entity mention.",
- "type": "string",
- "enumDescriptions": [
- "Unknown",
- "Proper name",
- "Common noun (or noun compound)"
- ]
- },
- "text": {
- "description": "The mention text.",
- "$ref": "TextSpan"
- }
- },
- "id": "EntityMention",
- "description": "Represents a mention for an entity in the text. Currently, proper noun\nmentions are supported."
- },
- "Document": {
- "description": "################################################################ #\n\nRepresents the input to API methods.",
- "type": "object",
- "properties": {
- "gcsContentUri": {
- "description": "The Google Cloud Storage URI where the file content is located.\nThis URI must be of the form: gs://bucket_name/object_name. For more\ndetails, see https://cloud.google.com/storage/docs/reference-uris.\nNOTE: Cloud Storage object versioning is not supported.",
- "type": "string"
- },
- "language": {
- "description": "The language of the document (if not specified, the language is\nautomatically detected). Both ISO and BCP-47 language codes are\naccepted.\u003cbr\u003e\n[Language Support](/natural-language/docs/languages)\nlists currently supported languages for each API method.\nIf the language (either specified by the caller or automatically detected)\nis not supported by the called API method, an `INVALID_ARGUMENT` error\nis returned.",
- "type": "string"
- },
- "content": {
- "description": "The content of the input in string format.",
- "type": "string"
- },
- "type": {
- "enumDescriptions": [
- "The content type is not specified.",
- "Plain text",
- "HTML"
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "PLAIN_TEXT",
- "HTML"
- ],
- "description": "Required. If the type is not set or is `TYPE_UNSPECIFIED`,\nreturns an `INVALID_ARGUMENT` error.",
+ "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": "Document"
- },
- "Sentence": {
- "description": "Represents a sentence in the input document.",
- "type": "object",
- "properties": {
- "text": {
- "$ref": "TextSpan",
- "description": "The sentence text."
- },
- "sentiment": {
- "description": "For calls to AnalyzeSentiment or if\nAnnotateTextRequest.Features.extract_document_sentiment is set to\ntrue, this field will contain the sentiment for the sentence.",
- "$ref": "Sentiment"
- }
- },
- "id": "Sentence"
- },
- "AnalyzeEntitiesRequest": {
- "description": "The entity analysis request message.",
- "type": "object",
- "properties": {
- "encodingType": {
- "description": "The encoding type used by the API to calculate offsets.",
- "type": "string",
- "enumDescriptions": [
- "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
- ],
- "enum": [
- "NONE",
- "UTF8",
- "UTF16",
- "UTF32"
- ]
- },
- "document": {
- "description": "Input document.",
- "$ref": "Document"
- }
- },
- "id": "AnalyzeEntitiesRequest"
- },
- "Sentiment": {
- "description": "Represents the feeling associated with the entire text or entities in\nthe text.",
- "type": "object",
- "properties": {
- "score": {
- "format": "float",
- "description": "Sentiment score between -1.0 (negative sentiment) and 1.0\n(positive sentiment).",
- "type": "number"
- },
- "polarity": {
- "format": "float",
- "description": "DEPRECATED FIELD - This field is being deprecated in\nfavor of score. Please refer to our documentation at\nhttps://cloud.google.com/natural-language/docs for more information.",
- "type": "number"
- },
- "magnitude": {
- "format": "float",
- "description": "A non-negative number in the [0, +inf) range, which represents\nthe absolute magnitude of sentiment regardless of score (positive or\nnegative).",
- "type": "number"
- }
- },
- "id": "Sentiment"
- },
- "PartOfSpeech": {
- "description": "Represents part of speech information for a token.",
- "type": "object",
- "properties": {
- "tense": {
- "enumDescriptions": [
- "Tense is not applicable in the analyzed language or is not predicted.",
- "Conditional",
- "Future",
- "Past",
- "Present",
- "Imperfect",
- "Pluperfect"
- ],
- "enum": [
- "TENSE_UNKNOWN",
- "CONDITIONAL_TENSE",
- "FUTURE",
- "PAST",
- "PRESENT",
- "IMPERFECT",
- "PLUPERFECT"
- ],
- "description": "The grammatical tense.",
- "type": "string"
- },
- "reciprocity": {
- "enum": [
- "RECIPROCITY_UNKNOWN",
- "RECIPROCAL",
- "NON_RECIPROCAL"
- ],
- "description": "The grammatical reciprocity.",
- "type": "string",
- "enumDescriptions": [
- "Reciprocity is not applicable in the analyzed language or is not\npredicted.",
- "Reciprocal",
- "Non-reciprocal"
- ]
- },
- "form": {
- "description": "The grammatical form.",
- "type": "string",
- "enumDescriptions": [
- "Form is not applicable in the analyzed language or is not predicted.",
- "Adnomial",
- "Auxiliary",
- "Complementizer",
- "Final ending",
- "Gerund",
- "Realis",
- "Irrealis",
- "Short form",
- "Long form",
- "Order form",
- "Specific form"
- ],
- "enum": [
- "FORM_UNKNOWN",
- "ADNOMIAL",
- "AUXILIARY",
- "COMPLEMENTIZER",
- "FINAL_ENDING",
- "GERUND",
- "REALIS",
- "IRREALIS",
- "SHORT",
- "LONG",
- "ORDER",
- "SPECIFIC"
- ]
- },
- "number": {
- "type": "string",
- "enumDescriptions": [
- "Number is not applicable in the analyzed language or is not predicted.",
- "Singular",
- "Plural",
- "Dual"
- ],
- "enum": [
- "NUMBER_UNKNOWN",
- "SINGULAR",
- "PLURAL",
- "DUAL"
- ],
- "description": "The grammatical number."
- },
- "voice": {
- "type": "string",
- "enumDescriptions": [
- "Voice is not applicable in the analyzed language or is not predicted.",
- "Active",
- "Causative",
- "Passive"
- ],
- "enum": [
- "VOICE_UNKNOWN",
- "ACTIVE",
- "CAUSATIVE",
- "PASSIVE"
- ],
- "description": "The grammatical voice."
- },
- "aspect": {
- "type": "string",
- "enumDescriptions": [
- "Aspect is not applicable in the analyzed language or is not predicted.",
- "Perfective",
- "Imperfective",
- "Progressive"
- ],
- "enum": [
- "ASPECT_UNKNOWN",
- "PERFECTIVE",
- "IMPERFECTIVE",
- "PROGRESSIVE"
- ],
- "description": "The grammatical aspect."
- },
- "mood": {
- "enumDescriptions": [
- "Mood is not applicable in the analyzed language or is not predicted.",
- "Conditional",
- "Imperative",
- "Indicative",
- "Interrogative",
- "Jussive",
- "Subjunctive"
- ],
- "enum": [
- "MOOD_UNKNOWN",
- "CONDITIONAL_MOOD",
- "IMPERATIVE",
- "INDICATIVE",
- "INTERROGATIVE",
- "JUSSIVE",
- "SUBJUNCTIVE"
- ],
- "description": "The grammatical mood.",
- "type": "string"
- },
- "tag": {
- "enum": [
- "UNKNOWN",
- "ADJ",
- "ADP",
- "ADV",
- "CONJ",
- "DET",
- "NOUN",
- "NUM",
- "PRON",
- "PRT",
- "PUNCT",
- "VERB",
- "X",
- "AFFIX"
- ],
- "description": "The part of speech tag.",
- "type": "string",
- "enumDescriptions": [
- "Unknown",
- "Adjective",
- "Adposition (preposition and postposition)",
- "Adverb",
- "Conjunction",
- "Determiner",
- "Noun (common and proper)",
- "Cardinal number",
- "Pronoun",
- "Particle or other function word",
- "Punctuation",
- "Verb (all tenses and modes)",
- "Other: foreign words, typos, abbreviations",
- "Affix"
- ]
- },
- "gender": {
- "type": "string",
- "enumDescriptions": [
- "Gender is not applicable in the analyzed language or is not predicted.",
- "Feminine",
- "Masculine",
- "Neuter"
- ],
- "enum": [
- "GENDER_UNKNOWN",
- "FEMININE",
- "MASCULINE",
- "NEUTER"
- ],
- "description": "The grammatical gender."
- },
- "person": {
- "enumDescriptions": [
- "Person is not applicable in the analyzed language or is not predicted.",
- "First",
- "Second",
- "Third",
- "Reflexive"
- ],
- "enum": [
- "PERSON_UNKNOWN",
- "FIRST",
- "SECOND",
- "THIRD",
- "REFLEXIVE_PERSON"
- ],
- "description": "The grammatical person.",
- "type": "string"
- },
- "proper": {
- "type": "string",
- "enumDescriptions": [
- "Proper is not applicable in the analyzed language or is not predicted.",
- "Proper",
- "Not proper"
- ],
- "enum": [
- "PROPER_UNKNOWN",
- "PROPER",
- "NOT_PROPER"
- ],
- "description": "The grammatical properness."
- },
- "case": {
- "type": "string",
- "enumDescriptions": [
- "Case is not applicable in the analyzed language or is not predicted.",
- "Accusative",
- "Adverbial",
- "Complementive",
- "Dative",
- "Genitive",
- "Instrumental",
- "Locative",
- "Nominative",
- "Oblique",
- "Partitive",
- "Prepositional",
- "Reflexive",
- "Relative",
- "Vocative"
- ],
- "enum": [
- "CASE_UNKNOWN",
- "ACCUSATIVE",
- "ADVERBIAL",
- "COMPLEMENTIVE",
- "DATIVE",
- "GENITIVE",
- "INSTRUMENTAL",
- "LOCATIVE",
- "NOMINATIVE",
- "OBLIQUE",
- "PARTITIVE",
- "PREPOSITIONAL",
- "REFLEXIVE_CASE",
- "RELATIVE_CASE",
- "VOCATIVE"
- ],
- "description": "The grammatical case."
- }
- },
- "id": "PartOfSpeech"
- },
- "AnalyzeSyntaxRequest": {
- "description": "The syntax analysis request message.",
- "type": "object",
- "properties": {
- "encodingType": {
- "enum": [
- "NONE",
- "UTF8",
- "UTF16",
- "UTF32"
- ],
- "description": "The encoding type used by the API to calculate offsets.",
- "type": "string",
- "enumDescriptions": [
- "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
- ]
- },
- "document": {
- "description": "Input document.",
- "$ref": "Document"
- }
- },
- "id": "AnalyzeSyntaxRequest"
- },
- "AnalyzeSentimentResponse": {
- "description": "The sentiment analysis response message.",
- "type": "object",
- "properties": {
- "language": {
- "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
- "type": "string"
- },
- "sentences": {
- "description": "The sentiment for all the sentences in the document.",
- "items": {
- "$ref": "Sentence"
- },
- "type": "array"
- },
- "documentSentiment": {
- "$ref": "Sentiment",
- "description": "The overall sentiment of the input document."
- }
- },
- "id": "AnalyzeSentimentResponse"
- },
- "AnalyzeEntitiesResponse": {
- "description": "The entity analysis response message.",
- "type": "object",
- "properties": {
- "language": {
- "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
- "type": "string"
- },
- "entities": {
- "description": "The recognized entities in the input document.",
- "items": {
- "$ref": "Entity"
- },
- "type": "array"
- }
- },
- "id": "AnalyzeEntitiesResponse"
- },
- "AnalyzeSyntaxResponse": {
- "description": "The syntax analysis response message.",
- "type": "object",
- "properties": {
- "tokens": {
- "description": "Tokens, along with their syntactic information, in the input document.",
- "items": {
- "$ref": "Token"
- },
- "type": "array"
- },
- "language": {
- "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
- "type": "string"
- },
- "sentences": {
- "items": {
- "$ref": "Sentence"
- },
- "type": "array",
- "description": "Sentences in the input document."
- }
- },
- "id": "AnalyzeSyntaxResponse"
- },
- "Entity": {
- "properties": {
- "salience": {
- "type": "number",
- "format": "float",
- "description": "The salience score associated with the entity in the [0, 1.0] range.\n\nThe salience score for an entity provides information about the\nimportance or centrality of that entity to the entire document text.\nScores closer to 0 are less salient, while scores closer to 1.0 are highly\nsalient."
- },
- "metadata": {
- "description": "Metadata associated with the entity.\n\nCurrently, Wikipedia URLs and Knowledge Graph MIDs are provided, if\navailable. The associated keys are \"wikipedia_url\" and \"mid\", respectively.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "type": {
- "enumDescriptions": [
- "Unknown",
- "Person",
- "Location",
- "Organization",
- "Event",
- "Work of art",
- "Consumer goods",
- "Other types"
- ],
- "enum": [
- "UNKNOWN",
- "PERSON",
- "LOCATION",
- "ORGANIZATION",
- "EVENT",
- "WORK_OF_ART",
- "CONSUMER_GOOD",
- "OTHER"
- ],
- "description": "The entity type.",
- "type": "string"
- },
- "mentions": {
- "description": "The mentions of this entity in the input document. The API currently\nsupports proper noun mentions.",
- "items": {
- "$ref": "EntityMention"
- },
- "type": "array"
- },
- "name": {
- "description": "The representative name for the entity.",
- "type": "string"
- }
- },
- "id": "Entity",
- "description": "Represents a phrase in the text that is a known entity, such as\na person, an organization, or location. The API associates information, such\nas salience and mentions, with entities.",
- "type": "object"
+ "id": "Status"
}
},
- "protocol": "rest",
"icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
},
+ "protocol": "rest",
"canonicalName": "Cloud Natural Language",
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/cloud-language": {
- "description": "Apply machine learning models to reveal the structure and meaning of text"
- },
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/cloud-language": {
+ "description": "Apply machine learning models to reveal the structure and meaning of text"
}
}
}
@@ -935,175 +1105,5 @@
"name": "language",
"batchPath": "batch",
"title": "Google Cloud Natural Language API",
- "ownerName": "Google",
- "resources": {
- "documents": {
- "methods": {
- "analyzeSyntax": {
- "response": {
- "$ref": "AnalyzeSyntaxResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-language",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/documents:analyzeSyntax",
- "id": "language.documents.analyzeSyntax",
- "path": "v1beta1/documents:analyzeSyntax",
- "description": "Analyzes the syntax of the text and provides sentence boundaries and\ntokenization along with part of speech tags, dependency trees, and other\nproperties.",
- "request": {
- "$ref": "AnalyzeSyntaxRequest"
- }
- },
- "analyzeSentiment": {
- "response": {
- "$ref": "AnalyzeSentimentResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-language",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/documents:analyzeSentiment",
- "id": "language.documents.analyzeSentiment",
- "path": "v1beta1/documents:analyzeSentiment",
- "description": "Analyzes the sentiment of the provided text.",
- "request": {
- "$ref": "AnalyzeSentimentRequest"
- }
- },
- "annotateText": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "AnnotateTextResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-language",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v1beta1/documents:annotateText",
- "path": "v1beta1/documents:annotateText",
- "id": "language.documents.annotateText",
- "request": {
- "$ref": "AnnotateTextRequest"
- },
- "description": "A convenience method that provides all the features that analyzeSentiment,\nanalyzeEntities, and analyzeSyntax provide in one call."
- },
- "analyzeEntities": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "AnalyzeEntitiesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-language",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v1beta1/documents:analyzeEntities",
- "path": "v1beta1/documents:analyzeEntities",
- "id": "language.documents.analyzeEntities",
- "request": {
- "$ref": "AnalyzeEntitiesRequest"
- },
- "description": "Finds named entities (currently proper names and common nouns) in the text\nalong with entity types, salience, mentions for each entity, and\nother properties."
- }
- }
- }
- },
- "parameters": {
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "type": "string",
- "location": "query",
- "description": "JSONP"
- },
- "alt": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- }
- }
+ "ownerName": "Google"
}
diff --git a/language/v1beta2/language-api.json b/language/v1beta2/language-api.json
index ce392ba..1cc2c02 100644
--- a/language/v1beta2/language-api.json
+++ b/language/v1beta2/language-api.json
@@ -1,41 +1,81 @@
{
+ "title": "Google Cloud Natural Language API",
+ "ownerName": "Google",
"resources": {
"documents": {
"methods": {
+ "analyzeEntities": {
+ "id": "language.documents.analyzeEntities",
+ "path": "v1beta2/documents:analyzeEntities",
+ "request": {
+ "$ref": "AnalyzeEntitiesRequest"
+ },
+ "description": "Finds named entities (currently proper names and common nouns) in the text\nalong with entity types, salience, mentions for each entity, and\nother properties.",
+ "response": {
+ "$ref": "AnalyzeEntitiesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-language",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1beta2/documents:analyzeEntities"
+ },
+ "analyzeSyntax": {
+ "description": "Analyzes the syntax of the text and provides sentence boundaries and\ntokenization along with part of speech tags, dependency trees, and other\nproperties.",
+ "request": {
+ "$ref": "AnalyzeSyntaxRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "AnalyzeSyntaxResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-language",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/documents:analyzeSyntax",
+ "path": "v1beta2/documents:analyzeSyntax",
+ "id": "language.documents.analyzeSyntax"
+ },
"annotateText": {
- "path": "v1beta2/documents:annotateText",
- "id": "language.documents.annotateText",
- "description": "A convenience method that provides all syntax, sentiment, entity, and\nclassification features in one call.",
"request": {
"$ref": "AnnotateTextRequest"
},
+ "description": "A convenience method that provides all syntax, sentiment, entity, and\nclassification features in one call.",
"httpMethod": "POST",
"parameterOrder": [],
"response": {
"$ref": "AnnotateTextResponse"
},
- "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-language",
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1beta2/documents:annotateText"
+ "parameters": {},
+ "flatPath": "v1beta2/documents:annotateText",
+ "path": "v1beta2/documents:annotateText",
+ "id": "language.documents.annotateText"
},
"classifyText": {
- "description": "Classifies a document into categories.",
"request": {
"$ref": "ClassifyTextRequest"
},
+ "description": "Classifies a document into categories.",
"response": {
"$ref": "ClassifyTextResponse"
},
"parameterOrder": [],
"httpMethod": "POST",
- "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-language",
"https://www.googleapis.com/auth/cloud-platform"
],
+ "parameters": {},
"flatPath": "v1beta2/documents:classifyText",
"id": "language.documents.classifyText",
"path": "v1beta2/documents:classifyText"
@@ -46,24 +86,20 @@
"response": {
"$ref": "AnalyzeSentimentResponse"
},
+ "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-language",
"https://www.googleapis.com/auth/cloud-platform"
],
- "parameters": {},
"flatPath": "v1beta2/documents:analyzeSentiment",
"path": "v1beta2/documents:analyzeSentiment",
"id": "language.documents.analyzeSentiment",
+ "description": "Analyzes the sentiment of the provided text.",
"request": {
"$ref": "AnalyzeSentimentRequest"
- },
- "description": "Analyzes the sentiment of the provided text."
+ }
},
"analyzeEntitySentiment": {
- "request": {
- "$ref": "AnalyzeEntitySentimentRequest"
- },
- "description": "Finds entities, similar to AnalyzeEntities in the text and analyzes\nsentiment associated with each entity and its mentions.",
"response": {
"$ref": "AnalyzeEntitySentimentResponse"
},
@@ -76,115 +112,26 @@
"parameters": {},
"flatPath": "v1beta2/documents:analyzeEntitySentiment",
"id": "language.documents.analyzeEntitySentiment",
- "path": "v1beta2/documents:analyzeEntitySentiment"
- },
- "analyzeEntities": {
- "description": "Finds named entities (currently proper names and common nouns) in the text\nalong with entity types, salience, mentions for each entity, and\nother properties.",
+ "path": "v1beta2/documents:analyzeEntitySentiment",
"request": {
- "$ref": "AnalyzeEntitiesRequest"
+ "$ref": "AnalyzeEntitySentimentRequest"
},
- "response": {
- "$ref": "AnalyzeEntitiesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-language",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/documents:analyzeEntities",
- "id": "language.documents.analyzeEntities",
- "path": "v1beta2/documents:analyzeEntities"
- },
- "analyzeSyntax": {
- "flatPath": "v1beta2/documents:analyzeSyntax",
- "id": "language.documents.analyzeSyntax",
- "path": "v1beta2/documents:analyzeSyntax",
- "request": {
- "$ref": "AnalyzeSyntaxRequest"
- },
- "description": "Analyzes the syntax of the text and provides sentence boundaries and\ntokenization along with part of speech tags, dependency trees, and other\nproperties.",
- "response": {
- "$ref": "AnalyzeSyntaxResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-language",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {}
+ "description": "Finds entities, similar to AnalyzeEntities in the text and analyzes\nsentiment associated with each entity and its mentions."
}
}
}
},
"parameters": {
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "alt": {
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "type": "string",
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
- },
- "pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
"bearer_token": {
"description": "OAuth bearer token.",
"type": "string",
"location": "query"
},
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
"upload_protocol": {
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
@@ -196,37 +143,133 @@
"default": "true",
"type": "boolean"
},
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
"fields": {
- "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response."
+ },
+ "$.xgafv": {
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query"
+ },
+ "callback": {
+ "description": "JSONP",
"type": "string",
"location": "query"
},
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
"type": "string",
- "location": "query"
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "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": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth access token."
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
}
},
"version": "v1beta2",
"baseUrl": "https://language.googleapis.com/",
+ "servicePath": "",
"description": "Provides natural language understanding technologies to developers. Examples include sentiment analysis, entity recognition, entity sentiment analysis, and text annotations.",
"kind": "discovery#restDescription",
- "servicePath": "",
"basePath": "",
- "id": "language:v1beta2",
"documentationLink": "https://cloud.google.com/natural-language/",
- "revision": "20171003",
+ "id": "language:v1beta2",
+ "revision": "20171009",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "AnnotateTextResponse": {
- "description": "The text annotations response message.",
+ "AnalyzeSentimentResponse": {
+ "description": "The sentiment analysis response message.",
"type": "object",
"properties": {
+ "documentSentiment": {
+ "$ref": "Sentiment",
+ "description": "The overall sentiment of the input document."
+ },
+ "language": {
+ "type": "string",
+ "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details."
+ },
+ "sentences": {
+ "description": "The sentiment for all the sentences in the document.",
+ "items": {
+ "$ref": "Sentence"
+ },
+ "type": "array"
+ }
+ },
+ "id": "AnalyzeSentimentResponse"
+ },
+ "AnalyzeSyntaxResponse": {
+ "description": "The syntax analysis response message.",
+ "type": "object",
+ "properties": {
+ "sentences": {
+ "description": "Sentences in the input document.",
+ "items": {
+ "$ref": "Sentence"
+ },
+ "type": "array"
+ },
+ "tokens": {
+ "description": "Tokens, along with their syntactic information, in the input document.",
+ "items": {
+ "$ref": "Token"
+ },
+ "type": "array"
+ },
"language": {
"description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
"type": "string"
- },
+ }
+ },
+ "id": "AnalyzeSyntaxResponse"
+ },
+ "AnnotateTextResponse": {
+ "properties": {
"entities": {
"description": "Entities, along with their semantic information, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.Features.extract_entities.",
"items": {
@@ -256,20 +299,25 @@
"type": "array"
},
"documentSentiment": {
- "$ref": "Sentiment",
- "description": "The overall sentiment for the document. Populated if the user enables\nAnnotateTextRequest.Features.extract_document_sentiment."
+ "description": "The overall sentiment for the document. Populated if the user enables\nAnnotateTextRequest.Features.extract_document_sentiment.",
+ "$ref": "Sentiment"
+ },
+ "language": {
+ "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
+ "type": "string"
}
},
- "id": "AnnotateTextResponse"
+ "id": "AnnotateTextResponse",
+ "description": "The text annotations response message.",
+ "type": "object"
},
"DependencyEdge": {
- "description": "Represents dependency parse tree information for a token.",
"type": "object",
"properties": {
"headTokenIndex": {
+ "type": "integer",
"format": "int32",
- "description": "Represents the head of this token in the dependency tree.\nThis is the index of the token which has an arc going to this token.\nThe index is the position of the token in the array of tokens returned\nby the API method. If this token is a root token, then the\n`head_token_index` is its own index.",
- "type": "integer"
+ "description": "Represents the head of this token in the dependency tree.\nThis is the index of the token which has an arc going to this token.\nThe index is the position of the token in the array of tokens returned\nby the API method. If this token is a root token, then the\n`head_token_index` is its own index."
},
"label": {
"enum": [
@@ -446,32 +494,35 @@
]
}
},
- "id": "DependencyEdge"
+ "id": "DependencyEdge",
+ "description": "Represents dependency parse tree information for a token."
},
"Token": {
"description": "Represents the smallest syntactic building block of the text.",
"type": "object",
"properties": {
- "partOfSpeech": {
- "$ref": "PartOfSpeech",
- "description": "Parts of speech tag for this token."
- },
"dependencyEdge": {
- "description": "Dependency tree parse for this token.",
- "$ref": "DependencyEdge"
+ "$ref": "DependencyEdge",
+ "description": "Dependency tree parse for this token."
},
"text": {
"description": "The token text.",
"$ref": "TextSpan"
},
"lemma": {
- "description": "[Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.",
- "type": "string"
+ "type": "string",
+ "description": "[Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token."
+ },
+ "partOfSpeech": {
+ "description": "Parts of speech tag for this token.",
+ "$ref": "PartOfSpeech"
}
},
"id": "Token"
},
"TextSpan": {
+ "description": "Represents an output piece of text.",
+ "type": "object",
"properties": {
"beginOffset": {
"format": "int32",
@@ -483,11 +534,10 @@
"type": "string"
}
},
- "id": "TextSpan",
- "description": "Represents an output piece of text.",
- "type": "object"
+ "id": "TextSpan"
},
"ClassifyTextResponse": {
+ "description": "The document classification response message.",
"type": "object",
"properties": {
"categories": {
@@ -498,37 +548,36 @@
"type": "array"
}
},
- "id": "ClassifyTextResponse",
- "description": "The document classification response message."
+ "id": "ClassifyTextResponse"
},
"EntityMention": {
+ "id": "EntityMention",
+ "description": "Represents a mention for an entity in the text. Currently, proper noun\nmentions are supported.",
+ "type": "object",
"properties": {
"type": {
+ "enumDescriptions": [
+ "Unknown",
+ "Proper name",
+ "Common noun (or noun compound)"
+ ],
"enum": [
"TYPE_UNKNOWN",
"PROPER",
"COMMON"
],
"description": "The type of the entity mention.",
- "type": "string",
- "enumDescriptions": [
- "Unknown",
- "Proper name",
- "Common noun (or noun compound)"
- ]
+ "type": "string"
},
"text": {
"$ref": "TextSpan",
"description": "The mention text."
},
"sentiment": {
- "$ref": "Sentiment",
- "description": "For calls to AnalyzeEntitySentiment or if\nAnnotateTextRequest.Features.extract_entity_sentiment is set to\ntrue, this field will contain the sentiment expressed for this mention of\nthe entity in the provided document."
+ "description": "For calls to AnalyzeEntitySentiment or if\nAnnotateTextRequest.Features.extract_entity_sentiment is set to\ntrue, this field will contain the sentiment expressed for this mention of\nthe entity in the provided document.",
+ "$ref": "Sentiment"
}
- },
- "id": "EntityMention",
- "description": "Represents a mention for an entity in the text. Currently, proper noun\nmentions are supported.",
- "type": "object"
+ }
},
"Sentence": {
"description": "Represents a sentence in the input document.",
@@ -546,25 +595,29 @@
"id": "Sentence"
},
"Sentiment": {
+ "description": "Represents the feeling associated with the entire text or entities in\nthe text.",
+ "type": "object",
"properties": {
+ "score": {
+ "type": "number",
+ "format": "float",
+ "description": "Sentiment score between -1.0 (negative sentiment) and 1.0\n(positive sentiment)."
+ },
"magnitude": {
"format": "float",
"description": "A non-negative number in the [0, +inf) range, which represents\nthe absolute magnitude of sentiment regardless of score (positive or\nnegative).",
"type": "number"
- },
- "score": {
- "format": "float",
- "description": "Sentiment score between -1.0 (negative sentiment) and 1.0\n(positive sentiment).",
- "type": "number"
}
},
- "id": "Sentiment",
- "description": "Represents the feeling associated with the entire text or entities in\nthe text.",
- "type": "object"
+ "id": "Sentiment"
},
"AnalyzeEntitySentimentRequest": {
+ "description": "The entity-level sentiment analysis request message.",
+ "type": "object",
"properties": {
"encodingType": {
+ "description": "The encoding type used by the API to calculate offsets.",
+ "type": "string",
"enumDescriptions": [
"If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
"Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
@@ -576,38 +629,20 @@
"UTF8",
"UTF16",
"UTF32"
- ],
- "description": "The encoding type used by the API to calculate offsets.",
- "type": "string"
+ ]
},
"document": {
- "description": "Input document.",
- "$ref": "Document"
+ "$ref": "Document",
+ "description": "Input document."
}
},
- "id": "AnalyzeEntitySentimentRequest",
- "description": "The entity-level sentiment analysis request message.",
- "type": "object"
+ "id": "AnalyzeEntitySentimentRequest"
},
"PartOfSpeech": {
"description": "Represents part of speech information for a token.",
"type": "object",
"properties": {
"form": {
- "enumDescriptions": [
- "Form is not applicable in the analyzed language or is not predicted.",
- "Adnomial",
- "Auxiliary",
- "Complementizer",
- "Final ending",
- "Gerund",
- "Realis",
- "Irrealis",
- "Short form",
- "Long form",
- "Order form",
- "Specific form"
- ],
"enum": [
"FORM_UNKNOWN",
"ADNOMIAL",
@@ -623,9 +658,29 @@
"SPECIFIC"
],
"description": "The grammatical form.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Form is not applicable in the analyzed language or is not predicted.",
+ "Adnomial",
+ "Auxiliary",
+ "Complementizer",
+ "Final ending",
+ "Gerund",
+ "Realis",
+ "Irrealis",
+ "Short form",
+ "Long form",
+ "Order form",
+ "Specific form"
+ ]
},
"number": {
+ "enumDescriptions": [
+ "Number is not applicable in the analyzed language or is not predicted.",
+ "Singular",
+ "Plural",
+ "Dual"
+ ],
"enum": [
"NUMBER_UNKNOWN",
"SINGULAR",
@@ -633,21 +688,9 @@
"DUAL"
],
"description": "The grammatical number.",
- "type": "string",
- "enumDescriptions": [
- "Number is not applicable in the analyzed language or is not predicted.",
- "Singular",
- "Plural",
- "Dual"
- ]
+ "type": "string"
},
"voice": {
- "enum": [
- "VOICE_UNKNOWN",
- "ACTIVE",
- "CAUSATIVE",
- "PASSIVE"
- ],
"description": "The grammatical voice.",
"type": "string",
"enumDescriptions": [
@@ -655,9 +698,17 @@
"Active",
"Causative",
"Passive"
+ ],
+ "enum": [
+ "VOICE_UNKNOWN",
+ "ACTIVE",
+ "CAUSATIVE",
+ "PASSIVE"
]
},
"aspect": {
+ "description": "The grammatical aspect.",
+ "type": "string",
"enumDescriptions": [
"Aspect is not applicable in the analyzed language or is not predicted.",
"Perfective",
@@ -669,13 +720,9 @@
"PERFECTIVE",
"IMPERFECTIVE",
"PROGRESSIVE"
- ],
- "description": "The grammatical aspect.",
- "type": "string"
+ ]
},
"mood": {
- "description": "The grammatical mood.",
- "type": "string",
"enumDescriptions": [
"Mood is not applicable in the analyzed language or is not predicted.",
"Conditional",
@@ -693,9 +740,13 @@
"INTERROGATIVE",
"JUSSIVE",
"SUBJUNCTIVE"
- ]
+ ],
+ "description": "The grammatical mood.",
+ "type": "string"
},
"tag": {
+ "description": "The part of speech tag.",
+ "type": "string",
"enumDescriptions": [
"Unknown",
"Adjective",
@@ -727,34 +778,25 @@
"VERB",
"X",
"AFFIX"
- ],
- "description": "The part of speech tag.",
- "type": "string"
+ ]
},
"gender": {
- "enum": [
- "GENDER_UNKNOWN",
- "FEMININE",
- "MASCULINE",
- "NEUTER"
- ],
- "description": "The grammatical gender.",
"type": "string",
"enumDescriptions": [
"Gender is not applicable in the analyzed language or is not predicted.",
"Feminine",
"Masculine",
"Neuter"
- ]
+ ],
+ "enum": [
+ "GENDER_UNKNOWN",
+ "FEMININE",
+ "MASCULINE",
+ "NEUTER"
+ ],
+ "description": "The grammatical gender."
},
"person": {
- "enum": [
- "PERSON_UNKNOWN",
- "FIRST",
- "SECOND",
- "THIRD",
- "REFLEXIVE_PERSON"
- ],
"description": "The grammatical person.",
"type": "string",
"enumDescriptions": [
@@ -763,9 +805,18 @@
"Second",
"Third",
"Reflexive"
+ ],
+ "enum": [
+ "PERSON_UNKNOWN",
+ "FIRST",
+ "SECOND",
+ "THIRD",
+ "REFLEXIVE_PERSON"
]
},
"proper": {
+ "description": "The grammatical properness.",
+ "type": "string",
"enumDescriptions": [
"Proper is not applicable in the analyzed language or is not predicted.",
"Proper",
@@ -775,11 +826,11 @@
"PROPER_UNKNOWN",
"PROPER",
"NOT_PROPER"
- ],
- "description": "The grammatical properness.",
- "type": "string"
+ ]
},
"case": {
+ "description": "The grammatical case.",
+ "type": "string",
"enumDescriptions": [
"Case is not applicable in the analyzed language or is not predicted.",
"Accusative",
@@ -813,11 +864,18 @@
"REFLEXIVE_CASE",
"RELATIVE_CASE",
"VOCATIVE"
- ],
- "description": "The grammatical case.",
- "type": "string"
+ ]
},
"tense": {
+ "enumDescriptions": [
+ "Tense is not applicable in the analyzed language or is not predicted.",
+ "Conditional",
+ "Future",
+ "Past",
+ "Present",
+ "Imperfect",
+ "Pluperfect"
+ ],
"enum": [
"TENSE_UNKNOWN",
"CONDITIONAL_TENSE",
@@ -828,36 +886,26 @@
"PLUPERFECT"
],
"description": "The grammatical tense.",
- "type": "string",
- "enumDescriptions": [
- "Tense is not applicable in the analyzed language or is not predicted.",
- "Conditional",
- "Future",
- "Past",
- "Present",
- "Imperfect",
- "Pluperfect"
- ]
+ "type": "string"
},
"reciprocity": {
- "enum": [
- "RECIPROCITY_UNKNOWN",
- "RECIPROCAL",
- "NON_RECIPROCAL"
- ],
"description": "The grammatical reciprocity.",
"type": "string",
"enumDescriptions": [
"Reciprocity is not applicable in the analyzed language or is not\npredicted.",
"Reciprocal",
"Non-reciprocal"
+ ],
+ "enum": [
+ "RECIPROCITY_UNKNOWN",
+ "RECIPROCAL",
+ "NON_RECIPROCAL"
]
}
},
"id": "PartOfSpeech"
},
"ClassificationCategory": {
- "description": "Represents a category returned from the text classifier.",
"type": "object",
"properties": {
"confidence": {
@@ -870,11 +918,20 @@
"type": "string"
}
},
- "id": "ClassificationCategory"
+ "id": "ClassificationCategory",
+ "description": "Represents a category returned from the text classifier."
},
"AnalyzeSyntaxRequest": {
+ "description": "The syntax analysis request message.",
+ "type": "object",
"properties": {
"encodingType": {
+ "enumDescriptions": [
+ "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
+ ],
"enum": [
"NONE",
"UTF8",
@@ -882,37 +939,29 @@
"UTF32"
],
"description": "The encoding type used by the API to calculate offsets.",
- "type": "string",
- "enumDescriptions": [
- "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
- ]
+ "type": "string"
},
"document": {
"description": "Input document.",
"$ref": "Document"
}
},
- "id": "AnalyzeSyntaxRequest",
- "description": "The syntax analysis request message.",
- "type": "object"
+ "id": "AnalyzeSyntaxRequest"
},
"AnalyzeEntitiesResponse": {
"description": "The entity analysis response message.",
"type": "object",
"properties": {
+ "language": {
+ "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
+ "type": "string"
+ },
"entities": {
"description": "The recognized entities in the input document.",
"items": {
"$ref": "Entity"
},
"type": "array"
- },
- "language": {
- "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
- "type": "string"
}
},
"id": "AnalyzeEntitiesResponse"
@@ -921,11 +970,28 @@
"description": "Represents a phrase in the text that is a known entity, such as\na person, an organization, or location. The API associates information, such\nas salience and mentions, with entities.",
"type": "object",
"properties": {
+ "mentions": {
+ "description": "The mentions of this entity in the input document. The API currently\nsupports proper noun mentions.",
+ "items": {
+ "$ref": "EntityMention"
+ },
+ "type": "array"
+ },
"name": {
"description": "The representative name for the entity.",
"type": "string"
},
"type": {
+ "enum": [
+ "UNKNOWN",
+ "PERSON",
+ "LOCATION",
+ "ORGANIZATION",
+ "EVENT",
+ "WORK_OF_ART",
+ "CONSUMER_GOOD",
+ "OTHER"
+ ],
"description": "The entity type.",
"type": "string",
"enumDescriptions": [
@@ -937,24 +1003,14 @@
"Work of art",
"Consumer goods",
"Other types"
- ],
- "enum": [
- "UNKNOWN",
- "PERSON",
- "LOCATION",
- "ORGANIZATION",
- "EVENT",
- "WORK_OF_ART",
- "CONSUMER_GOOD",
- "OTHER"
]
},
"metadata": {
+ "description": "Metadata associated with the entity.\n\nCurrently, Wikipedia URLs and Knowledge Graph MIDs are provided, if\navailable. The associated keys are \"wikipedia_url\" and \"mid\", respectively.",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "Metadata associated with the entity.\n\nCurrently, Wikipedia URLs and Knowledge Graph MIDs are provided, if\navailable. The associated keys are \"wikipedia_url\" and \"mid\", respectively.",
- "type": "object"
+ }
},
"salience": {
"format": "float",
@@ -964,20 +1020,11 @@
"sentiment": {
"$ref": "Sentiment",
"description": "For calls to AnalyzeEntitySentiment or if\nAnnotateTextRequest.Features.extract_entity_sentiment is set to\ntrue, this field will contain the aggregate sentiment expressed for this\nentity in the provided document."
- },
- "mentions": {
- "description": "The mentions of this entity in the input document. The API currently\nsupports proper noun mentions.",
- "items": {
- "$ref": "EntityMention"
- },
- "type": "array"
}
},
"id": "Entity"
},
"AnnotateTextRequest": {
- "id": "AnnotateTextRequest",
- "description": "The request message for the text annotation API, which can perform multiple\nanalysis types (sentiment, entities, and syntax) in one call.",
"type": "object",
"properties": {
"encodingType": {
@@ -997,20 +1044,26 @@
"type": "string"
},
"document": {
- "description": "Input document.",
- "$ref": "Document"
+ "$ref": "Document",
+ "description": "Input document."
},
"features": {
- "description": "The enabled features.",
- "$ref": "Features"
+ "$ref": "Features",
+ "description": "The enabled features."
}
- }
+ },
+ "id": "AnnotateTextRequest",
+ "description": "The request message for the text annotation API, which can perform multiple\nanalysis types (sentiment, entities, and syntax) in one call."
},
"AnalyzeSentimentRequest": {
- "description": "The sentiment analysis request message.",
- "type": "object",
"properties": {
"encodingType": {
+ "enumDescriptions": [
+ "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
+ ],
"enum": [
"NONE",
"UTF8",
@@ -1018,37 +1071,29 @@
"UTF32"
],
"description": "The encoding type used by the API to calculate sentence offsets for the\nsentence sentiment.",
- "type": "string",
- "enumDescriptions": [
- "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
- ]
+ "type": "string"
},
"document": {
- "description": "Input document.",
- "$ref": "Document"
+ "$ref": "Document",
+ "description": "Input document."
}
},
- "id": "AnalyzeSentimentRequest"
+ "id": "AnalyzeSentimentRequest",
+ "description": "The sentiment analysis request message.",
+ "type": "object"
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
- "type": "object",
"additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
- }
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
},
"type": "array"
},
@@ -1056,6 +1101,10 @@
"format": "int32",
"description": "The status code, which should be an enum value of google.rpc.Code.",
"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"
@@ -1064,6 +1113,14 @@
"description": "All available features for sentiment, syntax, and semantic analysis.\nSetting each one to true will enable that specific analysis for the input.",
"type": "object",
"properties": {
+ "extractEntities": {
+ "description": "Extract entities.",
+ "type": "boolean"
+ },
+ "classifyText": {
+ "description": "Classify the full document into categories.",
+ "type": "boolean"
+ },
"extractEntitySentiment": {
"description": "Extract entities and their associated sentiment.",
"type": "boolean"
@@ -1073,15 +1130,7 @@
"type": "boolean"
},
"extractSyntax": {
- "type": "boolean",
- "description": "Extract syntax information."
- },
- "extractEntities": {
- "description": "Extract entities.",
- "type": "boolean"
- },
- "classifyText": {
- "description": "Classify the full document into categories.",
+ "description": "Extract syntax information.",
"type": "boolean"
}
},
@@ -1096,26 +1145,26 @@
"type": "string"
},
"type": {
+ "enumDescriptions": [
+ "The content type is not specified.",
+ "Plain text",
+ "HTML"
+ ],
"enum": [
"TYPE_UNSPECIFIED",
"PLAIN_TEXT",
"HTML"
],
"description": "Required. If the type is not set or is `TYPE_UNSPECIFIED`,\nreturns an `INVALID_ARGUMENT` error.",
- "type": "string",
- "enumDescriptions": [
- "The content type is not specified.",
- "Plain text",
- "HTML"
- ]
+ "type": "string"
},
"gcsContentUri": {
"description": "The Google Cloud Storage URI where the file content is located.\nThis URI must be of the form: gs://bucket_name/object_name. For more\ndetails, see https://cloud.google.com/storage/docs/reference-uris.\nNOTE: Cloud Storage object versioning is not supported.",
"type": "string"
},
"language": {
- "description": "The language of the document (if not specified, the language is\nautomatically detected). Both ISO and BCP-47 language codes are\naccepted.\u003cbr\u003e\n[Language Support](/natural-language/docs/languages)\nlists currently supported languages for each API method.\nIf the language (either specified by the caller or automatically detected)\nis not supported by the called API method, an `INVALID_ARGUMENT` error\nis returned.",
- "type": "string"
+ "type": "string",
+ "description": "The language of the document (if not specified, the language is\nautomatically detected). Both ISO and BCP-47 language codes are\naccepted.\u003cbr\u003e\n[Language Support](/natural-language/docs/languages)\nlists currently supported languages for each API method.\nIf the language (either specified by the caller or automatically detected)\nis not supported by the called API method, an `INVALID_ARGUMENT` error\nis returned."
}
},
"id": "Document"
@@ -1123,12 +1172,6 @@
"AnalyzeEntitiesRequest": {
"properties": {
"encodingType": {
- "enum": [
- "NONE",
- "UTF8",
- "UTF16",
- "UTF32"
- ],
"description": "The encoding type used by the API to calculate offsets.",
"type": "string",
"enumDescriptions": [
@@ -1136,11 +1179,17 @@
"Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
"Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
"Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
+ ],
+ "enum": [
+ "NONE",
+ "UTF8",
+ "UTF16",
+ "UTF32"
]
},
"document": {
- "$ref": "Document",
- "description": "Input document."
+ "description": "Input document.",
+ "$ref": "Document"
}
},
"id": "AnalyzeEntitiesRequest",
@@ -1148,96 +1197,49 @@
"type": "object"
},
"ClassifyTextRequest": {
- "id": "ClassifyTextRequest",
"description": "The document classification request message.",
"type": "object",
"properties": {
"document": {
- "description": "Input document.",
- "$ref": "Document"
+ "$ref": "Document",
+ "description": "Input document."
}
- }
+ },
+ "id": "ClassifyTextRequest"
},
"AnalyzeEntitySentimentResponse": {
+ "description": "The entity-level sentiment analysis response message.",
"type": "object",
"properties": {
- "language": {
- "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
- "type": "string"
- },
"entities": {
"description": "The recognized entities in the input document with associated sentiments.",
"items": {
"$ref": "Entity"
},
"type": "array"
- }
- },
- "id": "AnalyzeEntitySentimentResponse",
- "description": "The entity-level sentiment analysis response message."
- },
- "AnalyzeSentimentResponse": {
- "description": "The sentiment analysis response message.",
- "type": "object",
- "properties": {
- "documentSentiment": {
- "$ref": "Sentiment",
- "description": "The overall sentiment of the input document."
},
"language": {
"description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
"type": "string"
- },
- "sentences": {
- "description": "The sentiment for all the sentences in the document.",
- "items": {
- "$ref": "Sentence"
- },
- "type": "array"
}
},
- "id": "AnalyzeSentimentResponse"
- },
- "AnalyzeSyntaxResponse": {
- "description": "The syntax analysis response message.",
- "type": "object",
- "properties": {
- "language": {
- "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
- "type": "string"
- },
- "sentences": {
- "description": "Sentences in the input document.",
- "items": {
- "$ref": "Sentence"
- },
- "type": "array"
- },
- "tokens": {
- "description": "Tokens, along with their syntactic information, in the input document.",
- "items": {
- "$ref": "Token"
- },
- "type": "array"
- }
- },
- "id": "AnalyzeSyntaxResponse"
+ "id": "AnalyzeEntitySentimentResponse"
}
},
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"protocol": "rest",
"canonicalName": "Cloud Natural Language",
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
"https://www.googleapis.com/auth/cloud-language": {
"description": "Apply machine learning models to reveal the structure and meaning of text"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
}
}
}
@@ -1245,7 +1247,5 @@
"rootUrl": "https://language.googleapis.com/",
"ownerDomain": "google.com",
"name": "language",
- "batchPath": "batch",
- "title": "Google Cloud Natural Language API",
- "ownerName": "Google"
+ "batchPath": "batch"
}
diff --git a/logging/v2/logging-api.json b/logging/v2/logging-api.json
index 5ee0fe0..0cfe5ab 100644
--- a/logging/v2/logging-api.json
+++ b/logging/v2/logging-api.json
@@ -1,2251 +1,15 @@
{
- "ownerDomain": "google.com",
- "name": "logging",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Stackdriver Logging API",
- "ownerName": "Google",
- "resources": {
- "folders": {
- "resources": {
- "exclusions": {
- "methods": {
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "LogExclusion"
- },
- "parameters": {
- "parent": {
- "description": "Required. The parent resource in which to create the exclusion:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
- "type": "string",
- "required": true,
- "pattern": "^folders/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/folders/{foldersId}/exclusions",
- "path": "v2/{+parent}/exclusions",
- "id": "logging.folders.exclusions.create",
- "description": "Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.",
- "request": {
- "$ref": "LogExclusion"
- }
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "Required. The resource name of an existing exclusion to delete:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
- "type": "string",
- "required": true,
- "pattern": "^folders/[^/]+/exclusions/[^/]+$"
- }
- },
- "flatPath": "v2/folders/{foldersId}/exclusions/{exclusionsId}",
- "id": "logging.folders.exclusions.delete",
- "path": "v2/{+name}",
- "description": "Deletes an exclusion."
- },
- "patch": {
- "request": {
- "$ref": "LogExclusion"
- },
- "description": "Changes one or more properties of an existing exclusion.",
- "httpMethod": "PATCH",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "LogExclusion"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "updateMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of \"filter,description\".",
- "type": "string"
- },
- "name": {
- "location": "path",
- "description": "Required. The resource name of the exclusion to update:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
- "type": "string",
- "required": true,
- "pattern": "^folders/[^/]+/exclusions/[^/]+$"
- }
- },
- "flatPath": "v2/folders/{foldersId}/exclusions/{exclusionsId}",
- "path": "v2/{+name}",
- "id": "logging.folders.exclusions.patch"
- },
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "LogExclusion"
- },
- "parameters": {
- "name": {
- "type": "string",
- "required": true,
- "pattern": "^folders/[^/]+/exclusions/[^/]+$",
- "location": "path",
- "description": "Required. The resource name of an existing exclusion:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\"."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2/folders/{foldersId}/exclusions/{exclusionsId}",
- "path": "v2/{+name}",
- "id": "logging.folders.exclusions.get",
- "description": "Gets the description of an exclusion."
- },
- "list": {
- "description": "Lists all the exclusions in a parent resource.",
- "response": {
- "$ref": "ListExclusionsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "parent": {
- "description": "Required. The parent resource whose exclusions are to be listed.\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "type": "string",
- "required": true,
- "pattern": "^folders/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string"
- },
- "pageSize": {
- "format": "int32",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2/folders/{foldersId}/exclusions",
- "id": "logging.folders.exclusions.list",
- "path": "v2/{+parent}/exclusions"
- }
- }
- },
- "sinks": {
- "methods": {
- "list": {
- "id": "logging.folders.sinks.list",
- "path": "v2/{+parent}/sinks",
- "description": "Lists sinks.",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "ListSinksResponse"
- },
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call."
- },
- "pageSize": {
- "format": "int32",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "location": "path",
- "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "type": "string",
- "required": true,
- "pattern": "^folders/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2/folders/{foldersId}/sinks"
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "LogSink"
- },
- "parameters": {
- "parent": {
- "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
- "type": "string",
- "required": true,
- "pattern": "^folders/[^/]+$",
- "location": "path"
- },
- "uniqueWriterIdentity": {
- "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
- "type": "boolean",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/folders/{foldersId}/sinks",
- "path": "v2/{+parent}/sinks",
- "id": "logging.folders.sinks.create",
- "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.",
- "request": {
- "$ref": "LogSink"
- }
- },
- "get": {
- "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}",
- "id": "logging.folders.sinks.get",
- "path": "v2/{+sinkName}",
- "description": "Gets a sink.",
- "response": {
- "$ref": "LogSink"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "parameters": {
- "sinkName": {
- "location": "path",
- "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "type": "string",
- "required": true,
- "pattern": "^folders/[^/]+/sinks/[^/]+$"
- }
- }
- },
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "sinkName"
- ],
- "response": {
- "$ref": "LogSink"
- },
- "parameters": {
- "updateMask": {
- "format": "google-fieldmask",
- "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.",
- "type": "string",
- "location": "query"
- },
- "uniqueWriterIdentity": {
- "type": "boolean",
- "location": "query",
- "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false."
- },
- "sinkName": {
- "location": "path",
- "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "type": "string",
- "required": true,
- "pattern": "^folders/[^/]+/sinks/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}",
- "path": "v2/{+sinkName}",
- "id": "logging.folders.sinks.patch",
- "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
- "request": {
- "$ref": "LogSink"
- }
- },
- "update": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "updateMask": {
- "format": "google-fieldmask",
- "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.",
- "type": "string",
- "location": "query"
- },
- "uniqueWriterIdentity": {
- "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
- "type": "boolean",
- "location": "query"
- },
- "sinkName": {
- "location": "path",
- "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "type": "string",
- "required": true,
- "pattern": "^folders/[^/]+/sinks/[^/]+$"
- }
- },
- "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}",
- "id": "logging.folders.sinks.update",
- "path": "v2/{+sinkName}",
- "request": {
- "$ref": "LogSink"
- },
- "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
- "response": {
- "$ref": "LogSink"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "httpMethod": "PUT"
- },
- "delete": {
- "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.",
- "parameterOrder": [
- "sinkName"
- ],
- "response": {
- "$ref": "Empty"
- },
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "sinkName": {
- "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "type": "string",
- "required": true,
- "pattern": "^folders/[^/]+/sinks/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}",
- "id": "logging.folders.sinks.delete",
- "path": "v2/{+sinkName}"
- }
- }
- },
- "logs": {
- "methods": {
- "delete": {
- "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "logName"
- ],
- "parameters": {
- "logName": {
- "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
- "type": "string",
- "required": true,
- "pattern": "^folders/[^/]+/logs/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/folders/{foldersId}/logs/{logsId}",
- "path": "v2/{+logName}",
- "id": "logging.folders.logs.delete"
- },
- "list": {
- "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
- "response": {
- "$ref": "ListLogsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "parameters": {
- "pageToken": {
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "type": "integer"
- },
- "parent": {
- "location": "path",
- "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "type": "string",
- "required": true,
- "pattern": "^folders/[^/]+$"
- }
- },
- "flatPath": "v2/folders/{foldersId}/logs",
- "id": "logging.folders.logs.list",
- "path": "v2/{+parent}/logs"
- }
- }
- }
- }
- },
- "monitoredResourceDescriptors": {
- "methods": {
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListMonitoredResourceDescriptorsResponse"
- },
- "parameterOrder": [],
- "parameters": {
- "pageToken": {
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "format": "int32",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2/monitoredResourceDescriptors",
- "path": "v2/monitoredResourceDescriptors",
- "id": "logging.monitoredResourceDescriptors.list",
- "description": "Lists the descriptors for monitored resource types used by Stackdriver Logging."
- }
- }
- },
- "organizations": {
- "resources": {
- "exclusions": {
- "methods": {
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "name": {
- "description": "Required. The resource name of an existing exclusion to delete:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+/exclusions/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2/organizations/{organizationsId}/exclusions/{exclusionsId}",
- "id": "logging.organizations.exclusions.delete",
- "path": "v2/{+name}",
- "description": "Deletes an exclusion."
- },
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "LogExclusion"
- },
- "parameters": {
- "updateMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of \"filter,description\".",
- "type": "string"
- },
- "name": {
- "description": "Required. The resource name of the exclusion to update:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+/exclusions/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/organizations/{organizationsId}/exclusions/{exclusionsId}",
- "path": "v2/{+name}",
- "id": "logging.organizations.exclusions.patch",
- "description": "Changes one or more properties of an existing exclusion.",
- "request": {
- "$ref": "LogExclusion"
- }
- },
- "get": {
- "path": "v2/{+name}",
- "id": "logging.organizations.exclusions.get",
- "description": "Gets the description of an exclusion.",
- "httpMethod": "GET",
- "response": {
- "$ref": "LogExclusion"
- },
- "parameterOrder": [
- "name"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "parameters": {
- "name": {
- "description": "Required. The resource name of an existing exclusion:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+/exclusions/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2/organizations/{organizationsId}/exclusions/{exclusionsId}"
- },
- "list": {
- "response": {
- "$ref": "ListExclusionsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "parent": {
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+$",
- "location": "path",
- "description": "Required. The parent resource whose exclusions are to be listed.\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n"
- },
- "pageToken": {
- "location": "query",
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2/organizations/{organizationsId}/exclusions",
- "id": "logging.organizations.exclusions.list",
- "path": "v2/{+parent}/exclusions",
- "description": "Lists all the exclusions in a parent resource."
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "LogExclusion"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "parent": {
- "pattern": "^organizations/[^/]+$",
- "location": "path",
- "description": "Required. The parent resource in which to create the exclusion:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v2/organizations/{organizationsId}/exclusions",
- "path": "v2/{+parent}/exclusions",
- "id": "logging.organizations.exclusions.create",
- "request": {
- "$ref": "LogExclusion"
- },
- "description": "Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource."
- }
- }
- },
- "sinks": {
- "methods": {
- "get": {
- "parameterOrder": [
- "sinkName"
- ],
- "httpMethod": "GET",
- "response": {
- "$ref": "LogSink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "parameters": {
- "sinkName": {
- "location": "path",
- "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+/sinks/[^/]+$"
- }
- },
- "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}",
- "id": "logging.organizations.sinks.get",
- "path": "v2/{+sinkName}",
- "description": "Gets a sink."
- },
- "patch": {
- "response": {
- "$ref": "LogSink"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "updateMask": {
- "format": "google-fieldmask",
- "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.",
- "type": "string",
- "location": "query"
- },
- "uniqueWriterIdentity": {
- "location": "query",
- "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
- "type": "boolean"
- },
- "sinkName": {
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+/sinks/[^/]+$",
- "location": "path",
- "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\"."
- }
- },
- "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}",
- "id": "logging.organizations.sinks.patch",
- "path": "v2/{+sinkName}",
- "request": {
- "$ref": "LogSink"
- },
- "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field."
- },
- "update": {
- "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
- "request": {
- "$ref": "LogSink"
- },
- "response": {
- "$ref": "LogSink"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "updateMask": {
- "type": "string",
- "location": "query",
- "format": "google-fieldmask",
- "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter."
- },
- "uniqueWriterIdentity": {
- "location": "query",
- "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
- "type": "boolean"
- },
- "sinkName": {
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+/sinks/[^/]+$",
- "location": "path",
- "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\"."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}",
- "id": "logging.organizations.sinks.update",
- "path": "v2/{+sinkName}"
- },
- "delete": {
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "sinkName": {
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+/sinks/[^/]+$",
- "location": "path",
- "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\"."
- }
- },
- "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}",
- "path": "v2/{+sinkName}",
- "id": "logging.organizations.sinks.delete",
- "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted."
- },
- "list": {
- "response": {
- "$ref": "ListSinksResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "format": "int32",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available."
- },
- "parent": {
- "pattern": "^organizations/[^/]+$",
- "location": "path",
- "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2/organizations/{organizationsId}/sinks",
- "id": "logging.organizations.sinks.list",
- "path": "v2/{+parent}/sinks",
- "description": "Lists sinks."
- },
- "create": {
- "flatPath": "v2/organizations/{organizationsId}/sinks",
- "id": "logging.organizations.sinks.create",
- "path": "v2/{+parent}/sinks",
- "request": {
- "$ref": "LogSink"
- },
- "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.",
- "response": {
- "$ref": "LogSink"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "uniqueWriterIdentity": {
- "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
- "type": "boolean",
- "location": "query"
- },
- "parent": {
- "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- }
- }
- }
- }
- },
- "logs": {
- "methods": {
- "delete": {
- "flatPath": "v2/organizations/{organizationsId}/logs/{logsId}",
- "id": "logging.organizations.logs.delete",
- "path": "v2/{+logName}",
- "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "logName"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "logName": {
- "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+/logs/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ]
- },
- "list": {
- "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "ListLogsResponse"
- },
- "parameters": {
- "parent": {
- "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call."
- },
- "pageSize": {
- "format": "int32",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2/organizations/{organizationsId}/logs",
- "path": "v2/{+parent}/logs",
- "id": "logging.organizations.logs.list"
- }
- }
- }
- }
- },
- "entries": {
- "methods": {
- "write": {
- "flatPath": "v2/entries:write",
- "id": "logging.entries.write",
- "path": "v2/entries:write",
- "request": {
- "$ref": "WriteLogEntriesRequest"
- },
- "description": "Log entry resourcesWrites log entries to Stackdriver Logging. This API method is the only way to send log entries to Stackdriver Logging. This method is used, directly or indirectly, by the Stackdriver Logging agent (fluentd) and all logging libraries configured to use Stackdriver Logging.",
- "response": {
- "$ref": "WriteLogEntriesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.write"
- ],
- "parameters": {}
- },
- "list": {
- "id": "logging.entries.list",
- "path": "v2/entries:list",
- "description": "Lists log entries. Use this method to retrieve log entries from Stackdriver Logging. For ways to export log entries, see Exporting Logs.",
- "request": {
- "$ref": "ListLogEntriesRequest"
- },
- "response": {
- "$ref": "ListLogEntriesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2/entries:list"
- }
- }
- },
- "projects": {
- "resources": {
- "sinks": {
- "methods": {
- "create": {
- "request": {
- "$ref": "LogSink"
- },
- "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.",
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "LogSink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
- "type": "string",
- "required": true
- },
- "uniqueWriterIdentity": {
- "location": "query",
- "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
- "type": "boolean"
- }
- },
- "flatPath": "v2/projects/{projectsId}/sinks",
- "path": "v2/{+parent}/sinks",
- "id": "logging.projects.sinks.create"
- },
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "sinkName"
- ],
- "response": {
- "$ref": "LogSink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "updateMask": {
- "format": "google-fieldmask",
- "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.",
- "type": "string",
- "location": "query"
- },
- "uniqueWriterIdentity": {
- "location": "query",
- "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
- "type": "boolean"
- },
- "sinkName": {
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/sinks/[^/]+$",
- "location": "path",
- "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\"."
- }
- },
- "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
- "path": "v2/{+sinkName}",
- "id": "logging.projects.sinks.patch",
- "request": {
- "$ref": "LogSink"
- },
- "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field."
- },
- "get": {
- "description": "Gets a sink.",
- "httpMethod": "GET",
- "parameterOrder": [
- "sinkName"
- ],
- "response": {
- "$ref": "LogSink"
- },
- "parameters": {
- "sinkName": {
- "location": "path",
- "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/sinks/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
- "path": "v2/{+sinkName}",
- "id": "logging.projects.sinks.get"
- },
- "update": {
- "request": {
- "$ref": "LogSink"
- },
- "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
- "response": {
- "$ref": "LogSink"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "updateMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.",
- "type": "string"
- },
- "uniqueWriterIdentity": {
- "type": "boolean",
- "location": "query",
- "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false."
- },
- "sinkName": {
- "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/sinks/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
- "id": "logging.projects.sinks.update",
- "path": "v2/{+sinkName}"
- },
- "delete": {
- "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
- "id": "logging.projects.sinks.delete",
- "path": "v2/{+sinkName}",
- "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "sinkName": {
- "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/sinks/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ]
- },
- "list": {
- "description": "Lists sinks.",
- "response": {
- "$ref": "ListSinksResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "format": "int32",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available."
- },
- "parent": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2/projects/{projectsId}/sinks",
- "id": "logging.projects.sinks.list",
- "path": "v2/{+parent}/sinks"
- }
- }
- },
- "logs": {
- "methods": {
- "list": {
- "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
- "response": {
- "$ref": "ListLogsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "type": "integer"
- },
- "parent": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "type": "string",
- "required": true
- },
- "pageToken": {
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2/projects/{projectsId}/logs",
- "id": "logging.projects.logs.list",
- "path": "v2/{+parent}/logs"
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "logName"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "logName": {
- "location": "path",
- "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/logs/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/projects/{projectsId}/logs/{logsId}",
- "id": "logging.projects.logs.delete",
- "path": "v2/{+logName}",
- "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted."
- }
- }
- },
- "exclusions": {
- "methods": {
- "create": {
- "response": {
- "$ref": "LogExclusion"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "location": "path",
- "description": "Required. The parent resource in which to create the exclusion:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/projects/{projectsId}/exclusions",
- "id": "logging.projects.exclusions.create",
- "path": "v2/{+parent}/exclusions",
- "description": "Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.",
- "request": {
- "$ref": "LogExclusion"
- }
- },
- "delete": {
- "id": "logging.projects.exclusions.delete",
- "path": "v2/{+name}",
- "description": "Deletes an exclusion.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/exclusions/[^/]+$",
- "location": "path",
- "description": "Required. The resource name of an existing exclusion to delete:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\"."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/projects/{projectsId}/exclusions/{exclusionsId}"
- },
- "patch": {
- "description": "Changes one or more properties of an existing exclusion.",
- "request": {
- "$ref": "LogExclusion"
- },
- "httpMethod": "PATCH",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "LogExclusion"
- },
- "parameters": {
- "updateMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of \"filter,description\".",
- "type": "string"
- },
- "name": {
- "pattern": "^projects/[^/]+/exclusions/[^/]+$",
- "location": "path",
- "description": "Required. The resource name of the exclusion to update:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/projects/{projectsId}/exclusions/{exclusionsId}",
- "path": "v2/{+name}",
- "id": "logging.projects.exclusions.patch"
- },
- "get": {
- "description": "Gets the description of an exclusion.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "LogExclusion"
- },
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/exclusions/[^/]+$",
- "location": "path",
- "description": "Required. The resource name of an existing exclusion:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2/projects/{projectsId}/exclusions/{exclusionsId}",
- "path": "v2/{+name}",
- "id": "logging.projects.exclusions.get"
- },
- "list": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "parameters": {
- "parent": {
- "description": "Required. The parent resource whose exclusions are to be listed.\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "type": "integer"
- }
- },
- "flatPath": "v2/projects/{projectsId}/exclusions",
- "id": "logging.projects.exclusions.list",
- "path": "v2/{+parent}/exclusions",
- "description": "Lists all the exclusions in a parent resource.",
- "response": {
- "$ref": "ListExclusionsResponse"
- },
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ]
- }
- }
- },
- "metrics": {
- "methods": {
- "delete": {
- "description": "Deletes a logs-based metric.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "metricName"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.write"
- ],
- "parameters": {
- "metricName": {
- "description": "The resource name of the metric to delete:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/metrics/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2/projects/{projectsId}/metrics/{metricsId}",
- "id": "logging.projects.metrics.delete",
- "path": "v2/{+metricName}"
- },
- "get": {
- "path": "v2/{+metricName}",
- "id": "logging.projects.metrics.get",
- "description": "Gets a logs-based metric.",
- "httpMethod": "GET",
- "parameterOrder": [
- "metricName"
- ],
- "response": {
- "$ref": "LogMetric"
- },
- "parameters": {
- "metricName": {
- "pattern": "^projects/[^/]+/metrics/[^/]+$",
- "location": "path",
- "description": "The resource name of the desired metric:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2/projects/{projectsId}/metrics/{metricsId}"
- },
- "list": {
- "response": {
- "$ref": "ListLogMetricsResponse"
- },
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "parameters": {
- "parent": {
- "description": "Required. The name of the project containing the metrics:\n\"projects/[PROJECT_ID]\"\n",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "format": "int32",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "type": "integer",
- "location": "query"
- }
- },
- "flatPath": "v2/projects/{projectsId}/metrics",
- "id": "logging.projects.metrics.list",
- "path": "v2/{+parent}/metrics",
- "description": "Lists logs-based metrics."
- },
- "update": {
- "request": {
- "$ref": "LogMetric"
- },
- "description": "Creates or updates a logs-based metric.",
- "response": {
- "$ref": "LogMetric"
- },
- "parameterOrder": [
- "metricName"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.write"
- ],
- "parameters": {
- "metricName": {
- "location": "path",
- "description": "The resource name of the metric to update:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\nThe updated metric must be provided in the request and it's name field must be the same as [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a new metric is created.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/metrics/[^/]+$"
- }
- },
- "flatPath": "v2/projects/{projectsId}/metrics/{metricsId}",
- "id": "logging.projects.metrics.update",
- "path": "v2/{+metricName}"
- },
- "create": {
- "response": {
- "$ref": "LogMetric"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "description": "The resource name of the project in which to create the metric:\n\"projects/[PROJECT_ID]\"\nThe new metric must be provided in the request.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.write"
- ],
- "flatPath": "v2/projects/{projectsId}/metrics",
- "id": "logging.projects.metrics.create",
- "path": "v2/{+parent}/metrics",
- "description": "Creates a logs-based metric.",
- "request": {
- "$ref": "LogMetric"
- }
- }
- }
- }
- }
- },
- "billingAccounts": {
- "resources": {
- "sinks": {
- "methods": {
- "delete": {
- "path": "v2/{+sinkName}",
- "id": "logging.billingAccounts.sinks.delete",
- "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "sinkName": {
- "type": "string",
- "required": true,
- "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$",
- "location": "path",
- "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\"."
- }
- },
- "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}"
- },
- "list": {
- "description": "Lists sinks.",
- "response": {
- "$ref": "ListSinksResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "parameters": {
- "parent": {
- "location": "path",
- "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "type": "string",
- "required": true,
- "pattern": "^billingAccounts/[^/]+$"
- },
- "pageToken": {
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "format": "int32",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "type": "integer",
- "location": "query"
- }
- },
- "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks",
- "id": "logging.billingAccounts.sinks.list",
- "path": "v2/{+parent}/sinks"
- },
- "create": {
- "path": "v2/{+parent}/sinks",
- "id": "logging.billingAccounts.sinks.create",
- "request": {
- "$ref": "LogSink"
- },
- "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.",
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "LogSink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "parent": {
- "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
- "type": "string",
- "required": true,
- "pattern": "^billingAccounts/[^/]+$",
- "location": "path"
- },
- "uniqueWriterIdentity": {
- "location": "query",
- "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
- "type": "boolean"
- }
- },
- "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks"
- },
- "get": {
- "description": "Gets a sink.",
- "httpMethod": "GET",
- "parameterOrder": [
- "sinkName"
- ],
- "response": {
- "$ref": "LogSink"
- },
- "parameters": {
- "sinkName": {
- "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "type": "string",
- "required": true,
- "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}",
- "path": "v2/{+sinkName}",
- "id": "logging.billingAccounts.sinks.get"
- },
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "sinkName"
- ],
- "response": {
- "$ref": "LogSink"
- },
- "parameters": {
- "updateMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.",
- "type": "string"
- },
- "uniqueWriterIdentity": {
- "location": "query",
- "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
- "type": "boolean"
- },
- "sinkName": {
- "type": "string",
- "required": true,
- "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$",
- "location": "path",
- "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\"."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}",
- "path": "v2/{+sinkName}",
- "id": "logging.billingAccounts.sinks.patch",
- "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
- "request": {
- "$ref": "LogSink"
- }
- },
- "update": {
- "id": "logging.billingAccounts.sinks.update",
- "path": "v2/{+sinkName}",
- "request": {
- "$ref": "LogSink"
- },
- "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
- "response": {
- "$ref": "LogSink"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "updateMask": {
- "type": "string",
- "location": "query",
- "format": "google-fieldmask",
- "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter."
- },
- "uniqueWriterIdentity": {
- "location": "query",
- "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
- "type": "boolean"
- },
- "sinkName": {
- "type": "string",
- "required": true,
- "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$",
- "location": "path",
- "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\"."
- }
- },
- "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}"
- }
- }
- },
- "logs": {
- "methods": {
- "list": {
- "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
- "response": {
- "$ref": "ListLogsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "parameters": {
- "pageSize": {
- "type": "integer",
- "location": "query",
- "format": "int32",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available."
- },
- "parent": {
- "type": "string",
- "required": true,
- "pattern": "^billingAccounts/[^/]+$",
- "location": "path",
- "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n"
- },
- "pageToken": {
- "location": "query",
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string"
- }
- },
- "flatPath": "v2/billingAccounts/{billingAccountsId}/logs",
- "id": "logging.billingAccounts.logs.list",
- "path": "v2/{+parent}/logs"
- },
- "delete": {
- "id": "logging.billingAccounts.logs.delete",
- "path": "v2/{+logName}",
- "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "logName"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "logName": {
- "location": "path",
- "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
- "type": "string",
- "required": true,
- "pattern": "^billingAccounts/[^/]+/logs/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/billingAccounts/{billingAccountsId}/logs/{logsId}"
- }
- }
- },
- "exclusions": {
- "methods": {
- "patch": {
- "id": "logging.billingAccounts.exclusions.patch",
- "path": "v2/{+name}",
- "request": {
- "$ref": "LogExclusion"
- },
- "description": "Changes one or more properties of an existing exclusion.",
- "response": {
- "$ref": "LogExclusion"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "Required. The resource name of the exclusion to update:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
- "type": "string",
- "required": true,
- "pattern": "^billingAccounts/[^/]+/exclusions/[^/]+$"
- },
- "updateMask": {
- "type": "string",
- "location": "query",
- "format": "google-fieldmask",
- "description": "Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of \"filter,description\"."
- }
- },
- "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions/{exclusionsId}"
- },
- "get": {
- "response": {
- "$ref": "LogExclusion"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "parameters": {
- "name": {
- "type": "string",
- "required": true,
- "pattern": "^billingAccounts/[^/]+/exclusions/[^/]+$",
- "location": "path",
- "description": "Required. The resource name of an existing exclusion:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\"."
- }
- },
- "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions/{exclusionsId}",
- "id": "logging.billingAccounts.exclusions.get",
- "path": "v2/{+name}",
- "description": "Gets the description of an exclusion."
- },
- "list": {
- "response": {
- "$ref": "ListExclusionsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string"
- },
- "pageSize": {
- "format": "int32",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "pattern": "^billingAccounts/[^/]+$",
- "location": "path",
- "description": "Required. The parent resource whose exclusions are to be listed.\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions",
- "id": "logging.billingAccounts.exclusions.list",
- "path": "v2/{+parent}/exclusions",
- "description": "Lists all the exclusions in a parent resource."
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "LogExclusion"
- },
- "parameters": {
- "parent": {
- "location": "path",
- "description": "Required. The parent resource in which to create the exclusion:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
- "type": "string",
- "required": true,
- "pattern": "^billingAccounts/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions",
- "path": "v2/{+parent}/exclusions",
- "id": "logging.billingAccounts.exclusions.create",
- "description": "Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.",
- "request": {
- "$ref": "LogExclusion"
- }
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "name": {
- "description": "Required. The resource name of an existing exclusion to delete:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
- "type": "string",
- "required": true,
- "pattern": "^billingAccounts/[^/]+/exclusions/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions/{exclusionsId}",
- "id": "logging.billingAccounts.exclusions.delete",
- "path": "v2/{+name}",
- "description": "Deletes an exclusion."
- }
- }
- }
- }
- }
- },
- "parameters": {
- "quotaUser": {
- "type": "string",
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
- },
- "pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "default": "true",
- "type": "boolean",
- "location": "query",
- "description": "Returns response with indentations and line breaks."
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "alt": {
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- }
- },
- "version": "v2",
- "baseUrl": "https://logging.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Writes log entries and manages your Stackdriver Logging configuration.",
- "servicePath": "",
"basePath": "",
+ "revision": "20171002",
"documentationLink": "https://cloud.google.com/logging/docs/",
"id": "logging:v2",
- "revision": "20171009",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "MonitoredResourceDescriptor": {
- "properties": {
- "labels": {
- "description": "Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels \"database_id\" and \"zone\".",
- "items": {
- "$ref": "LabelDescriptor"
- },
- "type": "array"
- },
- "name": {
- "description": "Optional. The resource name of the monitored resource descriptor: \"projects/{project_id}/monitoredResourceDescriptors/{type}\" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format \"monitoredResourceDescriptors/{type}\".",
- "type": "string"
- },
- "description": {
- "type": "string",
- "description": "Optional. A detailed description of the monitored resource type that might be used in documentation."
- },
- "displayName": {
- "description": "Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, \"Google Cloud SQL Database\".",
- "type": "string"
- },
- "type": {
- "description": "Required. The monitored resource type. For example, the type \"cloudsql_database\" represents databases in Google Cloud SQL. The maximum length of this value is 256 characters.",
- "type": "string"
- }
- },
- "id": "MonitoredResourceDescriptor",
- "description": "An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of \"gce_instance\" and specifies the use of the labels \"instance_id\" and \"zone\" to identify particular VM instances.Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API.",
- "type": "object"
- },
- "LogEntrySourceLocation": {
- "type": "object",
- "properties": {
- "file": {
- "description": "Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.",
- "type": "string"
- },
- "function": {
- "description": "Optional. Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information may be used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: qual.if.ied.Class.method (Java), dir/package.func (Go), function (Python).",
- "type": "string"
- },
- "line": {
- "format": "int64",
- "description": "Optional. Line within the source file. 1-based; 0 indicates no line number available.",
- "type": "string"
- }
- },
- "id": "LogEntrySourceLocation",
- "description": "Additional information about the source code location that produced the log entry."
- },
- "ListLogEntriesResponse": {
- "description": "Result returned from ListLogEntries.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.If a value for next_page_token appears and the entries field is empty, it means that the search found no log entries so far but it did not have time to search all the possible log entries. Retry the method with this value for page_token to continue the search. Alternatively, consider speeding up the search by changing your filter to specify a single log name or resource type, or to narrow the time range of the search.",
- "type": "string"
- },
- "entries": {
- "description": "A list of log entries. If entries is empty, nextPageToken may still be returned, indicating that more entries may exist. See nextPageToken for more information.",
- "items": {
- "$ref": "LogEntry"
- },
- "type": "array"
- }
- },
- "id": "ListLogEntriesResponse"
- },
- "LogLine": {
- "description": "Application log line emitted while processing a request.",
- "type": "object",
- "properties": {
- "logMessage": {
- "description": "App-provided log message.",
- "type": "string"
- },
- "severity": {
- "enumDescriptions": [
- "(0) The log entry has no assigned severity level.",
- "(100) Debug or trace information.",
- "(200) Routine information, such as ongoing status or performance.",
- "(300) Normal but significant events, such as start up, shut down, or a configuration change.",
- "(400) Warning events might cause problems.",
- "(500) Error events are likely to cause problems.",
- "(600) Critical events cause more severe problems or outages.",
- "(700) A person must take an action immediately.",
- "(800) One or more systems are unusable."
- ],
- "enum": [
- "DEFAULT",
- "DEBUG",
- "INFO",
- "NOTICE",
- "WARNING",
- "ERROR",
- "CRITICAL",
- "ALERT",
- "EMERGENCY"
- ],
- "description": "Severity of this log entry.",
- "type": "string"
- },
- "sourceLocation": {
- "$ref": "SourceLocation",
- "description": "Where in the source code this log message was written."
- },
- "time": {
- "format": "google-datetime",
- "description": "Approximate time when this log entry was made.",
- "type": "string"
- }
- },
- "id": "LogLine"
- },
"Linear": {
+ "description": "Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): offset + (width * i). Lower bound (1 \u003c= i \u003c N): offset + (width * (i - 1)).",
"type": "object",
"properties": {
- "numFiniteBuckets": {
- "format": "int32",
- "description": "Must be greater than 0.",
- "type": "integer"
- },
"width": {
"format": "double",
"description": "Must be greater than 0.",
@@ -2255,10 +19,14 @@
"format": "double",
"description": "Lower bound of the first bucket.",
"type": "number"
+ },
+ "numFiniteBuckets": {
+ "format": "int32",
+ "description": "Must be greater than 0.",
+ "type": "integer"
}
},
- "id": "Linear",
- "description": "Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): offset + (width * i). Lower bound (1 \u003c= i \u003c N): offset + (width * (i - 1))."
+ "id": "Linear"
},
"Empty": {
"properties": {},
@@ -2268,10 +36,6 @@
},
"SourceLocation": {
"properties": {
- "file": {
- "description": "Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.",
- "type": "string"
- },
"functionName": {
"description": "Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information is used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: qual.if.ied.Class.method (Java), dir/package.func (Go), function (Python).",
"type": "string"
@@ -2280,6 +44,10 @@
"format": "int64",
"description": "Line within the source file.",
"type": "string"
+ },
+ "file": {
+ "description": "Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.",
+ "type": "string"
}
},
"id": "SourceLocation",
@@ -2287,9 +55,16 @@
"type": "object"
},
"ListLogEntriesRequest": {
- "description": "The parameters to ListLogEntries.",
- "type": "object",
"properties": {
+ "pageToken": {
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of next_page_token in the response indicates that more results might be available.",
+ "type": "integer"
+ },
"orderBy": {
"description": "Optional. How the results should be sorted. Presently, the only permitted values are \"timestamp asc\" (default) and \"timestamp desc\". The first option returns entries in order of increasing values of LogEntry.timestamp (oldest first), and the second option returns entries in order of decreasing timestamps (newest first). Entries with equal timestamps are returned in order of their insert_id values.",
"type": "string"
@@ -2301,10 +76,6 @@
},
"type": "array"
},
- "filter": {
- "description": "Optional. A filter that chooses which log entries to return. See Advanced Logs Filters. Only log entries that match the filter are returned. An empty filter matches all log entries in the resources listed in resource_names. Referencing a parent resource that is not listed in resource_names will cause the filter to return no results. The maximum length of the filter is 20000 characters.",
- "type": "string"
- },
"projectIds": {
"description": "Deprecated. Use resource_names instead. One or more project identifiers or project numbers from which to retrieve log entries. Example: \"my-project-1A\". If present, these project identifiers are converted to resource name format and added to the list of resources in resource_names.",
"items": {
@@ -2312,17 +83,14 @@
},
"type": "array"
},
- "pageToken": {
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "filter": {
+ "description": "Optional. A filter that chooses which log entries to return. See Advanced Logs Filters. Only log entries that match the filter are returned. An empty filter matches all log entries in the resources listed in resource_names. Referencing a parent resource that is not listed in resource_names will cause the filter to return no results. The maximum length of the filter is 20000 characters.",
"type": "string"
- },
- "pageSize": {
- "type": "integer",
- "format": "int32",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of next_page_token in the response indicates that more results might be available."
}
},
- "id": "ListLogEntriesRequest"
+ "id": "ListLogEntriesRequest",
+ "description": "The parameters to ListLogEntries.",
+ "type": "object"
},
"Explicit": {
"description": "Specifies a set of buckets with arbitrary widths.There are size(bounds) + 1 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): boundsi Lower bound (1 \u003c= i \u003c N); boundsi - 1The bounds field must contain at least one element. If bounds has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.",
@@ -2340,8 +108,6 @@
"id": "Explicit"
},
"SourceReference": {
- "description": "A reference to a particular snapshot of the source tree used to build and deploy an application.",
- "type": "object",
"properties": {
"revisionId": {
"description": "The canonical and persistent identifier of the deployed revision. Example (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b\"",
@@ -2352,19 +118,25 @@
"type": "string"
}
},
- "id": "SourceReference"
+ "id": "SourceReference",
+ "description": "A reference to a particular snapshot of the source tree used to build and deploy an application.",
+ "type": "object"
},
"WriteLogEntriesResponse": {
+ "description": "Result returned from WriteLogEntries. empty",
"type": "object",
"properties": {},
- "id": "WriteLogEntriesResponse",
- "description": "Result returned from WriteLogEntries. empty"
+ "id": "WriteLogEntriesResponse"
},
"Exponential": {
- "id": "Exponential",
"description": "Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): scale * (growth_factor ^ i). Lower bound (1 \u003c= i \u003c N): scale * (growth_factor ^ (i - 1)).",
"type": "object",
"properties": {
+ "scale": {
+ "format": "double",
+ "description": "Must be greater than 0.",
+ "type": "number"
+ },
"numFiniteBuckets": {
"format": "int32",
"description": "Must be greater than 0.",
@@ -2374,28 +146,14 @@
"format": "double",
"description": "Must be greater than 1.",
"type": "number"
- },
- "scale": {
- "format": "double",
- "description": "Must be greater than 0.",
- "type": "number"
}
- }
+ },
+ "id": "Exponential"
},
"WriteLogEntriesRequest": {
+ "description": "The parameters to WriteLogEntries.",
"type": "object",
"properties": {
- "labels": {
- "description": "Optional. Default labels that are added to the labels field of all log entries in entries. If a log entry already has a label with the same key as a label in this parameter, then the log entry's label is not changed. See LogEntry.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "resource": {
- "$ref": "MonitoredResource",
- "description": "Optional. A default monitored resource object that is assigned to all log entries in entries that do not specify a value for resource. Example:\n{ \"type\": \"gce_instance\",\n \"labels\": {\n \"zone\": \"us-central1-a\", \"instance_id\": \"00000000000000000000\" }}\nSee LogEntry."
- },
"entries": {
"description": "Required. The log entries to send to Stackdriver Logging. The order of log entries in this list does not matter. Values supplied in this method's log_name, resource, and labels fields are copied into those log entries in this list that do not include values for their corresponding fields. For more information, see the LogEntry type.If the timestamp or insert_id fields are missing in log entries, then this method supplies the current time or a unique identifier, respectively. The supplied values are chosen so that, among the log entries that did not supply their own values, the entries earlier in the list will sort before the entries later in the list. See the entries.list method.Log entries with timestamps that are more than the logs retention period in the past or more than 24 hours in the future might be discarded. Discarding does not return an error.To improve throughput and to avoid exceeding the quota limit for calls to entries.write, you should try to include several log entries in this list, rather than calling this method for each individual log entry.",
"items": {
@@ -2404,21 +162,45 @@
"type": "array"
},
"logName": {
- "type": "string",
- "description": "Optional. A default log resource name that is assigned to all log entries in entries that do not specify a value for log_name:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\" or \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry."
+ "description": "Optional. A default log resource name that is assigned to all log entries in entries that do not specify a value for log_name:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\" or \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
+ "type": "string"
},
"partialSuccess": {
"description": "Optional. Whether valid entries should be written even if some other entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any entry is not written, then the response status is the error associated with one of the failed entries and the response includes error details keyed by the entries' zero-based index in the entries.write method.",
"type": "boolean"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional. Default labels that are added to the labels field of all log entries in entries. If a log entry already has a label with the same key as a label in this parameter, then the log entry's label is not changed. See LogEntry.",
+ "type": "object"
+ },
+ "resource": {
+ "description": "Optional. A default monitored resource object that is assigned to all log entries in entries that do not specify a value for resource. Example:\n{ \"type\": \"gce_instance\",\n \"labels\": {\n \"zone\": \"us-central1-a\", \"instance_id\": \"00000000000000000000\" }}\nSee LogEntry.",
+ "$ref": "MonitoredResource"
}
},
- "id": "WriteLogEntriesRequest",
- "description": "The parameters to WriteLogEntries."
+ "id": "WriteLogEntriesRequest"
},
"LabelDescriptor": {
"description": "A description of a label.",
"type": "object",
"properties": {
+ "valueType": {
+ "enum": [
+ "STRING",
+ "BOOL",
+ "INT64"
+ ],
+ "description": "The type of data that can be assigned to the label.",
+ "type": "string",
+ "enumDescriptions": [
+ "A variable-length string. This is the default.",
+ "Boolean; true or false.",
+ "A 64-bit signed integer."
+ ]
+ },
"key": {
"description": "The label key.",
"type": "string"
@@ -2426,65 +208,73 @@
"description": {
"description": "A human-readable description for the label.",
"type": "string"
- },
- "valueType": {
- "enumDescriptions": [
- "A variable-length string. This is the default.",
- "Boolean; true or false.",
- "A 64-bit signed integer."
- ],
- "enum": [
- "STRING",
- "BOOL",
- "INT64"
- ],
- "description": "The type of data that can be assigned to the label.",
- "type": "string"
}
},
"id": "LabelDescriptor"
},
"BucketOptions": {
- "description": "BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i \u003e 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.",
- "type": "object",
"properties": {
"exponentialBuckets": {
- "description": "The exponential buckets.",
- "$ref": "Exponential"
+ "$ref": "Exponential",
+ "description": "The exponential buckets."
},
"explicitBuckets": {
- "$ref": "Explicit",
- "description": "The explicit buckets."
+ "description": "The explicit buckets.",
+ "$ref": "Explicit"
},
"linearBuckets": {
- "$ref": "Linear",
- "description": "The linear bucket."
+ "description": "The linear bucket.",
+ "$ref": "Linear"
}
},
- "id": "BucketOptions"
+ "id": "BucketOptions",
+ "description": "BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i \u003e 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.",
+ "type": "object"
},
"ListLogMetricsResponse": {
"description": "Result returned from ListLogMetrics.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.",
+ "type": "string"
+ },
"metrics": {
"description": "A list of logs-based metrics.",
"items": {
"$ref": "LogMetric"
},
"type": "array"
- },
- "nextPageToken": {
- "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.",
- "type": "string"
}
},
"id": "ListLogMetricsResponse"
},
"MetricDescriptor": {
- "description": "Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.",
- "type": "object",
"properties": {
+ "metricKind": {
+ "enum": [
+ "METRIC_KIND_UNSPECIFIED",
+ "GAUGE",
+ "DELTA",
+ "CUMULATIVE"
+ ],
+ "description": "Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.",
+ "type": "string",
+ "enumDescriptions": [
+ "Do not use this default value.",
+ "An instantaneous measurement of a value.",
+ "The change in a value during a time interval.",
+ "A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points."
+ ]
+ },
+ "description": {
+ "description": "A detailed description of the metric, which can be used in documentation.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example \"Request count\". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.",
+ "type": "string"
+ },
"unit": {
"description": "The unit in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are a subset of The Unified Code for Units of Measure (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT)\nbit bit\nBy byte\ns second\nmin minute\nh hour\nd dayPrefixes (PREFIX)\nk kilo (10**3)\nM mega (10**6)\nG giga (10**9)\nT tera (10**12)\nP peta (10**15)\nE exa (10**18)\nZ zetta (10**21)\nY yotta (10**24)\nm milli (10**-3)\nu micro (10**-6)\nn nano (10**-9)\np pico (10**-12)\nf femto (10**-15)\na atto (10**-18)\nz zepto (10**-21)\ny yocto (10**-24)\nKi kibi (2**10)\nMi mebi (2**20)\nGi gibi (2**30)\nTi tebi (2**40)GrammarThe grammar includes the dimensionless unit 1, such as 1/s.The grammar also includes these connectors:\n/ division (as an infix operator, e.g. 1/s).\n. multiplication (as an infix operator, e.g. GBy.d)The grammar for a unit is as follows:\nExpression = Component { \".\" Component } { \"/\" Component } ;\n\nComponent = [ PREFIX ] UNIT [ Annotation ]\n | Annotation\n | \"1\"\n ;\n\nAnnotation = \"{\" NAME \"}\" ;\nNotes:\nAnnotation is just a comment if it follows a UNIT and is equivalent to 1 if it is used alone. For examples, {requests}/s == 1/s, By{transmitted}/s == By/s.\nNAME is a sequence of non-blank printable ASCII characters not containing '{' or '}'.",
"type": "string"
@@ -2525,49 +315,33 @@
"The value is a Distribution.",
"The value is money."
]
- },
- "metricKind": {
- "enum": [
- "METRIC_KIND_UNSPECIFIED",
- "GAUGE",
- "DELTA",
- "CUMULATIVE"
- ],
- "description": "Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.",
- "type": "string",
- "enumDescriptions": [
- "Do not use this default value.",
- "An instantaneous measurement of a value.",
- "The change in a value during a time interval.",
- "A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points."
- ]
- },
- "displayName": {
- "description": "A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example \"Request count\". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.",
- "type": "string"
- },
- "description": {
- "description": "A detailed description of the metric, which can be used in documentation.",
- "type": "string"
}
},
- "id": "MetricDescriptor"
+ "id": "MetricDescriptor",
+ "description": "Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.",
+ "type": "object"
},
"LogEntry": {
- "description": "An individual entry in a log.",
- "type": "object",
"properties": {
- "labels": {
- "description": "Optional. A set of user-defined (key, value) data that provides additional information about the log entry.",
- "type": "object",
+ "protoPayload": {
"additionalProperties": {
- "type": "string"
- }
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The log entry payload, represented as a protocol buffer. Some Google Cloud Platform services use this field for their log entry payloads.",
+ "type": "object"
},
"trace": {
"description": "Optional. Resource name of the trace associated with the log entry, if any. If it contains a relative resource name, the name is assumed to be relative to //tracing.googleapis.com. Example: projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824",
"type": "string"
},
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional. A set of user-defined (key, value) data that provides additional information about the log entry.",
+ "type": "object"
+ },
"severity": {
"enum": [
"DEFAULT",
@@ -2595,30 +369,30 @@
]
},
"sourceLocation": {
- "description": "Optional. Source code location information associated with the log entry, if any.",
- "$ref": "LogEntrySourceLocation"
- },
- "timestamp": {
- "format": "google-datetime",
- "description": "Optional. The time the event described by the log entry occurred. This time is used to compute the log entry's age and to enforce the logs retention period. If this field is omitted in a new log entry, then Stackdriver Logging assigns it the current time.Incoming log entries should have timestamps that are no more than the logs retention period in the past, and no more than 24 hours in the future. See the entries.write API method for more information.",
- "type": "string"
+ "$ref": "LogEntrySourceLocation",
+ "description": "Optional. Source code location information associated with the log entry, if any."
},
"receiveTimestamp": {
"format": "google-datetime",
"description": "Output only. The time the log entry was received by Stackdriver Logging.",
"type": "string"
},
+ "timestamp": {
+ "format": "google-datetime",
+ "description": "Optional. The time the event described by the log entry occurred. This time is used to compute the log entry's age and to enforce the logs retention period. If this field is omitted in a new log entry, then Stackdriver Logging assigns it the current time.Incoming log entries should have timestamps that are no more than the logs retention period in the past, and no more than 24 hours in the future. See the entries.write API method for more information.",
+ "type": "string"
+ },
"logName": {
"description": "Required. The resource name of the log to which this log entry belongs:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\nA project number may optionally be used in place of PROJECT_ID. The project number is translated to its corresponding PROJECT_ID internally and the log_name field will contain PROJECT_ID in queries and exports.[LOG_ID] must be URL-encoded within log_name. Example: \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". [LOG_ID] must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters, forward-slash, underscore, hyphen, and period.For backward compatibility, if log_name begins with a forward-slash, such as /projects/..., then the log entry is ingested as usual but the forward-slash is removed. Listing the log entry will not show the leading slash and filtering for a log name with a leading slash will never return any results.",
"type": "string"
},
- "resource": {
- "$ref": "MonitoredResource",
- "description": "Required. The monitored resource associated with this log entry. Example: a log entry that reports a database error would be associated with the monitored resource designating the particular database that reported the error."
- },
"httpRequest": {
- "description": "Optional. Information about the HTTP request associated with this log entry, if applicable.",
- "$ref": "HttpRequest"
+ "$ref": "HttpRequest",
+ "description": "Optional. Information about the HTTP request associated with this log entry, if applicable."
+ },
+ "resource": {
+ "description": "Required. The monitored resource associated with this log entry. Example: a log entry that reports a database error would be associated with the monitored resource designating the particular database that reported the error.",
+ "$ref": "MonitoredResource"
},
"jsonPayload": {
"additionalProperties": {
@@ -2628,33 +402,29 @@
"description": "The log entry payload, represented as a structure that is expressed as a JSON object.",
"type": "object"
},
- "operation": {
- "$ref": "LogEntryOperation",
- "description": "Optional. Information about an operation associated with the log entry, if applicable."
- },
"insertId": {
"description": "Optional. A unique identifier for the log entry. If you provide a value, then Stackdriver Logging considers other log entries in the same project, with the same timestamp, and with the same insert_id to be duplicates which can be removed. If omitted in new log entries, then Stackdriver Logging assigns its own unique identifier. The insert_id is also used to order log entries that have the same timestamp value.",
"type": "string"
},
+ "operation": {
+ "$ref": "LogEntryOperation",
+ "description": "Optional. Information about an operation associated with the log entry, if applicable."
+ },
"textPayload": {
"description": "The log entry payload, represented as a Unicode string (UTF-8).",
"type": "string"
- },
- "protoPayload": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "The log entry payload, represented as a protocol buffer. Some Google Cloud Platform services use this field for their log entry payloads.",
- "type": "object"
}
},
- "id": "LogEntry"
+ "id": "LogEntry",
+ "description": "An individual entry in a log.",
+ "type": "object"
},
"RequestLog": {
- "description": "Complete log information about a single HTTP request to an App Engine application.",
- "type": "object",
"properties": {
+ "traceId": {
+ "description": "Stackdriver Trace identifier for this request.",
+ "type": "string"
+ },
"line": {
"description": "A list of log lines emitted by the application while serving this request.",
"items": {
@@ -2732,8 +502,8 @@
"type": "string"
},
"appId": {
- "type": "string",
- "description": "Application that handled this request."
+ "description": "Application that handled this request.",
+ "type": "string"
},
"appEngineRelease": {
"description": "App Engine release version.",
@@ -2744,18 +514,18 @@
"type": "string"
},
"cost": {
- "type": "number",
"format": "double",
- "description": "An indication of the relative cost of serving this request."
+ "description": "An indication of the relative cost of serving this request.",
+ "type": "number"
},
"instanceId": {
"description": "An identifier for the instance that handled the request.",
"type": "string"
},
"megaCycles": {
- "type": "string",
"format": "int64",
- "description": "Number of CPU megacycles used to process request."
+ "description": "Number of CPU megacycles used to process request.",
+ "type": "string"
},
"first": {
"description": "Whether this is the first RequestLog entry for this request. If an active request has several RequestLog entries written to Stackdriver Logging, then this field will be set for one of them.",
@@ -2779,8 +549,8 @@
"type": "string"
},
"wasLoadingRequest": {
- "type": "boolean",
- "description": "Whether this was a loading request for the instance."
+ "description": "Whether this was a loading request for the instance.",
+ "type": "boolean"
},
"sourceReference": {
"description": "Source code for the application that handled this request. There can be more than one source reference per deployed application if source code is distributed among multiple repositories.",
@@ -2793,15 +563,15 @@
"format": "int64",
"description": "Size in bytes sent back to client by request.",
"type": "string"
- },
- "traceId": {
- "type": "string",
- "description": "Stackdriver Trace identifier for this request."
}
},
- "id": "RequestLog"
+ "id": "RequestLog",
+ "description": "Complete log information about a single HTTP request to an App Engine application.",
+ "type": "object"
},
"LogExclusion": {
+ "description": "Specifies a set of log entries that are not to be stored in Stackdriver Logging. If your project receives a large volume of logs, you might be able to use exclusions to reduce your chargeable logs. Exclusions are processed after log sinks, so you can export log entries before they are excluded. Audit log entries and log entries from Amazon Web Services are never excluded.",
+ "type": "object",
"properties": {
"name": {
"description": "Required. A client-assigned identifier, such as \"load-balancer-exclusion\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods.",
@@ -2820,9 +590,7 @@
"type": "string"
}
},
- "id": "LogExclusion",
- "description": "Specifies a set of log entries that are not to be stored in Stackdriver Logging. If your project receives a large volume of logs, you might be able to use exclusions to reduce your chargeable logs. Exclusions are processed after log sinks, so you can export log entries before they are excluded. Audit log entries and log entries from Amazon Web Services are never excluded.",
- "type": "object"
+ "id": "LogExclusion"
},
"ListMonitoredResourceDescriptorsResponse": {
"description": "Result returned from ListMonitoredResourceDescriptors.",
@@ -2865,16 +633,16 @@
"type": "object",
"properties": {
"version": {
- "enumDescriptions": [
- "Stackdriver Logging API v2.",
- "Stackdriver Logging API v1."
- ],
"enum": [
"V2",
"V1"
],
"description": "Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Stackdriver Logging API v2.",
+ "Stackdriver Logging API v1."
+ ]
},
"metricDescriptor": {
"description": "Optional. The metric descriptor associated with the logs-based metric. If unspecified, it uses a default metric descriptor with a DELTA metric kind, INT64 value type, with no labels and a unit of \"1\". Such a metric counts the number of log entries matching the filter expression.The name, type, and description fields in the metric_descriptor are output only, and is constructed using the name and description field in the LogMetric.To create a logs-based metric that records a distribution of log values, a DELTA metric kind with a DISTRIBUTION value type must be used along with a value_extractor expression in the LogMetric.Each label in the metric descriptor must have a matching label name as the key and an extractor expression as the value in the label_extractors map.The metric_kind and value_type fields in the metric_descriptor cannot be updated once initially configured. New labels can be added in the metric_descriptor, but existing labels cannot be modified except for their description.",
@@ -2885,8 +653,8 @@
"type": "string"
},
"description": {
- "type": "string",
- "description": "Optional. A description of this metric, which is used in documentation."
+ "description": "Optional. A description of this metric, which is used in documentation.",
+ "type": "string"
},
"bucketOptions": {
"$ref": "BucketOptions",
@@ -2897,15 +665,15 @@
"type": "string"
},
"name": {
- "type": "string",
- "description": "Required. The client-assigned metric identifier. Examples: \"error_count\", \"nginx/requests\".Metric identifiers are limited to 100 characters and can include only the following characters: A-Z, a-z, 0-9, and the special characters _-.,+!*',()%/. The forward-slash character (/) denotes a hierarchy of name pieces, and it cannot be the first character of the name.The metric identifier in this field must not be URL-encoded (https://en.wikipedia.org/wiki/Percent-encoding). However, when the metric identifier appears as the [METRIC_ID] part of a metric_name API parameter, then the metric identifier must be URL-encoded. Example: \"projects/my-project/metrics/nginx%2Frequests\"."
+ "description": "Required. The client-assigned metric identifier. Examples: \"error_count\", \"nginx/requests\".Metric identifiers are limited to 100 characters and can include only the following characters: A-Z, a-z, 0-9, and the special characters _-.,+!*',()%/. The forward-slash character (/) denotes a hierarchy of name pieces, and it cannot be the first character of the name.The metric identifier in this field must not be URL-encoded (https://en.wikipedia.org/wiki/Percent-encoding). However, when the metric identifier appears as the [METRIC_ID] part of a metric_name API parameter, then the metric identifier must be URL-encoded. Example: \"projects/my-project/metrics/nginx%2Frequests\".",
+ "type": "string"
},
"labelExtractors": {
- "type": "object",
"additionalProperties": {
"type": "string"
},
- "description": "Optional. A map from a label key string to an extractor expression which is used to extract data from a log entry field and assign as the label value. Each label key specified in the LabelDescriptor must have an associated extractor expression in this map. The syntax of the extractor expression is the same as for the value_extractor field.The extracted value is converted to the type defined in the label descriptor. If the either the extraction or the type conversion fails, the label will have a default value. The default value for a string label is an empty string, for an integer label its 0, and for a boolean label its false.Note that there are upper bounds on the maximum number of labels and the number of active time series that are allowed in a project."
+ "description": "Optional. A map from a label key string to an extractor expression which is used to extract data from a log entry field and assign as the label value. Each label key specified in the LabelDescriptor must have an associated extractor expression in this map. The syntax of the extractor expression is the same as for the value_extractor field.The extracted value is converted to the type defined in the label descriptor. If the either the extraction or the type conversion fails, the label will have a default value. The default value for a string label is an empty string, for an integer label its 0, and for a boolean label its false.Note that there are upper bounds on the maximum number of labels and the number of active time series that are allowed in a project.",
+ "type": "object"
}
},
"id": "LogMetric"
@@ -2914,6 +682,10 @@
"description": "Additional information about a potentially long-running operation with which a log entry is associated.",
"type": "object",
"properties": {
+ "last": {
+ "description": "Optional. Set this to True if this is the last log entry in the operation.",
+ "type": "boolean"
+ },
"id": {
"description": "Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.",
"type": "string"
@@ -2925,82 +697,78 @@
"producer": {
"description": "Optional. An arbitrary producer identifier. The combination of id and producer must be globally unique. Examples for producer: \"MyDivision.MyBigCompany.com\", \"github.com/MyProject/MyApplication\".",
"type": "string"
- },
- "last": {
- "description": "Optional. Set this to True if this is the last log entry in the operation.",
- "type": "boolean"
}
},
"id": "LogEntryOperation"
},
"MonitoredResource": {
+ "description": "An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for \"gce_instance\" has labels \"instance_id\" and \"zone\":\n{ \"type\": \"gce_instance\",\n \"labels\": { \"instance_id\": \"12345678901234\",\n \"zone\": \"us-central1-a\" }}\n",
+ "type": "object",
"properties": {
"type": {
"description": "Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance.",
"type": "string"
},
"labels": {
- "type": "object",
"additionalProperties": {
"type": "string"
},
- "description": "Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels \"project_id\", \"instance_id\", and \"zone\"."
+ "description": "Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels \"project_id\", \"instance_id\", and \"zone\".",
+ "type": "object"
}
},
- "id": "MonitoredResource",
- "description": "An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for \"gce_instance\" has labels \"instance_id\" and \"zone\":\n{ \"type\": \"gce_instance\",\n \"labels\": { \"instance_id\": \"12345678901234\",\n \"zone\": \"us-central1-a\" }}\n",
- "type": "object"
+ "id": "MonitoredResource"
},
"LogSink": {
- "id": "LogSink",
- "description": "Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.",
- "type": "object",
"properties": {
"includeChildren": {
"description": "Optional. This field applies only to sinks owned by organizations and folders. If the field is false, the default, only the logs owned by the sink's parent resource are available for export. If the field is true, then logs from all the projects, folders, and billing accounts contained in the sink's parent resource are also available for export. Whether a particular log entry from the children is exported depends on the sink's filter expression. For example, if this field is true, then the filter resource.type=gce_instance would export all Compute Engine VM instance log entries from all projects in the sink's parent. To only export entries from certain child projects, filter on the project part of the log name:\nlogName:(\"projects/test-project1/\" OR \"projects/test-project2/\") AND\nresource.type=gce_instance\n",
"type": "boolean"
},
- "destination": {
- "description": "Required. The export destination:\n\"storage.googleapis.com/[GCS_BUCKET]\"\n\"bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]\"\n\"pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]\"\nThe sink's writer_identity, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs With Sinks.",
- "type": "string"
- },
"filter": {
"description": "Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. For example:\nlogName=\"projects/[PROJECT_ID]/logs/[LOG_ID]\" AND severity\u003e=ERROR\n",
"type": "string"
},
- "endTime": {
- "type": "string",
- "format": "google-datetime",
- "description": "Deprecated. This field is ignored when creating or updating sinks."
+ "destination": {
+ "description": "Required. The export destination:\n\"storage.googleapis.com/[GCS_BUCKET]\"\n\"bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]\"\n\"pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]\"\nThe sink's writer_identity, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs With Sinks.",
+ "type": "string"
},
- "writerIdentity": {
- "type": "string",
- "description": "Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity."
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Deprecated. This field is ignored when creating or updating sinks.",
+ "type": "string"
},
"startTime": {
"format": "google-datetime",
"description": "Deprecated. This field is ignored when creating or updating sinks.",
"type": "string"
},
+ "writerIdentity": {
+ "description": "Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.",
+ "type": "string"
+ },
"outputVersionFormat": {
+ "enumDescriptions": [
+ "An unspecified format version that will default to V2.",
+ "LogEntry version 2 format.",
+ "LogEntry version 1 format."
+ ],
"enum": [
"VERSION_FORMAT_UNSPECIFIED",
"V2",
"V1"
],
"description": "Deprecated. The log entry format to use for this sink's exported log entries. The v2 format is used by default and cannot be changed.",
- "type": "string",
- "enumDescriptions": [
- "An unspecified format version that will default to V2.",
- "LogEntry version 2 format.",
- "LogEntry version 1 format."
- ]
+ "type": "string"
},
"name": {
"description": "Required. The client-assigned sink identifier, unique within the project. Example: \"my-syslog-errors-to-pubsub\". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.",
"type": "string"
}
- }
+ },
+ "id": "LogSink",
+ "description": "Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.",
+ "type": "object"
},
"ListLogsResponse": {
"description": "Result returned from ListLogs.",
@@ -3021,6 +789,7 @@
"id": "ListLogsResponse"
},
"ListSinksResponse": {
+ "description": "Result returned from ListSinks.",
"type": "object",
"properties": {
"sinks": {
@@ -3035,49 +804,12 @@
"type": "string"
}
},
- "id": "ListSinksResponse",
- "description": "Result returned from ListSinks."
+ "id": "ListSinksResponse"
},
"HttpRequest": {
"description": "A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message.",
"type": "object",
"properties": {
- "latency": {
- "format": "google-duration",
- "description": "The request processing latency on the server, from the time the request was received until the response was sent.",
- "type": "string"
- },
- "userAgent": {
- "description": "The user agent sent by the client. Example: \"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)\".",
- "type": "string"
- },
- "cacheFillBytes": {
- "type": "string",
- "format": "int64",
- "description": "The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted."
- },
- "requestMethod": {
- "description": "The request method. Examples: \"GET\", \"HEAD\", \"PUT\", \"POST\".",
- "type": "string"
- },
- "protocol": {
- "description": "Protocol used for the request. Examples: \"HTTP/1.1\", \"HTTP/2\", \"websocket\"",
- "type": "string"
- },
- "responseSize": {
- "format": "int64",
- "description": "The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.",
- "type": "string"
- },
- "requestSize": {
- "format": "int64",
- "description": "The size of the HTTP request message in bytes, including the request headers and the request body.",
- "type": "string"
- },
- "requestUrl": {
- "description": "The scheme (http, https), the host name, the path and the query portion of the URL that was requested. Example: \"http://example.com/some/info?color=red\".",
- "type": "string"
- },
"serverIp": {
"description": "The IP address (IPv4 or IPv6) of the origin server that the request was sent to.",
"type": "string"
@@ -3106,9 +838,159 @@
"referer": {
"description": "The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).",
"type": "string"
+ },
+ "userAgent": {
+ "description": "The user agent sent by the client. Example: \"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)\".",
+ "type": "string"
+ },
+ "latency": {
+ "format": "google-duration",
+ "description": "The request processing latency on the server, from the time the request was received until the response was sent.",
+ "type": "string"
+ },
+ "cacheFillBytes": {
+ "format": "int64",
+ "description": "The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.",
+ "type": "string"
+ },
+ "requestMethod": {
+ "description": "The request method. Examples: \"GET\", \"HEAD\", \"PUT\", \"POST\".",
+ "type": "string"
+ },
+ "protocol": {
+ "description": "Protocol used for the request. Examples: \"HTTP/1.1\", \"HTTP/2\", \"websocket\"",
+ "type": "string"
+ },
+ "responseSize": {
+ "format": "int64",
+ "description": "The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.",
+ "type": "string"
+ },
+ "requestSize": {
+ "format": "int64",
+ "description": "The size of the HTTP request message in bytes, including the request headers and the request body.",
+ "type": "string"
+ },
+ "requestUrl": {
+ "description": "The scheme (http, https), the host name, the path and the query portion of the URL that was requested. Example: \"http://example.com/some/info?color=red\".",
+ "type": "string"
}
},
"id": "HttpRequest"
+ },
+ "MonitoredResourceDescriptor": {
+ "description": "An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of \"gce_instance\" and specifies the use of the labels \"instance_id\" and \"zone\" to identify particular VM instances.Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Optional. The resource name of the monitored resource descriptor: \"projects/{project_id}/monitoredResourceDescriptors/{type}\" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format \"monitoredResourceDescriptors/{type}\".",
+ "type": "string"
+ },
+ "description": {
+ "description": "Optional. A detailed description of the monitored resource type that might be used in documentation.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, \"Google Cloud SQL Database\".",
+ "type": "string"
+ },
+ "type": {
+ "description": "Required. The monitored resource type. For example, the type \"cloudsql_database\" represents databases in Google Cloud SQL. The maximum length of this value is 256 characters.",
+ "type": "string"
+ },
+ "labels": {
+ "description": "Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels \"database_id\" and \"zone\".",
+ "items": {
+ "$ref": "LabelDescriptor"
+ },
+ "type": "array"
+ }
+ },
+ "id": "MonitoredResourceDescriptor"
+ },
+ "LogEntrySourceLocation": {
+ "description": "Additional information about the source code location that produced the log entry.",
+ "type": "object",
+ "properties": {
+ "function": {
+ "description": "Optional. Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information may be used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: qual.if.ied.Class.method (Java), dir/package.func (Go), function (Python).",
+ "type": "string"
+ },
+ "line": {
+ "format": "int64",
+ "description": "Optional. Line within the source file. 1-based; 0 indicates no line number available.",
+ "type": "string"
+ },
+ "file": {
+ "description": "Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.",
+ "type": "string"
+ }
+ },
+ "id": "LogEntrySourceLocation"
+ },
+ "ListLogEntriesResponse": {
+ "description": "Result returned from ListLogEntries.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.If a value for next_page_token appears and the entries field is empty, it means that the search found no log entries so far but it did not have time to search all the possible log entries. Retry the method with this value for page_token to continue the search. Alternatively, consider speeding up the search by changing your filter to specify a single log name or resource type, or to narrow the time range of the search.",
+ "type": "string"
+ },
+ "entries": {
+ "description": "A list of log entries. If entries is empty, nextPageToken may still be returned, indicating that more entries may exist. See nextPageToken for more information.",
+ "items": {
+ "$ref": "LogEntry"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListLogEntriesResponse"
+ },
+ "LogLine": {
+ "properties": {
+ "logMessage": {
+ "description": "App-provided log message.",
+ "type": "string"
+ },
+ "severity": {
+ "enum": [
+ "DEFAULT",
+ "DEBUG",
+ "INFO",
+ "NOTICE",
+ "WARNING",
+ "ERROR",
+ "CRITICAL",
+ "ALERT",
+ "EMERGENCY"
+ ],
+ "description": "Severity of this log entry.",
+ "type": "string",
+ "enumDescriptions": [
+ "(0) The log entry has no assigned severity level.",
+ "(100) Debug or trace information.",
+ "(200) Routine information, such as ongoing status or performance.",
+ "(300) Normal but significant events, such as start up, shut down, or a configuration change.",
+ "(400) Warning events might cause problems.",
+ "(500) Error events are likely to cause problems.",
+ "(600) Critical events cause more severe problems or outages.",
+ "(700) A person must take an action immediately.",
+ "(800) One or more systems are unusable."
+ ]
+ },
+ "sourceLocation": {
+ "description": "Where in the source code this log message was written.",
+ "$ref": "SourceLocation"
+ },
+ "time": {
+ "format": "google-datetime",
+ "description": "Approximate time when this log entry was made.",
+ "type": "string"
+ }
+ },
+ "id": "LogLine",
+ "description": "Application log line emitted while processing a request.",
+ "type": "object"
}
},
"protocol": "rest",
@@ -3120,6 +1002,9 @@
"auth": {
"oauth2": {
"scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
"https://www.googleapis.com/auth/logging.write": {
"description": "Submit log data for your projects"
},
@@ -3131,12 +1016,2127 @@
},
"https://www.googleapis.com/auth/cloud-platform.read-only": {
"description": "View your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
- "rootUrl": "https://logging.googleapis.com/"
+ "rootUrl": "https://logging.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "logging",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Stackdriver Logging API",
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "resources": {
+ "sinks": {
+ "methods": {
+ "update": {
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.",
+ "type": "string",
+ "location": "query"
+ },
+ "uniqueWriterIdentity": {
+ "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "sinkName": {
+ "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/sinks/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
+ "id": "logging.projects.sinks.update",
+ "path": "v2/{+sinkName}",
+ "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
+ "request": {
+ "$ref": "LogSink"
+ }
+ },
+ "delete": {
+ "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "sinkName": {
+ "pattern": "^projects/[^/]+/sinks/[^/]+$",
+ "location": "path",
+ "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.projects.sinks.delete"
+ },
+ "list": {
+ "description": "Lists sinks.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListSinksResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "type": "string",
+ "required": true
+ },
+ "pageToken": {
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "flatPath": "v2/projects/{projectsId}/sinks",
+ "path": "v2/{+parent}/sinks",
+ "id": "logging.projects.sinks.list"
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "LogSink"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
+ "type": "string",
+ "required": true
+ },
+ "uniqueWriterIdentity": {
+ "location": "query",
+ "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
+ "type": "boolean"
+ }
+ },
+ "flatPath": "v2/projects/{projectsId}/sinks",
+ "path": "v2/{+parent}/sinks",
+ "id": "logging.projects.sinks.create",
+ "request": {
+ "$ref": "LogSink"
+ },
+ "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink."
+ },
+ "get": {
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "sinkName": {
+ "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/sinks/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
+ "id": "logging.projects.sinks.get",
+ "path": "v2/{+sinkName}",
+ "description": "Gets a sink."
+ },
+ "patch": {
+ "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
+ "request": {
+ "$ref": "LogSink"
+ },
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameters": {
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.",
+ "type": "string",
+ "location": "query"
+ },
+ "uniqueWriterIdentity": {
+ "location": "query",
+ "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
+ "type": "boolean"
+ },
+ "sinkName": {
+ "pattern": "^projects/[^/]+/sinks/[^/]+$",
+ "location": "path",
+ "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.projects.sinks.patch"
+ }
+ }
+ },
+ "logs": {
+ "methods": {
+ "delete": {
+ "id": "logging.projects.logs.delete",
+ "path": "v2/{+logName}",
+ "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "logName"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "logName": {
+ "pattern": "^projects/[^/]+/logs/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/projects/{projectsId}/logs/{logsId}"
+ },
+ "list": {
+ "id": "logging.projects.logs.list",
+ "path": "v2/{+parent}/logs",
+ "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
+ "response": {
+ "$ref": "ListLogsResponse"
+ },
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "type": "string",
+ "required": true
+ },
+ "pageToken": {
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "flatPath": "v2/projects/{projectsId}/logs"
+ }
+ }
+ },
+ "exclusions": {
+ "methods": {
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "LogExclusion"
+ },
+ "parameters": {
+ "parent": {
+ "description": "Required. The parent resource in which to create the exclusion:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/projects/{projectsId}/exclusions",
+ "path": "v2/{+parent}/exclusions",
+ "id": "logging.projects.exclusions.create",
+ "description": "Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.",
+ "request": {
+ "$ref": "LogExclusion"
+ }
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/exclusions/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name of an existing exclusion to delete:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v2/projects/{projectsId}/exclusions/{exclusionsId}",
+ "id": "logging.projects.exclusions.delete",
+ "path": "v2/{+name}",
+ "description": "Deletes an exclusion."
+ },
+ "patch": {
+ "response": {
+ "$ref": "LogExclusion"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The resource name of the exclusion to update:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/exclusions/[^/]+$",
+ "location": "path"
+ },
+ "updateMask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of \"filter,description\".",
+ "type": "string"
+ }
+ },
+ "flatPath": "v2/projects/{projectsId}/exclusions/{exclusionsId}",
+ "id": "logging.projects.exclusions.patch",
+ "path": "v2/{+name}",
+ "request": {
+ "$ref": "LogExclusion"
+ },
+ "description": "Changes one or more properties of an existing exclusion."
+ },
+ "get": {
+ "description": "Gets the description of an exclusion.",
+ "response": {
+ "$ref": "LogExclusion"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The resource name of an existing exclusion:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/exclusions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2/projects/{projectsId}/exclusions/{exclusionsId}",
+ "id": "logging.projects.exclusions.get",
+ "path": "v2/{+name}"
+ },
+ "list": {
+ "id": "logging.projects.exclusions.list",
+ "path": "v2/{+parent}/exclusions",
+ "description": "Lists all the exclusions in a parent resource.",
+ "response": {
+ "$ref": "ListExclusionsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "type": "integer"
+ },
+ "parent": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Required. The parent resource whose exclusions are to be listed.\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v2/projects/{projectsId}/exclusions"
+ }
+ }
+ },
+ "metrics": {
+ "methods": {
+ "delete": {
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "metricName"
+ ],
+ "parameters": {
+ "metricName": {
+ "description": "The resource name of the metric to delete:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/metrics/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.write"
+ ],
+ "flatPath": "v2/projects/{projectsId}/metrics/{metricsId}",
+ "path": "v2/{+metricName}",
+ "id": "logging.projects.metrics.delete",
+ "description": "Deletes a logs-based metric."
+ },
+ "get": {
+ "path": "v2/{+metricName}",
+ "id": "logging.projects.metrics.get",
+ "description": "Gets a logs-based metric.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "LogMetric"
+ },
+ "parameterOrder": [
+ "metricName"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "metricName": {
+ "description": "The resource name of the desired metric:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/metrics/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2/projects/{projectsId}/metrics/{metricsId}"
+ },
+ "list": {
+ "description": "Lists logs-based metrics.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListLogMetricsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required. The name of the project containing the metrics:\n\"projects/[PROJECT_ID]\"\n",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "type": "integer"
+ }
+ },
+ "flatPath": "v2/projects/{projectsId}/metrics",
+ "path": "v2/{+parent}/metrics",
+ "id": "logging.projects.metrics.list"
+ },
+ "update": {
+ "response": {
+ "$ref": "LogMetric"
+ },
+ "parameterOrder": [
+ "metricName"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.write"
+ ],
+ "parameters": {
+ "metricName": {
+ "pattern": "^projects/[^/]+/metrics/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the metric to update:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\nThe updated metric must be provided in the request and it's name field must be the same as [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a new metric is created.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v2/projects/{projectsId}/metrics/{metricsId}",
+ "id": "logging.projects.metrics.update",
+ "path": "v2/{+metricName}",
+ "request": {
+ "$ref": "LogMetric"
+ },
+ "description": "Creates or updates a logs-based metric."
+ },
+ "create": {
+ "description": "Creates a logs-based metric.",
+ "request": {
+ "$ref": "LogMetric"
+ },
+ "response": {
+ "$ref": "LogMetric"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the project in which to create the metric:\n\"projects/[PROJECT_ID]\"\nThe new metric must be provided in the request.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.write"
+ ],
+ "flatPath": "v2/projects/{projectsId}/metrics",
+ "id": "logging.projects.metrics.create",
+ "path": "v2/{+parent}/metrics"
+ }
+ }
+ }
+ }
+ },
+ "billingAccounts": {
+ "resources": {
+ "sinks": {
+ "methods": {
+ "delete": {
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "sinkName": {
+ "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$",
+ "location": "path",
+ "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.billingAccounts.sinks.delete",
+ "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted."
+ },
+ "list": {
+ "description": "Lists sinks.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListSinksResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "type": "string",
+ "required": true,
+ "pattern": "^billingAccounts/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks",
+ "path": "v2/{+parent}/sinks",
+ "id": "logging.billingAccounts.sinks.list"
+ },
+ "create": {
+ "id": "logging.billingAccounts.sinks.create",
+ "path": "v2/{+parent}/sinks",
+ "request": {
+ "$ref": "LogSink"
+ },
+ "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.",
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "parent": {
+ "pattern": "^billingAccounts/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
+ "type": "string",
+ "required": true
+ },
+ "uniqueWriterIdentity": {
+ "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
+ "type": "boolean",
+ "location": "query"
+ }
+ },
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks"
+ },
+ "get": {
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "sinkName": {
+ "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}",
+ "id": "logging.billingAccounts.sinks.get",
+ "path": "v2/{+sinkName}",
+ "description": "Gets a sink."
+ },
+ "patch": {
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "response": {
+ "$ref": "LogSink"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.",
+ "type": "string",
+ "location": "query"
+ },
+ "uniqueWriterIdentity": {
+ "location": "query",
+ "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
+ "type": "boolean"
+ },
+ "sinkName": {
+ "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$",
+ "location": "path",
+ "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.billingAccounts.sinks.patch",
+ "request": {
+ "$ref": "LogSink"
+ },
+ "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field."
+ },
+ "update": {
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.",
+ "type": "string",
+ "location": "query"
+ },
+ "uniqueWriterIdentity": {
+ "location": "query",
+ "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
+ "type": "boolean"
+ },
+ "sinkName": {
+ "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}",
+ "id": "logging.billingAccounts.sinks.update",
+ "path": "v2/{+sinkName}",
+ "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
+ "request": {
+ "$ref": "LogSink"
+ }
+ }
+ }
+ },
+ "logs": {
+ "methods": {
+ "delete": {
+ "id": "logging.billingAccounts.logs.delete",
+ "path": "v2/{+logName}",
+ "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "logName"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "logName": {
+ "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
+ "type": "string",
+ "required": true,
+ "pattern": "^billingAccounts/[^/]+/logs/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/logs/{logsId}"
+ },
+ "list": {
+ "response": {
+ "$ref": "ListLogsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "type": "string",
+ "required": true,
+ "pattern": "^billingAccounts/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "type": "integer"
+ }
+ },
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/logs",
+ "id": "logging.billingAccounts.logs.list",
+ "path": "v2/{+parent}/logs",
+ "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed."
+ }
+ }
+ },
+ "exclusions": {
+ "methods": {
+ "create": {
+ "id": "logging.billingAccounts.exclusions.create",
+ "path": "v2/{+parent}/exclusions",
+ "request": {
+ "$ref": "LogExclusion"
+ },
+ "description": "Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.",
+ "response": {
+ "$ref": "LogExclusion"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "parent": {
+ "pattern": "^billingAccounts/[^/]+$",
+ "location": "path",
+ "description": "Required. The parent resource in which to create the exclusion:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions"
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "name": {
+ "description": "Required. The resource name of an existing exclusion to delete:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^billingAccounts/[^/]+/exclusions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions/{exclusionsId}",
+ "path": "v2/{+name}",
+ "id": "logging.billingAccounts.exclusions.delete",
+ "description": "Deletes an exclusion."
+ },
+ "patch": {
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "LogExclusion"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^billingAccounts/[^/]+/exclusions/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name of the exclusion to update:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
+ "type": "string",
+ "required": true
+ },
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of \"filter,description\".",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions/{exclusionsId}",
+ "path": "v2/{+name}",
+ "id": "logging.billingAccounts.exclusions.patch",
+ "request": {
+ "$ref": "LogExclusion"
+ },
+ "description": "Changes one or more properties of an existing exclusion."
+ },
+ "get": {
+ "description": "Gets the description of an exclusion.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "LogExclusion"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The resource name of an existing exclusion:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^billingAccounts/[^/]+/exclusions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions/{exclusionsId}",
+ "path": "v2/{+name}",
+ "id": "logging.billingAccounts.exclusions.get"
+ },
+ "list": {
+ "id": "logging.billingAccounts.exclusions.list",
+ "path": "v2/{+parent}/exclusions",
+ "description": "Lists all the exclusions in a parent resource.",
+ "response": {
+ "$ref": "ListExclusionsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "pattern": "^billingAccounts/[^/]+$",
+ "location": "path",
+ "description": "Required. The parent resource whose exclusions are to be listed.\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions"
+ }
+ }
+ }
+ }
+ },
+ "folders": {
+ "resources": {
+ "sinks": {
+ "methods": {
+ "update": {
+ "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
+ "request": {
+ "$ref": "LogSink"
+ },
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameters": {
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.",
+ "type": "string",
+ "location": "query"
+ },
+ "uniqueWriterIdentity": {
+ "location": "query",
+ "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
+ "type": "boolean"
+ },
+ "sinkName": {
+ "pattern": "^folders/[^/]+/sinks/[^/]+$",
+ "location": "path",
+ "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.folders.sinks.update"
+ },
+ "delete": {
+ "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "sinkName": {
+ "pattern": "^folders/[^/]+/sinks/[^/]+$",
+ "location": "path",
+ "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}",
+ "id": "logging.folders.sinks.delete",
+ "path": "v2/{+sinkName}"
+ },
+ "list": {
+ "id": "logging.folders.sinks.list",
+ "path": "v2/{+parent}/sinks",
+ "description": "Lists sinks.",
+ "response": {
+ "$ref": "ListSinksResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "parent": {
+ "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "type": "string",
+ "required": true,
+ "pattern": "^folders/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2/folders/{foldersId}/sinks"
+ },
+ "create": {
+ "request": {
+ "$ref": "LogSink"
+ },
+ "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.",
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^folders/[^/]+$",
+ "location": "path"
+ },
+ "uniqueWriterIdentity": {
+ "location": "query",
+ "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
+ "type": "boolean"
+ }
+ },
+ "flatPath": "v2/folders/{foldersId}/sinks",
+ "id": "logging.folders.sinks.create",
+ "path": "v2/{+parent}/sinks"
+ },
+ "patch": {
+ "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
+ "request": {
+ "$ref": "LogSink"
+ },
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.",
+ "type": "string",
+ "location": "query"
+ },
+ "uniqueWriterIdentity": {
+ "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "sinkName": {
+ "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^folders/[^/]+/sinks/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}",
+ "id": "logging.folders.sinks.patch",
+ "path": "v2/{+sinkName}"
+ },
+ "get": {
+ "response": {
+ "$ref": "LogSink"
+ },
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "sinkName": {
+ "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^folders/[^/]+/sinks/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}",
+ "id": "logging.folders.sinks.get",
+ "path": "v2/{+sinkName}",
+ "description": "Gets a sink."
+ }
+ }
+ },
+ "logs": {
+ "methods": {
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "logName"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "logName": {
+ "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
+ "type": "string",
+ "required": true,
+ "pattern": "^folders/[^/]+/logs/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2/folders/{foldersId}/logs/{logsId}",
+ "id": "logging.folders.logs.delete",
+ "path": "v2/{+logName}",
+ "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted."
+ },
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListLogsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "type": "string",
+ "required": true,
+ "pattern": "^folders/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2/folders/{foldersId}/logs",
+ "path": "v2/{+parent}/logs",
+ "id": "logging.folders.logs.list",
+ "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed."
+ }
+ }
+ },
+ "exclusions": {
+ "methods": {
+ "create": {
+ "description": "Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.",
+ "request": {
+ "$ref": "LogExclusion"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "LogExclusion"
+ },
+ "parameters": {
+ "parent": {
+ "description": "Required. The parent resource in which to create the exclusion:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^folders/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/folders/{foldersId}/exclusions",
+ "path": "v2/{+parent}/exclusions",
+ "id": "logging.folders.exclusions.create"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "pattern": "^folders/[^/]+/exclusions/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name of an existing exclusion to delete:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/folders/{foldersId}/exclusions/{exclusionsId}",
+ "id": "logging.folders.exclusions.delete",
+ "path": "v2/{+name}",
+ "description": "Deletes an exclusion."
+ },
+ "patch": {
+ "request": {
+ "$ref": "LogExclusion"
+ },
+ "description": "Changes one or more properties of an existing exclusion.",
+ "response": {
+ "$ref": "LogExclusion"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^folders/[^/]+/exclusions/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name of the exclusion to update:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
+ "type": "string",
+ "required": true
+ },
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of \"filter,description\".",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v2/folders/{foldersId}/exclusions/{exclusionsId}",
+ "id": "logging.folders.exclusions.patch",
+ "path": "v2/{+name}"
+ },
+ "get": {
+ "id": "logging.folders.exclusions.get",
+ "path": "v2/{+name}",
+ "description": "Gets the description of an exclusion.",
+ "response": {
+ "$ref": "LogExclusion"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The resource name of an existing exclusion:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^folders/[^/]+/exclusions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2/folders/{foldersId}/exclusions/{exclusionsId}"
+ },
+ "list": {
+ "description": "Lists all the exclusions in a parent resource.",
+ "response": {
+ "$ref": "ListExclusionsResponse"
+ },
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "description": "Required. The parent resource whose exclusions are to be listed.\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "type": "string",
+ "required": true,
+ "pattern": "^folders/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2/folders/{foldersId}/exclusions",
+ "id": "logging.folders.exclusions.list",
+ "path": "v2/{+parent}/exclusions"
+ }
+ }
+ }
+ }
+ },
+ "monitoredResourceDescriptors": {
+ "methods": {
+ "list": {
+ "description": "Lists the descriptors for monitored resource types used by Stackdriver Logging.",
+ "httpMethod": "GET",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ListMonitoredResourceDescriptorsResponse"
+ },
+ "parameters": {
+ "pageToken": {
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2/monitoredResourceDescriptors",
+ "path": "v2/monitoredResourceDescriptors",
+ "id": "logging.monitoredResourceDescriptors.list"
+ }
+ }
+ },
+ "organizations": {
+ "resources": {
+ "sinks": {
+ "methods": {
+ "get": {
+ "path": "v2/{+sinkName}",
+ "id": "logging.organizations.sinks.get",
+ "description": "Gets a sink.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "parameters": {
+ "sinkName": {
+ "pattern": "^organizations/[^/]+/sinks/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}"
+ },
+ "patch": {
+ "id": "logging.organizations.sinks.patch",
+ "path": "v2/{+sinkName}",
+ "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
+ "request": {
+ "$ref": "LogSink"
+ },
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "updateMask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.",
+ "type": "string"
+ },
+ "uniqueWriterIdentity": {
+ "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "sinkName": {
+ "pattern": "^organizations/[^/]+/sinks/[^/]+$",
+ "location": "path",
+ "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}"
+ },
+ "update": {
+ "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
+ "request": {
+ "$ref": "LogSink"
+ },
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.",
+ "type": "string",
+ "location": "query"
+ },
+ "uniqueWriterIdentity": {
+ "location": "query",
+ "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
+ "type": "boolean"
+ },
+ "sinkName": {
+ "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+/sinks/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}",
+ "id": "logging.organizations.sinks.update",
+ "path": "v2/{+sinkName}"
+ },
+ "delete": {
+ "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "sinkName": {
+ "pattern": "^organizations/[^/]+/sinks/[^/]+$",
+ "location": "path",
+ "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.organizations.sinks.delete"
+ },
+ "list": {
+ "path": "v2/{+parent}/sinks",
+ "id": "logging.organizations.sinks.list",
+ "description": "Lists sinks.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListSinksResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "flatPath": "v2/organizations/{organizationsId}/sinks"
+ },
+ "create": {
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
+ },
+ "uniqueWriterIdentity": {
+ "location": "query",
+ "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
+ "type": "boolean"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/organizations/{organizationsId}/sinks",
+ "id": "logging.organizations.sinks.create",
+ "path": "v2/{+parent}/sinks",
+ "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.",
+ "request": {
+ "$ref": "LogSink"
+ }
+ }
+ }
+ },
+ "logs": {
+ "methods": {
+ "delete": {
+ "path": "v2/{+logName}",
+ "id": "logging.organizations.logs.delete",
+ "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "logName"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "logName": {
+ "pattern": "^organizations/[^/]+/logs/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v2/organizations/{organizationsId}/logs/{logsId}"
+ },
+ "list": {
+ "id": "logging.organizations.logs.list",
+ "path": "v2/{+parent}/logs",
+ "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
+ "response": {
+ "$ref": "ListLogsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "type": "integer"
+ }
+ },
+ "flatPath": "v2/organizations/{organizationsId}/logs"
+ }
+ }
+ },
+ "exclusions": {
+ "methods": {
+ "create": {
+ "path": "v2/{+parent}/exclusions",
+ "id": "logging.organizations.exclusions.create",
+ "description": "Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.",
+ "request": {
+ "$ref": "LogExclusion"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "LogExclusion"
+ },
+ "parameters": {
+ "parent": {
+ "description": "Required. The parent resource in which to create the exclusion:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/organizations/{organizationsId}/exclusions"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^organizations/[^/]+/exclusions/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name of an existing exclusion to delete:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v2/organizations/{organizationsId}/exclusions/{exclusionsId}",
+ "id": "logging.organizations.exclusions.delete",
+ "path": "v2/{+name}",
+ "description": "Deletes an exclusion."
+ },
+ "patch": {
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "LogExclusion"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "updateMask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of \"filter,description\".",
+ "type": "string"
+ },
+ "name": {
+ "pattern": "^organizations/[^/]+/exclusions/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name of the exclusion to update:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v2/organizations/{organizationsId}/exclusions/{exclusionsId}",
+ "path": "v2/{+name}",
+ "id": "logging.organizations.exclusions.patch",
+ "request": {
+ "$ref": "LogExclusion"
+ },
+ "description": "Changes one or more properties of an existing exclusion."
+ },
+ "get": {
+ "description": "Gets the description of an exclusion.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "LogExclusion"
+ },
+ "parameters": {
+ "name": {
+ "description": "Required. The resource name of an existing exclusion:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+/exclusions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2/organizations/{organizationsId}/exclusions/{exclusionsId}",
+ "path": "v2/{+name}",
+ "id": "logging.organizations.exclusions.get"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListExclusionsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required. The parent resource whose exclusions are to be listed.\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "flatPath": "v2/organizations/{organizationsId}/exclusions",
+ "path": "v2/{+parent}/exclusions",
+ "id": "logging.organizations.exclusions.list",
+ "description": "Lists all the exclusions in a parent resource."
+ }
+ }
+ }
+ }
+ },
+ "entries": {
+ "methods": {
+ "list": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ListLogEntriesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {},
+ "flatPath": "v2/entries:list",
+ "path": "v2/entries:list",
+ "id": "logging.entries.list",
+ "request": {
+ "$ref": "ListLogEntriesRequest"
+ },
+ "description": "Lists log entries. Use this method to retrieve log entries from Stackdriver Logging. For ways to export log entries, see Exporting Logs."
+ },
+ "write": {
+ "response": {
+ "$ref": "WriteLogEntriesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.write"
+ ],
+ "parameters": {},
+ "flatPath": "v2/entries:write",
+ "id": "logging.entries.write",
+ "path": "v2/entries:write",
+ "request": {
+ "$ref": "WriteLogEntriesRequest"
+ },
+ "description": "Log entry resourcesWrites log entries to Stackdriver Logging. This API method is the only way to send log entries to Stackdriver Logging. This method is used, directly or indirectly, by the Stackdriver Logging agent (fluentd) and all logging libraries configured to use Stackdriver Logging."
+ }
+ }
+ }
+ },
+ "parameters": {
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "version": "v2",
+ "baseUrl": "https://logging.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Writes log entries and manages your Stackdriver Logging configuration.",
+ "servicePath": ""
}
diff --git a/logging/v2beta1/logging-api.json b/logging/v2beta1/logging-api.json
index fe9f794..784e19e 100644
--- a/logging/v2beta1/logging-api.json
+++ b/logging/v2beta1/logging-api.json
@@ -1,11 +1,12 @@
{
+ "revision": "20171009",
"id": "logging:v2beta1",
"documentationLink": "https://cloud.google.com/logging/docs/",
- "revision": "20171009",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
"ListMonitoredResourceDescriptorsResponse": {
+ "description": "Result returned from ListMonitoredResourceDescriptors.",
"type": "object",
"properties": {
"resourceDescriptors": {
@@ -20,51 +21,73 @@
"type": "string"
}
},
- "id": "ListMonitoredResourceDescriptorsResponse",
- "description": "Result returned from ListMonitoredResourceDescriptors."
+ "id": "ListMonitoredResourceDescriptorsResponse"
+ },
+ "LogEntryOperation": {
+ "description": "Additional information about a potentially long-running operation with which a log entry is associated.",
+ "type": "object",
+ "properties": {
+ "first": {
+ "description": "Optional. Set this to True if this is the first log entry in the operation.",
+ "type": "boolean"
+ },
+ "producer": {
+ "description": "Optional. An arbitrary producer identifier. The combination of id and producer must be globally unique. Examples for producer: \"MyDivision.MyBigCompany.com\", \"github.com/MyProject/MyApplication\".",
+ "type": "string"
+ },
+ "last": {
+ "description": "Optional. Set this to True if this is the last log entry in the operation.",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.",
+ "type": "string"
+ }
+ },
+ "id": "LogEntryOperation"
},
"LogMetric": {
"description": "Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter in a given time interval.Logs-based metric can also be used to extract values from logs and create a a distribution of the values. The distribution records the statistics of the extracted values along with an optional histogram of the values as specified by the bucket options.",
"type": "object",
"properties": {
"description": {
- "type": "string",
- "description": "Optional. A description of this metric, which is used in documentation."
- },
- "bucketOptions": {
- "description": "Optional. The bucket_options are required when the logs-based metric is using a DISTRIBUTION value type and it describes the bucket boundaries used to create a histogram of the extracted values.",
- "$ref": "BucketOptions"
+ "description": "Optional. A description of this metric, which is used in documentation.",
+ "type": "string"
},
"valueExtractor": {
"description": "Optional. A value_extractor is required when using a distribution logs-based metric to extract the values to record from a log entry. Two functions are supported for value extraction: EXTRACT(field) or REGEXP_EXTRACT(field, regex). The argument are: 1. field: The name of the log entry field from which the value is to be extracted. 2. regex: A regular expression using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax) with a single capture group to extract data from the specified log entry field. The value of the field is converted to a string before applying the regex. It is an error to specify a regex that does not include exactly one capture group.The result of the extraction must be convertible to a double type, as the distribution always records double values. If either the extraction or the conversion to double fails, then those values are not recorded in the distribution.Example: REGEXP_EXTRACT(jsonPayload.request, \".*quantity=(\\d+).*\")",
"type": "string"
},
+ "bucketOptions": {
+ "description": "Optional. The bucket_options are required when the logs-based metric is using a DISTRIBUTION value type and it describes the bucket boundaries used to create a histogram of the extracted values.",
+ "$ref": "BucketOptions"
+ },
"name": {
"description": "Required. The client-assigned metric identifier. Examples: \"error_count\", \"nginx/requests\".Metric identifiers are limited to 100 characters and can include only the following characters: A-Z, a-z, 0-9, and the special characters _-.,+!*',()%/. The forward-slash character (/) denotes a hierarchy of name pieces, and it cannot be the first character of the name.The metric identifier in this field must not be URL-encoded (https://en.wikipedia.org/wiki/Percent-encoding). However, when the metric identifier appears as the [METRIC_ID] part of a metric_name API parameter, then the metric identifier must be URL-encoded. Example: \"projects/my-project/metrics/nginx%2Frequests\".",
"type": "string"
},
"labelExtractors": {
+ "description": "Optional. A map from a label key string to an extractor expression which is used to extract data from a log entry field and assign as the label value. Each label key specified in the LabelDescriptor must have an associated extractor expression in this map. The syntax of the extractor expression is the same as for the value_extractor field.The extracted value is converted to the type defined in the label descriptor. If the either the extraction or the type conversion fails, the label will have a default value. The default value for a string label is an empty string, for an integer label its 0, and for a boolean label its false.Note that there are upper bounds on the maximum number of labels and the number of active time series that are allowed in a project.",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "Optional. A map from a label key string to an extractor expression which is used to extract data from a log entry field and assign as the label value. Each label key specified in the LabelDescriptor must have an associated extractor expression in this map. The syntax of the extractor expression is the same as for the value_extractor field.The extracted value is converted to the type defined in the label descriptor. If the either the extraction or the type conversion fails, the label will have a default value. The default value for a string label is an empty string, for an integer label its 0, and for a boolean label its false.Note that there are upper bounds on the maximum number of labels and the number of active time series that are allowed in a project.",
- "type": "object"
+ }
+ },
+ "metricDescriptor": {
+ "$ref": "MetricDescriptor",
+ "description": "Optional. The metric descriptor associated with the logs-based metric. If unspecified, it uses a default metric descriptor with a DELTA metric kind, INT64 value type, with no labels and a unit of \"1\". Such a metric counts the number of log entries matching the filter expression.The name, type, and description fields in the metric_descriptor are output only, and is constructed using the name and description field in the LogMetric.To create a logs-based metric that records a distribution of log values, a DELTA metric kind with a DISTRIBUTION value type must be used along with a value_extractor expression in the LogMetric.Each label in the metric descriptor must have a matching label name as the key and an extractor expression as the value in the label_extractors map.The metric_kind and value_type fields in the metric_descriptor cannot be updated once initially configured. New labels can be added in the metric_descriptor, but existing labels cannot be modified except for their description."
},
"version": {
+ "enumDescriptions": [
+ "Stackdriver Logging API v2.",
+ "Stackdriver Logging API v1."
+ ],
"enum": [
"V2",
"V1"
],
"description": "Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.",
- "type": "string",
- "enumDescriptions": [
- "Stackdriver Logging API v2.",
- "Stackdriver Logging API v1."
- ]
- },
- "metricDescriptor": {
- "$ref": "MetricDescriptor",
- "description": "Optional. The metric descriptor associated with the logs-based metric. If unspecified, it uses a default metric descriptor with a DELTA metric kind, INT64 value type, with no labels and a unit of \"1\". Such a metric counts the number of log entries matching the filter expression.The name, type, and description fields in the metric_descriptor are output only, and is constructed using the name and description field in the LogMetric.To create a logs-based metric that records a distribution of log values, a DELTA metric kind with a DISTRIBUTION value type must be used along with a value_extractor expression in the LogMetric.Each label in the metric descriptor must have a matching label name as the key and an extractor expression as the value in the label_extractors map.The metric_kind and value_type fields in the metric_descriptor cannot be updated once initially configured. New labels can be added in the metric_descriptor, but existing labels cannot be modified except for their description."
+ "type": "string"
},
"filter": {
"description": "Required. An advanced logs filter which is used to match log entries. Example:\n\"resource.type=gae_app AND severity\u003e=ERROR\"\nThe maximum length of the filter is 20000 characters.",
@@ -73,43 +96,20 @@
},
"id": "LogMetric"
},
- "LogEntryOperation": {
- "id": "LogEntryOperation",
- "description": "Additional information about a potentially long-running operation with which a log entry is associated.",
- "type": "object",
- "properties": {
- "last": {
- "description": "Optional. Set this to True if this is the last log entry in the operation.",
- "type": "boolean"
- },
- "id": {
- "description": "Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.",
- "type": "string"
- },
- "first": {
- "description": "Optional. Set this to True if this is the first log entry in the operation.",
- "type": "boolean"
- },
- "producer": {
- "description": "Optional. An arbitrary producer identifier. The combination of id and producer must be globally unique. Examples for producer: \"MyDivision.MyBigCompany.com\", \"github.com/MyProject/MyApplication\".",
- "type": "string"
- }
- }
- },
"MonitoredResource": {
"description": "An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for \"gce_instance\" has labels \"instance_id\" and \"zone\":\n{ \"type\": \"gce_instance\",\n \"labels\": { \"instance_id\": \"12345678901234\",\n \"zone\": \"us-central1-a\" }}\n",
"type": "object",
"properties": {
+ "labels": {
+ "description": "Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels \"project_id\", \"instance_id\", and \"zone\".",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
"type": {
"description": "Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance.",
"type": "string"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels \"project_id\", \"instance_id\", and \"zone\".",
- "type": "object"
}
},
"id": "MonitoredResource"
@@ -126,28 +126,28 @@
"description": "Optional. This field applies only to sinks owned by organizations and folders. If the field is false, the default, only the logs owned by the sink's parent resource are available for export. If the field is true, then logs from all the projects, folders, and billing accounts contained in the sink's parent resource are also available for export. Whether a particular log entry from the children is exported depends on the sink's filter expression. For example, if this field is true, then the filter resource.type=gce_instance would export all Compute Engine VM instance log entries from all projects in the sink's parent. To only export entries from certain child projects, filter on the project part of the log name:\nlogName:(\"projects/test-project1/\" OR \"projects/test-project2/\") AND\nresource.type=gce_instance\n",
"type": "boolean"
},
- "filter": {
- "description": "Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. For example:\nlogName=\"projects/[PROJECT_ID]/logs/[LOG_ID]\" AND severity\u003e=ERROR\n",
- "type": "string"
- },
"destination": {
"description": "Required. The export destination:\n\"storage.googleapis.com/[GCS_BUCKET]\"\n\"bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]\"\n\"pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]\"\nThe sink's writer_identity, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs With Sinks.",
"type": "string"
},
+ "filter": {
+ "description": "Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. For example:\nlogName=\"projects/[PROJECT_ID]/logs/[LOG_ID]\" AND severity\u003e=ERROR\n",
+ "type": "string"
+ },
"endTime": {
"format": "google-datetime",
"description": "Deprecated. This field is ignored when creating or updating sinks.",
"type": "string"
},
- "writerIdentity": {
- "type": "string",
- "description": "Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity."
- },
"startTime": {
"format": "google-datetime",
"description": "Deprecated. This field is ignored when creating or updating sinks.",
"type": "string"
},
+ "writerIdentity": {
+ "description": "Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.",
+ "type": "string"
+ },
"outputVersionFormat": {
"description": "Deprecated. The log entry format to use for this sink's exported log entries. The v2 format is used by default and cannot be changed.",
"type": "string",
@@ -187,11 +187,6 @@
"description": "A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message.",
"type": "object",
"properties": {
- "cacheFillBytes": {
- "format": "int64",
- "description": "The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.",
- "type": "string"
- },
"requestMethod": {
"description": "The request method. Examples: \"GET\", \"HEAD\", \"PUT\", \"POST\".",
"type": "string"
@@ -201,9 +196,9 @@
"type": "string"
},
"responseSize": {
- "type": "string",
"format": "int64",
- "description": "The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body."
+ "description": "The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.",
+ "type": "string"
},
"requestSize": {
"format": "int64",
@@ -231,8 +226,8 @@
"type": "boolean"
},
"cacheValidatedWithOriginServer": {
- "type": "boolean",
- "description": "Whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if cache_hit is True."
+ "description": "Whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if cache_hit is True.",
+ "type": "boolean"
},
"status": {
"format": "int32",
@@ -251,27 +246,32 @@
"format": "google-duration",
"description": "The request processing latency on the server, from the time the request was received until the response was sent.",
"type": "string"
+ },
+ "cacheFillBytes": {
+ "format": "int64",
+ "description": "The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.",
+ "type": "string"
}
},
"id": "HttpRequest"
},
"ListSinksResponse": {
+ "description": "Result returned from ListSinks.",
+ "type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken.",
+ "type": "string"
+ },
"sinks": {
"description": "A list of sinks.",
"items": {
"$ref": "LogSink"
},
"type": "array"
- },
- "nextPageToken": {
- "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken.",
- "type": "string"
}
},
- "id": "ListSinksResponse",
- "description": "Result returned from ListSinks.",
- "type": "object"
+ "id": "ListSinksResponse"
},
"MonitoredResourceDescriptor": {
"description": "An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of \"gce_instance\" and specifies the use of the labels \"instance_id\" and \"zone\" to identify particular VM instances.Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API.",
@@ -304,6 +304,7 @@
"id": "MonitoredResourceDescriptor"
},
"LogEntrySourceLocation": {
+ "description": "Additional information about the source code location that produced the log entry.",
"type": "object",
"properties": {
"file": {
@@ -320,8 +321,7 @@
"type": "string"
}
},
- "id": "LogEntrySourceLocation",
- "description": "Additional information about the source code location that produced the log entry."
+ "id": "LogEntrySourceLocation"
},
"ListLogEntriesResponse": {
"description": "Result returned from ListLogEntries.",
@@ -350,6 +350,17 @@
"type": "string"
},
"severity": {
+ "enumDescriptions": [
+ "(0) The log entry has no assigned severity level.",
+ "(100) Debug or trace information.",
+ "(200) Routine information, such as ongoing status or performance.",
+ "(300) Normal but significant events, such as start up, shut down, or a configuration change.",
+ "(400) Warning events might cause problems.",
+ "(500) Error events are likely to cause problems.",
+ "(600) Critical events cause more severe problems or outages.",
+ "(700) A person must take an action immediately.",
+ "(800) One or more systems are unusable."
+ ],
"enum": [
"DEFAULT",
"DEBUG",
@@ -362,22 +373,11 @@
"EMERGENCY"
],
"description": "Severity of this log entry.",
- "type": "string",
- "enumDescriptions": [
- "(0) The log entry has no assigned severity level.",
- "(100) Debug or trace information.",
- "(200) Routine information, such as ongoing status or performance.",
- "(300) Normal but significant events, such as start up, shut down, or a configuration change.",
- "(400) Warning events might cause problems.",
- "(500) Error events are likely to cause problems.",
- "(600) Critical events cause more severe problems or outages.",
- "(700) A person must take an action immediately.",
- "(800) One or more systems are unusable."
- ]
+ "type": "string"
},
"sourceLocation": {
- "$ref": "SourceLocation",
- "description": "Where in the source code this log message was written."
+ "description": "Where in the source code this log message was written.",
+ "$ref": "SourceLocation"
},
"time": {
"format": "google-datetime",
@@ -391,11 +391,6 @@
"description": "Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): offset + (width * i). Lower bound (1 \u003c= i \u003c N): offset + (width * (i - 1)).",
"type": "object",
"properties": {
- "offset": {
- "format": "double",
- "description": "Lower bound of the first bucket.",
- "type": "number"
- },
"numFiniteBuckets": {
"format": "int32",
"description": "Must be greater than 0.",
@@ -405,17 +400,24 @@
"format": "double",
"description": "Must be greater than 0.",
"type": "number"
+ },
+ "offset": {
+ "format": "double",
+ "description": "Lower bound of the first bucket.",
+ "type": "number"
}
},
"id": "Linear"
},
"Empty": {
- "id": "Empty",
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
"type": "object",
- "properties": {}
+ "properties": {},
+ "id": "Empty"
},
"SourceLocation": {
+ "description": "Specifies a location in a source code file.",
+ "type": "object",
"properties": {
"file": {
"description": "Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.",
@@ -431,14 +433,21 @@
"type": "string"
}
},
- "id": "SourceLocation",
- "description": "Specifies a location in a source code file.",
- "type": "object"
+ "id": "SourceLocation"
},
"ListLogEntriesRequest": {
"description": "The parameters to ListLogEntries.",
"type": "object",
"properties": {
+ "pageSize": {
+ "format": "int32",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of next_page_token in the response indicates that more results might be available.",
+ "type": "integer"
+ },
+ "orderBy": {
+ "description": "Optional. How the results should be sorted. Presently, the only permitted values are \"timestamp asc\" (default) and \"timestamp desc\". The first option returns entries in order of increasing values of LogEntry.timestamp (oldest first), and the second option returns entries in order of decreasing timestamps (newest first). Entries with equal timestamps are returned in order of their insert_id values.",
+ "type": "string"
+ },
"resourceNames": {
"description": "Required. Names of one or more parent resources from which to retrieve log entries:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nProjects listed in the project_ids field are added to this list.",
"items": {
@@ -446,29 +455,20 @@
},
"type": "array"
},
+ "projectIds": {
+ "description": "Deprecated. Use resource_names instead. One or more project identifiers or project numbers from which to retrieve log entries. Example: \"my-project-1A\". If present, these project identifiers are converted to resource name format and added to the list of resources in resource_names.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
"filter": {
"description": "Optional. A filter that chooses which log entries to return. See Advanced Logs Filters. Only log entries that match the filter are returned. An empty filter matches all log entries in the resources listed in resource_names. Referencing a parent resource that is not listed in resource_names will cause the filter to return no results. The maximum length of the filter is 20000 characters.",
"type": "string"
},
- "projectIds": {
- "description": "Deprecated. Use resource_names instead. One or more project identifiers or project numbers from which to retrieve log entries. Example: \"my-project-1A\". If present, these project identifiers are converted to resource name format and added to the list of resources in resource_names.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
"pageToken": {
"description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of other method parameters should be identical to those in the previous call.",
"type": "string"
- },
- "pageSize": {
- "type": "integer",
- "format": "int32",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of next_page_token in the response indicates that more results might be available."
- },
- "orderBy": {
- "description": "Optional. How the results should be sorted. Presently, the only permitted values are \"timestamp asc\" (default) and \"timestamp desc\". The first option returns entries in order of increasing values of LogEntry.timestamp (oldest first), and the second option returns entries in order of decreasing timestamps (newest first). Entries with equal timestamps are returned in order of their insert_id values.",
- "type": "string"
}
},
"id": "ListLogEntriesRequest"
@@ -489,19 +489,19 @@
"id": "Explicit"
},
"SourceReference": {
+ "description": "A reference to a particular snapshot of the source tree used to build and deploy an application.",
+ "type": "object",
"properties": {
- "repository": {
- "description": "Optional. A URI string identifying the repository. Example: \"https://github.com/GoogleCloudPlatform/kubernetes.git\"",
- "type": "string"
- },
"revisionId": {
"description": "The canonical and persistent identifier of the deployed revision. Example (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b\"",
"type": "string"
+ },
+ "repository": {
+ "description": "Optional. A URI string identifying the repository. Example: \"https://github.com/GoogleCloudPlatform/kubernetes.git\"",
+ "type": "string"
}
},
- "id": "SourceReference",
- "description": "A reference to a particular snapshot of the source tree used to build and deploy an application.",
- "type": "object"
+ "id": "SourceReference"
},
"WriteLogEntriesResponse": {
"description": "Result returned from WriteLogEntries. empty",
@@ -513,6 +513,11 @@
"description": "Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): scale * (growth_factor ^ i). Lower bound (1 \u003c= i \u003c N): scale * (growth_factor ^ (i - 1)).",
"type": "object",
"properties": {
+ "numFiniteBuckets": {
+ "format": "int32",
+ "description": "Must be greater than 0.",
+ "type": "integer"
+ },
"growthFactor": {
"format": "double",
"description": "Must be greater than 1.",
@@ -522,20 +527,25 @@
"format": "double",
"description": "Must be greater than 0.",
"type": "number"
- },
- "numFiniteBuckets": {
- "format": "int32",
- "description": "Must be greater than 0.",
- "type": "integer"
}
},
"id": "Exponential"
},
"WriteLogEntriesRequest": {
- "id": "WriteLogEntriesRequest",
"description": "The parameters to WriteLogEntries.",
"type": "object",
"properties": {
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional. Default labels that are added to the labels field of all log entries in entries. If a log entry already has a label with the same key as a label in this parameter, then the log entry's label is not changed. See LogEntry.",
+ "type": "object"
+ },
+ "resource": {
+ "$ref": "MonitoredResource",
+ "description": "Optional. A default monitored resource object that is assigned to all log entries in entries that do not specify a value for resource. Example:\n{ \"type\": \"gce_instance\",\n \"labels\": {\n \"zone\": \"us-central1-a\", \"instance_id\": \"00000000000000000000\" }}\nSee LogEntry."
+ },
"entries": {
"description": "Required. The log entries to send to Stackdriver Logging. The order of log entries in this list does not matter. Values supplied in this method's log_name, resource, and labels fields are copied into those log entries in this list that do not include values for their corresponding fields. For more information, see the LogEntry type.If the timestamp or insert_id fields are missing in log entries, then this method supplies the current time or a unique identifier, respectively. The supplied values are chosen so that, among the log entries that did not supply their own values, the entries earlier in the list will sort before the entries later in the list. See the entries.list method.Log entries with timestamps that are more than the logs retention period in the past or more than 24 hours in the future might be discarded. Discarding does not return an error.To improve throughput and to avoid exceeding the quota limit for calls to entries.write, you should try to include several log entries in this list, rather than calling this method for each individual log entry.",
"items": {
@@ -550,38 +560,14 @@
"partialSuccess": {
"description": "Optional. Whether valid entries should be written even if some other entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any entry is not written, then the response status is the error associated with one of the failed entries and the response includes error details keyed by the entries' zero-based index in the entries.write method.",
"type": "boolean"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional. Default labels that are added to the labels field of all log entries in entries. If a log entry already has a label with the same key as a label in this parameter, then the log entry's label is not changed. See LogEntry.",
- "type": "object"
- },
- "resource": {
- "$ref": "MonitoredResource",
- "description": "Optional. A default monitored resource object that is assigned to all log entries in entries that do not specify a value for resource. Example:\n{ \"type\": \"gce_instance\",\n \"labels\": {\n \"zone\": \"us-central1-a\", \"instance_id\": \"00000000000000000000\" }}\nSee LogEntry."
}
- }
+ },
+ "id": "WriteLogEntriesRequest"
},
"LabelDescriptor": {
"description": "A description of a label.",
"type": "object",
"properties": {
- "valueType": {
- "enum": [
- "STRING",
- "BOOL",
- "INT64"
- ],
- "description": "The type of data that can be assigned to the label.",
- "type": "string",
- "enumDescriptions": [
- "A variable-length string. This is the default.",
- "Boolean; true or false.",
- "A 64-bit signed integer."
- ]
- },
"key": {
"description": "The label key.",
"type": "string"
@@ -589,11 +575,27 @@
"description": {
"description": "A human-readable description for the label.",
"type": "string"
+ },
+ "valueType": {
+ "enumDescriptions": [
+ "A variable-length string. This is the default.",
+ "Boolean; true or false.",
+ "A 64-bit signed integer."
+ ],
+ "enum": [
+ "STRING",
+ "BOOL",
+ "INT64"
+ ],
+ "description": "The type of data that can be assigned to the label.",
+ "type": "string"
}
},
"id": "LabelDescriptor"
},
"BucketOptions": {
+ "description": "BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i \u003e 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.",
+ "type": "object",
"properties": {
"exponentialBuckets": {
"$ref": "Exponential",
@@ -608,11 +610,11 @@
"description": "The linear bucket."
}
},
- "id": "BucketOptions",
- "description": "BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i \u003e 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.",
- "type": "object"
+ "id": "BucketOptions"
},
"ListLogMetricsResponse": {
+ "description": "Result returned from ListLogMetrics.",
+ "type": "object",
"properties": {
"metrics": {
"description": "A list of logs-based metrics.",
@@ -626,44 +628,12 @@
"type": "string"
}
},
- "id": "ListLogMetricsResponse",
- "description": "Result returned from ListLogMetrics.",
- "type": "object"
+ "id": "ListLogMetricsResponse"
},
"MetricDescriptor": {
"description": "Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.",
"type": "object",
"properties": {
- "name": {
- "description": "The resource name of the metric descriptor.",
- "type": "string"
- },
- "type": {
- "description": "The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined custom metric types have the DNS name custom.googleapis.com. Metric types should use a natural hierarchical grouping. For example:\n\"custom.googleapis.com/invoice/paid/amount\"\n\"appengine.googleapis.com/http/server/response_latencies\"\n",
- "type": "string"
- },
- "valueType": {
- "enum": [
- "VALUE_TYPE_UNSPECIFIED",
- "BOOL",
- "INT64",
- "DOUBLE",
- "STRING",
- "DISTRIBUTION",
- "MONEY"
- ],
- "description": "Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.",
- "type": "string",
- "enumDescriptions": [
- "Do not use this default value.",
- "The value is a boolean. This value type can be used only if the metric kind is GAUGE.",
- "The value is a signed 64-bit integer.",
- "The value is a double precision floating point number.",
- "The value is a text string. This value type can be used only if the metric kind is GAUGE.",
- "The value is a Distribution.",
- "The value is money."
- ]
- },
"metricKind": {
"enumDescriptions": [
"Do not use this default value.",
@@ -698,6 +668,36 @@
"$ref": "LabelDescriptor"
},
"type": "array"
+ },
+ "name": {
+ "description": "The resource name of the metric descriptor.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined custom metric types have the DNS name custom.googleapis.com. Metric types should use a natural hierarchical grouping. For example:\n\"custom.googleapis.com/invoice/paid/amount\"\n\"appengine.googleapis.com/http/server/response_latencies\"\n",
+ "type": "string"
+ },
+ "valueType": {
+ "enumDescriptions": [
+ "Do not use this default value.",
+ "The value is a boolean. This value type can be used only if the metric kind is GAUGE.",
+ "The value is a signed 64-bit integer.",
+ "The value is a double precision floating point number.",
+ "The value is a text string. This value type can be used only if the metric kind is GAUGE.",
+ "The value is a Distribution.",
+ "The value is money."
+ ],
+ "enum": [
+ "VALUE_TYPE_UNSPECIFIED",
+ "BOOL",
+ "INT64",
+ "DOUBLE",
+ "STRING",
+ "DISTRIBUTION",
+ "MONEY"
+ ],
+ "description": "Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.",
+ "type": "string"
}
},
"id": "MetricDescriptor"
@@ -706,6 +706,59 @@
"description": "An individual entry in a log.",
"type": "object",
"properties": {
+ "textPayload": {
+ "description": "The log entry payload, represented as a Unicode string (UTF-8).",
+ "type": "string"
+ },
+ "protoPayload": {
+ "description": "The log entry payload, represented as a protocol buffer. Some Google Cloud Platform services use this field for their log entry payloads.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "trace": {
+ "description": "Optional. Resource name of the trace associated with the log entry, if any. If it contains a relative resource name, the name is assumed to be relative to //tracing.googleapis.com. Example: projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824",
+ "type": "string"
+ },
+ "labels": {
+ "description": "Optional. A set of user-defined (key, value) data that provides additional information about the log entry.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "severity": {
+ "description": "Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT.",
+ "type": "string",
+ "enumDescriptions": [
+ "(0) The log entry has no assigned severity level.",
+ "(100) Debug or trace information.",
+ "(200) Routine information, such as ongoing status or performance.",
+ "(300) Normal but significant events, such as start up, shut down, or a configuration change.",
+ "(400) Warning events might cause problems.",
+ "(500) Error events are likely to cause problems.",
+ "(600) Critical events cause more severe problems or outages.",
+ "(700) A person must take an action immediately.",
+ "(800) One or more systems are unusable."
+ ],
+ "enum": [
+ "DEFAULT",
+ "DEBUG",
+ "INFO",
+ "NOTICE",
+ "WARNING",
+ "ERROR",
+ "CRITICAL",
+ "ALERT",
+ "EMERGENCY"
+ ]
+ },
+ "sourceLocation": {
+ "description": "Optional. Source code location information associated with the log entry, if any.",
+ "$ref": "LogEntrySourceLocation"
+ },
"timestamp": {
"format": "google-datetime",
"description": "Optional. The time the event described by the log entry occurred. This time is used to compute the log entry's age and to enforce the logs retention period. If this field is omitted in a new log entry, then Stackdriver Logging assigns it the current time.Incoming log entries should have timestamps that are no more than the logs retention period in the past, and no more than 24 hours in the future. See the entries.write API method for more information.",
@@ -721,20 +774,20 @@
"type": "string"
},
"resource": {
- "$ref": "MonitoredResource",
- "description": "Required. The monitored resource associated with this log entry. Example: a log entry that reports a database error would be associated with the monitored resource designating the particular database that reported the error."
+ "description": "Required. The monitored resource associated with this log entry. Example: a log entry that reports a database error would be associated with the monitored resource designating the particular database that reported the error.",
+ "$ref": "MonitoredResource"
},
"httpRequest": {
- "description": "Optional. Information about the HTTP request associated with this log entry, if applicable.",
- "$ref": "HttpRequest"
+ "$ref": "HttpRequest",
+ "description": "Optional. Information about the HTTP request associated with this log entry, if applicable."
},
"jsonPayload": {
+ "description": "The log entry payload, represented as a structure that is expressed as a JSON object.",
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
- },
- "description": "The log entry payload, represented as a structure that is expressed as a JSON object.",
- "type": "object"
+ }
},
"operation": {
"description": "Optional. Information about an operation associated with the log entry, if applicable.",
@@ -743,68 +796,35 @@
"insertId": {
"description": "Optional. A unique identifier for the log entry. If you provide a value, then Stackdriver Logging considers other log entries in the same project, with the same timestamp, and with the same insert_id to be duplicates which can be removed. If omitted in new log entries, then Stackdriver Logging assigns its own unique identifier. The insert_id is also used to order log entries that have the same timestamp value.",
"type": "string"
- },
- "textPayload": {
- "description": "The log entry payload, represented as a Unicode string (UTF-8).",
- "type": "string"
- },
- "protoPayload": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "The log entry payload, represented as a protocol buffer. Some Google Cloud Platform services use this field for their log entry payloads.",
- "type": "object"
- },
- "trace": {
- "description": "Optional. Resource name of the trace associated with the log entry, if any. If it contains a relative resource name, the name is assumed to be relative to //tracing.googleapis.com. Example: projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824",
- "type": "string"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional. A set of user-defined (key, value) data that provides additional information about the log entry.",
- "type": "object"
- },
- "severity": {
- "enum": [
- "DEFAULT",
- "DEBUG",
- "INFO",
- "NOTICE",
- "WARNING",
- "ERROR",
- "CRITICAL",
- "ALERT",
- "EMERGENCY"
- ],
- "description": "Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT.",
- "type": "string",
- "enumDescriptions": [
- "(0) The log entry has no assigned severity level.",
- "(100) Debug or trace information.",
- "(200) Routine information, such as ongoing status or performance.",
- "(300) Normal but significant events, such as start up, shut down, or a configuration change.",
- "(400) Warning events might cause problems.",
- "(500) Error events are likely to cause problems.",
- "(600) Critical events cause more severe problems or outages.",
- "(700) A person must take an action immediately.",
- "(800) One or more systems are unusable."
- ]
- },
- "sourceLocation": {
- "description": "Optional. Source code location information associated with the log entry, if any.",
- "$ref": "LogEntrySourceLocation"
}
},
"id": "LogEntry"
},
"RequestLog": {
- "id": "RequestLog",
"description": "Complete log information about a single HTTP request to an App Engine application.",
"type": "object",
"properties": {
+ "latency": {
+ "format": "google-duration",
+ "description": "Latency of the request.",
+ "type": "string"
+ },
+ "ip": {
+ "description": "Origin IP address.",
+ "type": "string"
+ },
+ "appId": {
+ "description": "Application that handled this request.",
+ "type": "string"
+ },
+ "appEngineRelease": {
+ "description": "App Engine release version.",
+ "type": "string"
+ },
+ "method": {
+ "description": "Request method. Example: \"GET\", \"HEAD\", \"PUT\", \"POST\", \"DELETE\".",
+ "type": "string"
+ },
"cost": {
"format": "double",
"description": "An indication of the relative cost of serving this request.",
@@ -845,11 +865,11 @@
"type": "boolean"
},
"sourceReference": {
+ "description": "Source code for the application that handled this request. There can be more than one source reference per deployed application if source code is distributed among multiple repositories.",
"items": {
"$ref": "SourceReference"
},
- "type": "array",
- "description": "Source code for the application that handled this request. There can be more than one source reference per deployed application if source code is distributed among multiple repositories."
+ "type": "array"
},
"responseSize": {
"format": "int64",
@@ -867,17 +887,17 @@
},
"type": "array"
},
- "taskQueueName": {
- "description": "Queue name of the request, in the case of an offline request.",
- "type": "string"
- },
"referrer": {
"description": "Referrer URL of request.",
"type": "string"
},
+ "taskQueueName": {
+ "description": "Queue name of the request, in the case of an offline request.",
+ "type": "string"
+ },
"requestId": {
- "type": "string",
- "description": "Globally unique identifier for a request, which is based on the request start time. Request IDs for requests which started later will compare greater as strings than those for requests which started earlier."
+ "description": "Globally unique identifier for a request, which is based on the request start time. Request IDs for requests which started later will compare greater as strings than those for requests which started earlier.",
+ "type": "string"
},
"nickname": {
"description": "The logged-in user who made the request.Most likely, this is the part of the user's email before the @ sign. The field value is the same for different requests from the same user, but different users can have similar names. This information is also available to the application via the App Engine Users API.This field will be populated starting with App Engine 1.9.21.",
@@ -888,15 +908,15 @@
"description": "Time this request spent in the pending request queue.",
"type": "string"
},
- "resource": {
- "description": "Contains the path and query portion of the URL that was requested. For example, if the URL was \"http://example.com/app?name=val\", the resource would be \"/app?name=val\". The fragment identifier, which is identified by the # character, is not included.",
- "type": "string"
- },
"status": {
"format": "int32",
"description": "HTTP response status code. Example: 200, 404.",
"type": "integer"
},
+ "resource": {
+ "description": "Contains the path and query portion of the URL that was requested. For example, if the URL was \"http://example.com/app?name=val\", the resource would be \"/app?name=val\". The fragment identifier, which is identified by the # character, is not included.",
+ "type": "string"
+ },
"taskName": {
"description": "Task name of the request, in the case of an offline request.",
"type": "string"
@@ -926,36 +946,16 @@
"format": "google-datetime",
"description": "Time when the request started.",
"type": "string"
- },
- "latency": {
- "format": "google-duration",
- "description": "Latency of the request.",
- "type": "string"
- },
- "ip": {
- "type": "string",
- "description": "Origin IP address."
- },
- "appId": {
- "description": "Application that handled this request.",
- "type": "string"
- },
- "appEngineRelease": {
- "description": "App Engine release version.",
- "type": "string"
- },
- "method": {
- "description": "Request method. Example: \"GET\", \"HEAD\", \"PUT\", \"POST\", \"DELETE\".",
- "type": "string"
}
- }
+ },
+ "id": "RequestLog"
}
},
+ "protocol": "rest",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
- "protocol": "rest",
"canonicalName": "Logging",
"auth": {
"oauth2": {
@@ -990,55 +990,163 @@
"resources": {
"sinks": {
"methods": {
- "create": {
- "id": "logging.projects.sinks.create",
- "path": "v2beta1/{+parent}/sinks",
- "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.",
- "request": {
- "$ref": "LogSink"
- },
+ "get": {
+ "description": "Gets a sink.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "sinkName"
+ ],
"response": {
"$ref": "LogSink"
},
+ "parameters": {
+ "sinkName": {
+ "location": "path",
+ "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/sinks/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/sinks/{sinksId}",
+ "path": "v2beta1/{+sinkName}",
+ "id": "logging.projects.sinks.get"
+ },
+ "list": {
+ "flatPath": "v2beta1/projects/{projectsId}/sinks",
+ "id": "logging.projects.sinks.list",
+ "path": "v2beta1/{+parent}/sinks",
+ "description": "Lists sinks.",
+ "response": {
+ "$ref": "ListSinksResponse"
+ },
"parameterOrder": [
"parent"
],
- "httpMethod": "POST",
+ "httpMethod": "GET",
"parameters": {
- "uniqueWriterIdentity": {
- "location": "query",
- "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
- "type": "boolean"
+ "pageSize": {
+ "format": "int32",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "type": "integer",
+ "location": "query"
},
"parent": {
- "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
+ "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+$",
"location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ]
+ },
+ "update": {
+ "request": {
+ "$ref": "LogSink"
+ },
+ "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "updateMask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.",
+ "type": "string"
+ },
+ "uniqueWriterIdentity": {
+ "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "sinkName": {
+ "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/sinks/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/sinks/{sinksId}",
+ "id": "logging.projects.sinks.update",
+ "path": "v2beta1/{+sinkName}"
+ },
+ "create": {
+ "request": {
+ "$ref": "LogSink"
+ },
+ "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "LogSink"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
],
- "flatPath": "v2beta1/projects/{projectsId}/sinks"
+ "parameters": {
+ "uniqueWriterIdentity": {
+ "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "parent": {
+ "location": "path",
+ "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/sinks",
+ "path": "v2beta1/{+parent}/sinks",
+ "id": "logging.projects.sinks.create"
},
"delete": {
+ "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.",
"httpMethod": "DELETE",
- "parameterOrder": [
- "sinkName"
- ],
"response": {
"$ref": "Empty"
},
+ "parameterOrder": [
+ "sinkName"
+ ],
"parameters": {
"sinkName": {
- "location": "path",
"description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+/sinks/[^/]+$"
+ "pattern": "^projects/[^/]+/sinks/[^/]+$",
+ "location": "path"
}
},
"scopes": [
@@ -1047,46 +1155,50 @@
],
"flatPath": "v2beta1/projects/{projectsId}/sinks/{sinksId}",
"path": "v2beta1/{+sinkName}",
- "id": "logging.projects.sinks.delete",
- "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted."
- },
- "get": {
- "description": "Gets a sink.",
+ "id": "logging.projects.sinks.delete"
+ }
+ }
+ },
+ "logs": {
+ "methods": {
+ "delete": {
+ "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.",
"response": {
- "$ref": "LogSink"
+ "$ref": "Empty"
},
"parameterOrder": [
- "sinkName"
+ "logName"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
+ "httpMethod": "DELETE",
"parameters": {
- "sinkName": {
- "pattern": "^projects/[^/]+/sinks/[^/]+$",
- "location": "path",
- "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "logName": {
+ "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
"type": "string",
- "required": true
+ "required": true,
+ "pattern": "^projects/[^/]+/logs/[^/]+$",
+ "location": "path"
}
},
- "flatPath": "v2beta1/projects/{projectsId}/sinks/{sinksId}",
- "id": "logging.projects.sinks.get",
- "path": "v2beta1/{+sinkName}"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/logs/{logsId}",
+ "id": "logging.projects.logs.delete",
+ "path": "v2beta1/{+logName}"
},
"list": {
- "description": "Lists sinks.",
- "httpMethod": "GET",
+ "flatPath": "v2beta1/projects/{projectsId}/logs",
+ "id": "logging.projects.logs.list",
+ "path": "v2beta1/{+parent}/logs",
+ "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
"response": {
- "$ref": "ListSinksResponse"
+ "$ref": "ListLogsResponse"
},
"parameterOrder": [
"parent"
],
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
@@ -1100,96 +1212,187 @@
"location": "query"
},
"pageSize": {
- "location": "query",
"format": "int32",
"description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
},
"parent": {
- "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "location": "path",
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$"
+ }
+ }
+ }
+ }
+ },
+ "metrics": {
+ "methods": {
+ "delete": {
+ "flatPath": "v2beta1/projects/{projectsId}/metrics/{metricsId}",
+ "id": "logging.projects.metrics.delete",
+ "path": "v2beta1/{+metricName}",
+ "description": "Deletes a logs-based metric.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "metricName"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.write"
+ ],
+ "parameters": {
+ "metricName": {
+ "description": "The resource name of the metric to delete:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/metrics/[^/]+$",
+ "location": "path"
+ }
+ }
+ },
+ "get": {
+ "description": "Gets a logs-based metric.",
+ "response": {
+ "$ref": "LogMetric"
+ },
+ "parameterOrder": [
+ "metricName"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "metricName": {
+ "location": "path",
+ "description": "The resource name of the desired metric:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/metrics/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/metrics/{metricsId}",
+ "id": "logging.projects.metrics.get",
+ "path": "v2beta1/{+metricName}"
+ },
+ "list": {
+ "description": "Lists logs-based metrics.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListLogMetricsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "pageSize": {
+ "format": "int32",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "description": "Required. The name of the project containing the metrics:\n\"projects/[PROJECT_ID]\"\n",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/metrics",
+ "path": "v2beta1/{+parent}/metrics",
+ "id": "logging.projects.metrics.list"
+ },
+ "update": {
+ "request": {
+ "$ref": "LogMetric"
+ },
+ "description": "Creates or updates a logs-based metric.",
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "metricName"
+ ],
+ "response": {
+ "$ref": "LogMetric"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.write"
+ ],
+ "parameters": {
+ "metricName": {
+ "description": "The resource name of the metric to update:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\nThe updated metric must be provided in the request and it's name field must be the same as [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a new metric is created.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/metrics/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/metrics/{metricsId}",
+ "path": "v2beta1/{+metricName}",
+ "id": "logging.projects.metrics.update"
+ },
+ "create": {
+ "response": {
+ "$ref": "LogMetric"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.write"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "The resource name of the project in which to create the metric:\n\"projects/[PROJECT_ID]\"\nThe new metric must be provided in the request.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+$",
"location": "path"
}
},
- "flatPath": "v2beta1/projects/{projectsId}/sinks",
- "path": "v2beta1/{+parent}/sinks",
- "id": "logging.projects.sinks.list"
- },
- "update": {
- "response": {
- "$ref": "LogSink"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "updateMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.",
- "type": "string"
- },
- "uniqueWriterIdentity": {
- "location": "query",
- "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
- "type": "boolean"
- },
- "sinkName": {
- "location": "path",
- "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/sinks/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/sinks/{sinksId}",
- "id": "logging.projects.sinks.update",
- "path": "v2beta1/{+sinkName}",
- "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
+ "flatPath": "v2beta1/projects/{projectsId}/metrics",
+ "id": "logging.projects.metrics.create",
+ "path": "v2beta1/{+parent}/metrics",
"request": {
- "$ref": "LogSink"
- }
+ "$ref": "LogMetric"
+ },
+ "description": "Creates a logs-based metric."
}
}
- },
+ }
+ }
+ },
+ "billingAccounts": {
+ "resources": {
"logs": {
"methods": {
- "delete": {
- "id": "logging.projects.logs.delete",
- "path": "v2beta1/{+logName}",
- "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "logName"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "logName": {
- "location": "path",
- "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/logs/[^/]+$"
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/logs/{logsId}"
- },
"list": {
- "path": "v2beta1/{+parent}/logs",
- "id": "logging.projects.logs.list",
"description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
"httpMethod": "GET",
"parameterOrder": [
@@ -1206,72 +1409,6 @@
],
"parameters": {
"pageSize": {
- "format": "int32",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/logs"
- }
- }
- },
- "metrics": {
- "methods": {
- "get": {
- "description": "Gets a logs-based metric.",
- "httpMethod": "GET",
- "parameterOrder": [
- "metricName"
- ],
- "response": {
- "$ref": "LogMetric"
- },
- "parameters": {
- "metricName": {
- "description": "The resource name of the desired metric:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/metrics/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/metrics/{metricsId}",
- "path": "v2beta1/{+metricName}",
- "id": "logging.projects.metrics.get"
- },
- "list": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "parameters": {
- "pageToken": {
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
"location": "query",
"format": "int32",
"description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
@@ -1279,120 +1416,23 @@
},
"parent": {
"location": "path",
- "description": "Required. The name of the project containing the metrics:\n\"projects/[PROJECT_ID]\"\n",
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+$"
+ "pattern": "^billingAccounts/[^/]+$"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
}
},
- "flatPath": "v2beta1/projects/{projectsId}/metrics",
- "id": "logging.projects.metrics.list",
- "path": "v2beta1/{+parent}/metrics",
- "description": "Lists logs-based metrics.",
- "response": {
- "$ref": "ListLogMetricsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET"
- },
- "update": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.write"
- ],
- "parameters": {
- "metricName": {
- "pattern": "^projects/[^/]+/metrics/[^/]+$",
- "location": "path",
- "description": "The resource name of the metric to update:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\nThe updated metric must be provided in the request and it's name field must be the same as [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a new metric is created.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/metrics/{metricsId}",
- "path": "v2beta1/{+metricName}",
- "id": "logging.projects.metrics.update",
- "request": {
- "$ref": "LogMetric"
- },
- "description": "Creates or updates a logs-based metric.",
- "httpMethod": "PUT",
- "parameterOrder": [
- "metricName"
- ],
- "response": {
- "$ref": "LogMetric"
- }
- },
- "create": {
- "flatPath": "v2beta1/projects/{projectsId}/metrics",
- "id": "logging.projects.metrics.create",
- "path": "v2beta1/{+parent}/metrics",
- "request": {
- "$ref": "LogMetric"
- },
- "description": "Creates a logs-based metric.",
- "response": {
- "$ref": "LogMetric"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.write"
- ],
- "parameters": {
- "parent": {
- "location": "path",
- "description": "The resource name of the project in which to create the metric:\n\"projects/[PROJECT_ID]\"\nThe new metric must be provided in the request.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$"
- }
- }
+ "flatPath": "v2beta1/billingAccounts/{billingAccountsId}/logs",
+ "path": "v2beta1/{+parent}/logs",
+ "id": "logging.billingAccounts.logs.list"
},
"delete": {
- "description": "Deletes a logs-based metric.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "metricName"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.write"
- ],
- "parameters": {
- "metricName": {
- "pattern": "^projects/[^/]+/metrics/[^/]+$",
- "location": "path",
- "description": "The resource name of the metric to delete:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/metrics/{metricsId}",
- "path": "v2beta1/{+metricName}",
- "id": "logging.projects.metrics.delete"
- }
- }
- }
- }
- },
- "billingAccounts": {
- "resources": {
- "logs": {
- "methods": {
- "delete": {
+ "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.",
"response": {
"$ref": "Empty"
},
@@ -1400,62 +1440,22 @@
"logName"
],
"httpMethod": "DELETE",
- "parameters": {
- "logName": {
- "pattern": "^billingAccounts/[^/]+/logs/[^/]+$",
- "location": "path",
- "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
- "type": "string",
- "required": true
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
],
- "flatPath": "v2beta1/billingAccounts/{billingAccountsId}/logs/{logsId}",
- "id": "logging.billingAccounts.logs.delete",
- "path": "v2beta1/{+logName}",
- "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted."
- },
- "list": {
- "response": {
- "$ref": "ListLogsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
"parameters": {
- "pageToken": {
- "location": "query",
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string"
- },
- "pageSize": {
- "format": "int32",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "location": "path",
- "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "logName": {
+ "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
"type": "string",
"required": true,
- "pattern": "^billingAccounts/[^/]+$"
+ "pattern": "^billingAccounts/[^/]+/logs/[^/]+$",
+ "location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2beta1/billingAccounts/{billingAccountsId}/logs",
- "id": "logging.billingAccounts.logs.list",
- "path": "v2beta1/{+parent}/logs",
- "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed."
+ "flatPath": "v2beta1/billingAccounts/{billingAccountsId}/logs/{logsId}",
+ "id": "logging.billingAccounts.logs.delete",
+ "path": "v2beta1/{+logName}"
}
}
}
@@ -1470,17 +1470,11 @@
},
"parameterOrder": [],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
"parameters": {
"pageToken": {
+ "location": "query",
"description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pageSize": {
"format": "int32",
@@ -1489,6 +1483,12 @@
"location": "query"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
"flatPath": "v2beta1/monitoredResourceDescriptors",
"id": "logging.monitoredResourceDescriptors.list",
"path": "v2beta1/monitoredResourceDescriptors"
@@ -1500,30 +1500,30 @@
"logs": {
"methods": {
"delete": {
+ "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "logName"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "logName": {
+ "location": "path",
+ "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+/logs/[^/]+$"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
],
- "parameters": {
- "logName": {
- "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+/logs/[^/]+$",
- "location": "path"
- }
- },
"flatPath": "v2beta1/organizations/{organizationsId}/logs/{logsId}",
- "id": "logging.organizations.logs.delete",
"path": "v2beta1/{+logName}",
- "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "logName"
- ],
- "httpMethod": "DELETE"
+ "id": "logging.organizations.logs.delete"
},
"list": {
"flatPath": "v2beta1/organizations/{organizationsId}/logs",
@@ -1538,23 +1538,23 @@
],
"httpMethod": "GET",
"parameters": {
+ "pageSize": {
+ "format": "int32",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "location": "path",
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "type": "string",
+ "required": true,
+ "pattern": "^organizations/[^/]+$"
+ },
"pageToken": {
"location": "query",
"description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
"type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "type": "integer"
- },
- "parent": {
- "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "type": "string",
- "required": true,
- "pattern": "^organizations/[^/]+$",
- "location": "path"
}
},
"scopes": [
@@ -1572,17 +1572,17 @@
"methods": {
"list": {
"flatPath": "v2beta1/entries:list",
- "path": "v2beta1/entries:list",
"id": "logging.entries.list",
+ "path": "v2beta1/entries:list",
"description": "Lists log entries. Use this method to retrieve log entries from Stackdriver Logging. For ways to export log entries, see Exporting Logs.",
"request": {
"$ref": "ListLogEntriesRequest"
},
- "httpMethod": "POST",
- "parameterOrder": [],
"response": {
"$ref": "ListLogEntriesResponse"
},
+ "parameterOrder": [],
+ "httpMethod": "POST",
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
@@ -1592,38 +1592,38 @@
]
},
"write": {
- "httpMethod": "POST",
- "parameterOrder": [],
+ "request": {
+ "$ref": "WriteLogEntriesRequest"
+ },
+ "description": "Log entry resourcesWrites log entries to Stackdriver Logging. This API method is the only way to send log entries to Stackdriver Logging. This method is used, directly or indirectly, by the Stackdriver Logging agent (fluentd) and all logging libraries configured to use Stackdriver Logging.",
"response": {
"$ref": "WriteLogEntriesResponse"
},
- "parameters": {},
+ "parameterOrder": [],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.write"
],
+ "parameters": {},
"flatPath": "v2beta1/entries:write",
- "path": "v2beta1/entries:write",
"id": "logging.entries.write",
- "description": "Log entry resourcesWrites log entries to Stackdriver Logging. This API method is the only way to send log entries to Stackdriver Logging. This method is used, directly or indirectly, by the Stackdriver Logging agent (fluentd) and all logging libraries configured to use Stackdriver Logging.",
- "request": {
- "$ref": "WriteLogEntriesRequest"
- }
+ "path": "v2beta1/entries:write"
}
}
}
},
"parameters": {
"bearer_token": {
- "location": "query",
"description": "OAuth bearer token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
"type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
+ "location": "query"
},
"upload_protocol": {
"location": "query",
@@ -1631,20 +1631,25 @@
"type": "string"
},
"prettyPrint": {
- "default": "true",
- "type": "boolean",
"location": "query",
- "description": "Returns response with indentations and line breaks."
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean"
},
"fields": {
+ "location": "query",
"description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
},
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
},
"$.xgafv": {
"enumDescriptions": [
@@ -1659,11 +1664,6 @@
"description": "V1 error format.",
"type": "string"
},
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
"alt": {
"enum": [
"json",
@@ -1691,21 +1691,21 @@
"location": "query"
},
"quotaUser": {
- "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pp": {
+ "description": "Pretty-print response.",
"default": "true",
"type": "boolean",
- "location": "query",
- "description": "Pretty-print response."
+ "location": "query"
}
},
"version": "v2beta1",
"baseUrl": "https://logging.googleapis.com/",
- "servicePath": "",
- "description": "Writes log entries and manages your Stackdriver Logging configuration.",
"kind": "discovery#restDescription",
+ "description": "Writes log entries and manages your Stackdriver Logging configuration.",
+ "servicePath": "",
"basePath": ""
}
diff --git a/manufacturers/v1/manufacturers-api.json b/manufacturers/v1/manufacturers-api.json
index 7223da1..83aad1d 100644
--- a/manufacturers/v1/manufacturers-api.json
+++ b/manufacturers/v1/manufacturers-api.json
@@ -1,303 +1,99 @@
{
- "resources": {
- "accounts": {
- "resources": {
- "products": {
- "methods": {
- "get": {
- "response": {
- "$ref": "Product"
- },
- "parameterOrder": [
- "parent",
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "parent": {
- "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.",
- "type": "string",
- "required": true,
- "pattern": "^accounts/[^/]+$",
- "location": "path"
- },
- "name": {
- "description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.",
- "type": "string",
- "required": true,
- "pattern": "^[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/manufacturercenter"
- ],
- "flatPath": "v1/accounts/{accountsId}/products/{productsId}",
- "id": "manufacturers.accounts.products.get",
- "path": "v1/{+parent}/products/{+name}",
- "description": "Gets the product from a Manufacturer Center account, including product\nissues.\n\nA recently updated product takes around 15 minutes to process. Changes are\nonly visible after it has been processed. While some issues may be\navailable once the product has been processed, other issues may take days\nto appear."
- },
- "list": {
- "response": {
- "$ref": "ListProductsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/manufacturercenter"
- ],
- "parameters": {
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Maximum number of product statuses to return in the response, used for\npaging.",
- "type": "integer"
- },
- "parent": {
- "type": "string",
- "required": true,
- "pattern": "^accounts/[^/]+$",
- "location": "path",
- "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account."
- },
- "pageToken": {
- "description": "The token returned by the previous request.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1/accounts/{accountsId}/products",
- "id": "manufacturers.accounts.products.list",
- "path": "v1/{+parent}/products",
- "description": "Lists all the products in a Manufacturer Center account."
- },
- "update": {
- "parameters": {
- "name": {
- "description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.",
- "type": "string",
- "required": true,
- "pattern": "^[^/]+$",
- "location": "path"
- },
- "parent": {
- "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.",
- "type": "string",
- "required": true,
- "pattern": "^accounts/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/manufacturercenter"
- ],
- "flatPath": "v1/accounts/{accountsId}/products/{productsId}",
- "id": "manufacturers.accounts.products.update",
- "path": "v1/{+parent}/products/{+name}",
- "description": "Inserts or updates the product in a Manufacturer Center account.\n\nThe checks at upload time are minimal. All required attributes need to be\npresent for a product to be valid. Issues may show up later\nafter the API has accepted an update for a product and it is possible to\noverwrite an existing valid product with an invalid product. To detect\nthis, you should retrieve the product and check it for issues once the\nupdated version is available.\n\nInserted or updated products first need to be processed before they can be\nretrieved. Until then, new products will be unavailable, and retrieval\nof updated products will return the original state of the product.",
- "request": {
- "$ref": "Product"
- },
- "response": {
- "$ref": "Product"
- },
- "parameterOrder": [
- "parent",
- "name"
- ],
- "httpMethod": "PUT"
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "httpMethod": "DELETE",
- "parameterOrder": [
- "parent",
- "name"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/manufacturercenter"
- ],
- "parameters": {
- "parent": {
- "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.",
- "type": "string",
- "required": true,
- "pattern": "^accounts/[^/]+$",
- "location": "path"
- },
- "name": {
- "location": "path",
- "description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.",
- "type": "string",
- "required": true,
- "pattern": "^[^/]+$"
- }
- },
- "flatPath": "v1/accounts/{accountsId}/products/{productsId}",
- "id": "manufacturers.accounts.products.delete",
- "path": "v1/{+parent}/products/{+name}",
- "description": "Deletes the product from a Manufacturer Center account."
- }
- }
- }
- }
- }
- },
- "parameters": {
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "alt": {
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
- }
- },
- "version": "v1",
"baseUrl": "https://manufacturers.googleapis.com/",
"kind": "discovery#restDescription",
"description": "Public API for managing Manufacturer Center related data.",
"servicePath": "",
"basePath": "",
- "revision": "20171009",
+ "revision": "20171011",
"documentationLink": "https://developers.google.com/manufacturers/",
"id": "manufacturers:v1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
+ },
+ "Price": {
+ "description": "A price.",
+ "type": "object",
+ "properties": {
+ "amount": {
+ "description": "The numeric value of the price.",
+ "type": "string"
+ },
+ "currency": {
+ "description": "The currency in which the price is denoted.",
+ "type": "string"
+ }
+ },
+ "id": "Price"
+ },
+ "Image": {
+ "description": "An image.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "The type of the image, i.e., crawled or uploaded.\n@OutputOnly",
+ "type": "string",
+ "enumDescriptions": [
+ "Type is unspecified. Should not be used.",
+ "The image was crawled from a provided URL.",
+ "The image was uploaded."
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "CRAWLED",
+ "UPLOADED"
+ ]
+ },
+ "imageUrl": {
+ "description": "The URL of the image. For crawled images, this is the provided URL. For\nuploaded images, this is a serving URL from Google if the image has been\nprocessed successfully.",
+ "type": "string"
+ },
+ "status": {
+ "description": "The status of the image.\n@OutputOnly",
+ "type": "string",
+ "enumDescriptions": [
+ "The image status is unspecified. Should not be used.",
+ "The image was uploaded and is being processed.",
+ "The image crawl is still pending.",
+ "The image was processed and it meets the requirements.",
+ "The image URL is protected by robots.txt file and cannot be crawled.",
+ "The image URL is protected by X-Robots-Tag and cannot be crawled.",
+ "There was an error while crawling the image.",
+ "The image cannot be processed.",
+ "The image cannot be decoded.",
+ "The image is too big.",
+ "The image was manually overridden and will not be crawled.",
+ "The image crawl was postponed to avoid overloading the host.",
+ "The image URL returned a \"404 Not Found\" error."
+ ],
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "PENDING_PROCESSING",
+ "PENDING_CRAWL",
+ "OK",
+ "ROBOTED",
+ "XROBOTED",
+ "CRAWL_ERROR",
+ "PROCESSING_ERROR",
+ "DECODING_ERROR",
+ "TOO_BIG",
+ "CRAWL_SKIPPED",
+ "HOSTLOADED",
+ "HTTP_404"
+ ]
+ }
+ },
+ "id": "Image"
+ },
"Attributes": {
"description": "Attributes of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116.",
"type": "object",
"properties": {
- "productName": {
- "type": "string",
- "description": "The canonical name of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productname."
- },
- "sizeType": {
- "description": "The size type of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#sizetype.",
- "type": "string"
- },
- "suggestedRetailPrice": {
- "description": "The suggested retail price (MSRP) of the product. For more information,\nsee https://support.google.com/manufacturers/answer/6124116#price.",
- "$ref": "Price"
- },
- "featureDescription": {
- "description": "The rich format description of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#featuredesc.",
- "items": {
- "$ref": "FeatureDescription"
- },
- "type": "array"
- },
- "size": {
- "description": "The size of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#size.",
- "type": "string"
- },
- "title": {
- "description": "The title of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#title.",
- "type": "string"
- },
- "count": {
- "$ref": "Count",
- "description": "The count of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#count."
- },
- "brand": {
- "description": "The brand name of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#brand.",
- "type": "string"
- },
- "disclosureDate": {
- "description": "The disclosure date of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#disclosure.",
- "type": "string"
- },
- "material": {
- "description": "The material of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#material.",
- "type": "string"
- },
- "scent": {
- "description": "The scent of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#scent.",
- "type": "string"
- },
"ageGroup": {
"description": "The target age group of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#agegroup.",
"type": "string"
@@ -325,10 +121,6 @@
"description": "The release date of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#release.",
"type": "string"
},
- "itemGroupId": {
- "type": "string",
- "description": "The item group id of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#itemgroupid."
- },
"gtin": {
"description": "The Global Trade Item Number (GTIN) of the product. For more information,\nsee https://support.google.com/manufacturers/answer/6124116#gtin.",
"items": {
@@ -336,6 +128,10 @@
},
"type": "array"
},
+ "itemGroupId": {
+ "description": "The item group id of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#itemgroupid.",
+ "type": "string"
+ },
"productLine": {
"description": "The name of the group of products related to the product. For more\ninformation, see\nhttps://support.google.com/manufacturers/answer/6124116#productline.",
"type": "string"
@@ -353,8 +149,8 @@
"type": "string"
},
"sizeSystem": {
- "type": "string",
- "description": "The size system of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#sizesystem."
+ "description": "The size system of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#sizesystem.",
+ "type": "string"
},
"theme": {
"description": "The theme of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#theme.",
@@ -400,6 +196,53 @@
"color": {
"description": "The color of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#color.",
"type": "string"
+ },
+ "productName": {
+ "description": "The canonical name of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productname.",
+ "type": "string"
+ },
+ "sizeType": {
+ "description": "The size type of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#sizetype.",
+ "type": "string"
+ },
+ "suggestedRetailPrice": {
+ "description": "The suggested retail price (MSRP) of the product. For more information,\nsee https://support.google.com/manufacturers/answer/6124116#price.",
+ "$ref": "Price"
+ },
+ "featureDescription": {
+ "description": "The rich format description of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#featuredesc.",
+ "items": {
+ "$ref": "FeatureDescription"
+ },
+ "type": "array"
+ },
+ "size": {
+ "description": "The size of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#size.",
+ "type": "string"
+ },
+ "title": {
+ "description": "The title of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#title.",
+ "type": "string"
+ },
+ "count": {
+ "description": "The count of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#count.",
+ "$ref": "Count"
+ },
+ "brand": {
+ "description": "The brand name of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#brand.",
+ "type": "string"
+ },
+ "material": {
+ "description": "The material of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#material.",
+ "type": "string"
+ },
+ "disclosureDate": {
+ "description": "The disclosure date of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#disclosure.",
+ "type": "string"
+ },
+ "scent": {
+ "description": "The scent of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#scent.",
+ "type": "string"
}
},
"id": "Attributes"
@@ -421,11 +264,36 @@
"id": "Count"
},
"Product": {
+ "description": "Product data.",
"type": "object",
"properties": {
+ "productId": {
+ "description": "The ID of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#id.\n@OutputOnly",
+ "type": "string"
+ },
+ "uploadedAttributes": {
+ "description": "Attributes of the product uploaded via the Manufacturer Center API or via\nfeeds.",
+ "$ref": "Attributes"
+ },
+ "parent": {
+ "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.\n@OutputOnly",
+ "type": "string"
+ },
+ "manuallyProvidedAttributes": {
+ "description": "Attributes of the product provided manually via the Manufacturer Center UI.\n@OutputOnly",
+ "$ref": "Attributes"
+ },
+ "targetCountry": {
+ "description": "The target country of the product as a CLDR territory code (for example,\nUS).\n@OutputOnly",
+ "type": "string"
+ },
+ "contentLanguage": {
+ "description": "The content language of the product as a two-letter ISO 639-1 language code\n(for example, en).\n@OutputOnly",
+ "type": "string"
+ },
"name": {
- "type": "string",
- "description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.\n@OutputOnly"
+ "description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.\n@OutputOnly",
+ "type": "string"
},
"manuallyDeletedAttributes": {
"description": "Names of the attributes of the product deleted manually via the\nManufacturer Center UI.\n@OutputOnly",
@@ -442,36 +310,11 @@
"type": "array"
},
"finalAttributes": {
- "description": "Final attributes of the product. The final attributes are obtained by\noverriding the uploaded attributes with the manually provided and deleted\nattributes. Google systems only process, evaluate, review, and/or use final\nattributes.\n@OutputOnly",
- "$ref": "Attributes"
- },
- "productId": {
- "description": "The ID of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#id.\n@OutputOnly",
- "type": "string"
- },
- "uploadedAttributes": {
"$ref": "Attributes",
- "description": "Attributes of the product uploaded via the Manufacturer Center API or via\nfeeds."
- },
- "parent": {
- "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.\n@OutputOnly",
- "type": "string"
- },
- "manuallyProvidedAttributes": {
- "$ref": "Attributes",
- "description": "Attributes of the product provided manually via the Manufacturer Center UI.\n@OutputOnly"
- },
- "contentLanguage": {
- "description": "The content language of the product as a two-letter ISO 639-1 language code\n(for example, en).\n@OutputOnly",
- "type": "string"
- },
- "targetCountry": {
- "description": "The target country of the product as a CLDR territory code (for example,\nUS).\n@OutputOnly",
- "type": "string"
+ "description": "Final attributes of the product. The final attributes are obtained by\noverriding the uploaded attributes with the manually provided and deleted\nattributes. Google systems only process, evaluate, review, and/or use final\nattributes.\n@OutputOnly"
}
},
- "id": "Product",
- "description": "Product data."
+ "id": "Product"
},
"Capacity": {
"description": "The capacity of a product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#capacity.",
@@ -510,10 +353,6 @@
"description": "A product detail of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productdetail.",
"type": "object",
"properties": {
- "attributeValue": {
- "description": "The value of the attribute.",
- "type": "string"
- },
"sectionName": {
"description": "A short section name that can be reused between multiple product details.",
"type": "string"
@@ -521,6 +360,10 @@
"attributeName": {
"description": "The name of the attribute.",
"type": "string"
+ },
+ "attributeValue": {
+ "description": "The value of the attribute.",
+ "type": "string"
}
},
"id": "ProductDetail"
@@ -535,7 +378,6 @@
"type": "string"
},
"severity": {
- "type": "string",
"enumDescriptions": [
"Unspecified severity, never used.",
"Error severity. The issue prevents the usage of the whole item.",
@@ -548,7 +390,8 @@
"WARNING",
"INFO"
],
- "description": "The severity of the issue."
+ "description": "The severity of the issue.",
+ "type": "string"
},
"description": {
"description": "Description of the issue.",
@@ -570,8 +413,8 @@
"type": "object",
"properties": {
"image": {
- "description": "An optional image describing the feature.",
- "$ref": "Image"
+ "$ref": "Image",
+ "description": "An optional image describing the feature."
},
"headline": {
"description": "A short description of the feature.",
@@ -583,93 +426,13 @@
}
},
"id": "FeatureDescription"
- },
- "Empty": {
- "type": "object",
- "properties": {},
- "id": "Empty",
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`."
- },
- "Price": {
- "description": "A price.",
- "type": "object",
- "properties": {
- "amount": {
- "description": "The numeric value of the price.",
- "type": "string"
- },
- "currency": {
- "description": "The currency in which the price is denoted.",
- "type": "string"
- }
- },
- "id": "Price"
- },
- "Image": {
- "description": "An image.",
- "type": "object",
- "properties": {
- "type": {
- "enumDescriptions": [
- "Type is unspecified. Should not be used.",
- "The image was crawled from a provided URL.",
- "The image was uploaded."
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "CRAWLED",
- "UPLOADED"
- ],
- "description": "The type of the image, i.e., crawled or uploaded.\n@OutputOnly",
- "type": "string"
- },
- "imageUrl": {
- "description": "The URL of the image. For crawled images, this is the provided URL. For\nuploaded images, this is a serving URL from Google if the image has been\nprocessed successfully.",
- "type": "string"
- },
- "status": {
- "description": "The status of the image.\n@OutputOnly",
- "type": "string",
- "enumDescriptions": [
- "The image status is unspecified. Should not be used.",
- "The image was uploaded and is being processed.",
- "The image crawl is still pending.",
- "The image was processed and it meets the requirements.",
- "The image URL is protected by robots.txt file and cannot be crawled.",
- "The image URL is protected by X-Robots-Tag and cannot be crawled.",
- "There was an error while crawling the image.",
- "The image cannot be processed.",
- "The image cannot be decoded.",
- "The image is too big.",
- "The image was manually overridden and will not be crawled.",
- "The image crawl was postponed to avoid overloading the host.",
- "The image URL returned a \"404 Not Found\" error."
- ],
- "enum": [
- "STATUS_UNSPECIFIED",
- "PENDING_PROCESSING",
- "PENDING_CRAWL",
- "OK",
- "ROBOTED",
- "XROBOTED",
- "CRAWL_ERROR",
- "PROCESSING_ERROR",
- "DECODING_ERROR",
- "TOO_BIG",
- "CRAWL_SKIPPED",
- "HOSTLOADED",
- "HTTP_404"
- ]
- }
- },
- "id": "Image"
}
},
+ "protocol": "rest",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
- "protocol": "rest",
"canonicalName": "Manufacturer Center",
"auth": {
"oauth2": {
@@ -685,5 +448,242 @@
"name": "manufacturers",
"batchPath": "batch",
"title": "Manufacturer Center API",
- "ownerName": "Google"
+ "ownerName": "Google",
+ "resources": {
+ "accounts": {
+ "resources": {
+ "products": {
+ "methods": {
+ "delete": {
+ "flatPath": "v1/accounts/{accountsId}/products/{productsId}",
+ "id": "manufacturers.accounts.products.delete",
+ "path": "v1/{+parent}/products/{+name}",
+ "description": "Deletes the product from a Manufacturer Center account.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "parent",
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "parent": {
+ "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.",
+ "type": "string",
+ "required": true,
+ "pattern": "^accounts/[^/]+$",
+ "location": "path"
+ },
+ "name": {
+ "description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.",
+ "type": "string",
+ "required": true,
+ "pattern": "^[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/manufacturercenter"
+ ]
+ },
+ "get": {
+ "response": {
+ "$ref": "Product"
+ },
+ "parameterOrder": [
+ "parent",
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.",
+ "type": "string",
+ "required": true,
+ "pattern": "^[^/]+$",
+ "location": "path"
+ },
+ "parent": {
+ "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.",
+ "type": "string",
+ "required": true,
+ "pattern": "^accounts/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/manufacturercenter"
+ ],
+ "flatPath": "v1/accounts/{accountsId}/products/{productsId}",
+ "id": "manufacturers.accounts.products.get",
+ "path": "v1/{+parent}/products/{+name}",
+ "description": "Gets the product from a Manufacturer Center account, including product\nissues.\n\nA recently updated product takes around 15 minutes to process. Changes are\nonly visible after it has been processed. While some issues may be\navailable once the product has been processed, other issues may take days\nto appear."
+ },
+ "list": {
+ "response": {
+ "$ref": "ListProductsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/manufacturercenter"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "The token returned by the previous request.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Maximum number of product statuses to return in the response, used for\npaging.",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "location": "path",
+ "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.",
+ "type": "string",
+ "required": true,
+ "pattern": "^accounts/[^/]+$"
+ }
+ },
+ "flatPath": "v1/accounts/{accountsId}/products",
+ "id": "manufacturers.accounts.products.list",
+ "path": "v1/{+parent}/products",
+ "description": "Lists all the products in a Manufacturer Center account."
+ },
+ "update": {
+ "description": "Inserts or updates the product in a Manufacturer Center account.\n\nThe checks at upload time are minimal. All required attributes need to be\npresent for a product to be valid. Issues may show up later\nafter the API has accepted an update for a product and it is possible to\noverwrite an existing valid product with an invalid product. To detect\nthis, you should retrieve the product and check it for issues once the\nupdated version is available.\n\nInserted or updated products first need to be processed before they can be\nretrieved. Until then, new products will be unavailable, and retrieval\nof updated products will return the original state of the product.",
+ "request": {
+ "$ref": "Product"
+ },
+ "response": {
+ "$ref": "Product"
+ },
+ "parameterOrder": [
+ "parent",
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "name": {
+ "description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.",
+ "type": "string",
+ "required": true,
+ "pattern": "^[^/]+$",
+ "location": "path"
+ },
+ "parent": {
+ "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.",
+ "type": "string",
+ "required": true,
+ "pattern": "^accounts/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/manufacturercenter"
+ ],
+ "flatPath": "v1/accounts/{accountsId}/products/{productsId}",
+ "id": "manufacturers.accounts.products.update",
+ "path": "v1/{+parent}/products/{+name}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ }
+ },
+ "version": "v1"
}
diff --git a/ml/v1/ml-api.json b/ml/v1/ml-api.json
index e1d47ba..0a97cd4 100644
--- a/ml/v1/ml-api.json
+++ b/ml/v1/ml-api.json
@@ -1,14 +1,909 @@
{
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "resources": {
+ "jobs": {
+ "methods": {
+ "cancel": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "GoogleProtobuf__Empty"
+ },
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the job to cancel.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/jobs/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:cancel",
+ "path": "v1/{+name}:cancel",
+ "id": "ml.projects.jobs.cancel",
+ "description": "Cancels a running job.",
+ "request": {
+ "$ref": "GoogleCloudMlV1__CancelJobRequest"
+ }
+ },
+ "getIamPolicy": {
+ "id": "ml.projects.jobs.getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
+ "response": {
+ "$ref": "GoogleIamV1__Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/jobs/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:getIamPolicy"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "GoogleCloudMlV1__Job"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/jobs/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the job to get the description of.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}",
+ "path": "v1/{+name}",
+ "id": "ml.projects.jobs.get",
+ "description": "Describes a job."
+ },
+ "testIamPermissions": {
+ "request": {
+ "$ref": "GoogleIamV1__TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "GoogleIamV1__TestIamPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/jobs/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "ml.projects.jobs.testIamPermissions"
+ },
+ "list": {
+ "path": "v1/{+parent}/jobs",
+ "id": "ml.projects.jobs.list",
+ "description": "Lists the jobs in the project.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "GoogleCloudMlV1__ListJobsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required. The name of the project for which to list jobs.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "filter": {
+ "location": "query",
+ "description": "Optional. Specifies the subset of jobs to retrieve.",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Optional. A page token to request the next page of results.\n\nYou get the token from the `next_page_token` field of the response from\nthe previous call.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Optional. The number of jobs to retrieve per \"page\" of results. If there\nare more remaining results than this number, the response message will\ncontain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.",
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/jobs"
+ },
+ "setIamPolicy": {
+ "response": {
+ "$ref": "GoogleIamV1__Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/jobs/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:setIamPolicy",
+ "id": "ml.projects.jobs.setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "request": {
+ "$ref": "GoogleIamV1__SetIamPolicyRequest"
+ }
+ },
+ "create": {
+ "response": {
+ "$ref": "GoogleCloudMlV1__Job"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "description": "Required. The project name.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/jobs",
+ "id": "ml.projects.jobs.create",
+ "path": "v1/{+parent}/jobs",
+ "description": "Creates a training or a batch prediction job.",
+ "request": {
+ "$ref": "GoogleCloudMlV1__Job"
+ }
+ }
+ }
+ },
+ "models": {
+ "methods": {
+ "getIamPolicy": {
+ "id": "ml.projects.models.getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
+ "response": {
+ "$ref": "GoogleIamV1__Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/models/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}:getIamPolicy"
+ },
+ "patch": {
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "GoogleLongrunning__Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The project name.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/models/[^/]+$",
+ "location": "path"
+ },
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "Required. Specifies the path, relative to `Model`, of the field to update.\n\nFor example, to change the description of a model to \"foo\" and set its\ndefault version to \"version_1\", the `update_mask` parameter would be\nspecified as `description`, `default_version.name`, and the `PATCH`\nrequest body would specify the new value, as follows:\n {\n \"description\": \"foo\",\n \"defaultVersion\": {\n \"name\":\"version_1\"\n }\n }\nIn this example, the model is blindly overwritten since no etag is given.\n\nTo adopt etag mechanism, include `etag` field in the mask, and include the\n`etag` value in your model resource.\n\nCurrently the supported update masks are `description`,\n`default_version.name`, `labels`, and `etag`.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}",
+ "path": "v1/{+name}",
+ "id": "ml.projects.models.patch",
+ "request": {
+ "$ref": "GoogleCloudMlV1__Model"
+ },
+ "description": "Updates a specific model resource.\n\nCurrently the only supported fields to update are `description` and\n`default_version.name`."
+ },
+ "get": {
+ "id": "ml.projects.models.get",
+ "path": "v1/{+name}",
+ "description": "Gets information about a model, including its name, the description (if\nset), and the default version (if at least one version of the model has\nbeen deployed).",
+ "response": {
+ "$ref": "GoogleCloudMlV1__Model"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/models/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the model.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}"
+ },
+ "testIamPermissions": {
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "ml.projects.models.testIamPermissions",
+ "request": {
+ "$ref": "GoogleIamV1__TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "GoogleIamV1__TestIamPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/models/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}:testIamPermissions"
+ },
+ "delete": {
+ "response": {
+ "$ref": "GoogleLongrunning__Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/models/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the model.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}",
+ "id": "ml.projects.models.delete",
+ "path": "v1/{+name}",
+ "description": "Deletes a model.\n\nYou can only delete a model if there are no versions in it. You can delete\nversions by calling\n[projects.models.versions.delete](/ml-engine/reference/rest/v1/projects.models.versions/delete)."
+ },
+ "list": {
+ "response": {
+ "$ref": "GoogleCloudMlV1__ListModelsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. A page token to request the next page of results.\n\nYou get the token from the `next_page_token` field of the response from\nthe previous call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Optional. The number of models to retrieve per \"page\" of results. If there\nare more remaining results than this number, the response message will\ncontain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.",
+ "type": "integer"
+ },
+ "parent": {
+ "description": "Required. The name of the project whose models are to be listed.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/models",
+ "id": "ml.projects.models.list",
+ "path": "v1/{+parent}/models",
+ "description": "Lists the models in a project.\n\nEach project can contain multiple models, and each model can have multiple\nversions."
+ },
+ "setIamPolicy": {
+ "request": {
+ "$ref": "GoogleIamV1__SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "response": {
+ "$ref": "GoogleIamV1__Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/models/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}:setIamPolicy",
+ "id": "ml.projects.models.setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy"
+ },
+ "create": {
+ "id": "ml.projects.models.create",
+ "path": "v1/{+parent}/models",
+ "request": {
+ "$ref": "GoogleCloudMlV1__Model"
+ },
+ "description": "Creates a model which will later contain one or more versions.\n\nYou must add at least one version before you can request predictions from\nthe model. Add versions by calling\n[projects.models.versions.create](/ml-engine/reference/rest/v1/projects.models.versions/create).",
+ "response": {
+ "$ref": "GoogleCloudMlV1__Model"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required. The project name.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/models"
+ }
+ },
+ "resources": {
+ "versions": {
+ "methods": {
+ "patch": {
+ "request": {
+ "$ref": "GoogleCloudMlV1__Version"
+ },
+ "description": "Updates the specified Version resource.\n\nCurrently the only supported field to update is `description`.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "GoogleLongrunning__Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "updateMask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Required. Specifies the path, relative to `Version`, of the field to\nupdate. Must be present and non-empty.\n\nFor example, to change the description of a version to \"foo\", the\n`update_mask` parameter would be specified as `description`, and the\n`PATCH` request body would specify the new value, as follows:\n {\n \"description\": \"foo\"\n }\nIn this example, the version is blindly overwritten since no etag is given.\n\nTo adopt etag mechanism, include `etag` field in the mask, and include the\n`etag` value in your version resource.\n\nCurrently the only supported update masks are `description`, `labels`, and\n`etag`.",
+ "type": "string"
+ },
+ "name": {
+ "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the model.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}",
+ "path": "v1/{+name}",
+ "id": "ml.projects.models.versions.patch"
+ },
+ "get": {
+ "response": {
+ "$ref": "GoogleCloudMlV1__Version"
+ },
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the version.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}",
+ "id": "ml.projects.models.versions.get",
+ "path": "v1/{+name}",
+ "description": "Gets information about a model version.\n\nModels can have multiple versions. You can call\n[projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list)\nto get the same information that this method returns for all of the\nversions of a model."
+ },
+ "setDefault": {
+ "request": {
+ "$ref": "GoogleCloudMlV1__SetDefaultVersionRequest"
+ },
+ "description": "Designates a version to be the default for the model.\n\nThe default version is used for prediction requests made against the model\nthat don't specify a version.\n\nThe first version to be created for a model is automatically set as the\ndefault. You must make any subsequent changes to the default version\nsetting manually using this method.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "GoogleCloudMlV1__Version"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the version to make the default for the model. You\ncan get the names of all the versions of a model by calling\n[projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list).",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}:setDefault",
+ "path": "v1/{+name}:setDefault",
+ "id": "ml.projects.models.versions.setDefault"
+ },
+ "delete": {
+ "description": "Deletes a model version.\n\nEach model can have multiple versions deployed and in use at any given\ntime. Use this method to remove a single version.\n\nNote: You cannot delete the version that is set as the default version\nof the model unless it is the only remaining version.",
+ "response": {
+ "$ref": "GoogleLongrunning__Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the version. You can get the names of all the\nversions of a model by calling\n[projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list).",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}",
+ "id": "ml.projects.models.versions.delete",
+ "path": "v1/{+name}"
+ },
+ "list": {
+ "description": "Gets basic information about all the versions of a model.\n\nIf you expect that a model has a lot of versions, or if you need to handle\nonly a limited number of results at a time, you can request that the list\nbe retrieved in batches (called pages):",
+ "response": {
+ "$ref": "GoogleCloudMlV1__ListVersionsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. A page token to request the next page of results.\n\nYou get the token from the `next_page_token` field of the response from\nthe previous call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Optional. The number of versions to retrieve per \"page\" of results. If\nthere are more remaining results than this number, the response message\nwill contain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "pattern": "^projects/[^/]+/models/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the model for which to list the version.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions",
+ "id": "ml.projects.models.versions.list",
+ "path": "v1/{+parent}/versions"
+ },
+ "create": {
+ "response": {
+ "$ref": "GoogleLongrunning__Operation"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+/models/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the model.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions",
+ "id": "ml.projects.models.versions.create",
+ "path": "v1/{+parent}/versions",
+ "request": {
+ "$ref": "GoogleCloudMlV1__Version"
+ },
+ "description": "Creates a new version of a model from a trained TensorFlow model.\n\nIf the version created in the cloud by this call is the first deployed\nversion of the specified model, it will be made the default version of the\nmodel. When you add a version to a model that already has one or more\nversions, the default version does not automatically change. If you want a\nnew version to be the default, you must call\n[projects.models.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault)."
+ }
+ }
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "cancel": {
+ "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "GoogleProtobuf__Empty"
+ },
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/operations/[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource to be cancelled.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/operations/{operationsId}:cancel",
+ "path": "v1/{+name}:cancel",
+ "id": "ml.projects.operations.cancel"
+ },
+ "delete": {
+ "path": "v1/{+name}",
+ "id": "ml.projects.operations.delete",
+ "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "GoogleProtobuf__Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/operations/[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource to be deleted.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/operations/{operationsId}"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "GoogleLongrunning__Operation"
+ },
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/operations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/operations/{operationsId}",
+ "path": "v1/{+name}",
+ "id": "ml.projects.operations.get",
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
+ },
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "GoogleLongrunning__ListOperationsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "description": "The name of the operation's parent resource.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer",
+ "location": "query"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/operations",
+ "path": "v1/{+name}/operations",
+ "id": "ml.projects.operations.list",
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id."
+ }
+ }
+ }
+ },
+ "methods": {
+ "getConfig": {
+ "description": "Get the service account information associated with your project. You need\nthis information in order to grant the service account persmissions for\nthe Google Cloud Storage location where you put your model training code\nfor training the model with Google Cloud Machine Learning.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "GoogleCloudMlV1__GetConfigResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Required. The project name.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}:getConfig",
+ "path": "v1/{+name}:getConfig",
+ "id": "ml.projects.getConfig"
+ },
+ "predict": {
+ "id": "ml.projects.predict",
+ "path": "v1/{+name}:predict",
+ "request": {
+ "$ref": "GoogleCloudMlV1__PredictRequest"
+ },
+ "description": "Performs prediction on the data in the request.\n\n**** REMOVE FROM GENERATED DOCUMENTATION",
+ "response": {
+ "$ref": "GoogleApi__HttpBody"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/.+$",
+ "location": "path",
+ "description": "Required. The resource name of a model or a version.\n\nAuthorization: requires the `predict` permission on the specified resource.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}:predict"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://ml.googleapis.com/",
+ "servicePath": "",
+ "description": "An API to enable creating and using machine learning models.",
+ "kind": "discovery#restDescription",
"basePath": "",
- "id": "ml:v1",
- "documentationLink": "https://cloud.google.com/ml/",
"revision": "20170928",
+ "documentationLink": "https://cloud.google.com/ml/",
+ "id": "ml:v1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
"GoogleLongrunning__ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
@@ -22,7 +917,9 @@
"type": "array"
}
},
- "id": "GoogleLongrunning__ListOperationsResponse"
+ "id": "GoogleLongrunning__ListOperationsResponse",
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object"
},
"GoogleCloudMlV1__ManualScaling": {
"properties": {
@@ -59,9 +956,12 @@
"id": "GoogleIamV1__Binding"
},
"GoogleCloudMlV1__TrainingOutput": {
- "description": "Represents results of a training job. Output only.",
- "type": "object",
"properties": {
+ "consumedMLUnits": {
+ "format": "double",
+ "description": "The amount of ML units consumed by the job.",
+ "type": "number"
+ },
"trials": {
"description": "Results for individual Hyperparameter trials.\nOnly set for hyperparameter tuning jobs.",
"items": {
@@ -77,20 +977,17 @@
"isHyperparameterTuningJob": {
"description": "Whether this job is a hyperparameter tuning job.",
"type": "boolean"
- },
- "consumedMLUnits": {
- "format": "double",
- "description": "The amount of ML units consumed by the job.",
- "type": "number"
}
},
- "id": "GoogleCloudMlV1__TrainingOutput"
+ "id": "GoogleCloudMlV1__TrainingOutput",
+ "description": "Represents results of a training job. Output only.",
+ "type": "object"
},
"GoogleCloudMlV1__PredictRequest": {
"properties": {
"httpBody": {
- "$ref": "GoogleApi__HttpBody",
- "description": "\nRequired. The prediction request body."
+ "description": "\nRequired. The prediction request body.",
+ "$ref": "GoogleApi__HttpBody"
}
},
"id": "GoogleCloudMlV1__PredictRequest",
@@ -98,6 +995,8 @@
"type": "object"
},
"GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric": {
+ "description": "An observed value of a metric.",
+ "type": "object",
"properties": {
"objectiveValue": {
"format": "double",
@@ -110,28 +1009,18 @@
"type": "string"
}
},
- "id": "GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric",
- "description": "An observed value of a metric.",
- "type": "object"
+ "id": "GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric"
},
"GoogleCloudMlV1__Version": {
- "description": "Represents a version of the model.\n\nEach version is a trained model deployed in the cloud, ready to handle\nprediction requests. A model can have multiple versions. You can get\ninformation about all of the versions of a given model by calling\n[projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list).\n\nNext ID: 19\nLINT.IfChange",
- "type": "object",
"properties": {
- "isDefault": {
- "description": "Output only. If true, this version will be used to handle prediction\nrequests that do not specify a version.\n\nYou can change the default version by calling\n[projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault).",
- "type": "boolean"
- },
- "autoScaling": {
- "description": "Automatically scale the number of nodes used to serve the model in\nresponse to increases and decreases in traffic. Care should be\ntaken to ramp up traffic according to the model's ability to scale\nor you will start seeing increases in latency and 429 response codes.",
- "$ref": "GoogleCloudMlV1__AutoScaling"
- },
- "createTime": {
- "format": "google-datetime",
- "description": "Output only. The time the version was created.",
- "type": "string"
- },
"state": {
+ "enumDescriptions": [
+ "The version state is unspecified.",
+ "The version is ready for prediction.",
+ "The version is in the process of creation.",
+ "The version failed to be created, possibly cancelled.\n`error_message` should contain the details of the failure.",
+ "The version is in the process of deletion."
+ ],
"enum": [
"UNKNOWN",
"READY",
@@ -140,18 +1029,11 @@
"DELETING"
],
"description": "Output only. The state of a version.",
- "type": "string",
- "enumDescriptions": [
- "The version state is unspecified.",
- "The version is ready for prediction.",
- "The version is in the process of creation.",
- "The version failed to be created, possibly cancelled.\n`error_message` should contain the details of the failure.",
- "The version is in the process of deletion."
- ]
+ "type": "string"
},
"manualScaling": {
- "$ref": "GoogleCloudMlV1__ManualScaling",
- "description": "Manually select the number of nodes to use for serving the\nmodel. You should generally use `auto_scaling` with an appropriate\n`min_nodes` instead, but this option is available if you want more\npredictable billing. Beware that latency and error rates will increase\nif the traffic exceeds that capability of the system to serve it based\non the selected number of nodes."
+ "description": "Manually select the number of nodes to use for serving the\nmodel. You should generally use `auto_scaling` with an appropriate\n`min_nodes` instead, but this option is available if you want more\npredictable billing. Beware that latency and error rates will increase\nif the traffic exceeds that capability of the system to serve it based\non the selected number of nodes.",
+ "$ref": "GoogleCloudMlV1__ManualScaling"
},
"name": {
"description": "Required.The name specified for the version when it was created.\n\nThe version name must be unique within the model it is created in.",
@@ -161,29 +1043,68 @@
"description": "Output only. The details of a failure or a cancellation.",
"type": "string"
},
+ "runtimeVersion": {
+ "description": "Optional. The Google Cloud ML runtime version to use for this deployment.\nIf not set, Google Cloud ML will choose a version.",
+ "type": "string"
+ },
"lastUseTime": {
"format": "google-datetime",
"description": "Output only. The time the version was last used for prediction.",
"type": "string"
},
- "runtimeVersion": {
- "description": "Optional. The Google Cloud ML runtime version to use for this deployment.\nIf not set, Google Cloud ML will choose a version.",
- "type": "string"
- },
"description": {
"description": "Optional. The description specified for the version when it was created.",
"type": "string"
},
"deploymentUri": {
- "type": "string",
- "description": "Required. The Google Cloud Storage location of the trained model used to\ncreate the version. See the\n[overview of model\ndeployment](/ml-engine/docs/concepts/deployment-overview) for more\ninformation.\n\nWhen passing Version to\n[projects.models.versions.create](/ml-engine/reference/rest/v1/projects.models.versions/create)\nthe model service uses the specified location as the source of the model.\nOnce deployed, the model version is hosted by the prediction service, so\nthis location is useful only as a historical record.\nThe total number of model files can't exceed 1000."
+ "description": "Required. The Google Cloud Storage location of the trained model used to\ncreate the version. See the\n[overview of model\ndeployment](/ml-engine/docs/concepts/deployment-overview) for more\ninformation.\n\nWhen passing Version to\n[projects.models.versions.create](/ml-engine/reference/rest/v1/projects.models.versions/create)\nthe model service uses the specified location as the source of the model.\nOnce deployed, the model version is hosted by the prediction service, so\nthis location is useful only as a historical record.\nThe total number of model files can't exceed 1000.",
+ "type": "string"
+ },
+ "autoScaling": {
+ "description": "Automatically scale the number of nodes used to serve the model in\nresponse to increases and decreases in traffic. Care should be\ntaken to ramp up traffic according to the model's ability to scale\nor you will start seeing increases in latency and 429 response codes.",
+ "$ref": "GoogleCloudMlV1__AutoScaling"
+ },
+ "isDefault": {
+ "description": "Output only. If true, this version will be used to handle prediction\nrequests that do not specify a version.\n\nYou can change the default version by calling\n[projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault).",
+ "type": "boolean"
+ },
+ "createTime": {
+ "format": "google-datetime",
+ "description": "Output only. The time the version was created.",
+ "type": "string"
}
},
- "id": "GoogleCloudMlV1__Version"
+ "id": "GoogleCloudMlV1__Version",
+ "description": "Represents a version of the model.\n\nEach version is a trained model deployed in the cloud, ready to handle\nprediction requests. A model can have multiple versions. You can get\ninformation about all of the versions of a given model by calling\n[projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list).\n\nNext ID: 19\nLINT.IfChange",
+ "type": "object"
},
"GoogleCloudMlV1__ParameterSpec": {
"properties": {
+ "minValue": {
+ "format": "double",
+ "description": "Required if type is `DOUBLE` or `INTEGER`. This field\nshould be unset if type is `CATEGORICAL`. This value should be integers if\ntype is INTEGER.",
+ "type": "number"
+ },
+ "discreteValues": {
+ "description": "Required if type is `DISCRETE`.\nA list of feasible points.\nThe list should be in strictly increasing order. For instance, this\nparameter might have possible settings of 1.5, 2.5, and 4.0. This list\nshould not contain more than 1,000 values.",
+ "items": {
+ "format": "double",
+ "type": "number"
+ },
+ "type": "array"
+ },
+ "maxValue": {
+ "format": "double",
+ "description": "Required if typeis `DOUBLE` or `INTEGER`. This field\nshould be unset if type is `CATEGORICAL`. This value should be integers if\ntype is `INTEGER`.",
+ "type": "number"
+ },
"scaleType": {
+ "enum": [
+ "NONE",
+ "UNIT_LINEAR_SCALE",
+ "UNIT_LOG_SCALE",
+ "UNIT_REVERSE_LOG_SCALE"
+ ],
"description": "Optional. How the parameter should be scaled to the hypercube.\nLeave unset for categorical parameters.\nSome kind of scaling is strongly recommended for real or integral\nparameters (e.g., `UNIT_LINEAR_SCALE`).",
"type": "string",
"enumDescriptions": [
@@ -191,19 +1112,8 @@
"Scales the feasible space to (0, 1) linearly.",
"Scales the feasible space logarithmically to (0, 1). The entire feasible\nspace must be strictly positive.",
"Scales the feasible space \"reverse\" logarithmically to (0, 1). The result\nis that values close to the top of the feasible space are spread out more\nthan points near the bottom. The entire feasible space must be strictly\npositive."
- ],
- "enum": [
- "NONE",
- "UNIT_LINEAR_SCALE",
- "UNIT_LOG_SCALE",
- "UNIT_REVERSE_LOG_SCALE"
]
},
- "maxValue": {
- "format": "double",
- "description": "Required if typeis `DOUBLE` or `INTEGER`. This field\nshould be unset if type is `CATEGORICAL`. This value should be integers if\ntype is `INTEGER`.",
- "type": "number"
- },
"type": {
"enumDescriptions": [
"You must specify a valid type. Using this unspecified type will result in\nan error.",
@@ -232,19 +1142,6 @@
"parameterName": {
"description": "Required. The parameter name must be unique amongst all ParameterConfigs in\na HyperparameterSpec message. E.g., \"learning_rate\".",
"type": "string"
- },
- "minValue": {
- "format": "double",
- "description": "Required if type is `DOUBLE` or `INTEGER`. This field\nshould be unset if type is `CATEGORICAL`. This value should be integers if\ntype is INTEGER.",
- "type": "number"
- },
- "discreteValues": {
- "description": "Required if type is `DISCRETE`.\nA list of feasible points.\nThe list should be in strictly increasing order. For instance, this\nparameter might have possible settings of 1.5, 2.5, and 4.0. This list\nshould not contain more than 1,000 values.",
- "items": {
- "format": "double",
- "type": "number"
- },
- "type": "array"
}
},
"id": "GoogleCloudMlV1__ParameterSpec",
@@ -252,25 +1149,7 @@
"type": "object"
},
"GoogleCloudMlV1__PredictionInput": {
- "description": "Represents input parameters for a prediction job.",
- "type": "object",
"properties": {
- "runtimeVersion": {
- "description": "Optional. The Google Cloud ML runtime version to use for this batch\nprediction. If not set, Google Cloud ML will pick the runtime version used\nduring the CreateVersion request for this model version, or choose the\nlatest stable version when model version information is not available\nsuch as when the model is specified by uri.",
- "type": "string"
- },
- "batchSize": {
- "format": "int64",
- "description": "Optional. Number of records per batch, defaults to 64.\nThe service will buffer batch_size number of records in memory before\ninvoking one Tensorflow prediction call internally. So take the record\nsize and memory available into consideration when setting this parameter.",
- "type": "string"
- },
- "inputPaths": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "Required. The Google Cloud Storage location of the input data files.\nMay contain wildcards."
- },
"region": {
"description": "Required. The Google Compute Engine region to run the prediction job in.",
"type": "string"
@@ -287,15 +1166,15 @@
"description": "Required. The output Google Cloud Storage location.",
"type": "string"
},
- "uri": {
- "description": "Use this field if you want to specify a Google Cloud Storage path for\nthe model to use.",
- "type": "string"
- },
"maxWorkerCount": {
"format": "int64",
"description": "Optional. The maximum number of workers to be used for parallel processing.\nDefaults to 10 if not specified.",
"type": "string"
},
+ "uri": {
+ "description": "Use this field if you want to specify a Google Cloud Storage path for\nthe model to use.",
+ "type": "string"
+ },
"dataFormat": {
"enumDescriptions": [
"Unspecified format.",
@@ -311,18 +1190,30 @@
],
"description": "Required. The format of the input data files.",
"type": "string"
- }
- },
- "id": "GoogleCloudMlV1__PredictionInput"
- },
- "GoogleType__Expr": {
- "description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"",
- "type": "object",
- "properties": {
- "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.",
+ },
+ "batchSize": {
+ "format": "int64",
+ "description": "Optional. Number of records per batch, defaults to 64.\nThe service will buffer batch_size number of records in memory before\ninvoking one Tensorflow prediction call internally. So take the record\nsize and memory available into consideration when setting this parameter.",
"type": "string"
},
+ "runtimeVersion": {
+ "description": "Optional. The Google Cloud ML runtime version to use for this batch\nprediction. If not set, Google Cloud ML will pick the runtime version used\nduring the CreateVersion request for this model version, or choose the\nlatest stable version when model version information is not available\nsuch as when the model is specified by uri.",
+ "type": "string"
+ },
+ "inputPaths": {
+ "description": "Required. The Google Cloud Storage location of the input data files.\nMay contain wildcards.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "GoogleCloudMlV1__PredictionInput",
+ "description": "Represents input parameters for a prediction job.",
+ "type": "object"
+ },
+ "GoogleType__Expr": {
+ "properties": {
"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"
@@ -334,17 +1225,53 @@
"description": {
"description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
"type": "string"
+ },
+ "expression": {
+ "description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
+ "type": "string"
}
},
- "id": "GoogleType__Expr"
+ "id": "GoogleType__Expr",
+ "description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"",
+ "type": "object"
+ },
+ "GoogleIamV1__AuditLogConfig": {
+ "properties": {
+ "exemptedMembers": {
+ "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "logType": {
+ "enumDescriptions": [
+ "Default case. Should never be this.",
+ "Admin reads. Example: CloudIAM getIamPolicy",
+ "Data writes. Example: CloudSQL Users create",
+ "Data reads. Example: CloudSQL Users list"
+ ],
+ "enum": [
+ "LOG_TYPE_UNSPECIFIED",
+ "ADMIN_READ",
+ "DATA_WRITE",
+ "DATA_READ"
+ ],
+ "description": "The log type that this config enables.",
+ "type": "string"
+ }
+ },
+ "id": "GoogleIamV1__AuditLogConfig",
+ "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
+ "type": "object"
},
"GoogleCloudMlV1__OperationMetadata": {
"description": "Represents the metadata of the long-running operation.\n\nNext ID: 9",
"type": "object",
"properties": {
"version": {
- "description": "Contains the version associated with the operation.",
- "$ref": "GoogleCloudMlV1__Version"
+ "$ref": "GoogleCloudMlV1__Version",
+ "description": "Contains the version associated with the operation."
},
"endTime": {
"format": "google-datetime",
@@ -392,40 +1319,15 @@
},
"id": "GoogleCloudMlV1__OperationMetadata"
},
- "GoogleIamV1__AuditLogConfig": {
- "properties": {
- "exemptedMembers": {
- "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "logType": {
- "enumDescriptions": [
- "Default case. Should never be this.",
- "Admin reads. Example: CloudIAM getIamPolicy",
- "Data writes. Example: CloudSQL Users create",
- "Data reads. Example: CloudSQL Users list"
- ],
- "enum": [
- "LOG_TYPE_UNSPECIFIED",
- "ADMIN_READ",
- "DATA_WRITE",
- "DATA_READ"
- ],
- "description": "The log type that this config enables.",
- "type": "string"
- }
- },
- "id": "GoogleIamV1__AuditLogConfig",
- "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
- "type": "object"
- },
"GoogleCloudMlV1__HyperparameterSpec": {
"description": "Represents a set of hyperparameters to optimize.",
"type": "object",
"properties": {
+ "maxParallelTrials": {
+ "format": "int32",
+ "description": "Optional. The number of training trials to run concurrently.\nYou can reduce the time it takes to perform hyperparameter tuning by adding\ntrials in parallel. However, each trail only benefits from the information\ngained in completed trials. That means that a trial does not get access to\nthe results of trials running at the same time, which could reduce the\nquality of the overall optimization.\n\nEach trial will use the same scale tier and machine types.\n\nDefaults to one.",
+ "type": "integer"
+ },
"hyperparameterMetricTag": {
"description": "Optional. The Tensorflow summary tag name to use for optimizing trials. For\ncurrent versions of Tensorflow, this tag name should exactly match what is\nshown in Tensorboard, including all scopes. For versions of Tensorflow\nprior to 0.12, this should be only the tag passed to tf.Summary.\nBy default, \"training/hptuning/metric\" will be used.",
"type": "string"
@@ -450,16 +1352,11 @@
"type": "integer"
},
"params": {
+ "description": "Required. The set of parameters to tune.",
"items": {
"$ref": "GoogleCloudMlV1__ParameterSpec"
},
- "type": "array",
- "description": "Required. The set of parameters to tune."
- },
- "maxParallelTrials": {
- "format": "int32",
- "description": "Optional. The number of training trials to run concurrently.\nYou can reduce the time it takes to perform hyperparameter tuning by adding\ntrials in parallel. However, each trail only benefits from the information\ngained in completed trials. That means that a trial does not get access to\nthe results of trials running at the same time, which could reduce the\nquality of the overall optimization.\n\nEach trial will use the same scale tier and machine types.\n\nDefaults to one.",
- "type": "integer"
+ "type": "array"
}
},
"id": "GoogleCloudMlV1__HyperparameterSpec"
@@ -468,34 +1365,30 @@
"description": "Response message for the ListJobs method.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call.",
+ "type": "string"
+ },
"jobs": {
"description": "The list of jobs.",
"items": {
"$ref": "GoogleCloudMlV1__Job"
},
"type": "array"
- },
- "nextPageToken": {
- "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call.",
- "type": "string"
}
},
"id": "GoogleCloudMlV1__ListJobsResponse"
},
"GoogleCloudMlV1__SetDefaultVersionRequest": {
+ "properties": {},
"id": "GoogleCloudMlV1__SetDefaultVersionRequest",
"description": "Request message for the SetDefaultVersion request.",
- "type": "object",
- "properties": {}
+ "type": "object"
},
"GoogleLongrunning__Operation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"type": "object",
"properties": {
- "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.",
@@ -519,40 +1412,16 @@
},
"description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
"type": "object"
+ },
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
}
},
"id": "GoogleLongrunning__Operation"
},
- "GoogleIamV1__AuditConfig": {
- "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
- "type": "object",
- "properties": {
- "service": {
- "type": "string",
- "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services."
- },
- "auditLogConfigs": {
- "description": "The configuration for logging of each type of permission.\nNext ID: 4",
- "items": {
- "$ref": "GoogleIamV1__AuditLogConfig"
- },
- "type": "array"
- },
- "exemptedMembers": {
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "GoogleIamV1__AuditConfig"
- },
"GoogleCloudMlV1__Model": {
"properties": {
- "defaultVersion": {
- "$ref": "GoogleCloudMlV1__Version",
- "description": "Output only. The default version of the model. This version will be used to\nhandle prediction requests that do not specify a version.\n\nYou can change the default version by calling\n[projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault)."
- },
"regions": {
"description": "Optional. The list of regions where the model is going to be deployed.\nCurrently only one region per model is supported.\nDefaults to 'us-central1' if nothing is set.\nNote:\n* No matter where a model is deployed, it can always be accessed by\n users from anywhere, both for online and batch prediction.\n* The region for a batch prediction job is set by the region field when\n submitting the batch prediction job and does not take its value from\n this field.",
"items": {
@@ -571,17 +1440,45 @@
"onlinePredictionLogging": {
"description": "Optional. If true, enables StackDriver Logging for online prediction.\nDefault is false.",
"type": "boolean"
+ },
+ "defaultVersion": {
+ "description": "Output only. The default version of the model. This version will be used to\nhandle prediction requests that do not specify a version.\n\nYou can change the default version by calling\n[projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault).",
+ "$ref": "GoogleCloudMlV1__Version"
}
},
"id": "GoogleCloudMlV1__Model",
"description": "Represents a machine learning solution.\n\nA model can have multiple versions, each of which is a deployed, trained\nmodel ready to receive prediction requests. The model itself is just a\ncontainer.\n\nNext ID: 8",
"type": "object"
},
- "GoogleProtobuf__Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "GoogleIamV1__AuditConfig": {
+ "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
"type": "object",
+ "properties": {
+ "exemptedMembers": {
+ "items": {
+ "type": "string"
+ },
+ "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"
+ },
+ "auditLogConfigs": {
+ "description": "The configuration for logging of each type of permission.\nNext ID: 4",
+ "items": {
+ "$ref": "GoogleIamV1__AuditLogConfig"
+ },
+ "type": "array"
+ }
+ },
+ "id": "GoogleIamV1__AuditConfig"
+ },
+ "GoogleProtobuf__Empty": {
"properties": {},
- "id": "GoogleProtobuf__Empty"
+ "id": "GoogleProtobuf__Empty",
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object"
},
"GoogleIamV1__TestIamPermissionsRequest": {
"description": "Request message for `TestIamPermissions` method.",
@@ -597,29 +1494,56 @@
},
"id": "GoogleIamV1__TestIamPermissionsRequest"
},
- "GoogleCloudMlV1__CancelJobRequest": {
- "description": "Request message for the CancelJob method.",
- "type": "object",
- "properties": {},
- "id": "GoogleCloudMlV1__CancelJobRequest"
- },
"GoogleCloudMlV1__ListVersionsResponse": {
- "id": "GoogleCloudMlV1__ListVersionsResponse",
- "description": "Response message for the ListVersions method.",
- "type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call.",
+ "type": "string"
+ },
"versions": {
"description": "The list of versions.",
"items": {
"$ref": "GoogleCloudMlV1__Version"
},
"type": "array"
- },
- "nextPageToken": {
- "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call.",
- "type": "string"
}
- }
+ },
+ "id": "GoogleCloudMlV1__ListVersionsResponse",
+ "description": "Response message for the ListVersions method.",
+ "type": "object"
+ },
+ "GoogleCloudMlV1__CancelJobRequest": {
+ "description": "Request message for the CancelJob method.",
+ "type": "object",
+ "properties": {},
+ "id": "GoogleCloudMlV1__CancelJobRequest"
+ },
+ "GoogleRpc__Status": {
+ "properties": {
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "code": {
+ "format": "int32",
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "type": "integer"
+ }
+ },
+ "id": "GoogleRpc__Status",
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object"
},
"GoogleCloudMlV1__AutoScaling": {
"description": "Options for automatically scaling a model.",
@@ -633,64 +1557,26 @@
},
"id": "GoogleCloudMlV1__AutoScaling"
},
- "GoogleRpc__Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "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"
- },
- "code": {
- "type": "integer",
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code."
- },
- "message": {
- "type": "string",
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client."
- }
- },
- "id": "GoogleRpc__Status"
- },
"GoogleCloudMlV1__ListModelsResponse": {
- "description": "Response message for the ListModels method.",
- "type": "object",
"properties": {
"nextPageToken": {
"description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call.",
"type": "string"
},
"models": {
+ "description": "The list of models.",
"items": {
"$ref": "GoogleCloudMlV1__Model"
},
- "type": "array",
- "description": "The list of models."
+ "type": "array"
}
},
- "id": "GoogleCloudMlV1__ListModelsResponse"
+ "id": "GoogleCloudMlV1__ListModelsResponse",
+ "description": "Response message for the ListModels method.",
+ "type": "object"
},
"GoogleCloudMlV1__TrainingInput": {
- "description": "Represents input parameters for a training job.",
- "type": "object",
"properties": {
- "workerCount": {
- "format": "int64",
- "description": "Optional. The number of worker replicas to use for the training job. Each\nreplica in the cluster will be of the type specified in `worker_type`.\n\nThis value can only be used when `scale_tier` is set to `CUSTOM`. If you\nset this value, you must also set `worker_type`.",
- "type": "string"
- },
- "masterType": {
- "description": "Optional. Specifies the type of virtual machine to use for your training\njob's master worker.\n\nThe following types are supported:\n\n\u003cdl\u003e\n \u003cdt\u003estandard\u003c/dt\u003e\n \u003cdd\u003e\n A basic machine configuration suitable for training simple models with\n small to moderate datasets.\n \u003c/dd\u003e\n \u003cdt\u003elarge_model\u003c/dt\u003e\n \u003cdd\u003e\n A machine with a lot of memory, specially suited for parameter servers\n when your model is large (having many hidden layers or layers with very\n large numbers of nodes).\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_s\u003c/dt\u003e\n \u003cdd\u003e\n A machine suitable for the master and workers of the cluster when your\n model requires more computation than the standard machine can handle\n satisfactorily.\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_m\u003c/dt\u003e\n \u003cdd\u003e\n A machine with roughly twice the number of cores and roughly double the\n memory of \u003ccode suppresswarning=\"true\"\u003ecomplex_model_s\u003c/code\u003e.\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_l\u003c/dt\u003e\n \u003cdd\u003e\n A machine with roughly twice the number of cores and roughly double the\n memory of \u003ccode suppresswarning=\"true\"\u003ecomplex_model_m\u003c/code\u003e.\n \u003c/dd\u003e\n \u003cdt\u003estandard_gpu\u003c/dt\u003e\n \u003cdd\u003e\n A machine equivalent to \u003ccode suppresswarning=\"true\"\u003estandard\u003c/code\u003e that\n also includes a\n \u003ca href=\"/ml-engine/docs/how-tos/using-gpus\"\u003e\n GPU that you can use in your trainer\u003c/a\u003e.\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_m_gpu\u003c/dt\u003e\n \u003cdd\u003e\n A machine equivalent to\n \u003ccode suppresswarning=\"true\"\u003ecomplex_model_m\u003c/code\u003e that also includes\n four GPUs.\n \u003c/dd\u003e\n\u003c/dl\u003e\n\nYou must set this value when `scaleTier` is set to `CUSTOM`.",
- "type": "string"
- },
"runtimeVersion": {
"description": "Optional. The Google Cloud ML runtime version to use for training. If not\nset, Google Cloud ML will choose the latest stable version.",
"type": "string"
@@ -719,8 +1605,6 @@
"type": "string"
},
"scaleTier": {
- "description": "Required. Specifies the machine types, the number of replicas for workers\nand parameter servers.",
- "type": "string",
"enumDescriptions": [
"A single worker instance. This tier is suitable for learning how to use\nCloud ML, and for experimenting with new models using small datasets.",
"Many workers and a few parameter servers.",
@@ -736,7 +1620,9 @@
"BASIC_GPU",
"BASIC_TPU",
"CUSTOM"
- ]
+ ],
+ "description": "Required. Specifies the machine types, the number of replicas for workers\nand parameter servers.",
+ "type": "string"
},
"jobDir": {
"description": "Optional. A Google Cloud Storage path in which to store training outputs\nand other data needed for training. This path is passed to your TensorFlow\nprogram as the 'job_dir' command-line argument. The benefit of specifying\nthis field is that Cloud ML validates the path for use in training.",
@@ -757,28 +1643,49 @@
"type": "string"
},
"type": "array"
+ },
+ "workerCount": {
+ "format": "int64",
+ "description": "Optional. The number of worker replicas to use for the training job. Each\nreplica in the cluster will be of the type specified in `worker_type`.\n\nThis value can only be used when `scale_tier` is set to `CUSTOM`. If you\nset this value, you must also set `worker_type`.",
+ "type": "string"
+ },
+ "masterType": {
+ "description": "Optional. Specifies the type of virtual machine to use for your training\njob's master worker.\n\nThe following types are supported:\n\n\u003cdl\u003e\n \u003cdt\u003estandard\u003c/dt\u003e\n \u003cdd\u003e\n A basic machine configuration suitable for training simple models with\n small to moderate datasets.\n \u003c/dd\u003e\n \u003cdt\u003elarge_model\u003c/dt\u003e\n \u003cdd\u003e\n A machine with a lot of memory, specially suited for parameter servers\n when your model is large (having many hidden layers or layers with very\n large numbers of nodes).\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_s\u003c/dt\u003e\n \u003cdd\u003e\n A machine suitable for the master and workers of the cluster when your\n model requires more computation than the standard machine can handle\n satisfactorily.\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_m\u003c/dt\u003e\n \u003cdd\u003e\n A machine with roughly twice the number of cores and roughly double the\n memory of \u003ccode suppresswarning=\"true\"\u003ecomplex_model_s\u003c/code\u003e.\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_l\u003c/dt\u003e\n \u003cdd\u003e\n A machine with roughly twice the number of cores and roughly double the\n memory of \u003ccode suppresswarning=\"true\"\u003ecomplex_model_m\u003c/code\u003e.\n \u003c/dd\u003e\n \u003cdt\u003estandard_gpu\u003c/dt\u003e\n \u003cdd\u003e\n A machine equivalent to \u003ccode suppresswarning=\"true\"\u003estandard\u003c/code\u003e that\n also includes a\n \u003ca href=\"/ml-engine/docs/how-tos/using-gpus\"\u003e\n GPU that you can use in your trainer\u003c/a\u003e.\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_m_gpu\u003c/dt\u003e\n \u003cdd\u003e\n A machine equivalent to\n \u003ccode suppresswarning=\"true\"\u003ecomplex_model_m\u003c/code\u003e that also includes\n four GPUs.\n \u003c/dd\u003e\n\u003c/dl\u003e\n\nYou must set this value when `scaleTier` is set to `CUSTOM`.",
+ "type": "string"
}
},
- "id": "GoogleCloudMlV1__TrainingInput"
+ "id": "GoogleCloudMlV1__TrainingInput",
+ "description": "Represents input parameters for a training job.",
+ "type": "object"
},
"GoogleCloudMlV1__Job": {
"properties": {
+ "endTime": {
+ "format": "google-datetime",
+ "description": "Output only. When the job processing was completed.",
+ "type": "string"
+ },
+ "startTime": {
+ "format": "google-datetime",
+ "description": "Output only. When the job processing was started.",
+ "type": "string"
+ },
+ "predictionOutput": {
+ "$ref": "GoogleCloudMlV1__PredictionOutput",
+ "description": "The current prediction job result."
+ },
"trainingOutput": {
"$ref": "GoogleCloudMlV1__TrainingOutput",
"description": "The current training job result."
},
- "trainingInput": {
- "$ref": "GoogleCloudMlV1__TrainingInput",
- "description": "Input parameters to create a training job."
- },
"createTime": {
"format": "google-datetime",
"description": "Output only. When the job was created.",
"type": "string"
},
- "predictionInput": {
- "description": "Input parameters to create a prediction job.",
- "$ref": "GoogleCloudMlV1__PredictionInput"
+ "trainingInput": {
+ "$ref": "GoogleCloudMlV1__TrainingInput",
+ "description": "Input parameters to create a training job."
},
"state": {
"enumDescriptions": [
@@ -804,27 +1711,17 @@
"description": "Output only. The detailed state of a job.",
"type": "string"
},
- "jobId": {
- "description": "Required. The user-specified id of the job.",
- "type": "string"
+ "predictionInput": {
+ "description": "Input parameters to create a prediction job.",
+ "$ref": "GoogleCloudMlV1__PredictionInput"
},
"errorMessage": {
"description": "Output only. The details of a failure or a cancellation.",
"type": "string"
},
- "endTime": {
- "format": "google-datetime",
- "description": "Output only. When the job processing was completed.",
+ "jobId": {
+ "description": "Required. The user-specified id of the job.",
"type": "string"
- },
- "startTime": {
- "format": "google-datetime",
- "description": "Output only. When the job processing was started.",
- "type": "string"
- },
- "predictionOutput": {
- "description": "The current prediction job result.",
- "$ref": "GoogleCloudMlV1__PredictionOutput"
}
},
"id": "GoogleCloudMlV1__Job",
@@ -832,8 +1729,6 @@
"type": "object"
},
"GoogleApi__HttpBody": {
- "description": "Message that represents an arbitrary HTTP body. It should only be used for\npayload formats that can't be represented as JSON, such as raw binary or\nan HTML page.\n\n\nThis message can be used both in streaming and non-streaming API methods in\nthe request as well as the response.\n\nIt can be used as a top-level request field, which is convenient if one\nwants to extract parameters from either the URL or HTTP template into the\nrequest fields and also want access to the raw HTTP body.\n\nExample:\n\n message GetResourceRequest {\n // A unique request id.\n string request_id = 1;\n\n // The raw HTTP body is bound to this field.\n google.api.HttpBody http_body = 2;\n }\n\n service ResourceService {\n rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);\n rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty);\n }\n\nExample with streaming methods:\n\n service CaldavService {\n rpc GetCalendar(stream google.api.HttpBody)\n returns (stream google.api.HttpBody);\n rpc UpdateCalendar(stream google.api.HttpBody)\n returns (stream google.api.HttpBody);\n }\n\nUse of this type only changes how the request and response bodies are\nhandled, all other features will continue to work unchanged.",
- "type": "object",
"properties": {
"extensions": {
"description": "Application specific response metadata. Must be set in the first response\nfor streaming APIs.",
@@ -856,16 +1751,18 @@
"type": "string"
}
},
- "id": "GoogleApi__HttpBody"
+ "id": "GoogleApi__HttpBody",
+ "description": "Message that represents an arbitrary HTTP body. It should only be used for\npayload formats that can't be represented as JSON, such as raw binary or\nan HTML page.\n\n\nThis message can be used both in streaming and non-streaming API methods in\nthe request as well as the response.\n\nIt can be used as a top-level request field, which is convenient if one\nwants to extract parameters from either the URL or HTTP template into the\nrequest fields and also want access to the raw HTTP body.\n\nExample:\n\n message GetResourceRequest {\n // A unique request id.\n string request_id = 1;\n\n // The raw HTTP body is bound to this field.\n google.api.HttpBody http_body = 2;\n }\n\n service ResourceService {\n rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);\n rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty);\n }\n\nExample with streaming methods:\n\n service CaldavService {\n rpc GetCalendar(stream google.api.HttpBody)\n returns (stream google.api.HttpBody);\n rpc UpdateCalendar(stream google.api.HttpBody)\n returns (stream google.api.HttpBody);\n }\n\nUse of this type only changes how the request and response bodies are\nhandled, all other features will continue to work unchanged.",
+ "type": "object"
},
"GoogleCloudMlV1__GetConfigResponse": {
"description": "Returns service account information associated with a project.",
"type": "object",
"properties": {
"serviceAccountProject": {
- "type": "string",
"format": "int64",
- "description": "The project number for `service_account`."
+ "description": "The project number for `service_account`.",
+ "type": "string"
},
"serviceAccount": {
"description": "The service account Cloud ML uses to access resources in the project.",
@@ -875,50 +1772,21 @@
"id": "GoogleCloudMlV1__GetConfigResponse"
},
"GoogleIamV1__TestIamPermissionsResponse": {
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object",
"properties": {
"permissions": {
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
"items": {
"type": "string"
},
- "type": "array",
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed."
+ "type": "array"
}
},
- "id": "GoogleIamV1__TestIamPermissionsResponse"
- },
- "GoogleIamV1__SetIamPolicyRequest": {
- "description": "Request message for `SetIamPolicy` method.",
- "type": "object",
- "properties": {
- "updateMask": {
- "format": "google-fieldmask",
- "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
- "type": "string"
- },
- "policy": {
- "$ref": "GoogleIamV1__Policy",
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
- }
- },
- "id": "GoogleIamV1__SetIamPolicyRequest"
+ "id": "GoogleIamV1__TestIamPermissionsResponse",
+ "description": "Response message for `TestIamPermissions` method.",
+ "type": "object"
},
"GoogleCloudMlV1__HyperparameterOutput": {
- "description": "Represents the result of a single hyperparameter tuning trial from a\ntraining job. The TrainingOutput object that is returned on successful\ncompletion of a training job with hyperparameter tuning includes a list\nof HyperparameterOutput objects, one for each successful trial.",
- "type": "object",
"properties": {
- "hyperparameters": {
- "description": "The hyperparameters given to this trial.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "trialId": {
- "description": "The trial id for these results.",
- "type": "string"
- },
"allMetrics": {
"description": "All recorded object metrics for this trial. This field is not currently\npopulated.",
"items": {
@@ -929,23 +1797,41 @@
"finalMetric": {
"description": "The final objective metric seen for this trial.",
"$ref": "GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric"
+ },
+ "hyperparameters": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The hyperparameters given to this trial.",
+ "type": "object"
+ },
+ "trialId": {
+ "description": "The trial id for these results.",
+ "type": "string"
}
},
- "id": "GoogleCloudMlV1__HyperparameterOutput"
+ "id": "GoogleCloudMlV1__HyperparameterOutput",
+ "description": "Represents the result of a single hyperparameter tuning trial from a\ntraining job. The TrainingOutput object that is returned on successful\ncompletion of a training job with hyperparameter tuning includes a list\nof HyperparameterOutput objects, one for each successful trial.",
+ "type": "object"
},
- "GoogleCloudMlV1__PredictionOutput": {
- "description": "Represents results of a prediction job.",
+ "GoogleIamV1__SetIamPolicyRequest": {
+ "description": "Request message for `SetIamPolicy` method.",
"type": "object",
"properties": {
- "nodeHours": {
- "format": "double",
- "description": "Node hours used by the batch prediction job.",
- "type": "number"
+ "policy": {
+ "$ref": "GoogleIamV1__Policy",
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
},
- "outputPath": {
- "description": "The output Google Cloud Storage location provided at the job creation time.",
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
"type": "string"
- },
+ }
+ },
+ "id": "GoogleIamV1__SetIamPolicyRequest"
+ },
+ "GoogleCloudMlV1__PredictionOutput": {
+ "properties": {
"predictionCount": {
"format": "int64",
"description": "The number of generated predictions.",
@@ -955,9 +1841,20 @@
"format": "int64",
"description": "The number of data instances which resulted in errors.",
"type": "string"
+ },
+ "nodeHours": {
+ "format": "double",
+ "description": "Node hours used by the batch prediction job.",
+ "type": "number"
+ },
+ "outputPath": {
+ "description": "The output Google Cloud Storage location provided at the job creation time.",
+ "type": "string"
}
},
- "id": "GoogleCloudMlV1__PredictionOutput"
+ "id": "GoogleCloudMlV1__PredictionOutput",
+ "description": "Represents results of a prediction job.",
+ "type": "object"
},
"GoogleIamV1__Policy": {
"properties": {
@@ -1013,902 +1910,5 @@
"ownerDomain": "google.com",
"name": "ml",
"batchPath": "batch",
- "title": "Google Cloud Machine Learning Engine",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "methods": {
- "getConfig": {
- "response": {
- "$ref": "GoogleCloudMlV1__GetConfigResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "location": "path",
- "description": "Required. The project name.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}:getConfig",
- "id": "ml.projects.getConfig",
- "path": "v1/{+name}:getConfig",
- "description": "Get the service account information associated with your project. You need\nthis information in order to grant the service account persmissions for\nthe Google Cloud Storage location where you put your model training code\nfor training the model with Google Cloud Machine Learning."
- },
- "predict": {
- "request": {
- "$ref": "GoogleCloudMlV1__PredictRequest"
- },
- "description": "Performs prediction on the data in the request.\n\n**** REMOVE FROM GENERATED DOCUMENTATION",
- "response": {
- "$ref": "GoogleApi__HttpBody"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/.+$",
- "location": "path",
- "description": "Required. The resource name of a model or a version.\n\nAuthorization: requires the `predict` permission on the specified resource.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/projects/{projectsId}:predict",
- "id": "ml.projects.predict",
- "path": "v1/{+name}:predict"
- }
- },
- "resources": {
- "models": {
- "methods": {
- "getIamPolicy": {
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
- "response": {
- "$ref": "GoogleIamV1__Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/models/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}:getIamPolicy",
- "id": "ml.projects.models.getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy"
- },
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "GoogleLongrunning__Operation"
- },
- "parameters": {
- "updateMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "Required. Specifies the path, relative to `Model`, of the field to update.\n\nFor example, to change the description of a model to \"foo\" and set its\ndefault version to \"version_1\", the `update_mask` parameter would be\nspecified as `description`, `default_version.name`, and the `PATCH`\nrequest body would specify the new value, as follows:\n {\n \"description\": \"foo\",\n \"defaultVersion\": {\n \"name\":\"version_1\"\n }\n }\nIn this example, the model is blindly overwritten since no etag is given.\n\nTo adopt etag mechanism, include `etag` field in the mask, and include the\n`etag` value in your model resource.\n\nCurrently the supported update masks are `description`,\n`default_version.name`, `labels`, and `etag`.",
- "type": "string"
- },
- "name": {
- "description": "Required. The project name.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/models/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}",
- "path": "v1/{+name}",
- "id": "ml.projects.models.patch",
- "description": "Updates a specific model resource.\n\nCurrently the only supported fields to update are `description` and\n`default_version.name`.",
- "request": {
- "$ref": "GoogleCloudMlV1__Model"
- }
- },
- "get": {
- "response": {
- "$ref": "GoogleCloudMlV1__Model"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/models/[^/]+$",
- "location": "path",
- "description": "Required. The name of the model.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}",
- "id": "ml.projects.models.get",
- "path": "v1/{+name}",
- "description": "Gets information about a model, including its name, the description (if\nset), and the default version (if at least one version of the model has\nbeen deployed)."
- },
- "testIamPermissions": {
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
- "request": {
- "$ref": "GoogleIamV1__TestIamPermissionsRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "GoogleIamV1__TestIamPermissionsResponse"
- },
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/models/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "id": "ml.projects.models.testIamPermissions"
- },
- "delete": {
- "path": "v1/{+name}",
- "id": "ml.projects.models.delete",
- "description": "Deletes a model.\n\nYou can only delete a model if there are no versions in it. You can delete\nversions by calling\n[projects.models.versions.delete](/ml-engine/reference/rest/v1/projects.models.versions/delete).",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "GoogleLongrunning__Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "Required. The name of the model.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/models/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}"
- },
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "GoogleCloudMlV1__ListModelsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "parameters": {
- "parent": {
- "location": "path",
- "description": "Required. The name of the project whose models are to be listed.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$"
- },
- "pageToken": {
- "location": "query",
- "description": "Optional. A page token to request the next page of results.\n\nYou get the token from the `next_page_token` field of the response from\nthe previous call.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Optional. The number of models to retrieve per \"page\" of results. If there\nare more remaining results than this number, the response message will\ncontain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/models",
- "path": "v1/{+parent}/models",
- "id": "ml.projects.models.list",
- "description": "Lists the models in a project.\n\nEach project can contain multiple models, and each model can have multiple\nversions."
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "GoogleCloudMlV1__Model"
- },
- "parameters": {
- "parent": {
- "description": "Required. The project name.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/models",
- "path": "v1/{+parent}/models",
- "id": "ml.projects.models.create",
- "description": "Creates a model which will later contain one or more versions.\n\nYou must add at least one version before you can request predictions from\nthe model. Add versions by calling\n[projects.models.versions.create](/ml-engine/reference/rest/v1/projects.models.versions/create).",
- "request": {
- "$ref": "GoogleCloudMlV1__Model"
- }
- },
- "setIamPolicy": {
- "response": {
- "$ref": "GoogleIamV1__Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/models/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}:setIamPolicy",
- "id": "ml.projects.models.setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "request": {
- "$ref": "GoogleIamV1__SetIamPolicyRequest"
- }
- }
- },
- "resources": {
- "versions": {
- "methods": {
- "get": {
- "description": "Gets information about a model version.\n\nModels can have multiple versions. You can call\n[projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list)\nto get the same information that this method returns for all of the\nversions of a model.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "GoogleCloudMlV1__Version"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$",
- "location": "path",
- "description": "Required. The name of the version."
- }
- },
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}",
- "path": "v1/{+name}",
- "id": "ml.projects.models.versions.get"
- },
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "GoogleLongrunning__Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "Required. The name of the model.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$",
- "location": "path"
- },
- "updateMask": {
- "format": "google-fieldmask",
- "description": "Required. Specifies the path, relative to `Version`, of the field to\nupdate. Must be present and non-empty.\n\nFor example, to change the description of a version to \"foo\", the\n`update_mask` parameter would be specified as `description`, and the\n`PATCH` request body would specify the new value, as follows:\n {\n \"description\": \"foo\"\n }\nIn this example, the version is blindly overwritten since no etag is given.\n\nTo adopt etag mechanism, include `etag` field in the mask, and include the\n`etag` value in your version resource.\n\nCurrently the only supported update masks are `description`, `labels`, and\n`etag`.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}",
- "path": "v1/{+name}",
- "id": "ml.projects.models.versions.patch",
- "request": {
- "$ref": "GoogleCloudMlV1__Version"
- },
- "description": "Updates the specified Version resource.\n\nCurrently the only supported field to update is `description`."
- },
- "setDefault": {
- "response": {
- "$ref": "GoogleCloudMlV1__Version"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "Required. The name of the version to make the default for the model. You\ncan get the names of all the versions of a model by calling\n[projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list).",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}:setDefault",
- "id": "ml.projects.models.versions.setDefault",
- "path": "v1/{+name}:setDefault",
- "request": {
- "$ref": "GoogleCloudMlV1__SetDefaultVersionRequest"
- },
- "description": "Designates a version to be the default for the model.\n\nThe default version is used for prediction requests made against the model\nthat don't specify a version.\n\nThe first version to be created for a model is automatically set as the\ndefault. You must make any subsequent changes to the default version\nsetting manually using this method."
- },
- "delete": {
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$",
- "location": "path",
- "description": "Required. The name of the version. You can get the names of all the\nversions of a model by calling\n[projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list).",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}",
- "id": "ml.projects.models.versions.delete",
- "path": "v1/{+name}",
- "description": "Deletes a model version.\n\nEach model can have multiple versions deployed and in use at any given\ntime. Use this method to remove a single version.\n\nNote: You cannot delete the version that is set as the default version\nof the model unless it is the only remaining version.",
- "response": {
- "$ref": "GoogleLongrunning__Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE"
- },
- "list": {
- "id": "ml.projects.models.versions.list",
- "path": "v1/{+parent}/versions",
- "description": "Gets basic information about all the versions of a model.\n\nIf you expect that a model has a lot of versions, or if you need to handle\nonly a limited number of results at a time, you can request that the list\nbe retrieved in batches (called pages):",
- "response": {
- "$ref": "GoogleCloudMlV1__ListVersionsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "pageToken": {
- "description": "Optional. A page token to request the next page of results.\n\nYou get the token from the `next_page_token` field of the response from\nthe previous call.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "format": "int32",
- "description": "Optional. The number of versions to retrieve per \"page\" of results. If\nthere are more remaining results than this number, the response message\nwill contain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "location": "path",
- "description": "Required. The name of the model for which to list the version.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/models/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions"
- },
- "create": {
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions",
- "id": "ml.projects.models.versions.create",
- "path": "v1/{+parent}/versions",
- "description": "Creates a new version of a model from a trained TensorFlow model.\n\nIf the version created in the cloud by this call is the first deployed\nversion of the specified model, it will be made the default version of the\nmodel. When you add a version to a model that already has one or more\nversions, the default version does not automatically change. If you want a\nnew version to be the default, you must call\n[projects.models.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault).",
- "request": {
- "$ref": "GoogleCloudMlV1__Version"
- },
- "response": {
- "$ref": "GoogleLongrunning__Operation"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+/models/[^/]+$",
- "location": "path",
- "description": "Required. The name of the model.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- }
- }
- }
- },
- "operations": {
- "methods": {
- "cancel": {
- "id": "ml.projects.operations.cancel",
- "path": "v1/{+name}:cancel",
- "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
- "response": {
- "$ref": "GoogleProtobuf__Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/operations/[^/]+$",
- "location": "path",
- "description": "The name of the operation resource to be cancelled.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/operations/{operationsId}:cancel"
- },
- "delete": {
- "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "GoogleProtobuf__Empty"
- },
- "parameters": {
- "name": {
- "description": "The name of the operation resource to be deleted.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/operations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/operations/{operationsId}",
- "path": "v1/{+name}",
- "id": "ml.projects.operations.delete"
- },
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "GoogleLongrunning__Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/operations/[^/]+$",
- "location": "path",
- "description": "The name of the operation resource.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/projects/{projectsId}/operations/{operationsId}",
- "path": "v1/{+name}",
- "id": "ml.projects.operations.get",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
- },
- "list": {
- "flatPath": "v1/projects/{projectsId}/operations",
- "id": "ml.projects.operations.list",
- "path": "v1/{+name}/operations",
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
- "response": {
- "$ref": "GoogleLongrunning__ListOperationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "location": "path",
- "description": "The name of the operation's parent resource.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$"
- },
- "pageSize": {
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- }
- },
- "jobs": {
- "methods": {
- "testIamPermissions": {
- "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:testIamPermissions",
- "id": "ml.projects.jobs.testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "request": {
- "$ref": "GoogleIamV1__TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
- "response": {
- "$ref": "GoogleIamV1__TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/jobs/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true
- }
- }
- },
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "GoogleCloudMlV1__ListJobsResponse"
- },
- "parameters": {
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Optional. The number of jobs to retrieve per \"page\" of results. If there\nare more remaining results than this number, the response message will\ncontain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.",
- "type": "integer"
- },
- "parent": {
- "location": "path",
- "description": "Required. The name of the project for which to list jobs.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$"
- },
- "filter": {
- "description": "Optional. Specifies the subset of jobs to retrieve.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "description": "Optional. A page token to request the next page of results.\n\nYou get the token from the `next_page_token` field of the response from\nthe previous call.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/jobs",
- "path": "v1/{+parent}/jobs",
- "id": "ml.projects.jobs.list",
- "description": "Lists the jobs in the project."
- },
- "setIamPolicy": {
- "response": {
- "$ref": "GoogleIamV1__Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/jobs/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:setIamPolicy",
- "id": "ml.projects.jobs.setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "request": {
- "$ref": "GoogleIamV1__SetIamPolicyRequest"
- }
- },
- "create": {
- "response": {
- "$ref": "GoogleCloudMlV1__Job"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "location": "path",
- "description": "Required. The project name.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/jobs",
- "id": "ml.projects.jobs.create",
- "path": "v1/{+parent}/jobs",
- "description": "Creates a training or a batch prediction job.",
- "request": {
- "$ref": "GoogleCloudMlV1__Job"
- }
- },
- "cancel": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "GoogleProtobuf__Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "Required. The name of the job to cancel.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/jobs/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:cancel",
- "path": "v1/{+name}:cancel",
- "id": "ml.projects.jobs.cancel",
- "request": {
- "$ref": "GoogleCloudMlV1__CancelJobRequest"
- },
- "description": "Cancels a running job."
- },
- "getIamPolicy": {
- "response": {
- "$ref": "GoogleIamV1__Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/jobs/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:getIamPolicy",
- "id": "ml.projects.jobs.getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset."
- },
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "GoogleCloudMlV1__Job"
- },
- "parameters": {
- "name": {
- "description": "Required. The name of the job to get the description of.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/jobs/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}",
- "path": "v1/{+name}",
- "id": "ml.projects.jobs.get",
- "description": "Describes a job."
- }
- }
- }
- }
- }
- },
- "parameters": {
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "type": "string",
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
- },
- "callback": {
- "type": "string",
- "location": "query",
- "description": "JSONP"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth access token."
- }
- },
- "version": "v1",
- "baseUrl": "https://ml.googleapis.com/",
- "kind": "discovery#restDescription",
- "servicePath": "",
- "description": "An API to enable creating and using machine learning models."
+ "title": "Google Cloud Machine Learning Engine"
}
diff --git a/monitoring/v3/monitoring-api.json b/monitoring/v3/monitoring-api.json
index 9537d65..6f3ac6c 100644
--- a/monitoring/v3/monitoring-api.json
+++ b/monitoring/v3/monitoring-api.json
@@ -1,81 +1,958 @@
{
- "servicePath": "",
- "description": "Manages your Stackdriver Monitoring data and configurations. Most projects must be associated with a Stackdriver account, with a few exceptions as noted on the individual method pages.",
+ "ownerName": "Google",
+ "resources": {
+ "uptimeCheckIps": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListUptimeCheckIpsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call. NOTE: this field is not yet implemented",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is \u003c=0, the server will decide the number of results to be returned. NOTE: this field is not yet implemented",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "flatPath": "v3/uptimeCheckIps",
+ "path": "v3/uptimeCheckIps",
+ "id": "monitoring.uptimeCheckIps.list",
+ "description": "Returns the list of IPs that checkers run from"
+ }
+ }
+ },
+ "projects": {
+ "resources": {
+ "timeSeries": {
+ "methods": {
+ "create": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.write"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/timeSeries",
+ "path": "v3/{+name}/timeSeries",
+ "id": "monitoring.projects.timeSeries.create",
+ "description": "Creates or adds data to one or more time series. The response is empty if all time series in the request were written. If any time series could not be written, a corresponding failure message is included in the error response.",
+ "request": {
+ "$ref": "CreateTimeSeriesRequest"
+ }
+ },
+ "list": {
+ "path": "v3/{+name}/timeSeries",
+ "id": "monitoring.projects.timeSeries.list",
+ "description": "Lists time series that match a filter. This method does not require a Stackdriver account.",
+ "response": {
+ "$ref": "ListTimeSeriesResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read"
+ ],
+ "parameters": {
+ "aggregation.crossSeriesReducer": {
+ "location": "query",
+ "enum": [
+ "REDUCE_NONE",
+ "REDUCE_MEAN",
+ "REDUCE_MIN",
+ "REDUCE_MAX",
+ "REDUCE_SUM",
+ "REDUCE_STDDEV",
+ "REDUCE_COUNT",
+ "REDUCE_COUNT_TRUE",
+ "REDUCE_FRACTION_TRUE",
+ "REDUCE_PERCENTILE_99",
+ "REDUCE_PERCENTILE_95",
+ "REDUCE_PERCENTILE_50",
+ "REDUCE_PERCENTILE_05"
+ ],
+ "description": "The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned.",
+ "type": "string"
+ },
+ "filter": {
+ "description": "A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example:\nmetric.type = \"compute.googleapis.com/instance/cpu/usage_time\" AND\n metric.label.instance_name = \"my-instance-name\"\n",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
+ "type": "string"
+ },
+ "aggregation.perSeriesAligner": {
+ "location": "query",
+ "enum": [
+ "ALIGN_NONE",
+ "ALIGN_DELTA",
+ "ALIGN_RATE",
+ "ALIGN_INTERPOLATE",
+ "ALIGN_NEXT_OLDER",
+ "ALIGN_MIN",
+ "ALIGN_MAX",
+ "ALIGN_MEAN",
+ "ALIGN_COUNT",
+ "ALIGN_SUM",
+ "ALIGN_STDDEV",
+ "ALIGN_COUNT_TRUE",
+ "ALIGN_FRACTION_TRUE",
+ "ALIGN_PERCENTILE_99",
+ "ALIGN_PERCENTILE_95",
+ "ALIGN_PERCENTILE_50",
+ "ALIGN_PERCENTILE_05"
+ ],
+ "description": "The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned.",
+ "type": "string"
+ },
+ "interval.startTime": {
+ "description": "Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.",
+ "format": "google-datetime",
+ "type": "string",
+ "location": "query"
+ },
+ "view": {
+ "enum": [
+ "FULL",
+ "HEADERS"
+ ],
+ "description": "Specifies which information is returned about the time series.",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
+ "required": true,
+ "type": "string"
+ },
+ "aggregation.groupByFields": {
+ "repeated": true,
+ "location": "query",
+ "description": "The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.",
+ "type": "string"
+ },
+ "interval.endTime": {
+ "location": "query",
+ "description": "Required. The end of the time interval.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "aggregation.alignmentPeriod": {
+ "description": "The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.",
+ "format": "google-duration",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "A positive number that is the maximum number of results to return. When view field sets to FULL, it limits the number of Points server will return; if view field is HEADERS, it limits the number of TimeSeries server will return.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "orderBy": {
+ "location": "query",
+ "description": "Specifies the order in which the points of the time series should be returned. By default, results are not ordered. Currently, this field must be left blank.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/timeSeries"
+ }
+ }
+ },
+ "uptimeCheckConfigs": {
+ "methods": {
+ "delete": {
+ "id": "monitoring.projects.uptimeCheckConfigs.delete",
+ "path": "v3/{+name}",
+ "description": "Deletes an uptime check configuration. Note that this method will fail if the uptime check configuration is referenced by an alert policy or other dependent configs that would be rendered invalid by the deletion.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The uptime check configuration to delete. The format isprojects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/uptimeCheckConfigs/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring"
+ ],
+ "flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs/{uptimeCheckConfigsId}"
+ },
+ "list": {
+ "path": "v3/{+parent}/uptimeCheckConfigs",
+ "id": "monitoring.projects.uptimeCheckConfigs.list",
+ "description": "Lists the existing valid uptime check configurations for the project, leaving out any invalid configurations.",
+ "response": {
+ "$ref": "ListUptimeCheckConfigsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is \u003c=0, the server will decide the number of results to be returned.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "description": "The project whose uptime check configurations are listed. The format isprojects/[PROJECT_ID].",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "filter": {
+ "description": "If provided, specifies the criteria that must be met by uptime check configurations in the provided project to be included in the response. One of the following filters can be provided. uptime_check_config.id = {uptime_check_id} resource.type = gce_instance AND resource.label.instance_id = {instance_id} resource.type = aws_ec2_instance AND resource.label.instance_id = {instance_id} resource.type = aws_elb_load_balancer AND resource.label.name = {name} resource.type = gae_app AND resource.label.module_id = {module_id} resource.type = uptime_url AND resource.label.host = {host} group.id = {group_id}",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs"
+ },
+ "get": {
+ "response": {
+ "$ref": "UptimeCheckConfig"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/uptimeCheckConfigs/[^/]+$",
+ "location": "path",
+ "description": "The uptime check configuration to retrieve. The format isprojects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read"
+ ],
+ "flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs/{uptimeCheckConfigsId}",
+ "path": "v3/{+name}",
+ "id": "monitoring.projects.uptimeCheckConfigs.get",
+ "description": "Gets a single uptime check configuration."
+ },
+ "patch": {
+ "path": "v3/{+name}",
+ "id": "monitoring.projects.uptimeCheckConfigs.patch",
+ "request": {
+ "$ref": "UptimeCheckConfig"
+ },
+ "description": "Updates an uptime check configuration. You can either replace the entire configuration with a new one or replace only certain fields in the current configuration by specifying the fields to be updated via \"updateMask\". Returns the updated configuration.",
+ "response": {
+ "$ref": "UptimeCheckConfig"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "updateMask": {
+ "description": "Optional. If present, only the listed fields in the current uptime check configuration are updated with values from the new configuration. If this field is empty, then the current configuration is completely replaced with the new configuration.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ },
+ "name1": {
+ "location": "query",
+ "description": "The uptime check configuration to update. The format isprojects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].",
+ "type": "string"
+ },
+ "name": {
+ "pattern": "^projects/[^/]+/uptimeCheckConfigs/[^/]+$",
+ "location": "path",
+ "description": "A unique resource name for this UptimeCheckConfig. The format is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This field should be omitted when creating the uptime check configuration; on create, the resource name is assigned by the server and included in the response.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring"
+ ],
+ "flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs/{uptimeCheckConfigsId}"
+ },
+ "create": {
+ "response": {
+ "$ref": "UptimeCheckConfig"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring"
+ ],
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The project in which to create the uptime check. The format is:projects/[PROJECT_ID].",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs",
+ "path": "v3/{+parent}/uptimeCheckConfigs",
+ "id": "monitoring.projects.uptimeCheckConfigs.create",
+ "description": "Creates a new uptime check configuration.",
+ "request": {
+ "$ref": "UptimeCheckConfig"
+ }
+ }
+ }
+ },
+ "monitoredResourceDescriptors": {
+ "methods": {
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListMonitoredResourceDescriptorsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "filter": {
+ "location": "query",
+ "description": "An optional filter describing the descriptors to be returned. The filter can reference the descriptor's type and labels. For example, the following filter returns only Google Compute Engine descriptors that have an id label:\nresource.type = starts_with(\"gce_\") AND resource.label:id\n",
+ "type": "string"
+ },
+ "name": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "A positive number that is the maximum number of results to return.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read",
+ "https://www.googleapis.com/auth/monitoring.write"
+ ],
+ "flatPath": "v3/projects/{projectsId}/monitoredResourceDescriptors",
+ "id": "monitoring.projects.monitoredResourceDescriptors.list",
+ "path": "v3/{+name}/monitoredResourceDescriptors",
+ "description": "Lists monitored resource descriptors that match a filter. This method does not require a Stackdriver account."
+ },
+ "get": {
+ "path": "v3/{+name}",
+ "id": "monitoring.projects.monitoredResourceDescriptors.get",
+ "description": "Gets a single monitored resource descriptor. This method does not require a Stackdriver account.",
+ "response": {
+ "$ref": "MonitoredResourceDescriptor"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read",
+ "https://www.googleapis.com/auth/monitoring.write"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/monitoredResourceDescriptors/[^/]+$",
+ "location": "path",
+ "description": "The monitored resource descriptor to get. The format is \"projects/{project_id_or_number}/monitoredResourceDescriptors/{resource_type}\". The {resource_type} is a predefined type, such as cloudsql_database.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/monitoredResourceDescriptors/{monitoredResourceDescriptorsId}"
+ }
+ }
+ },
+ "groups": {
+ "resources": {
+ "members": {
+ "methods": {
+ "list": {
+ "id": "monitoring.projects.groups.members.list",
+ "path": "v3/{+name}/members",
+ "description": "Lists the monitored resources that are members of a group.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListGroupMembersResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "A positive number that is the maximum number of results to return.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "interval.startTime": {
+ "description": "Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.",
+ "format": "google-datetime",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "description": "The group whose members are listed. The format is \"projects/{project_id_or_number}/groups/{group_id}\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/groups/[^/]+$",
+ "location": "path"
+ },
+ "interval.endTime": {
+ "location": "query",
+ "description": "Required. The end of the time interval.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "filter": {
+ "location": "query",
+ "description": "An optional list filter describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group. For example, to return only resources representing Compute Engine VM instances, use this filter:\nresource.type = \"gce_instance\"\n",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read"
+ ],
+ "flatPath": "v3/projects/{projectsId}/groups/{groupsId}/members"
+ }
+ }
+ }
+ },
+ "methods": {
+ "update": {
+ "description": "Updates an existing group. You can change any group attributes except name.",
+ "request": {
+ "$ref": "Group"
+ },
+ "response": {
+ "$ref": "Group"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/groups/[^/]+$",
+ "location": "path",
+ "description": "Output only. The name of this group. The format is \"projects/{project_id_or_number}/groups/{group_id}\". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique {group_id} that is generated automatically.",
+ "required": true,
+ "type": "string"
+ },
+ "validateOnly": {
+ "location": "query",
+ "description": "If true, validate this request but do not update the existing group.",
+ "type": "boolean"
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/groups/{groupsId}",
+ "path": "v3/{+name}",
+ "id": "monitoring.projects.groups.update"
+ },
+ "create": {
+ "path": "v3/{+name}/groups",
+ "id": "monitoring.projects.groups.create",
+ "description": "Creates a new group.",
+ "request": {
+ "$ref": "Group"
+ },
+ "response": {
+ "$ref": "Group"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The project in which to create the group. The format is \"projects/{project_id_or_number}\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "validateOnly": {
+ "description": "If true, validate this request but do not create the group.",
+ "type": "boolean",
+ "location": "query"
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/groups"
+ },
+ "delete": {
+ "path": "v3/{+name}",
+ "id": "monitoring.projects.groups.delete",
+ "description": "Deletes an existing group.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/groups/[^/]+$",
+ "location": "path",
+ "description": "The group to delete. The format is \"projects/{project_id_or_number}/groups/{group_id}\".",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/groups/{groupsId}"
+ },
+ "list": {
+ "response": {
+ "$ref": "ListGroupsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The project whose groups are to be listed. The format is \"projects/{project_id_or_number}\".",
+ "required": true,
+ "type": "string"
+ },
+ "childrenOfGroup": {
+ "location": "query",
+ "description": "A group name: \"projects/{project_id_or_number}/groups/{group_id}\". Returns groups whose parentName field contains the group name. If no groups have this parent, the results are empty.",
+ "type": "string"
+ },
+ "descendantsOfGroup": {
+ "location": "query",
+ "description": "A group name: \"projects/{project_id_or_number}/groups/{group_id}\". Returns the descendants of the specified group. This is a superset of the results returned by the childrenOfGroup filter, and includes children-of-children, and so forth.",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "A positive number that is the maximum number of results to return.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "ancestorsOfGroup": {
+ "description": "A group name: \"projects/{project_id_or_number}/groups/{group_id}\". Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/groups",
+ "path": "v3/{+name}/groups",
+ "id": "monitoring.projects.groups.list",
+ "description": "Lists the existing groups."
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Group"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/groups/[^/]+$",
+ "location": "path",
+ "description": "The group to retrieve. The format is \"projects/{project_id_or_number}/groups/{group_id}\".",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read"
+ ],
+ "flatPath": "v3/projects/{projectsId}/groups/{groupsId}",
+ "id": "monitoring.projects.groups.get",
+ "path": "v3/{+name}",
+ "description": "Gets a single group."
+ }
+ }
+ },
+ "collectdTimeSeries": {
+ "methods": {
+ "create": {
+ "response": {
+ "$ref": "CreateCollectdTimeSeriesResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.write"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The project in which to create the time series. The format is \"projects/PROJECT_ID_OR_NUMBER\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/collectdTimeSeries",
+ "path": "v3/{+name}/collectdTimeSeries",
+ "id": "monitoring.projects.collectdTimeSeries.create",
+ "description": "Stackdriver Monitoring Agent only: Creates a new time series.\u003caside class=\"caution\"\u003eThis method is only for use by the Stackdriver Monitoring Agent. Use projects.timeSeries.create instead.\u003c/aside\u003e",
+ "request": {
+ "$ref": "CreateCollectdTimeSeriesRequest"
+ }
+ }
+ }
+ },
+ "metricDescriptors": {
+ "methods": {
+ "create": {
+ "id": "monitoring.projects.metricDescriptors.create",
+ "path": "v3/{+name}/metricDescriptors",
+ "request": {
+ "$ref": "MetricDescriptor"
+ },
+ "description": "Creates a new metric descriptor. User-created metric descriptors define custom metrics.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "MetricDescriptor"
+ },
+ "parameters": {
+ "name": {
+ "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.write"
+ ],
+ "flatPath": "v3/projects/{projectsId}/metricDescriptors"
+ },
+ "delete": {
+ "description": "Deletes a metric descriptor. Only user-created custom metrics can be deleted.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The metric descriptor on which to execute the request. The format is \"projects/{project_id_or_number}/metricDescriptors/{metric_id}\". An example of {metric_id} is: \"custom.googleapis.com/my_test_metric\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/metricDescriptors/.+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/metricDescriptors/{metricDescriptorsId}",
+ "path": "v3/{+name}",
+ "id": "monitoring.projects.metricDescriptors.delete"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListMetricDescriptorsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "filter": {
+ "location": "query",
+ "description": "If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics:\nmetric.type = starts_with(\"custom.googleapis.com/\")\n",
+ "type": "string"
+ },
+ "name": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "A positive number that is the maximum number of results to return.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read",
+ "https://www.googleapis.com/auth/monitoring.write"
+ ],
+ "flatPath": "v3/projects/{projectsId}/metricDescriptors",
+ "id": "monitoring.projects.metricDescriptors.list",
+ "path": "v3/{+name}/metricDescriptors",
+ "description": "Lists metric descriptors that match a filter. This method does not require a Stackdriver account."
+ },
+ "get": {
+ "id": "monitoring.projects.metricDescriptors.get",
+ "path": "v3/{+name}",
+ "description": "Gets a single metric descriptor. This method does not require a Stackdriver account.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "MetricDescriptor"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The metric descriptor on which to execute the request. The format is \"projects/{project_id_or_number}/metricDescriptors/{metric_id}\". An example value of {metric_id} is \"compute.googleapis.com/instance/disk/read_bytes_count\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/metricDescriptors/.+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read",
+ "https://www.googleapis.com/auth/monitoring.write"
+ ],
+ "flatPath": "v3/projects/{projectsId}/metricDescriptors/{metricDescriptorsId}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ }
+ },
+ "version": "v3",
+ "baseUrl": "https://monitoring.googleapis.com/",
"kind": "discovery#restDescription",
+ "description": "Manages your Stackdriver Monitoring data and configurations. Most projects must be associated with a Stackdriver account, with a few exceptions as noted on the individual method pages.",
+ "servicePath": "",
"basePath": "",
"id": "monitoring:v3",
"documentationLink": "https://cloud.google.com/monitoring/api/",
- "revision": "20171001",
+ "revision": "20171010",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "Exponential": {
- "description": "Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): scale * (growth_factor ^ i). Lower bound (1 \u003c= i \u003c N): scale * (growth_factor ^ (i - 1)).",
- "type": "object",
- "properties": {
- "numFiniteBuckets": {
- "format": "int32",
- "description": "Must be greater than 0.",
- "type": "integer"
- },
- "growthFactor": {
- "format": "double",
- "description": "Must be greater than 1.",
- "type": "number"
- },
- "scale": {
- "format": "double",
- "description": "Must be greater than 0.",
- "type": "number"
- }
- },
- "id": "Exponential"
- },
- "Point": {
- "description": "A single data point in a time series.",
- "type": "object",
- "properties": {
- "value": {
- "description": "The value of the data point.",
- "$ref": "TypedValue"
- },
- "interval": {
- "description": "The time interval to which the data point applies. For GAUGE metrics, only the end time of the interval is used. For DELTA metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For CUMULATIVE metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points.",
- "$ref": "TimeInterval"
- }
- },
- "id": "Point"
- },
"Field": {
"description": "A single field of a message type.",
"type": "object",
"properties": {
- "jsonName": {
- "description": "The field JSON name.",
- "type": "string"
- },
"kind": {
- "enumDescriptions": [
- "Field type unknown.",
- "Field type double.",
- "Field type float.",
- "Field type int64.",
- "Field type uint64.",
- "Field type int32.",
- "Field type fixed64.",
- "Field type fixed32.",
- "Field type bool.",
- "Field type string.",
- "Field type group. Proto2 syntax only, and deprecated.",
- "Field type message.",
- "Field type bytes.",
- "Field type uint32.",
- "Field type enum.",
- "Field type sfixed32.",
- "Field type sfixed64.",
- "Field type sint32.",
- "Field type sint64."
- ],
"enum": [
"TYPE_UNKNOWN",
"TYPE_DOUBLE",
@@ -98,18 +975,43 @@
"TYPE_SINT64"
],
"description": "The field type.",
+ "type": "string",
+ "enumDescriptions": [
+ "Field type unknown.",
+ "Field type double.",
+ "Field type float.",
+ "Field type int64.",
+ "Field type uint64.",
+ "Field type int32.",
+ "Field type fixed64.",
+ "Field type fixed32.",
+ "Field type bool.",
+ "Field type string.",
+ "Field type group. Proto2 syntax only, and deprecated.",
+ "Field type message.",
+ "Field type bytes.",
+ "Field type uint32.",
+ "Field type enum.",
+ "Field type sfixed32.",
+ "Field type sfixed64.",
+ "Field type sint32.",
+ "Field type sint64."
+ ]
+ },
+ "jsonName": {
+ "description": "The field JSON name.",
"type": "string"
},
"options": {
"description": "The protocol buffer options.",
+ "type": "array",
"items": {
"$ref": "Option"
- },
- "type": "array"
+ }
},
"oneofIndex": {
- "format": "int32",
"description": "The index of the field type in Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list.",
+ "format": "int32",
"type": "integer"
},
"packed": {
@@ -145,77 +1047,95 @@
"type": "string"
},
"number": {
- "format": "int32",
"description": "The field number.",
+ "format": "int32",
"type": "integer"
}
},
"id": "Field"
},
- "Metric": {
- "description": "A specific metric, identified by specifying values for all of the labels of a MetricDescriptor.",
+ "ListUptimeCheckConfigsResponse": {
+ "description": "The protocol for the ListUptimeCheckConfigs response.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "This field represents the pagination token to retrieve the next page of results. If the value is empty, it means no further results for the request. To retrieve the next page of results, the value of the next_page_token is passed to the subsequent List method call (in the request message's page_token field).",
+ "type": "string"
+ },
+ "uptimeCheckConfigs": {
+ "description": "The returned uptime check configurations.",
+ "type": "array",
+ "items": {
+ "$ref": "UptimeCheckConfig"
+ }
+ }
+ },
+ "id": "ListUptimeCheckConfigsResponse"
+ },
+ "Metric": {
+ "properties": {
+ "type": {
+ "description": "An existing metric type, see google.api.MetricDescriptor. For example, custom.googleapis.com/invoice/paid/amount.",
+ "type": "string"
+ },
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "The set of label values that uniquely identify this metric. All labels listed in the MetricDescriptor must be assigned values.",
"type": "object"
- },
- "type": {
- "description": "An existing metric type, see google.api.MetricDescriptor. For example, custom.googleapis.com/invoice/paid/amount.",
- "type": "string"
}
},
- "id": "Metric"
+ "id": "Metric",
+ "description": "A specific metric, identified by specifying values for all of the labels of a MetricDescriptor.",
+ "type": "object"
},
"LabelDescriptor": {
- "description": "A description of a label.",
- "type": "object",
"properties": {
- "description": {
- "description": "A human-readable description for the label.",
- "type": "string"
- },
"valueType": {
+ "enum": [
+ "STRING",
+ "BOOL",
+ "INT64"
+ ],
"description": "The type of data that can be assigned to the label.",
"type": "string",
"enumDescriptions": [
"A variable-length string. This is the default.",
"Boolean; true or false.",
"A 64-bit signed integer."
- ],
- "enum": [
- "STRING",
- "BOOL",
- "INT64"
]
},
"key": {
"description": "The label key.",
"type": "string"
- }
- },
- "id": "LabelDescriptor"
- },
- "ListTimeSeriesResponse": {
- "description": "The ListTimeSeries response.",
- "type": "object",
- "properties": {
- "timeSeries": {
- "description": "One or more time series that match the filter included in the request.",
- "items": {
- "$ref": "TimeSeries"
- },
- "type": "array"
},
- "nextPageToken": {
- "description": "If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.",
+ "description": {
+ "description": "A human-readable description for the label.",
"type": "string"
}
},
- "id": "ListTimeSeriesResponse"
+ "id": "LabelDescriptor",
+ "description": "A description of a label.",
+ "type": "object"
+ },
+ "ListTimeSeriesResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.",
+ "type": "string"
+ },
+ "timeSeries": {
+ "description": "One or more time series that match the filter included in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "TimeSeries"
+ }
+ }
+ },
+ "id": "ListTimeSeriesResponse",
+ "description": "The ListTimeSeries response.",
+ "type": "object"
},
"Group": {
"description": "The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. Groups can contain any number of monitored resources, and each monitored resource can be a member of any number of groups.Groups can be nested in parent-child hierarchies. The parentName field identifies an optional parent for each group. If a group has a parent, then the only monitored resources available to be matched by the group's filter are the resources contained in the parent group. In other words, a group contains the monitored resources that match its filter and the filters of all the group's ancestors. A group without a parent can contain any monitored resource.For example, consider an infrastructure running a set of instances with two user-defined tags: \"environment\" and \"role\". A parent group has a filter, environment=\"production\". A child of that parent group has a filter, role=\"transcoder\". The parent group contains all instances in the production environment, regardless of their roles. The child group contains instances that have the transcoder role and are in the production environment.The monitored resources contained in a group can change at any moment, depending on what resources exist and what filters are associated with the group and its ancestors.",
@@ -225,14 +1145,14 @@
"description": "The filter used to determine which monitored resources belong to this group.",
"type": "string"
},
- "parentName": {
- "description": "The name of the group's parent, if it has one. The format is \"projects/{project_id_or_number}/groups/{group_id}\". For groups with no parent, parentName is the empty string, \"\".",
- "type": "string"
- },
"name": {
"description": "Output only. The name of this group. The format is \"projects/{project_id_or_number}/groups/{group_id}\". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique {group_id} that is generated automatically.",
"type": "string"
},
+ "parentName": {
+ "description": "The name of the group's parent, if it has one. The format is \"projects/{project_id_or_number}/groups/{group_id}\". For groups with no parent, parentName is the empty string, \"\".",
+ "type": "string"
+ },
"displayName": {
"description": "A user-assigned name for this group, used only for display purposes.",
"type": "string"
@@ -245,22 +1165,13 @@
"id": "Group"
},
"Type": {
- "description": "A protocol buffer message type.",
- "type": "object",
"properties": {
- "options": {
- "description": "The protocol buffer options.",
- "items": {
- "$ref": "Option"
- },
- "type": "array"
- },
"fields": {
"description": "The list of fields.",
+ "type": "array",
"items": {
"$ref": "Field"
- },
- "type": "array"
+ }
},
"name": {
"description": "The fully qualified message name.",
@@ -268,85 +1179,153 @@
},
"oneofs": {
"description": "The list of types appearing in oneof definitions in this type.",
+ "type": "array",
"items": {
"type": "string"
- },
- "type": "array"
+ }
+ },
+ "sourceContext": {
+ "description": "The source context.",
+ "$ref": "SourceContext"
},
"syntax": {
- "enumDescriptions": [
- "Syntax proto2.",
- "Syntax proto3."
- ],
"enum": [
"SYNTAX_PROTO2",
"SYNTAX_PROTO3"
],
"description": "The source syntax.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Syntax proto2.",
+ "Syntax proto3."
+ ]
},
- "sourceContext": {
- "$ref": "SourceContext",
- "description": "The source context."
+ "options": {
+ "description": "The protocol buffer options.",
+ "type": "array",
+ "items": {
+ "$ref": "Option"
+ }
}
},
- "id": "Type"
+ "id": "Type",
+ "description": "A protocol buffer message type.",
+ "type": "object"
},
- "BucketOptions": {
- "description": "BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i \u003e 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.",
+ "BasicAuthentication": {
+ "description": "A type of authentication to perform against the specified resource or URL that uses username and password. Currently, only Basic authentication is supported in Uptime Monitoring.",
"type": "object",
"properties": {
- "explicitBuckets": {
- "description": "The explicit buckets.",
- "$ref": "Explicit"
+ "password": {
+ "description": "The password to authenticate.",
+ "type": "string"
},
- "linearBuckets": {
- "description": "The linear bucket.",
- "$ref": "Linear"
- },
- "exponentialBuckets": {
- "description": "The exponential buckets.",
- "$ref": "Exponential"
+ "username": {
+ "description": "The username to authenticate.",
+ "type": "string"
}
},
- "id": "BucketOptions"
+ "id": "BasicAuthentication"
+ },
+ "BucketOptions": {
+ "properties": {
+ "exponentialBuckets": {
+ "$ref": "Exponential",
+ "description": "The exponential buckets."
+ },
+ "linearBuckets": {
+ "$ref": "Linear",
+ "description": "The linear bucket."
+ },
+ "explicitBuckets": {
+ "$ref": "Explicit",
+ "description": "The explicit buckets."
+ }
+ },
+ "id": "BucketOptions",
+ "description": "BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i \u003e 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.",
+ "type": "object"
+ },
+ "HttpCheck": {
+ "properties": {
+ "useSsl": {
+ "description": "If true, use HTTPS instead of HTTP to run the check.",
+ "type": "boolean"
+ },
+ "maskHeaders": {
+ "description": "Boolean specifiying whether to encrypt the header information. Encryption should be specified for any headers related to authentication that you do not wish to be seen when retrieving the configuration. The server will be responsible for encrypting the headers. On Get/List calls, if mask_headers is set to True then the headers will be obscured with ******.",
+ "type": "boolean"
+ },
+ "authInfo": {
+ "$ref": "BasicAuthentication",
+ "description": "The authentication information. Optional when creating an HTTP check; defaults to empty."
+ },
+ "port": {
+ "description": "The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) and path to construct the full URL. Optional (defaults to 80 without SSL, or 443 with SSL).",
+ "format": "int32",
+ "type": "integer"
+ },
+ "headers": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The list of headers to send as part of the uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described at https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second.",
+ "type": "object"
+ },
+ "path": {
+ "description": "The path to the page to run the check against. Will be combined with the host (specified within the MonitoredResource) and port to construct the full URL. Optional (defaults to \"/\").",
+ "type": "string"
+ }
+ },
+ "id": "HttpCheck",
+ "description": "Information involved in an HTTP/HTTPS uptime check request.",
+ "type": "object"
},
"Status": {
"description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
- "code": {
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer"
- },
"message": {
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
"type": "string"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
+ "type": "array",
"items": {
- "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- }
- },
- "type": "array"
+ },
+ "type": "object"
+ }
+ },
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
}
},
"id": "Status"
},
"CollectdValue": {
- "description": "A single data point from a collectd-based plugin.",
- "type": "object",
"properties": {
+ "dataSourceName": {
+ "description": "The data source for the collectd value. For example there are two data sources for network measurements: \"rx\" and \"tx\".",
+ "type": "string"
+ },
"value": {
- "$ref": "TypedValue",
- "description": "The measurement value."
+ "description": "The measurement value.",
+ "$ref": "TypedValue"
},
"dataSourceType": {
+ "enum": [
+ "UNSPECIFIED_DATA_SOURCE_TYPE",
+ "GAUGE",
+ "COUNTER",
+ "DERIVE",
+ "ABSOLUTE"
+ ],
"description": "The type of measurement.",
"type": "string",
"enumDescriptions": [
@@ -355,26 +1334,37 @@
"A cumulative value over time. This corresponds to google.api.MetricDescriptor.MetricKind.CUMULATIVE.",
"A rate of change of the measurement.",
"An amount of change since the last measurement interval. This corresponds to google.api.MetricDescriptor.MetricKind.DELTA."
- ],
- "enum": [
- "UNSPECIFIED_DATA_SOURCE_TYPE",
- "GAUGE",
- "COUNTER",
- "DERIVE",
- "ABSOLUTE"
]
- },
- "dataSourceName": {
- "description": "The data source for the collectd value. For example there are two data sources for network measurements: \"rx\" and \"tx\".",
- "type": "string"
}
},
- "id": "CollectdValue"
+ "id": "CollectdValue",
+ "description": "A single data point from a collectd-based plugin.",
+ "type": "object"
},
"MetricDescriptor": {
- "description": "Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.",
- "type": "object",
"properties": {
+ "valueType": {
+ "enumDescriptions": [
+ "Do not use this default value.",
+ "The value is a boolean. This value type can be used only if the metric kind is GAUGE.",
+ "The value is a signed 64-bit integer.",
+ "The value is a double precision floating point number.",
+ "The value is a text string. This value type can be used only if the metric kind is GAUGE.",
+ "The value is a Distribution.",
+ "The value is money."
+ ],
+ "enum": [
+ "VALUE_TYPE_UNSPECIFIED",
+ "BOOL",
+ "INT64",
+ "DOUBLE",
+ "STRING",
+ "DISTRIBUTION",
+ "MONEY"
+ ],
+ "description": "Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.",
+ "type": "string"
+ },
"metricKind": {
"enumDescriptions": [
"Do not use this default value.",
@@ -405,10 +1395,10 @@
},
"labels": {
"description": "The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.",
+ "type": "array",
"items": {
"$ref": "LabelDescriptor"
- },
- "type": "array"
+ }
},
"name": {
"description": "The resource name of the metric descriptor.",
@@ -417,77 +1407,126 @@
"type": {
"description": "The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined custom metric types have the DNS name custom.googleapis.com. Metric types should use a natural hierarchical grouping. For example:\n\"custom.googleapis.com/invoice/paid/amount\"\n\"appengine.googleapis.com/http/server/response_latencies\"\n",
"type": "string"
- },
- "valueType": {
- "enumDescriptions": [
- "Do not use this default value.",
- "The value is a boolean. This value type can be used only if the metric kind is GAUGE.",
- "The value is a signed 64-bit integer.",
- "The value is a double precision floating point number.",
- "The value is a text string. This value type can be used only if the metric kind is GAUGE.",
- "The value is a Distribution.",
- "The value is money."
- ],
- "enum": [
- "VALUE_TYPE_UNSPECIFIED",
- "BOOL",
- "INT64",
- "DOUBLE",
- "STRING",
- "DISTRIBUTION",
- "MONEY"
- ],
- "description": "Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.",
- "type": "string"
}
},
- "id": "MetricDescriptor"
+ "id": "MetricDescriptor",
+ "description": "Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.",
+ "type": "object"
},
"SourceContext": {
- "description": "SourceContext represents information about the source of a protobuf element, like the file in which it is defined.",
- "type": "object",
"properties": {
"fileName": {
"description": "The path-qualified name of the .proto file that contained the associated protobuf element. For example: \"google/protobuf/source_context.proto\".",
"type": "string"
}
},
- "id": "SourceContext"
+ "id": "SourceContext",
+ "description": "SourceContext represents information about the source of a protobuf element, like the file in which it is defined.",
+ "type": "object"
},
"Range": {
- "description": "The range of the population values.",
- "type": "object",
"properties": {
"min": {
- "format": "double",
"description": "The minimum of the population values.",
+ "format": "double",
"type": "number"
},
"max": {
- "format": "double",
"description": "The maximum of the population values.",
+ "format": "double",
"type": "number"
}
},
- "id": "Range"
+ "id": "Range",
+ "description": "The range of the population values.",
+ "type": "object"
},
"ListGroupsResponse": {
- "description": "The ListGroups response.",
- "type": "object",
"properties": {
- "group": {
- "description": "The groups that match the specified filters.",
- "items": {
- "$ref": "Group"
- },
- "type": "array"
- },
"nextPageToken": {
"description": "If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.",
"type": "string"
+ },
+ "group": {
+ "description": "The groups that match the specified filters.",
+ "type": "array",
+ "items": {
+ "$ref": "Group"
+ }
}
},
- "id": "ListGroupsResponse"
+ "id": "ListGroupsResponse",
+ "description": "The ListGroups response.",
+ "type": "object"
+ },
+ "UptimeCheckConfig": {
+ "properties": {
+ "tcpCheck": {
+ "description": "Contains information needed to make a TCP check.",
+ "$ref": "TcpCheck"
+ },
+ "selectedRegions": {
+ "description": "The list of regions from which the check will be run. If this field is specified, enough regions to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all regions.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "REGION_UNSPECIFIED",
+ "USA",
+ "EUROPE",
+ "SOUTH_AMERICA",
+ "ASIA_PACIFIC"
+ ],
+ "type": "string"
+ },
+ "enumDescriptions": [
+ "Default value if no region is specified. Will result in uptime checks running from all regions.",
+ "Allows checks to run from locations within the United States of America.",
+ "Allows checks to run from locations within the continent of Europe.",
+ "Allows checks to run from locations within the continent of South America.",
+ "Allows checks to run from locations within the Asia Pacific area (ex: Singapore)."
+ ]
+ },
+ "displayName": {
+ "description": "A human-friendly name for the uptime check configuration. The display name should be unique within a Stackdriver Account in order to make it easier to identify; however, uniqueness is not enforced. Required.",
+ "type": "string"
+ },
+ "monitoredResource": {
+ "description": "The monitored resource associated with the configuration.",
+ "$ref": "MonitoredResource"
+ },
+ "contentMatchers": {
+ "description": "The expected content on the page the check is run against. Currently, only the first entry in the list is supported, and other entries will be ignored. The server will look for an exact match of the string in the page response's content. This field is optional and should only be specified if a content match is required.",
+ "type": "array",
+ "items": {
+ "$ref": "ContentMatcher"
+ }
+ },
+ "timeout": {
+ "description": "The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "period": {
+ "description": "How often the uptime check is performed. Currently, only 1, 5, 10, and 15 minutes are supported. Required.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "name": {
+ "description": "A unique resource name for this UptimeCheckConfig. The format is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This field should be omitted when creating the uptime check configuration; on create, the resource name is assigned by the server and included in the response.",
+ "type": "string"
+ },
+ "httpCheck": {
+ "description": "Contains information needed to make an HTTP or HTTPS check.",
+ "$ref": "HttpCheck"
+ },
+ "resourceGroup": {
+ "description": "The group resource associated with the configuration.",
+ "$ref": "ResourceGroup"
+ }
+ },
+ "id": "UptimeCheckConfig",
+ "description": "This message configures which resources and services to monitor for availability.",
+ "type": "object"
},
"ListGroupMembersResponse": {
"description": "The ListGroupMembers response.",
@@ -495,18 +1534,18 @@
"properties": {
"members": {
"description": "A set of monitored resources in the group.",
+ "type": "array",
"items": {
"$ref": "MonitoredResource"
- },
- "type": "array"
+ }
},
"nextPageToken": {
"description": "If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.",
"type": "string"
},
"totalSize": {
- "format": "int32",
"description": "The total number of elements matching this request.",
+ "format": "int32",
"type": "integer"
}
},
@@ -516,86 +1555,45 @@
"description": "The CreateCollectdTimeSeries request.",
"type": "object",
"properties": {
- "collectdPayloads": {
- "description": "The collectd payloads representing the time series data. You must not include more than a single point for each time series, so no two payloads can have the same values for all of the fields plugin, plugin_instance, type, and type_instance.",
- "items": {
- "$ref": "CollectdPayload"
- },
- "type": "array"
+ "collectdVersion": {
+ "description": "The version of collectd that collected the data. Example: \"5.3.0-192.el6\".",
+ "type": "string"
},
"resource": {
"$ref": "MonitoredResource",
"description": "The monitored resource associated with the time series."
},
- "collectdVersion": {
- "description": "The version of collectd that collected the data. Example: \"5.3.0-192.el6\".",
- "type": "string"
+ "collectdPayloads": {
+ "description": "The collectd payloads representing the time series data. You must not include more than a single point for each time series, so no two payloads can have the same values for all of the fields plugin, plugin_instance, type, and type_instance.",
+ "type": "array",
+ "items": {
+ "$ref": "CollectdPayload"
+ }
}
},
"id": "CreateCollectdTimeSeriesRequest"
},
"ListMonitoredResourceDescriptorsResponse": {
- "description": "The ListMonitoredResourceDescriptors response.",
- "type": "object",
"properties": {
- "resourceDescriptors": {
- "description": "The monitored resource descriptors that are available to this project and that match filter, if present.",
- "items": {
- "$ref": "MonitoredResourceDescriptor"
- },
- "type": "array"
- },
"nextPageToken": {
"description": "If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.",
"type": "string"
+ },
+ "resourceDescriptors": {
+ "description": "The monitored resource descriptors that are available to this project and that match filter, if present.",
+ "type": "array",
+ "items": {
+ "$ref": "MonitoredResourceDescriptor"
+ }
}
},
- "id": "ListMonitoredResourceDescriptorsResponse"
+ "id": "ListMonitoredResourceDescriptorsResponse",
+ "description": "The ListMonitoredResourceDescriptors response.",
+ "type": "object"
},
"TimeSeries": {
- "description": "A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series.",
- "type": "object",
"properties": {
- "points": {
- "description": "The data points of this time series. When listing time series, the order of the points is specified by the list method.When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.",
- "items": {
- "$ref": "Point"
- },
- "type": "array"
- },
- "metric": {
- "description": "The associated metric. A fully-specified metric used to identify the time series.",
- "$ref": "Metric"
- },
- "valueType": {
- "enumDescriptions": [
- "Do not use this default value.",
- "The value is a boolean. This value type can be used only if the metric kind is GAUGE.",
- "The value is a signed 64-bit integer.",
- "The value is a double precision floating point number.",
- "The value is a text string. This value type can be used only if the metric kind is GAUGE.",
- "The value is a Distribution.",
- "The value is money."
- ],
- "enum": [
- "VALUE_TYPE_UNSPECIFIED",
- "BOOL",
- "INT64",
- "DOUBLE",
- "STRING",
- "DISTRIBUTION",
- "MONEY"
- ],
- "description": "The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the type of the data in the points field.",
- "type": "string"
- },
- "resource": {
- "$ref": "MonitoredResource",
- "description": "The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data."
- },
"metricKind": {
- "description": "The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE.",
- "type": "string",
"enumDescriptions": [
"Do not use this default value.",
"An instantaneous measurement of a value.",
@@ -607,32 +1605,77 @@
"GAUGE",
"DELTA",
"CUMULATIVE"
+ ],
+ "description": "The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE.",
+ "type": "string"
+ },
+ "metric": {
+ "description": "The associated metric. A fully-specified metric used to identify the time series.",
+ "$ref": "Metric"
+ },
+ "points": {
+ "description": "The data points of this time series. When listing time series, the order of the points is specified by the list method.When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.",
+ "type": "array",
+ "items": {
+ "$ref": "Point"
+ }
+ },
+ "valueType": {
+ "enum": [
+ "VALUE_TYPE_UNSPECIFIED",
+ "BOOL",
+ "INT64",
+ "DOUBLE",
+ "STRING",
+ "DISTRIBUTION",
+ "MONEY"
+ ],
+ "description": "The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the type of the data in the points field.",
+ "type": "string",
+ "enumDescriptions": [
+ "Do not use this default value.",
+ "The value is a boolean. This value type can be used only if the metric kind is GAUGE.",
+ "The value is a signed 64-bit integer.",
+ "The value is a double precision floating point number.",
+ "The value is a text string. This value type can be used only if the metric kind is GAUGE.",
+ "The value is a Distribution.",
+ "The value is money."
]
+ },
+ "resource": {
+ "description": "The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data.",
+ "$ref": "MonitoredResource"
}
},
- "id": "TimeSeries"
+ "id": "TimeSeries",
+ "description": "A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series.",
+ "type": "object"
},
"CreateTimeSeriesRequest": {
- "description": "The CreateTimeSeries request.",
- "type": "object",
"properties": {
"timeSeries": {
"description": "The new data to be added to a list of time series. Adds at most one data point to each of several time series. The new data point must be more recent than any other point in its time series. Each TimeSeries value must fully specify a unique time series by supplying all label values for the metric and the monitored resource.",
+ "type": "array",
"items": {
"$ref": "TimeSeries"
- },
- "type": "array"
+ }
}
},
- "id": "CreateTimeSeriesRequest"
+ "id": "CreateTimeSeriesRequest",
+ "description": "The CreateTimeSeries request.",
+ "type": "object"
},
"Distribution": {
"description": "Distribution contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets.The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths.Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the mean and sum_of_squared_deviation fields meaningless.",
"type": "object",
"properties": {
+ "bucketOptions": {
+ "description": "Required in the Stackdriver Monitoring API v3. Defines the histogram bucket boundaries.",
+ "$ref": "BucketOptions"
+ },
"sumOfSquaredDeviation": {
- "format": "double",
"description": "The sum of squared deviations from the mean of the values in the population. For values x_i this is:\nSum[i=1..n]((x_i - mean)^2)\nKnuth, \"The Art of Computer Programming\", Vol. 2, page 323, 3rd edition describes Welford's method for accumulating this sum in one pass.If count is zero then this field must be zero.",
+ "format": "double",
"type": "number"
},
"range": {
@@ -640,33 +1683,27 @@
"description": "If specified, contains the range of the population values. The field must not be present if the count is zero. This field is presently ignored by the Stackdriver Monitoring API v3."
},
"count": {
- "format": "int64",
"description": "The number of values in the population. Must be non-negative. This value must equal the sum of the values in bucket_counts if a histogram is provided.",
+ "format": "int64",
"type": "string"
},
"mean": {
- "format": "double",
"description": "The arithmetic mean of the values in the population. If count is zero then this field must be zero.",
+ "format": "double",
"type": "number"
},
"bucketCounts": {
"description": "Required in the Stackdriver Monitoring API v3. The values for each bucket specified in bucket_options. The sum of the values in bucketCounts must equal the value in the count field of the Distribution object. The order of the bucket counts follows the numbering schemes described for the three bucket types. The underflow bucket has number 0; the finite buckets, if any, have numbers 1 through N-2; and the overflow bucket has number N-1. The size of bucket_counts must not be greater than N. If the size is less than N, then the remaining buckets are assigned values of zero.",
+ "type": "array",
"items": {
"format": "int64",
"type": "string"
- },
- "type": "array"
- },
- "bucketOptions": {
- "$ref": "BucketOptions",
- "description": "Required in the Stackdriver Monitoring API v3. Defines the histogram bucket boundaries."
+ }
}
},
"id": "Distribution"
},
"MonitoredResource": {
- "description": "An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for \"gce_instance\" has labels \"instance_id\" and \"zone\":\n{ \"type\": \"gce_instance\",\n \"labels\": { \"instance_id\": \"12345678901234\",\n \"zone\": \"us-central1-a\" }}\n",
- "type": "object",
"properties": {
"labels": {
"additionalProperties": {
@@ -680,124 +1717,184 @@
"type": "string"
}
},
- "id": "MonitoredResource"
+ "id": "MonitoredResource",
+ "description": "An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for \"gce_instance\" has labels \"instance_id\" and \"zone\":\n{ \"type\": \"gce_instance\",\n \"labels\": { \"instance_id\": \"12345678901234\",\n \"zone\": \"us-central1-a\" }}\n",
+ "type": "object"
},
"ListMetricDescriptorsResponse": {
- "description": "The ListMetricDescriptors response.",
- "type": "object",
"properties": {
+ "metricDescriptors": {
+ "description": "The metric descriptors that are available to the project and that match the value of filter, if present.",
+ "type": "array",
+ "items": {
+ "$ref": "MetricDescriptor"
+ }
+ },
"nextPageToken": {
"description": "If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.",
"type": "string"
- },
- "metricDescriptors": {
- "description": "The metric descriptors that are available to the project and that match the value of filter, if present.",
- "items": {
- "$ref": "MetricDescriptor"
- },
- "type": "array"
}
},
- "id": "ListMetricDescriptorsResponse"
+ "id": "ListMetricDescriptorsResponse",
+ "description": "The ListMetricDescriptors response.",
+ "type": "object"
},
"CollectdPayloadError": {
- "description": "Describes the error status for payloads that were not written.",
- "type": "object",
"properties": {
"index": {
- "format": "int32",
"description": "The zero-based index in CreateCollectdTimeSeriesRequest.collectd_payloads.",
+ "format": "int32",
"type": "integer"
},
- "valueErrors": {
- "description": "Records the error status for values that were not written due to an error.Failed payloads for which nothing is written will not include partial value errors.",
- "items": {
- "$ref": "CollectdValueError"
- },
- "type": "array"
- },
"error": {
"description": "Records the error status for the payload. If this field is present, the partial errors for nested values won't be populated.",
"$ref": "Status"
+ },
+ "valueErrors": {
+ "description": "Records the error status for values that were not written due to an error.Failed payloads for which nothing is written will not include partial value errors.",
+ "type": "array",
+ "items": {
+ "$ref": "CollectdValueError"
+ }
}
},
- "id": "CollectdPayloadError"
+ "id": "CollectdPayloadError",
+ "description": "Describes the error status for payloads that were not written.",
+ "type": "object"
},
"MonitoredResourceDescriptor": {
"description": "An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of \"gce_instance\" and specifies the use of the labels \"instance_id\" and \"zone\" to identify particular VM instances.Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API.",
"type": "object",
"properties": {
- "description": {
- "description": "Optional. A detailed description of the monitored resource type that might be used in documentation.",
+ "name": {
+ "description": "Optional. The resource name of the monitored resource descriptor: \"projects/{project_id}/monitoredResourceDescriptors/{type}\" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format \"monitoredResourceDescriptors/{type}\".",
"type": "string"
},
"displayName": {
"description": "Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, \"Google Cloud SQL Database\".",
"type": "string"
},
+ "description": {
+ "description": "Optional. A detailed description of the monitored resource type that might be used in documentation.",
+ "type": "string"
+ },
"type": {
"description": "Required. The monitored resource type. For example, the type \"cloudsql_database\" represents databases in Google Cloud SQL. The maximum length of this value is 256 characters.",
"type": "string"
},
"labels": {
"description": "Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels \"database_id\" and \"zone\".",
+ "type": "array",
"items": {
"$ref": "LabelDescriptor"
- },
- "type": "array"
- },
- "name": {
- "description": "Optional. The resource name of the monitored resource descriptor: \"projects/{project_id}/monitoredResourceDescriptors/{type}\" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format \"monitoredResourceDescriptors/{type}\".",
- "type": "string"
+ }
}
},
"id": "MonitoredResourceDescriptor"
},
- "TypedValue": {
- "description": "A single strongly-typed value.",
+ "ResourceGroup": {
+ "description": "The resource submessage for group checks. It can be used instead of a monitored resource, when multiple resources are being monitored.",
"type": "object",
"properties": {
- "stringValue": {
- "description": "A variable-length string value.",
+ "resourceType": {
+ "enumDescriptions": [
+ "Default value (not valid).",
+ "A group of instances (could be either GCE or AWS_EC2).",
+ "A group of AWS load balancers."
+ ],
+ "enum": [
+ "RESOURCE_TYPE_UNSPECIFIED",
+ "INSTANCE",
+ "AWS_ELB_LOAD_BALANCER"
+ ],
+ "description": "The resource type of the group members.",
"type": "string"
},
+ "groupId": {
+ "description": "The group of resources being monitored. Should be only the group_id, not projects/\u003cproject_id\u003e/groups/\u003cgroup_id\u003e.",
+ "type": "string"
+ }
+ },
+ "id": "ResourceGroup"
+ },
+ "TypedValue": {
+ "properties": {
+ "doubleValue": {
+ "description": "A 64-bit double-precision floating-point number. Its magnitude is approximately ±10\u003csup\u003e±300\u003c/sup\u003e and it has 16 significant digits of precision.",
+ "format": "double",
+ "type": "number"
+ },
+ "int64Value": {
+ "description": "A 64-bit integer. Its range is approximately ±9.2x10\u003csup\u003e18\u003c/sup\u003e.",
+ "format": "int64",
+ "type": "string"
+ },
+ "distributionValue": {
+ "description": "A distribution value.",
+ "$ref": "Distribution"
+ },
"boolValue": {
"description": "A Boolean value: true or false.",
"type": "boolean"
},
- "doubleValue": {
- "format": "double",
- "description": "A 64-bit double-precision floating-point number. Its magnitude is approximately ±10\u003csup\u003e±300\u003c/sup\u003e and it has 16 significant digits of precision.",
- "type": "number"
- },
- "int64Value": {
- "format": "int64",
- "description": "A 64-bit integer. Its range is approximately ±9.2x10\u003csup\u003e18\u003c/sup\u003e.",
+ "stringValue": {
+ "description": "A variable-length string value.",
"type": "string"
- },
- "distributionValue": {
- "$ref": "Distribution",
- "description": "A distribution value."
}
},
- "id": "TypedValue"
+ "id": "TypedValue",
+ "description": "A single strongly-typed value.",
+ "type": "object"
},
"CollectdValueError": {
"description": "Describes the error status for values that were not written.",
"type": "object",
"properties": {
"index": {
- "format": "int32",
"description": "The zero-based index in CollectdPayload.values within the parent CreateCollectdTimeSeriesRequest.collectd_payloads.",
+ "format": "int32",
"type": "integer"
},
"error": {
- "$ref": "Status",
- "description": "Records the error status for the value."
+ "description": "Records the error status for the value.",
+ "$ref": "Status"
}
},
"id": "CollectdValueError"
},
+ "UptimeCheckIp": {
+ "description": "Contains the region, location, and list of IP addresses where checkers in the location run from.",
+ "type": "object",
+ "properties": {
+ "ipAddress": {
+ "description": "The IP address from which the uptime check originates. This is a full IP address (not an IP address range). Most IP addresses, as of this publication, are in IPv4 format; however, one should not rely on the IP addresses being in IPv4 format indefinitely and should support interpreting this field in either IPv4 or IPv6 format.",
+ "type": "string"
+ },
+ "region": {
+ "enumDescriptions": [
+ "Default value if no region is specified. Will result in uptime checks running from all regions.",
+ "Allows checks to run from locations within the United States of America.",
+ "Allows checks to run from locations within the continent of Europe.",
+ "Allows checks to run from locations within the continent of South America.",
+ "Allows checks to run from locations within the Asia Pacific area (ex: Singapore)."
+ ],
+ "enum": [
+ "REGION_UNSPECIFIED",
+ "USA",
+ "EUROPE",
+ "SOUTH_AMERICA",
+ "ASIA_PACIFIC"
+ ],
+ "description": "A broad region category in which the IP address is located.",
+ "type": "string"
+ },
+ "location": {
+ "description": "A more specific location within the region that typically encodes a particular city/town/metro (and its containing state/province or country) within the broader umbrella region category.",
+ "type": "string"
+ }
+ },
+ "id": "UptimeCheckIp"
+ },
"CollectdPayload": {
"description": "A collection of data points sent from a collectd-based plugin. See the collectd documentation for more information.",
"type": "object",
@@ -811,11 +1908,11 @@
"type": "string"
},
"metadata": {
- "description": "The measurement metadata. Example: \"process_id\" -\u003e 12345",
- "type": "object",
"additionalProperties": {
"$ref": "TypedValue"
- }
+ },
+ "description": "The measurement metadata. Example: \"process_id\" -\u003e 12345",
+ "type": "object"
},
"plugin": {
"description": "The name of the plugin. Example: \"disk\".",
@@ -826,69 +1923,63 @@
"type": "string"
},
"endTime": {
- "format": "google-datetime",
"description": "The end time of the interval.",
+ "format": "google-datetime",
"type": "string"
},
"startTime": {
- "format": "google-datetime",
"description": "The start time of the interval.",
+ "format": "google-datetime",
"type": "string"
},
"values": {
"description": "The measured values during this time interval. Each value must have a different dataSourceName.",
+ "type": "array",
"items": {
"$ref": "CollectdValue"
- },
- "type": "array"
+ }
}
},
"id": "CollectdPayload"
},
"CreateCollectdTimeSeriesResponse": {
- "description": "The CreateCollectdTimeSeries response.",
- "type": "object",
"properties": {
"payloadErrors": {
"description": "Records the error status for points that were not written due to an error.Failed requests for which nothing is written will return an error response instead.",
+ "type": "array",
"items": {
"$ref": "CollectdPayloadError"
- },
- "type": "array"
+ }
}
},
- "id": "CreateCollectdTimeSeriesResponse"
+ "id": "CreateCollectdTimeSeriesResponse",
+ "description": "The CreateCollectdTimeSeries response.",
+ "type": "object"
},
"Linear": {
- "description": "Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): offset + (width * i). Lower bound (1 \u003c= i \u003c N): offset + (width * (i - 1)).",
- "type": "object",
"properties": {
- "offset": {
+ "width": {
+ "description": "Must be greater than 0.",
"format": "double",
+ "type": "number"
+ },
+ "offset": {
"description": "Lower bound of the first bucket.",
+ "format": "double",
"type": "number"
},
"numFiniteBuckets": {
+ "description": "Must be greater than 0.",
"format": "int32",
- "description": "Must be greater than 0.",
"type": "integer"
- },
- "width": {
- "format": "double",
- "description": "Must be greater than 0.",
- "type": "number"
}
},
- "id": "Linear"
+ "id": "Linear",
+ "description": "Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): offset + (width * i). Lower bound (1 \u003c= i \u003c N): offset + (width * (i - 1)).",
+ "type": "object"
},
"Option": {
- "description": "A protocol buffer option, which can be attached to a message, field, enumeration, etc.",
- "type": "object",
"properties": {
- "name": {
- "description": "The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, \"map_entry\". For custom options, it should be the fully-qualified name. For example, \"google.api.http\".",
- "type": "string"
- },
"value": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
@@ -896,9 +1987,26 @@
},
"description": "The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.",
"type": "object"
+ },
+ "name": {
+ "description": "The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, \"map_entry\". For custom options, it should be the fully-qualified name. For example, \"google.api.http\".",
+ "type": "string"
}
},
- "id": "Option"
+ "id": "Option",
+ "description": "A protocol buffer option, which can be attached to a message, field, enumeration, etc.",
+ "type": "object"
+ },
+ "ContentMatcher": {
+ "description": "Used to perform string matching. Currently, this matches on the exact content. In the future, it can be expanded to allow for regular expressions and more complex matching.",
+ "type": "object",
+ "properties": {
+ "content": {
+ "description": "String content to match",
+ "type": "string"
+ }
+ },
+ "id": "ContentMatcher"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
@@ -906,59 +2014,126 @@
"properties": {},
"id": "Empty"
},
+ "TcpCheck": {
+ "properties": {
+ "port": {
+ "description": "The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) to construct the full URL. Required.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "TcpCheck",
+ "description": "Information required for a TCP uptime check request.",
+ "type": "object"
+ },
"TimeInterval": {
"description": "A time interval extending just after a start time through an end time. If the start time is the same as the end time, then the interval represents a single point in time.",
"type": "object",
"properties": {
- "endTime": {
+ "startTime": {
+ "description": "Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.",
"format": "google-datetime",
- "description": "Required. The end of the time interval.",
"type": "string"
},
- "startTime": {
+ "endTime": {
+ "description": "Required. The end of the time interval.",
"format": "google-datetime",
- "description": "Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.",
"type": "string"
}
},
"id": "TimeInterval"
},
"Explicit": {
- "description": "Specifies a set of buckets with arbitrary widths.There are size(bounds) + 1 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): boundsi Lower bound (1 \u003c= i \u003c N); boundsi - 1The bounds field must contain at least one element. If bounds has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.",
- "type": "object",
"properties": {
"bounds": {
"description": "The values must be monotonically increasing.",
+ "type": "array",
"items": {
"format": "double",
"type": "number"
- },
- "type": "array"
+ }
}
},
- "id": "Explicit"
+ "id": "Explicit",
+ "description": "Specifies a set of buckets with arbitrary widths.There are size(bounds) + 1 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): boundsi Lower bound (1 \u003c= i \u003c N); boundsi - 1The bounds field must contain at least one element. If bounds has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.",
+ "type": "object"
+ },
+ "ListUptimeCheckIpsResponse": {
+ "description": "The protocol for the ListUptimeCheckIps response.",
+ "type": "object",
+ "properties": {
+ "uptimeCheckIps": {
+ "description": "The returned list of IP addresses (including region and location) that the checkers run from.",
+ "type": "array",
+ "items": {
+ "$ref": "UptimeCheckIp"
+ }
+ },
+ "nextPageToken": {
+ "description": "This field represents the pagination token to retrieve the next page of results. If the value is empty, it means no further results for the request. To retrieve the next page of results, the value of the next_page_token is passed to the subsequent List method call (in the request message's page_token field). NOTE: this field is not yet implemented",
+ "type": "string"
+ }
+ },
+ "id": "ListUptimeCheckIpsResponse"
+ },
+ "Exponential": {
+ "description": "Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): scale * (growth_factor ^ i). Lower bound (1 \u003c= i \u003c N): scale * (growth_factor ^ (i - 1)).",
+ "type": "object",
+ "properties": {
+ "growthFactor": {
+ "description": "Must be greater than 1.",
+ "format": "double",
+ "type": "number"
+ },
+ "scale": {
+ "description": "Must be greater than 0.",
+ "format": "double",
+ "type": "number"
+ },
+ "numFiniteBuckets": {
+ "description": "Must be greater than 0.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "Exponential"
+ },
+ "Point": {
+ "properties": {
+ "interval": {
+ "description": "The time interval to which the data point applies. For GAUGE metrics, only the end time of the interval is used. For DELTA metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For CUMULATIVE metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points.",
+ "$ref": "TimeInterval"
+ },
+ "value": {
+ "description": "The value of the data point.",
+ "$ref": "TypedValue"
+ }
+ },
+ "id": "Point",
+ "description": "A single data point in a time series.",
+ "type": "object"
}
},
- "icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
"protocol": "rest",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
"canonicalName": "Monitoring",
"auth": {
"oauth2": {
"scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/monitoring.read": {
+ "description": "View monitoring data for all of your Google Cloud and third-party projects"
+ },
"https://www.googleapis.com/auth/monitoring": {
"description": "View and write monitoring data for all of your Google and third-party Cloud and API projects"
},
"https://www.googleapis.com/auth/monitoring.write": {
"description": "Publish metric data to your Google Cloud projects"
- },
- "https://www.googleapis.com/auth/monitoring.read": {
- "description": "View monitoring data for all of your Google Cloud and third-party projects"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
}
}
}
@@ -968,742 +2143,5 @@
"name": "monitoring",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
- "title": "Stackdriver Monitoring API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "groups": {
- "methods": {
- "delete": {
- "description": "Deletes an existing group.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "The group to delete. The format is \"projects/{project_id_or_number}/groups/{group_id}\".",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/groups/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring"
- ],
- "flatPath": "v3/projects/{projectsId}/groups/{groupsId}",
- "path": "v3/{+name}",
- "id": "monitoring.projects.groups.delete"
- },
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Group"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "The group to retrieve. The format is \"projects/{project_id_or_number}/groups/{group_id}\".",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/groups/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.read"
- ],
- "flatPath": "v3/projects/{projectsId}/groups/{groupsId}",
- "path": "v3/{+name}",
- "id": "monitoring.projects.groups.get",
- "description": "Gets a single group."
- },
- "list": {
- "response": {
- "$ref": "ListGroupsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.read"
- ],
- "parameters": {
- "name": {
- "description": "The project whose groups are to be listed. The format is \"projects/{project_id_or_number}\".",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "childrenOfGroup": {
- "description": "A group name: \"projects/{project_id_or_number}/groups/{group_id}\". Returns groups whose parentName field contains the group name. If no groups have this parent, the results are empty.",
- "type": "string",
- "location": "query"
- },
- "descendantsOfGroup": {
- "location": "query",
- "description": "A group name: \"projects/{project_id_or_number}/groups/{group_id}\". Returns the descendants of the specified group. This is a superset of the results returned by the childrenOfGroup filter, and includes children-of-children, and so forth.",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
- "type": "string"
- },
- "pageSize": {
- "format": "int32",
- "description": "A positive number that is the maximum number of results to return.",
- "type": "integer",
- "location": "query"
- },
- "ancestorsOfGroup": {
- "location": "query",
- "description": "A group name: \"projects/{project_id_or_number}/groups/{group_id}\". Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty.",
- "type": "string"
- }
- },
- "flatPath": "v3/projects/{projectsId}/groups",
- "id": "monitoring.projects.groups.list",
- "path": "v3/{+name}/groups",
- "description": "Lists the existing groups."
- },
- "update": {
- "request": {
- "$ref": "Group"
- },
- "description": "Updates an existing group. You can change any group attributes except name.",
- "response": {
- "$ref": "Group"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring"
- ],
- "parameters": {
- "validateOnly": {
- "description": "If true, validate this request but do not update the existing group.",
- "type": "boolean",
- "location": "query"
- },
- "name": {
- "location": "path",
- "description": "Output only. The name of this group. The format is \"projects/{project_id_or_number}/groups/{group_id}\". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique {group_id} that is generated automatically.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/groups/[^/]+$"
- }
- },
- "flatPath": "v3/projects/{projectsId}/groups/{groupsId}",
- "id": "monitoring.projects.groups.update",
- "path": "v3/{+name}"
- },
- "create": {
- "flatPath": "v3/projects/{projectsId}/groups",
- "id": "monitoring.projects.groups.create",
- "path": "v3/{+name}/groups",
- "description": "Creates a new group.",
- "request": {
- "$ref": "Group"
- },
- "response": {
- "$ref": "Group"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "validateOnly": {
- "description": "If true, validate this request but do not create the group.",
- "type": "boolean",
- "location": "query"
- },
- "name": {
- "location": "path",
- "description": "The project in which to create the group. The format is \"projects/{project_id_or_number}\".",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring"
- ]
- }
- },
- "resources": {
- "members": {
- "methods": {
- "list": {
- "description": "Lists the monitored resources that are members of a group.",
- "response": {
- "$ref": "ListGroupMembersResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "The group whose members are listed. The format is \"projects/{project_id_or_number}/groups/{group_id}\".",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/groups/[^/]+$",
- "location": "path"
- },
- "interval.endTime": {
- "location": "query",
- "format": "google-datetime",
- "description": "Required. The end of the time interval.",
- "type": "string"
- },
- "filter": {
- "description": "An optional list filter describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group. For example, to return only resources representing Compute Engine VM instances, use this filter:\nresource.type = \"gce_instance\"\n",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
- "type": "string"
- },
- "pageSize": {
- "format": "int32",
- "description": "A positive number that is the maximum number of results to return.",
- "type": "integer",
- "location": "query"
- },
- "interval.startTime": {
- "location": "query",
- "format": "google-datetime",
- "description": "Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.read"
- ],
- "flatPath": "v3/projects/{projectsId}/groups/{groupsId}/members",
- "id": "monitoring.projects.groups.members.list",
- "path": "v3/{+name}/members"
- }
- }
- }
- }
- },
- "collectdTimeSeries": {
- "methods": {
- "create": {
- "request": {
- "$ref": "CreateCollectdTimeSeriesRequest"
- },
- "description": "Stackdriver Monitoring Agent only: Creates a new time series.\u003caside class=\"caution\"\u003eThis method is only for use by the Stackdriver Monitoring Agent. Use projects.timeSeries.create instead.\u003c/aside\u003e",
- "response": {
- "$ref": "CreateCollectdTimeSeriesResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.write"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The project in which to create the time series. The format is \"projects/PROJECT_ID_OR_NUMBER\".",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$"
- }
- },
- "flatPath": "v3/projects/{projectsId}/collectdTimeSeries",
- "id": "monitoring.projects.collectdTimeSeries.create",
- "path": "v3/{+name}/collectdTimeSeries"
- }
- }
- },
- "timeSeries": {
- "methods": {
- "list": {
- "flatPath": "v3/projects/{projectsId}/timeSeries",
- "path": "v3/{+name}/timeSeries",
- "id": "monitoring.projects.timeSeries.list",
- "description": "Lists time series that match a filter. This method does not require a Stackdriver account.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "ListTimeSeriesResponse"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$"
- },
- "aggregation.groupByFields": {
- "description": "The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.",
- "type": "string",
- "repeated": true,
- "location": "query"
- },
- "interval.endTime": {
- "format": "google-datetime",
- "description": "Required. The end of the time interval.",
- "type": "string",
- "location": "query"
- },
- "aggregation.alignmentPeriod": {
- "location": "query",
- "format": "google-duration",
- "description": "The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "A positive number that is the maximum number of results to return. When view field sets to FULL, it limits the number of Points server will return; if view field is HEADERS, it limits the number of TimeSeries server will return.",
- "type": "integer"
- },
- "orderBy": {
- "location": "query",
- "description": "Specifies the order in which the points of the time series should be returned. By default, results are not ordered. Currently, this field must be left blank.",
- "type": "string"
- },
- "aggregation.crossSeriesReducer": {
- "location": "query",
- "enum": [
- "REDUCE_NONE",
- "REDUCE_MEAN",
- "REDUCE_MIN",
- "REDUCE_MAX",
- "REDUCE_SUM",
- "REDUCE_STDDEV",
- "REDUCE_COUNT",
- "REDUCE_COUNT_TRUE",
- "REDUCE_FRACTION_TRUE",
- "REDUCE_PERCENTILE_99",
- "REDUCE_PERCENTILE_95",
- "REDUCE_PERCENTILE_50",
- "REDUCE_PERCENTILE_05"
- ],
- "description": "The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned.",
- "type": "string"
- },
- "filter": {
- "description": "A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example:\nmetric.type = \"compute.googleapis.com/instance/cpu/usage_time\" AND\n metric.label.instance_name = \"my-instance-name\"\n",
- "type": "string",
- "location": "query"
- },
- "aggregation.perSeriesAligner": {
- "location": "query",
- "enum": [
- "ALIGN_NONE",
- "ALIGN_DELTA",
- "ALIGN_RATE",
- "ALIGN_INTERPOLATE",
- "ALIGN_NEXT_OLDER",
- "ALIGN_MIN",
- "ALIGN_MAX",
- "ALIGN_MEAN",
- "ALIGN_COUNT",
- "ALIGN_SUM",
- "ALIGN_STDDEV",
- "ALIGN_COUNT_TRUE",
- "ALIGN_FRACTION_TRUE",
- "ALIGN_PERCENTILE_99",
- "ALIGN_PERCENTILE_95",
- "ALIGN_PERCENTILE_50",
- "ALIGN_PERCENTILE_05"
- ],
- "description": "The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned.",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
- "type": "string"
- },
- "interval.startTime": {
- "location": "query",
- "format": "google-datetime",
- "description": "Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.",
- "type": "string"
- },
- "view": {
- "location": "query",
- "enum": [
- "FULL",
- "HEADERS"
- ],
- "description": "Specifies which information is returned about the time series.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.read"
- ]
- },
- "create": {
- "flatPath": "v3/projects/{projectsId}/timeSeries",
- "id": "monitoring.projects.timeSeries.create",
- "path": "v3/{+name}/timeSeries",
- "request": {
- "$ref": "CreateTimeSeriesRequest"
- },
- "description": "Creates or adds data to one or more time series. The response is empty if all time series in the request were written. If any time series could not be written, a corresponding failure message is included in the error response.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.write"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$"
- }
- }
- }
- }
- },
- "metricDescriptors": {
- "methods": {
- "delete": {
- "description": "Deletes a metric descriptor. Only user-created custom metrics can be deleted.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The metric descriptor on which to execute the request. The format is \"projects/{project_id_or_number}/metricDescriptors/{metric_id}\". An example of {metric_id} is: \"custom.googleapis.com/my_test_metric\".",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/metricDescriptors/.+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring"
- ],
- "flatPath": "v3/projects/{projectsId}/metricDescriptors/{metricDescriptorsId}",
- "id": "monitoring.projects.metricDescriptors.delete",
- "path": "v3/{+name}"
- },
- "get": {
- "response": {
- "$ref": "MetricDescriptor"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The metric descriptor on which to execute the request. The format is \"projects/{project_id_or_number}/metricDescriptors/{metric_id}\". An example value of {metric_id} is \"compute.googleapis.com/instance/disk/read_bytes_count\".",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/metricDescriptors/.+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.read",
- "https://www.googleapis.com/auth/monitoring.write"
- ],
- "flatPath": "v3/projects/{projectsId}/metricDescriptors/{metricDescriptorsId}",
- "id": "monitoring.projects.metricDescriptors.get",
- "path": "v3/{+name}",
- "description": "Gets a single metric descriptor. This method does not require a Stackdriver account."
- },
- "list": {
- "description": "Lists metric descriptors that match a filter. This method does not require a Stackdriver account.",
- "response": {
- "$ref": "ListMetricDescriptorsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.read",
- "https://www.googleapis.com/auth/monitoring.write"
- ],
- "parameters": {
- "filter": {
- "description": "If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics:\nmetric.type = starts_with(\"custom.googleapis.com/\")\n",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "location": "path",
- "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$"
- },
- "pageSize": {
- "format": "int32",
- "description": "A positive number that is the maximum number of results to return.",
- "type": "integer",
- "location": "query"
- }
- },
- "flatPath": "v3/projects/{projectsId}/metricDescriptors",
- "id": "monitoring.projects.metricDescriptors.list",
- "path": "v3/{+name}/metricDescriptors"
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "MetricDescriptor"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.write"
- ],
- "parameters": {
- "name": {
- "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v3/projects/{projectsId}/metricDescriptors",
- "path": "v3/{+name}/metricDescriptors",
- "id": "monitoring.projects.metricDescriptors.create",
- "request": {
- "$ref": "MetricDescriptor"
- },
- "description": "Creates a new metric descriptor. User-created metric descriptors define custom metrics."
- }
- }
- },
- "monitoredResourceDescriptors": {
- "methods": {
- "get": {
- "description": "Gets a single monitored resource descriptor. This method does not require a Stackdriver account.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "MonitoredResourceDescriptor"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.read",
- "https://www.googleapis.com/auth/monitoring.write"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The monitored resource descriptor to get. The format is \"projects/{project_id_or_number}/monitoredResourceDescriptors/{resource_type}\". The {resource_type} is a predefined type, such as cloudsql_database.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/monitoredResourceDescriptors/[^/]+$"
- }
- },
- "flatPath": "v3/projects/{projectsId}/monitoredResourceDescriptors/{monitoredResourceDescriptorsId}",
- "path": "v3/{+name}",
- "id": "monitoring.projects.monitoredResourceDescriptors.get"
- },
- "list": {
- "flatPath": "v3/projects/{projectsId}/monitoredResourceDescriptors",
- "id": "monitoring.projects.monitoredResourceDescriptors.list",
- "path": "v3/{+name}/monitoredResourceDescriptors",
- "description": "Lists monitored resource descriptors that match a filter. This method does not require a Stackdriver account.",
- "response": {
- "$ref": "ListMonitoredResourceDescriptorsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.read",
- "https://www.googleapis.com/auth/monitoring.write"
- ],
- "parameters": {
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "A positive number that is the maximum number of results to return.",
- "type": "integer"
- },
- "filter": {
- "location": "query",
- "description": "An optional filter describing the descriptors to be returned. The filter can reference the descriptor's type and labels. For example, the following filter returns only Google Compute Engine descriptors that have an id label:\nresource.type = starts_with(\"gce_\") AND resource.label:id\n",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
- "type": "string"
- },
- "name": {
- "location": "path",
- "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$"
- }
- }
- }
- }
- }
- }
- }
- },
- "parameters": {
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "alt": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- }
- },
- "version": "v3",
- "baseUrl": "https://monitoring.googleapis.com/"
+ "title": "Stackdriver Monitoring API"
}
diff --git a/monitoring/v3/monitoring-gen.go b/monitoring/v3/monitoring-gen.go
index b17dd19..26d3a47 100644
--- a/monitoring/v3/monitoring-gen.go
+++ b/monitoring/v3/monitoring-gen.go
@@ -68,6 +68,7 @@
}
s := &Service{client: client, BasePath: basePath}
s.Projects = NewProjectsService(s)
+ s.UptimeCheckIps = NewUptimeCheckIpsService(s)
return s, nil
}
@@ -77,6 +78,8 @@
UserAgent string // optional additional User-Agent fragment
Projects *ProjectsService
+
+ UptimeCheckIps *UptimeCheckIpsService
}
func (s *Service) userAgent() string {
@@ -93,6 +96,7 @@
rs.MetricDescriptors = NewProjectsMetricDescriptorsService(s)
rs.MonitoredResourceDescriptors = NewProjectsMonitoredResourceDescriptorsService(s)
rs.TimeSeries = NewProjectsTimeSeriesService(s)
+ rs.UptimeCheckConfigs = NewProjectsUptimeCheckConfigsService(s)
return rs
}
@@ -108,6 +112,8 @@
MonitoredResourceDescriptors *ProjectsMonitoredResourceDescriptorsService
TimeSeries *ProjectsTimeSeriesService
+
+ UptimeCheckConfigs *ProjectsUptimeCheckConfigsService
}
func NewProjectsCollectdTimeSeriesService(s *Service) *ProjectsCollectdTimeSeriesService {
@@ -167,6 +173,57 @@
s *Service
}
+func NewProjectsUptimeCheckConfigsService(s *Service) *ProjectsUptimeCheckConfigsService {
+ rs := &ProjectsUptimeCheckConfigsService{s: s}
+ return rs
+}
+
+type ProjectsUptimeCheckConfigsService struct {
+ s *Service
+}
+
+func NewUptimeCheckIpsService(s *Service) *UptimeCheckIpsService {
+ rs := &UptimeCheckIpsService{s: s}
+ return rs
+}
+
+type UptimeCheckIpsService struct {
+ s *Service
+}
+
+// BasicAuthentication: A type of authentication to perform against the
+// specified resource or URL that uses username and password. Currently,
+// only Basic authentication is supported in Uptime Monitoring.
+type BasicAuthentication struct {
+ // Password: The password to authenticate.
+ Password string `json:"password,omitempty"`
+
+ // Username: The username to authenticate.
+ Username string `json:"username,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Password") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Password") to include in
+ // API requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *BasicAuthentication) MarshalJSON() ([]byte, error) {
+ type noMethod BasicAuthentication
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// BucketOptions: BucketOptions describes the bucket boundaries used to
// create a histogram for the distribution. The buckets can be in a
// linear sequence, an exponential sequence, or each bucket can be
@@ -389,6 +446,36 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// ContentMatcher: Used to perform string matching. Currently, this
+// matches on the exact content. In the future, it can be expanded to
+// allow for regular expressions and more complex matching.
+type ContentMatcher struct {
+ // Content: String content to match
+ Content string `json:"content,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Content") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Content") to include in
+ // API requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *ContentMatcher) MarshalJSON() ([]byte, error) {
+ type noMethod ContentMatcher
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// CreateCollectdTimeSeriesRequest: The CreateCollectdTimeSeries
// request.
type CreateCollectdTimeSeriesRequest struct {
@@ -855,6 +942,67 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// HttpCheck: Information involved in an HTTP/HTTPS uptime check
+// request.
+type HttpCheck struct {
+ // AuthInfo: The authentication information. Optional when creating an
+ // HTTP check; defaults to empty.
+ AuthInfo *BasicAuthentication `json:"authInfo,omitempty"`
+
+ // Headers: The list of headers to send as part of the uptime check
+ // request. If two headers have the same key and different values, they
+ // should be entered as a single header, with the value being a
+ // comma-separated list of all the desired values as described at
+ // https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31). Entering
+ // two separate headers with the same key in a Create call will cause
+ // the first to be overwritten by the second.
+ Headers map[string]string `json:"headers,omitempty"`
+
+ // MaskHeaders: Boolean specifiying whether to encrypt the header
+ // information. Encryption should be specified for any headers related
+ // to authentication that you do not wish to be seen when retrieving the
+ // configuration. The server will be responsible for encrypting the
+ // headers. On Get/List calls, if mask_headers is set to True then the
+ // headers will be obscured with ******.
+ MaskHeaders bool `json:"maskHeaders,omitempty"`
+
+ // Path: The path to the page to run the check against. Will be combined
+ // with the host (specified within the MonitoredResource) and port to
+ // construct the full URL. Optional (defaults to "/").
+ Path string `json:"path,omitempty"`
+
+ // Port: The port to the page to run the check against. Will be combined
+ // with host (specified within the MonitoredResource) and path to
+ // construct the full URL. Optional (defaults to 80 without SSL, or 443
+ // with SSL).
+ Port int64 `json:"port,omitempty"`
+
+ // UseSsl: If true, use HTTPS instead of HTTP to run the check.
+ UseSsl bool `json:"useSsl,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "AuthInfo") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "AuthInfo") to include in
+ // API requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *HttpCheck) MarshalJSON() ([]byte, error) {
+ type noMethod HttpCheck
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// LabelDescriptor: A description of a label.
type LabelDescriptor struct {
// Description: A human-readable description for the label.
@@ -1143,6 +1291,88 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// ListUptimeCheckConfigsResponse: The protocol for the
+// ListUptimeCheckConfigs response.
+type ListUptimeCheckConfigsResponse struct {
+ // NextPageToken: This field represents the pagination token to retrieve
+ // the next page of results. If the value is empty, it means no further
+ // results for the request. To retrieve the next page of results, the
+ // value of the next_page_token is passed to the subsequent List method
+ // call (in the request message's page_token field).
+ NextPageToken string `json:"nextPageToken,omitempty"`
+
+ // UptimeCheckConfigs: The returned uptime check configurations.
+ UptimeCheckConfigs []*UptimeCheckConfig `json:"uptimeCheckConfigs,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "NextPageToken") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "NextPageToken") to include
+ // in API requests with the JSON null value. By default, fields with
+ // empty values are omitted from API requests. However, any field with
+ // an empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *ListUptimeCheckConfigsResponse) MarshalJSON() ([]byte, error) {
+ type noMethod ListUptimeCheckConfigsResponse
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// ListUptimeCheckIpsResponse: The protocol for the ListUptimeCheckIps
+// response.
+type ListUptimeCheckIpsResponse struct {
+ // NextPageToken: This field represents the pagination token to retrieve
+ // the next page of results. If the value is empty, it means no further
+ // results for the request. To retrieve the next page of results, the
+ // value of the next_page_token is passed to the subsequent List method
+ // call (in the request message's page_token field). NOTE: this field is
+ // not yet implemented
+ NextPageToken string `json:"nextPageToken,omitempty"`
+
+ // UptimeCheckIps: The returned list of IP addresses (including region
+ // and location) that the checkers run from.
+ UptimeCheckIps []*UptimeCheckIp `json:"uptimeCheckIps,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "NextPageToken") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "NextPageToken") to include
+ // in API requests with the JSON null value. By default, fields with
+ // empty values are omitted from API requests. However, any field with
+ // an empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *ListUptimeCheckIpsResponse) MarshalJSON() ([]byte, error) {
+ type noMethod ListUptimeCheckIpsResponse
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// Metric: A specific metric, identified by specifying values for all of
// the labels of a MetricDescriptor.
type Metric struct {
@@ -1561,6 +1791,45 @@
return nil
}
+// ResourceGroup: The resource submessage for group checks. It can be
+// used instead of a monitored resource, when multiple resources are
+// being monitored.
+type ResourceGroup struct {
+ // GroupId: The group of resources being monitored. Should be only the
+ // group_id, not projects/<project_id>/groups/<group_id>.
+ GroupId string `json:"groupId,omitempty"`
+
+ // ResourceType: The resource type of the group members.
+ //
+ // Possible values:
+ // "RESOURCE_TYPE_UNSPECIFIED" - Default value (not valid).
+ // "INSTANCE" - A group of instances (could be either GCE or AWS_EC2).
+ // "AWS_ELB_LOAD_BALANCER" - A group of AWS load balancers.
+ ResourceType string `json:"resourceType,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "GroupId") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "GroupId") to include in
+ // API requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *ResourceGroup) MarshalJSON() ([]byte, error) {
+ type noMethod ResourceGroup
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// SourceContext: SourceContext represents information about the source
// of a protobuf element, like the file in which it is defined.
type SourceContext struct {
@@ -1668,6 +1937,36 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// TcpCheck: Information required for a TCP uptime check request.
+type TcpCheck struct {
+ // Port: The port to the page to run the check against. Will be combined
+ // with host (specified within the MonitoredResource) to construct the
+ // full URL. Required.
+ Port int64 `json:"port,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Port") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Port") to include in API
+ // requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *TcpCheck) MarshalJSON() ([]byte, error) {
+ type noMethod TcpCheck
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// TimeInterval: A time interval extending just after a start time
// through an end time. If the start time is the same as the end time,
// then the interval represents a single point in time.
@@ -1894,6 +2193,153 @@
return nil
}
+// UptimeCheckConfig: This message configures which resources and
+// services to monitor for availability.
+type UptimeCheckConfig struct {
+ // ContentMatchers: The expected content on the page the check is run
+ // against. Currently, only the first entry in the list is supported,
+ // and other entries will be ignored. The server will look for an exact
+ // match of the string in the page response's content. This field is
+ // optional and should only be specified if a content match is required.
+ ContentMatchers []*ContentMatcher `json:"contentMatchers,omitempty"`
+
+ // DisplayName: A human-friendly name for the uptime check
+ // configuration. The display name should be unique within a Stackdriver
+ // Account in order to make it easier to identify; however, uniqueness
+ // is not enforced. Required.
+ DisplayName string `json:"displayName,omitempty"`
+
+ // HttpCheck: Contains information needed to make an HTTP or HTTPS
+ // check.
+ HttpCheck *HttpCheck `json:"httpCheck,omitempty"`
+
+ // MonitoredResource: The monitored resource associated with the
+ // configuration.
+ MonitoredResource *MonitoredResource `json:"monitoredResource,omitempty"`
+
+ // Name: A unique resource name for this UptimeCheckConfig. The format
+ // is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This
+ // field should be omitted when creating the uptime check configuration;
+ // on create, the resource name is assigned by the server and included
+ // in the response.
+ Name string `json:"name,omitempty"`
+
+ // Period: How often the uptime check is performed. Currently, only 1,
+ // 5, 10, and 15 minutes are supported. Required.
+ Period string `json:"period,omitempty"`
+
+ // ResourceGroup: The group resource associated with the configuration.
+ ResourceGroup *ResourceGroup `json:"resourceGroup,omitempty"`
+
+ // SelectedRegions: The list of regions from which the check will be
+ // run. If this field is specified, enough regions to include a minimum
+ // of 3 locations must be provided, or an error message is returned. Not
+ // specifying this field will result in uptime checks running from all
+ // regions.
+ //
+ // Possible values:
+ // "REGION_UNSPECIFIED" - Default value if no region is specified.
+ // Will result in uptime checks running from all regions.
+ // "USA" - Allows checks to run from locations within the United
+ // States of America.
+ // "EUROPE" - Allows checks to run from locations within the continent
+ // of Europe.
+ // "SOUTH_AMERICA" - Allows checks to run from locations within the
+ // continent of South America.
+ // "ASIA_PACIFIC" - Allows checks to run from locations within the
+ // Asia Pacific area (ex: Singapore).
+ SelectedRegions []string `json:"selectedRegions,omitempty"`
+
+ // TcpCheck: Contains information needed to make a TCP check.
+ TcpCheck *TcpCheck `json:"tcpCheck,omitempty"`
+
+ // Timeout: The maximum amount of time to wait for the request to
+ // complete (must be between 1 and 60 seconds). Required.
+ Timeout string `json:"timeout,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "ContentMatchers") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "ContentMatchers") to
+ // include in API requests with the JSON null value. By default, fields
+ // with empty values are omitted from API requests. However, any field
+ // with an empty value appearing in NullFields will be sent to the
+ // server as null. It is an error if a field in this list has a
+ // non-empty value. This may be used to include null fields in Patch
+ // requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *UptimeCheckConfig) MarshalJSON() ([]byte, error) {
+ type noMethod UptimeCheckConfig
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// UptimeCheckIp: Contains the region, location, and list of IP
+// addresses where checkers in the location run from.
+type UptimeCheckIp struct {
+ // IpAddress: The IP address from which the uptime check originates.
+ // This is a full IP address (not an IP address range). Most IP
+ // addresses, as of this publication, are in IPv4 format; however, one
+ // should not rely on the IP addresses being in IPv4 format indefinitely
+ // and should support interpreting this field in either IPv4 or IPv6
+ // format.
+ IpAddress string `json:"ipAddress,omitempty"`
+
+ // Location: A more specific location within the region that typically
+ // encodes a particular city/town/metro (and its containing
+ // state/province or country) within the broader umbrella region
+ // category.
+ Location string `json:"location,omitempty"`
+
+ // Region: A broad region category in which the IP address is located.
+ //
+ // Possible values:
+ // "REGION_UNSPECIFIED" - Default value if no region is specified.
+ // Will result in uptime checks running from all regions.
+ // "USA" - Allows checks to run from locations within the United
+ // States of America.
+ // "EUROPE" - Allows checks to run from locations within the continent
+ // of Europe.
+ // "SOUTH_AMERICA" - Allows checks to run from locations within the
+ // continent of South America.
+ // "ASIA_PACIFIC" - Allows checks to run from locations within the
+ // Asia Pacific area (ex: Singapore).
+ Region string `json:"region,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "IpAddress") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "IpAddress") to include in
+ // API requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *UptimeCheckIp) MarshalJSON() ([]byte, error) {
+ type noMethod UptimeCheckIp
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// method id "monitoring.projects.collectdTimeSeries.create":
type ProjectsCollectdTimeSeriesCreateCall struct {
@@ -4594,3 +5040,970 @@
c.PageToken(x.NextPageToken)
}
}
+
+// method id "monitoring.projects.uptimeCheckConfigs.create":
+
+type ProjectsUptimeCheckConfigsCreateCall struct {
+ s *Service
+ parent string
+ uptimecheckconfig *UptimeCheckConfig
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Create: Creates a new uptime check configuration.
+func (r *ProjectsUptimeCheckConfigsService) Create(parent string, uptimecheckconfig *UptimeCheckConfig) *ProjectsUptimeCheckConfigsCreateCall {
+ c := &ProjectsUptimeCheckConfigsCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.parent = parent
+ c.uptimecheckconfig = uptimecheckconfig
+ return c
+}
+
+// Fields allows partial responses to be retrieved. See
+// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
+// for more information.
+func (c *ProjectsUptimeCheckConfigsCreateCall) Fields(s ...googleapi.Field) *ProjectsUptimeCheckConfigsCreateCall {
+ c.urlParams_.Set("fields", googleapi.CombineFields(s))
+ return c
+}
+
+// Context sets the context to be used in this call's Do method. Any
+// pending HTTP request will be aborted if the provided context is
+// canceled.
+func (c *ProjectsUptimeCheckConfigsCreateCall) Context(ctx context.Context) *ProjectsUptimeCheckConfigsCreateCall {
+ c.ctx_ = ctx
+ return c
+}
+
+// Header returns an http.Header that can be modified by the caller to
+// add HTTP headers to the request.
+func (c *ProjectsUptimeCheckConfigsCreateCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsUptimeCheckConfigsCreateCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.uptimecheckconfig)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v3/{+parent}/uptimeCheckConfigs")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "parent": c.parent,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "monitoring.projects.uptimeCheckConfigs.create" call.
+// Exactly one of *UptimeCheckConfig or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *UptimeCheckConfig.ServerResponse.Header or (if a response was
+// returned at all) in error.(*googleapi.Error).Header. Use
+// googleapi.IsNotModified to check whether the returned error was
+// because http.StatusNotModified was returned.
+func (c *ProjectsUptimeCheckConfigsCreateCall) Do(opts ...googleapi.CallOption) (*UptimeCheckConfig, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &UptimeCheckConfig{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Creates a new uptime check configuration.",
+ // "flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs",
+ // "httpMethod": "POST",
+ // "id": "monitoring.projects.uptimeCheckConfigs.create",
+ // "parameterOrder": [
+ // "parent"
+ // ],
+ // "parameters": {
+ // "parent": {
+ // "description": "The project in which to create the uptime check. The format is:projects/[PROJECT_ID].",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v3/{+parent}/uptimeCheckConfigs",
+ // "request": {
+ // "$ref": "UptimeCheckConfig"
+ // },
+ // "response": {
+ // "$ref": "UptimeCheckConfig"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform",
+ // "https://www.googleapis.com/auth/monitoring"
+ // ]
+ // }
+
+}
+
+// method id "monitoring.projects.uptimeCheckConfigs.delete":
+
+type ProjectsUptimeCheckConfigsDeleteCall struct {
+ s *Service
+ name string
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Delete: Deletes an uptime check configuration. Note that this method
+// will fail if the uptime check configuration is referenced by an alert
+// policy or other dependent configs that would be rendered invalid by
+// the deletion.
+func (r *ProjectsUptimeCheckConfigsService) Delete(name string) *ProjectsUptimeCheckConfigsDeleteCall {
+ c := &ProjectsUptimeCheckConfigsDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ return c
+}
+
+// Fields allows partial responses to be retrieved. See
+// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
+// for more information.
+func (c *ProjectsUptimeCheckConfigsDeleteCall) Fields(s ...googleapi.Field) *ProjectsUptimeCheckConfigsDeleteCall {
+ c.urlParams_.Set("fields", googleapi.CombineFields(s))
+ return c
+}
+
+// Context sets the context to be used in this call's Do method. Any
+// pending HTTP request will be aborted if the provided context is
+// canceled.
+func (c *ProjectsUptimeCheckConfigsDeleteCall) Context(ctx context.Context) *ProjectsUptimeCheckConfigsDeleteCall {
+ c.ctx_ = ctx
+ return c
+}
+
+// Header returns an http.Header that can be modified by the caller to
+// add HTTP headers to the request.
+func (c *ProjectsUptimeCheckConfigsDeleteCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsUptimeCheckConfigsDeleteCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v3/{+name}")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("DELETE", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "name": c.name,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "monitoring.projects.uptimeCheckConfigs.delete" call.
+// Exactly one of *Empty or error will be non-nil. Any non-2xx status
+// code is an error. Response headers are in either
+// *Empty.ServerResponse.Header or (if a response was returned at all)
+// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
+// check whether the returned error was because http.StatusNotModified
+// was returned.
+func (c *ProjectsUptimeCheckConfigsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &Empty{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Deletes an uptime check configuration. Note that this method will fail if the uptime check configuration is referenced by an alert policy or other dependent configs that would be rendered invalid by the deletion.",
+ // "flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs/{uptimeCheckConfigsId}",
+ // "httpMethod": "DELETE",
+ // "id": "monitoring.projects.uptimeCheckConfigs.delete",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "The uptime check configuration to delete. The format isprojects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/uptimeCheckConfigs/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v3/{+name}",
+ // "response": {
+ // "$ref": "Empty"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform",
+ // "https://www.googleapis.com/auth/monitoring"
+ // ]
+ // }
+
+}
+
+// method id "monitoring.projects.uptimeCheckConfigs.get":
+
+type ProjectsUptimeCheckConfigsGetCall struct {
+ s *Service
+ name string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Get: Gets a single uptime check configuration.
+func (r *ProjectsUptimeCheckConfigsService) Get(name string) *ProjectsUptimeCheckConfigsGetCall {
+ c := &ProjectsUptimeCheckConfigsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ return c
+}
+
+// Fields allows partial responses to be retrieved. See
+// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
+// for more information.
+func (c *ProjectsUptimeCheckConfigsGetCall) Fields(s ...googleapi.Field) *ProjectsUptimeCheckConfigsGetCall {
+ c.urlParams_.Set("fields", googleapi.CombineFields(s))
+ return c
+}
+
+// IfNoneMatch sets the optional parameter which makes the operation
+// fail if the object's ETag matches the given value. This is useful for
+// getting updates only after the object has changed since the last
+// request. Use googleapi.IsNotModified to check whether the response
+// error from Do is the result of In-None-Match.
+func (c *ProjectsUptimeCheckConfigsGetCall) IfNoneMatch(entityTag string) *ProjectsUptimeCheckConfigsGetCall {
+ c.ifNoneMatch_ = entityTag
+ return c
+}
+
+// Context sets the context to be used in this call's Do method. Any
+// pending HTTP request will be aborted if the provided context is
+// canceled.
+func (c *ProjectsUptimeCheckConfigsGetCall) Context(ctx context.Context) *ProjectsUptimeCheckConfigsGetCall {
+ c.ctx_ = ctx
+ return c
+}
+
+// Header returns an http.Header that can be modified by the caller to
+// add HTTP headers to the request.
+func (c *ProjectsUptimeCheckConfigsGetCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsUptimeCheckConfigsGetCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ if c.ifNoneMatch_ != "" {
+ reqHeaders.Set("If-None-Match", c.ifNoneMatch_)
+ }
+ var body io.Reader = nil
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v3/{+name}")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("GET", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "name": c.name,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "monitoring.projects.uptimeCheckConfigs.get" call.
+// Exactly one of *UptimeCheckConfig or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *UptimeCheckConfig.ServerResponse.Header or (if a response was
+// returned at all) in error.(*googleapi.Error).Header. Use
+// googleapi.IsNotModified to check whether the returned error was
+// because http.StatusNotModified was returned.
+func (c *ProjectsUptimeCheckConfigsGetCall) Do(opts ...googleapi.CallOption) (*UptimeCheckConfig, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &UptimeCheckConfig{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Gets a single uptime check configuration.",
+ // "flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs/{uptimeCheckConfigsId}",
+ // "httpMethod": "GET",
+ // "id": "monitoring.projects.uptimeCheckConfigs.get",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "The uptime check configuration to retrieve. The format isprojects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/uptimeCheckConfigs/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v3/{+name}",
+ // "response": {
+ // "$ref": "UptimeCheckConfig"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform",
+ // "https://www.googleapis.com/auth/monitoring",
+ // "https://www.googleapis.com/auth/monitoring.read"
+ // ]
+ // }
+
+}
+
+// method id "monitoring.projects.uptimeCheckConfigs.list":
+
+type ProjectsUptimeCheckConfigsListCall struct {
+ s *Service
+ parent string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// List: Lists the existing valid uptime check configurations for the
+// project, leaving out any invalid configurations.
+func (r *ProjectsUptimeCheckConfigsService) List(parent string) *ProjectsUptimeCheckConfigsListCall {
+ c := &ProjectsUptimeCheckConfigsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.parent = parent
+ return c
+}
+
+// Filter sets the optional parameter "filter": If provided, specifies
+// the criteria that must be met by uptime check configurations in the
+// provided project to be included in the response. One of the following
+// filters can be provided. uptime_check_config.id = {uptime_check_id}
+// resource.type = gce_instance AND resource.label.instance_id =
+// {instance_id} resource.type = aws_ec2_instance AND
+// resource.label.instance_id = {instance_id} resource.type =
+// aws_elb_load_balancer AND resource.label.name = {name}
+// resource.type = gae_app AND resource.label.module_id = {module_id}
+// resource.type = uptime_url AND resource.label.host = {host} group.id
+// = {group_id}
+func (c *ProjectsUptimeCheckConfigsListCall) Filter(filter string) *ProjectsUptimeCheckConfigsListCall {
+ c.urlParams_.Set("filter", filter)
+ return c
+}
+
+// PageSize sets the optional parameter "pageSize": The maximum number
+// of results to return in a single response. The server may further
+// constrain the maximum number of results returned in a single page. If
+// the page_size is <=0, the server will decide the number of results to
+// be returned.
+func (c *ProjectsUptimeCheckConfigsListCall) PageSize(pageSize int64) *ProjectsUptimeCheckConfigsListCall {
+ c.urlParams_.Set("pageSize", fmt.Sprint(pageSize))
+ return c
+}
+
+// PageToken sets the optional parameter "pageToken": If this field is
+// not empty then it must contain the nextPageToken value returned by a
+// previous call to this method. Using this field causes the method to
+// return more results from the previous method call.
+func (c *ProjectsUptimeCheckConfigsListCall) PageToken(pageToken string) *ProjectsUptimeCheckConfigsListCall {
+ c.urlParams_.Set("pageToken", pageToken)
+ return c
+}
+
+// Fields allows partial responses to be retrieved. See
+// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
+// for more information.
+func (c *ProjectsUptimeCheckConfigsListCall) Fields(s ...googleapi.Field) *ProjectsUptimeCheckConfigsListCall {
+ c.urlParams_.Set("fields", googleapi.CombineFields(s))
+ return c
+}
+
+// IfNoneMatch sets the optional parameter which makes the operation
+// fail if the object's ETag matches the given value. This is useful for
+// getting updates only after the object has changed since the last
+// request. Use googleapi.IsNotModified to check whether the response
+// error from Do is the result of In-None-Match.
+func (c *ProjectsUptimeCheckConfigsListCall) IfNoneMatch(entityTag string) *ProjectsUptimeCheckConfigsListCall {
+ c.ifNoneMatch_ = entityTag
+ return c
+}
+
+// Context sets the context to be used in this call's Do method. Any
+// pending HTTP request will be aborted if the provided context is
+// canceled.
+func (c *ProjectsUptimeCheckConfigsListCall) Context(ctx context.Context) *ProjectsUptimeCheckConfigsListCall {
+ c.ctx_ = ctx
+ return c
+}
+
+// Header returns an http.Header that can be modified by the caller to
+// add HTTP headers to the request.
+func (c *ProjectsUptimeCheckConfigsListCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsUptimeCheckConfigsListCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ if c.ifNoneMatch_ != "" {
+ reqHeaders.Set("If-None-Match", c.ifNoneMatch_)
+ }
+ var body io.Reader = nil
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v3/{+parent}/uptimeCheckConfigs")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("GET", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "parent": c.parent,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "monitoring.projects.uptimeCheckConfigs.list" call.
+// Exactly one of *ListUptimeCheckConfigsResponse or error will be
+// non-nil. Any non-2xx status code is an error. Response headers are in
+// either *ListUptimeCheckConfigsResponse.ServerResponse.Header or (if a
+// response was returned at all) in error.(*googleapi.Error).Header. Use
+// googleapi.IsNotModified to check whether the returned error was
+// because http.StatusNotModified was returned.
+func (c *ProjectsUptimeCheckConfigsListCall) Do(opts ...googleapi.CallOption) (*ListUptimeCheckConfigsResponse, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &ListUptimeCheckConfigsResponse{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Lists the existing valid uptime check configurations for the project, leaving out any invalid configurations.",
+ // "flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs",
+ // "httpMethod": "GET",
+ // "id": "monitoring.projects.uptimeCheckConfigs.list",
+ // "parameterOrder": [
+ // "parent"
+ // ],
+ // "parameters": {
+ // "filter": {
+ // "description": "If provided, specifies the criteria that must be met by uptime check configurations in the provided project to be included in the response. One of the following filters can be provided. uptime_check_config.id = {uptime_check_id} resource.type = gce_instance AND resource.label.instance_id = {instance_id} resource.type = aws_ec2_instance AND resource.label.instance_id = {instance_id} resource.type = aws_elb_load_balancer AND resource.label.name = {name} resource.type = gae_app AND resource.label.module_id = {module_id} resource.type = uptime_url AND resource.label.host = {host} group.id = {group_id}",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "pageSize": {
+ // "description": "The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is \u003c=0, the server will decide the number of results to be returned.",
+ // "format": "int32",
+ // "location": "query",
+ // "type": "integer"
+ // },
+ // "pageToken": {
+ // "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "parent": {
+ // "description": "The project whose uptime check configurations are listed. The format isprojects/[PROJECT_ID].",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v3/{+parent}/uptimeCheckConfigs",
+ // "response": {
+ // "$ref": "ListUptimeCheckConfigsResponse"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform",
+ // "https://www.googleapis.com/auth/monitoring",
+ // "https://www.googleapis.com/auth/monitoring.read"
+ // ]
+ // }
+
+}
+
+// Pages invokes f for each page of results.
+// A non-nil error returned from f will halt the iteration.
+// The provided context supersedes any context provided to the Context method.
+func (c *ProjectsUptimeCheckConfigsListCall) Pages(ctx context.Context, f func(*ListUptimeCheckConfigsResponse) error) error {
+ c.ctx_ = ctx
+ defer c.PageToken(c.urlParams_.Get("pageToken")) // reset paging to original point
+ for {
+ x, err := c.Do()
+ if err != nil {
+ return err
+ }
+ if err := f(x); err != nil {
+ return err
+ }
+ if x.NextPageToken == "" {
+ return nil
+ }
+ c.PageToken(x.NextPageToken)
+ }
+}
+
+// method id "monitoring.projects.uptimeCheckConfigs.patch":
+
+type ProjectsUptimeCheckConfigsPatchCall struct {
+ s *Service
+ name string
+ uptimecheckconfig *UptimeCheckConfig
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Patch: Updates an uptime check configuration. You can either replace
+// the entire configuration with a new one or replace only certain
+// fields in the current configuration by specifying the fields to be
+// updated via "updateMask". Returns the updated configuration.
+func (r *ProjectsUptimeCheckConfigsService) Patch(name string, uptimecheckconfig *UptimeCheckConfig) *ProjectsUptimeCheckConfigsPatchCall {
+ c := &ProjectsUptimeCheckConfigsPatchCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ c.uptimecheckconfig = uptimecheckconfig
+ return c
+}
+
+// Name1 sets the optional parameter "name1": The uptime check
+// configuration to update. The format
+// isprojects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].
+func (c *ProjectsUptimeCheckConfigsPatchCall) Name1(name1 string) *ProjectsUptimeCheckConfigsPatchCall {
+ c.urlParams_.Set("name1", name1)
+ return c
+}
+
+// UpdateMask sets the optional parameter "updateMask": If present, only
+// the listed fields in the current uptime check configuration are
+// updated with values from the new configuration. If this field is
+// empty, then the current configuration is completely replaced with the
+// new configuration.
+func (c *ProjectsUptimeCheckConfigsPatchCall) UpdateMask(updateMask string) *ProjectsUptimeCheckConfigsPatchCall {
+ c.urlParams_.Set("updateMask", updateMask)
+ return c
+}
+
+// Fields allows partial responses to be retrieved. See
+// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
+// for more information.
+func (c *ProjectsUptimeCheckConfigsPatchCall) Fields(s ...googleapi.Field) *ProjectsUptimeCheckConfigsPatchCall {
+ c.urlParams_.Set("fields", googleapi.CombineFields(s))
+ return c
+}
+
+// Context sets the context to be used in this call's Do method. Any
+// pending HTTP request will be aborted if the provided context is
+// canceled.
+func (c *ProjectsUptimeCheckConfigsPatchCall) Context(ctx context.Context) *ProjectsUptimeCheckConfigsPatchCall {
+ c.ctx_ = ctx
+ return c
+}
+
+// Header returns an http.Header that can be modified by the caller to
+// add HTTP headers to the request.
+func (c *ProjectsUptimeCheckConfigsPatchCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsUptimeCheckConfigsPatchCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.uptimecheckconfig)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v3/{+name}")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("PATCH", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "name": c.name,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "monitoring.projects.uptimeCheckConfigs.patch" call.
+// Exactly one of *UptimeCheckConfig or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *UptimeCheckConfig.ServerResponse.Header or (if a response was
+// returned at all) in error.(*googleapi.Error).Header. Use
+// googleapi.IsNotModified to check whether the returned error was
+// because http.StatusNotModified was returned.
+func (c *ProjectsUptimeCheckConfigsPatchCall) Do(opts ...googleapi.CallOption) (*UptimeCheckConfig, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &UptimeCheckConfig{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Updates an uptime check configuration. You can either replace the entire configuration with a new one or replace only certain fields in the current configuration by specifying the fields to be updated via \"updateMask\". Returns the updated configuration.",
+ // "flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs/{uptimeCheckConfigsId}",
+ // "httpMethod": "PATCH",
+ // "id": "monitoring.projects.uptimeCheckConfigs.patch",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "A unique resource name for this UptimeCheckConfig. The format is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This field should be omitted when creating the uptime check configuration; on create, the resource name is assigned by the server and included in the response.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/uptimeCheckConfigs/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "name1": {
+ // "description": "The uptime check configuration to update. The format isprojects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "updateMask": {
+ // "description": "Optional. If present, only the listed fields in the current uptime check configuration are updated with values from the new configuration. If this field is empty, then the current configuration is completely replaced with the new configuration.",
+ // "format": "google-fieldmask",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "v3/{+name}",
+ // "request": {
+ // "$ref": "UptimeCheckConfig"
+ // },
+ // "response": {
+ // "$ref": "UptimeCheckConfig"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform",
+ // "https://www.googleapis.com/auth/monitoring"
+ // ]
+ // }
+
+}
+
+// method id "monitoring.uptimeCheckIps.list":
+
+type UptimeCheckIpsListCall struct {
+ s *Service
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// List: Returns the list of IPs that checkers run from
+func (r *UptimeCheckIpsService) List() *UptimeCheckIpsListCall {
+ c := &UptimeCheckIpsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ return c
+}
+
+// PageSize sets the optional parameter "pageSize": The maximum number
+// of results to return in a single response. The server may further
+// constrain the maximum number of results returned in a single page. If
+// the page_size is <=0, the server will decide the number of results to
+// be returned. NOTE: this field is not yet implemented
+func (c *UptimeCheckIpsListCall) PageSize(pageSize int64) *UptimeCheckIpsListCall {
+ c.urlParams_.Set("pageSize", fmt.Sprint(pageSize))
+ return c
+}
+
+// PageToken sets the optional parameter "pageToken": If this field is
+// not empty then it must contain the nextPageToken value returned by a
+// previous call to this method. Using this field causes the method to
+// return more results from the previous method call. NOTE: this field
+// is not yet implemented
+func (c *UptimeCheckIpsListCall) PageToken(pageToken string) *UptimeCheckIpsListCall {
+ c.urlParams_.Set("pageToken", pageToken)
+ return c
+}
+
+// Fields allows partial responses to be retrieved. See
+// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
+// for more information.
+func (c *UptimeCheckIpsListCall) Fields(s ...googleapi.Field) *UptimeCheckIpsListCall {
+ c.urlParams_.Set("fields", googleapi.CombineFields(s))
+ return c
+}
+
+// IfNoneMatch sets the optional parameter which makes the operation
+// fail if the object's ETag matches the given value. This is useful for
+// getting updates only after the object has changed since the last
+// request. Use googleapi.IsNotModified to check whether the response
+// error from Do is the result of In-None-Match.
+func (c *UptimeCheckIpsListCall) IfNoneMatch(entityTag string) *UptimeCheckIpsListCall {
+ c.ifNoneMatch_ = entityTag
+ return c
+}
+
+// Context sets the context to be used in this call's Do method. Any
+// pending HTTP request will be aborted if the provided context is
+// canceled.
+func (c *UptimeCheckIpsListCall) Context(ctx context.Context) *UptimeCheckIpsListCall {
+ c.ctx_ = ctx
+ return c
+}
+
+// Header returns an http.Header that can be modified by the caller to
+// add HTTP headers to the request.
+func (c *UptimeCheckIpsListCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *UptimeCheckIpsListCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ if c.ifNoneMatch_ != "" {
+ reqHeaders.Set("If-None-Match", c.ifNoneMatch_)
+ }
+ var body io.Reader = nil
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v3/uptimeCheckIps")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("GET", urls, body)
+ req.Header = reqHeaders
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "monitoring.uptimeCheckIps.list" call.
+// Exactly one of *ListUptimeCheckIpsResponse or error will be non-nil.
+// Any non-2xx status code is an error. Response headers are in either
+// *ListUptimeCheckIpsResponse.ServerResponse.Header or (if a response
+// was returned at all) in error.(*googleapi.Error).Header. Use
+// googleapi.IsNotModified to check whether the returned error was
+// because http.StatusNotModified was returned.
+func (c *UptimeCheckIpsListCall) Do(opts ...googleapi.CallOption) (*ListUptimeCheckIpsResponse, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &ListUptimeCheckIpsResponse{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := json.NewDecoder(res.Body).Decode(target); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Returns the list of IPs that checkers run from",
+ // "flatPath": "v3/uptimeCheckIps",
+ // "httpMethod": "GET",
+ // "id": "monitoring.uptimeCheckIps.list",
+ // "parameterOrder": [],
+ // "parameters": {
+ // "pageSize": {
+ // "description": "The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is \u003c=0, the server will decide the number of results to be returned. NOTE: this field is not yet implemented",
+ // "format": "int32",
+ // "location": "query",
+ // "type": "integer"
+ // },
+ // "pageToken": {
+ // "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call. NOTE: this field is not yet implemented",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "v3/uptimeCheckIps",
+ // "response": {
+ // "$ref": "ListUptimeCheckIpsResponse"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform",
+ // "https://www.googleapis.com/auth/monitoring",
+ // "https://www.googleapis.com/auth/monitoring.read"
+ // ]
+ // }
+
+}
+
+// Pages invokes f for each page of results.
+// A non-nil error returned from f will halt the iteration.
+// The provided context supersedes any context provided to the Context method.
+func (c *UptimeCheckIpsListCall) Pages(ctx context.Context, f func(*ListUptimeCheckIpsResponse) error) error {
+ c.ctx_ = ctx
+ defer c.PageToken(c.urlParams_.Get("pageToken")) // reset paging to original point
+ for {
+ x, err := c.Do()
+ if err != nil {
+ return err
+ }
+ if err := f(x); err != nil {
+ return err
+ }
+ if x.NextPageToken == "" {
+ return nil
+ }
+ c.PageToken(x.NextPageToken)
+ }
+}
diff --git a/oslogin/v1alpha/oslogin-api.json b/oslogin/v1alpha/oslogin-api.json
index f965a99..1ed1c45 100644
--- a/oslogin/v1alpha/oslogin-api.json
+++ b/oslogin/v1alpha/oslogin-api.json
@@ -1,96 +1,214 @@
{
+ "discoveryVersion": "v1",
+ "version_module": true,
+ "schemas": {
+ "LoginProfile": {
+ "type": "object",
+ "properties": {
+ "suspended": {
+ "description": "Indicates if the user is suspended.",
+ "type": "boolean"
+ },
+ "sshPublicKeys": {
+ "additionalProperties": {
+ "$ref": "SshPublicKey"
+ },
+ "description": "A map from SSH public key fingerprint to the associated key object.",
+ "type": "object"
+ },
+ "posixAccounts": {
+ "items": {
+ "$ref": "PosixAccount"
+ },
+ "type": "array",
+ "description": "The list of POSIX accounts associated with the Directory API user."
+ },
+ "name": {
+ "type": "string",
+ "description": "A unique user ID for identifying the user."
+ }
+ },
+ "id": "LoginProfile",
+ "description": "The Directory API profile information used for logging in to a virtual\nmachine on Google Compute Engine."
+ },
+ "SshPublicKey": {
+ "type": "object",
+ "properties": {
+ "fingerprint": {
+ "description": "The SHA-256 fingerprint of the SSH public key.\nOutput only.",
+ "type": "string"
+ },
+ "key": {
+ "description": "Public key text in SSH format, defined by\n\u003ca href=\"https://www.ietf.org/rfc/rfc4253.txt\" target=\"_blank\"\u003eRFC4253\u003c/a\u003e\nsection 6.6.",
+ "type": "string"
+ },
+ "expirationTimeUsec": {
+ "type": "string",
+ "format": "int64",
+ "description": "An expiration time in microseconds since epoch."
+ }
+ },
+ "id": "SshPublicKey",
+ "description": "The SSH public key information associated with a Directory API User."
+ },
+ "Empty": {
+ "type": "object",
+ "properties": {},
+ "id": "Empty",
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`."
+ },
+ "ImportSshPublicKeyResponse": {
+ "description": "A response message for importing an SSH public key.",
+ "type": "object",
+ "properties": {
+ "loginProfile": {
+ "$ref": "LoginProfile",
+ "description": "The login profile information for the user."
+ }
+ },
+ "id": "ImportSshPublicKeyResponse"
+ },
+ "PosixAccount": {
+ "description": "The POSIX account information associated with a Directory API User.",
+ "type": "object",
+ "properties": {
+ "gid": {
+ "type": "string",
+ "format": "int64",
+ "description": "The default group ID."
+ },
+ "uid": {
+ "format": "int64",
+ "description": "The user ID.",
+ "type": "string"
+ },
+ "username": {
+ "description": "The username of the POSIX account.",
+ "type": "string"
+ },
+ "shell": {
+ "type": "string",
+ "description": "The path to the logic shell for this account."
+ },
+ "homeDirectory": {
+ "description": "The path to the home directory for this account.",
+ "type": "string"
+ },
+ "gecos": {
+ "type": "string",
+ "description": "The GECOS (user information) entry for this account."
+ },
+ "systemId": {
+ "description": "System identifier for which account the username or uid applies to.\nBy default, the empty value is used.",
+ "type": "string"
+ },
+ "primary": {
+ "type": "boolean",
+ "description": "Only one POSIX account can be marked as primary."
+ }
+ },
+ "id": "PosixAccount"
+ }
+ },
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "protocol": "rest",
+ "canonicalName": "Cloud OS Login",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform.read-only": {
+ "description": "View your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/compute.readonly": {
+ "description": "View your Google Compute Engine resources"
+ },
+ "https://www.googleapis.com/auth/compute": {
+ "description": "View and manage your Google Compute Engine resources"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://oslogin.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "oslogin",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Google Cloud OS Login API",
"ownerName": "Google",
"resources": {
"users": {
"methods": {
"importSshPublicKey": {
- "response": {
- "$ref": "ImportSshPublicKeyResponse"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"parent"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "ImportSshPublicKeyResponse"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
],
"parameters": {
"parent": {
+ "type": "string",
+ "required": true,
"pattern": "^users/[^/]+$",
"location": "path",
- "description": "The unique ID for the user in format `users/{user}`.",
- "type": "string",
- "required": true
+ "description": "The unique ID for the user in format `users/{user}`."
}
},
"flatPath": "v1alpha/users/{usersId}:importSshPublicKey",
- "id": "oslogin.users.importSshPublicKey",
"path": "v1alpha/{+parent}:importSshPublicKey",
+ "id": "oslogin.users.importSshPublicKey",
"request": {
"$ref": "SshPublicKey"
},
"description": "Adds an SSH public key and returns the profile information. Default POSIX\naccount information is set when no username and UID exist as part of the\nlogin profile."
},
"getLoginProfile": {
- "description": "Retrieves the profile information used for logging in to a virtual machine\non Google Compute Engine.",
- "httpMethod": "GET",
"response": {
"$ref": "LoginProfile"
},
"parameterOrder": [
"name"
],
- "parameters": {
- "name": {
- "pattern": "^users/[^/]+$",
- "location": "path",
- "description": "The unique ID for the user in format `users/{user}`.",
- "type": "string",
- "required": true
- }
- },
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
],
+ "parameters": {
+ "name": {
+ "type": "string",
+ "required": true,
+ "pattern": "^users/[^/]+$",
+ "location": "path",
+ "description": "The unique ID for the user in format `users/{user}`."
+ }
+ },
"flatPath": "v1alpha/users/{usersId}/loginProfile",
+ "id": "oslogin.users.getLoginProfile",
"path": "v1alpha/{+name}/loginProfile",
- "id": "oslogin.users.getLoginProfile"
+ "description": "Retrieves the profile information used for logging in to a virtual machine\non Google Compute Engine."
}
},
"resources": {
"sshPublicKeys": {
"methods": {
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "description": "The fingerprint of the public key to update. Public keys are identified by\ntheir SHA-256 fingerprint. The fingerprint of the public key is in format\n`users/{user}/sshPublicKeys/{fingerprint}`.",
- "type": "string",
- "required": true,
- "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "flatPath": "v1alpha/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
- "id": "oslogin.users.sshPublicKeys.delete",
- "path": "v1alpha/{+name}",
- "description": "Deletes an SSH public key."
- },
"patch": {
+ "flatPath": "v1alpha/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
+ "id": "oslogin.users.sshPublicKeys.patch",
+ "path": "v1alpha/{+name}",
"request": {
"$ref": "SshPublicKey"
},
@@ -107,39 +225,62 @@
"https://www.googleapis.com/auth/compute"
],
"parameters": {
- "updateMask": {
- "format": "google-fieldmask",
- "description": "Mask to control which fields get updated. Updates all if not present.",
- "type": "string",
- "location": "query"
- },
"name": {
+ "location": "path",
"description": "The fingerprint of the public key to update. Public keys are identified by\ntheir SHA-256 fingerprint. The fingerprint of the public key is in format\n`users/{user}/sshPublicKeys/{fingerprint}`.",
"type": "string",
"required": true,
- "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$",
- "location": "path"
+ "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$"
+ },
+ "updateMask": {
+ "type": "string",
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Mask to control which fields get updated. Updates all if not present."
}
- },
- "flatPath": "v1alpha/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
- "id": "oslogin.users.sshPublicKeys.patch",
- "path": "v1alpha/{+name}"
+ }
},
"get": {
- "response": {
- "$ref": "SshPublicKey"
- },
+ "flatPath": "v1alpha/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
+ "path": "v1alpha/{+name}",
+ "id": "oslogin.users.sshPublicKeys.get",
+ "description": "Retrieves an SSH public key.",
+ "httpMethod": "GET",
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "SshPublicKey"
+ },
"parameters": {
"name": {
+ "location": "path",
"description": "The fingerprint of the public key to retrieve. Public keys are identified\nby their SHA-256 fingerprint. The fingerprint of the public key is in\nformat `users/{user}/sshPublicKeys/{fingerprint}`.",
"type": "string",
"required": true,
- "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$",
- "location": "path"
+ "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The fingerprint of the public key to update. Public keys are identified by\ntheir SHA-256 fingerprint. The fingerprint of the public key is in format\n`users/{user}/sshPublicKeys/{fingerprint}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$"
}
},
"scopes": [
@@ -147,9 +288,9 @@
"https://www.googleapis.com/auth/compute"
],
"flatPath": "v1alpha/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
- "id": "oslogin.users.sshPublicKeys.get",
"path": "v1alpha/{+name}",
- "description": "Retrieves an SSH public key."
+ "id": "oslogin.users.sshPublicKeys.delete",
+ "description": "Deletes an SSH public key."
}
}
}
@@ -158,25 +299,25 @@
},
"parameters": {
"upload_protocol": {
+ "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"prettyPrint": {
+ "location": "query",
"description": "Returns response with indentations and line breaks.",
"default": "true",
- "type": "boolean",
- "location": "query"
+ "type": "boolean"
},
"uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
},
"fields": {
+ "type": "string",
"location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
+ "description": "Selector specifying which fields to include in a partial response."
},
"callback": {
"location": "query",
@@ -184,6 +325,7 @@
"type": "string"
},
"$.xgafv": {
+ "location": "query",
"enum": [
"1",
"2"
@@ -193,8 +335,7 @@
"enumDescriptions": [
"v1 error format",
"v2 error format"
- ],
- "location": "query"
+ ]
},
"alt": {
"enum": [
@@ -212,186 +353,45 @@
"description": "Data format for response.",
"default": "json"
},
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
"key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string",
- "location": "query"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "oauth_token": {
"location": "query",
- "description": "OAuth 2.0 token for the current user.",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
"type": "string"
},
- "bearer_token": {
- "description": "OAuth bearer token.",
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "default": "true",
+ "type": "boolean",
+ "location": "query",
+ "description": "Pretty-print response."
+ },
+ "oauth_token": {
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user."
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
}
},
"version": "v1alpha",
"baseUrl": "https://oslogin.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Manages OS login configuration for Directory API users.",
"servicePath": "",
+ "description": "Manages OS login configuration for Directory API users.",
+ "kind": "discovery#restDescription",
"basePath": "",
- "id": "oslogin:v1alpha",
- "documentationLink": "https://cloud.google.com/compute/docs/oslogin/rest/",
"revision": "20170929",
- "discoveryVersion": "v1",
- "version_module": true,
- "schemas": {
- "LoginProfile": {
- "description": "The Directory API profile information used for logging in to a virtual\nmachine on Google Compute Engine.",
- "type": "object",
- "properties": {
- "posixAccounts": {
- "description": "The list of POSIX accounts associated with the Directory API user.",
- "items": {
- "$ref": "PosixAccount"
- },
- "type": "array"
- },
- "name": {
- "description": "A unique user ID for identifying the user.",
- "type": "string"
- },
- "suspended": {
- "description": "Indicates if the user is suspended.",
- "type": "boolean"
- },
- "sshPublicKeys": {
- "additionalProperties": {
- "$ref": "SshPublicKey"
- },
- "description": "A map from SSH public key fingerprint to the associated key object.",
- "type": "object"
- }
- },
- "id": "LoginProfile"
- },
- "SshPublicKey": {
- "properties": {
- "expirationTimeUsec": {
- "format": "int64",
- "description": "An expiration time in microseconds since epoch.",
- "type": "string"
- },
- "fingerprint": {
- "description": "The SHA-256 fingerprint of the SSH public key.\nOutput only.",
- "type": "string"
- },
- "key": {
- "description": "Public key text in SSH format, defined by\n\u003ca href=\"https://www.ietf.org/rfc/rfc4253.txt\" target=\"_blank\"\u003eRFC4253\u003c/a\u003e\nsection 6.6.",
- "type": "string"
- }
- },
- "id": "SshPublicKey",
- "description": "The SSH public key information associated with a Directory API User.",
- "type": "object"
- },
- "Empty": {
- "properties": {},
- "id": "Empty",
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object"
- },
- "ImportSshPublicKeyResponse": {
- "description": "A response message for importing an SSH public key.",
- "type": "object",
- "properties": {
- "loginProfile": {
- "$ref": "LoginProfile",
- "description": "The login profile information for the user."
- }
- },
- "id": "ImportSshPublicKeyResponse"
- },
- "PosixAccount": {
- "description": "The POSIX account information associated with a Directory API User.",
- "type": "object",
- "properties": {
- "primary": {
- "description": "Only one POSIX account can be marked as primary.",
- "type": "boolean"
- },
- "gid": {
- "format": "int64",
- "description": "The default group ID.",
- "type": "string"
- },
- "uid": {
- "format": "int64",
- "description": "The user ID.",
- "type": "string"
- },
- "username": {
- "description": "The username of the POSIX account.",
- "type": "string"
- },
- "shell": {
- "description": "The path to the logic shell for this account.",
- "type": "string"
- },
- "homeDirectory": {
- "description": "The path to the home directory for this account.",
- "type": "string"
- },
- "systemId": {
- "description": "System identifier for which account the username or uid applies to.\nBy default, the empty value is used.",
- "type": "string"
- },
- "gecos": {
- "description": "The GECOS (user information) entry for this account.",
- "type": "string"
- }
- },
- "id": "PosixAccount"
- }
- },
- "icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
- "protocol": "rest",
- "canonicalName": "Cloud OS Login",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/compute.readonly": {
- "description": "View your Google Compute Engine resources"
- },
- "https://www.googleapis.com/auth/compute": {
- "description": "View and manage your Google Compute Engine resources"
- },
- "https://www.googleapis.com/auth/cloud-platform.read-only": {
- "description": "View your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "rootUrl": "https://oslogin.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "oslogin",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Google Cloud OS Login API"
+ "documentationLink": "https://cloud.google.com/compute/docs/oslogin/rest/",
+ "id": "oslogin:v1alpha"
}
diff --git a/oslogin/v1beta/oslogin-api.json b/oslogin/v1beta/oslogin-api.json
index 6ce8f63..1d9d6fe 100644
--- a/oslogin/v1beta/oslogin-api.json
+++ b/oslogin/v1beta/oslogin-api.json
@@ -1,9 +1,327 @@
{
+ "ownerDomain": "google.com",
+ "name": "oslogin",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Google Cloud OS Login API",
+ "ownerName": "Google",
+ "resources": {
+ "users": {
+ "resources": {
+ "sshPublicKeys": {
+ "methods": {
+ "delete": {
+ "id": "oslogin.users.sshPublicKeys.delete",
+ "path": "v1beta/{+name}",
+ "description": "Deletes an SSH public key.",
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The fingerprint of the public key to update. Public keys are identified by\ntheir SHA-256 fingerprint. The fingerprint of the public key is in format\n`users/{user}/sshPublicKeys/{fingerprint}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta/users/{usersId}/sshPublicKeys/{sshPublicKeysId}"
+ },
+ "patch": {
+ "response": {
+ "$ref": "SshPublicKey"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The fingerprint of the public key to update. Public keys are identified by\ntheir SHA-256 fingerprint. The fingerprint of the public key is in format\n`users/{user}/sshPublicKeys/{fingerprint}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$",
+ "location": "path"
+ },
+ "updateMask": {
+ "location": "query",
+ "format": "google-fieldmask",
+ "description": "Mask to control which fields get updated. Updates all if not present.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
+ "id": "oslogin.users.sshPublicKeys.patch",
+ "path": "v1beta/{+name}",
+ "request": {
+ "$ref": "SshPublicKey"
+ },
+ "description": "Updates an SSH public key and returns the profile information. This method\nsupports patch semantics."
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "SshPublicKey"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$",
+ "location": "path",
+ "description": "The fingerprint of the public key to retrieve. Public keys are identified\nby their SHA-256 fingerprint. The fingerprint of the public key is in\nformat `users/{user}/sshPublicKeys/{fingerprint}`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
+ "path": "v1beta/{+name}",
+ "id": "oslogin.users.sshPublicKeys.get",
+ "description": "Retrieves an SSH public key."
+ }
+ }
+ }
+ },
+ "methods": {
+ "importSshPublicKey": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ImportSshPublicKeyResponse"
+ },
+ "parameters": {
+ "parent": {
+ "description": "The unique ID for the user in format `users/{user}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^users/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "flatPath": "v1beta/users/{usersId}:importSshPublicKey",
+ "path": "v1beta/{+parent}:importSshPublicKey",
+ "id": "oslogin.users.importSshPublicKey",
+ "description": "Adds an SSH public key and returns the profile information. Default POSIX\naccount information is set when no username and UID exist as part of the\nlogin profile.",
+ "request": {
+ "$ref": "SshPublicKey"
+ }
+ },
+ "getLoginProfile": {
+ "description": "Retrieves the profile information used for logging in to a virtual machine\non Google Compute Engine.",
+ "response": {
+ "$ref": "LoginProfile"
+ },
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The unique ID for the user in format `users/{user}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^users/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta/users/{usersId}/loginProfile",
+ "id": "oslogin.users.getLoginProfile",
+ "path": "v1beta/{+name}/loginProfile"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "alt": {
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ }
+ },
+ "version": "v1beta",
+ "baseUrl": "https://oslogin.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Manages OS login configuration for Directory API users.",
+ "servicePath": "",
+ "basePath": "",
+ "revision": "20170929",
+ "documentationLink": "https://cloud.google.com/compute/docs/oslogin/rest/",
+ "id": "oslogin:v1beta",
+ "discoveryVersion": "v1",
+ "version_module": true,
"schemas": {
- "LoginProfile": {
- "description": "The user profile information used for logging in to a virtual machine on\nGoogle Compute Engine.",
+ "ImportSshPublicKeyResponse": {
+ "properties": {
+ "loginProfile": {
+ "$ref": "LoginProfile",
+ "description": "The login profile information for the user."
+ }
+ },
+ "id": "ImportSshPublicKeyResponse",
+ "description": "A response message for importing an SSH public key.",
+ "type": "object"
+ },
+ "PosixAccount": {
+ "description": "The POSIX account information associated with a Directory API User.",
"type": "object",
"properties": {
+ "primary": {
+ "description": "Only one POSIX account can be marked as primary.",
+ "type": "boolean"
+ },
+ "gid": {
+ "format": "int64",
+ "description": "The default group ID.",
+ "type": "string"
+ },
+ "uid": {
+ "format": "int64",
+ "description": "The user ID.",
+ "type": "string"
+ },
+ "username": {
+ "description": "The username of the POSIX account.",
+ "type": "string"
+ },
+ "shell": {
+ "description": "The path to the logic shell for this account.",
+ "type": "string"
+ },
+ "homeDirectory": {
+ "description": "The path to the home directory for this account.",
+ "type": "string"
+ },
+ "systemId": {
+ "description": "System identifier for which account the username or uid applies to.\nBy default, the empty value is used.",
+ "type": "string"
+ },
+ "gecos": {
+ "description": "The GECOS (user information) entry for this account.",
+ "type": "string"
+ }
+ },
+ "id": "PosixAccount"
+ },
+ "LoginProfile": {
+ "properties": {
+ "sshPublicKeys": {
+ "additionalProperties": {
+ "$ref": "SshPublicKey"
+ },
+ "description": "A map from SSH public key fingerprint to the associated key object.",
+ "type": "object"
+ },
"posixAccounts": {
"description": "The list of POSIX accounts associated with the user.",
"items": {
@@ -12,22 +330,17 @@
"type": "array"
},
"name": {
- "type": "string",
- "description": "The primary email address that uniquely identifies the user."
+ "description": "The primary email address that uniquely identifies the user.",
+ "type": "string"
},
"suspended": {
"description": "Indicates if the user is suspended. A suspended user cannot log in but\ntheir profile information is retained.",
"type": "boolean"
- },
- "sshPublicKeys": {
- "additionalProperties": {
- "$ref": "SshPublicKey"
- },
- "description": "A map from SSH public key fingerprint to the associated key object.",
- "type": "object"
}
},
- "id": "LoginProfile"
+ "id": "LoginProfile",
+ "description": "The user profile information used for logging in to a virtual machine on\nGoogle Compute Engine.",
+ "type": "object"
},
"SshPublicKey": {
"description": "The SSH public key information associated with a Directory API User.",
@@ -50,69 +363,17 @@
"id": "SshPublicKey"
},
"Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\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"
- },
- "ImportSshPublicKeyResponse": {
- "description": "A response message for importing an SSH public key.",
- "type": "object",
- "properties": {
- "loginProfile": {
- "$ref": "LoginProfile",
- "description": "The login profile information for the user."
- }
- },
- "id": "ImportSshPublicKeyResponse"
- },
- "PosixAccount": {
- "description": "The POSIX account information associated with a Directory API User.",
- "type": "object",
- "properties": {
- "homeDirectory": {
- "description": "The path to the home directory for this account.",
- "type": "string"
- },
- "systemId": {
- "description": "System identifier for which account the username or uid applies to.\nBy default, the empty value is used.",
- "type": "string"
- },
- "gecos": {
- "description": "The GECOS (user information) entry for this account.",
- "type": "string"
- },
- "primary": {
- "description": "Only one POSIX account can be marked as primary.",
- "type": "boolean"
- },
- "gid": {
- "format": "int64",
- "description": "The default group ID.",
- "type": "string"
- },
- "uid": {
- "format": "int64",
- "description": "The user ID.",
- "type": "string"
- },
- "username": {
- "description": "The username of the POSIX account.",
- "type": "string"
- },
- "shell": {
- "description": "The path to the logic shell for this account.",
- "type": "string"
- }
- },
- "id": "PosixAccount"
+ "id": "Empty",
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object"
}
},
- "protocol": "rest",
"icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
},
+ "protocol": "rest",
"canonicalName": "Cloud OS Login",
"auth": {
"oauth2": {
@@ -132,266 +393,5 @@
}
}
},
- "rootUrl": "https://oslogin.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "oslogin",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Google Cloud OS Login API",
- "ownerName": "Google",
- "resources": {
- "users": {
- "methods": {
- "importSshPublicKey": {
- "request": {
- "$ref": "SshPublicKey"
- },
- "description": "Adds an SSH public key and returns the profile information. Default POSIX\naccount information is set when no username and UID exist as part of the\nlogin profile.",
- "response": {
- "$ref": "ImportSshPublicKeyResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "parent": {
- "description": "The unique ID for the user in format `users/{user}`.",
- "type": "string",
- "required": true,
- "pattern": "^users/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta/users/{usersId}:importSshPublicKey",
- "id": "oslogin.users.importSshPublicKey",
- "path": "v1beta/{+parent}:importSshPublicKey"
- },
- "getLoginProfile": {
- "parameters": {
- "name": {
- "location": "path",
- "description": "The unique ID for the user in format `users/{user}`.",
- "type": "string",
- "required": true,
- "pattern": "^users/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
- ],
- "flatPath": "v1beta/users/{usersId}/loginProfile",
- "id": "oslogin.users.getLoginProfile",
- "path": "v1beta/{+name}/loginProfile",
- "description": "Retrieves the profile information used for logging in to a virtual machine\non Google Compute Engine.",
- "response": {
- "$ref": "LoginProfile"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET"
- }
- },
- "resources": {
- "sshPublicKeys": {
- "methods": {
- "delete": {
- "flatPath": "v1beta/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
- "path": "v1beta/{+name}",
- "id": "oslogin.users.sshPublicKeys.delete",
- "description": "Deletes an SSH public key.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "name": {
- "description": "The fingerprint of the public key to update. Public keys are identified by\ntheir SHA-256 fingerprint. The fingerprint of the public key is in format\n`users/{user}/sshPublicKeys/{fingerprint}`.",
- "type": "string",
- "required": true,
- "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$",
- "location": "path"
- }
- }
- },
- "patch": {
- "request": {
- "$ref": "SshPublicKey"
- },
- "description": "Updates an SSH public key and returns the profile information. This method\nsupports patch semantics.",
- "httpMethod": "PATCH",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "SshPublicKey"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "updateMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "Mask to control which fields get updated. Updates all if not present.",
- "type": "string"
- },
- "name": {
- "description": "The fingerprint of the public key to update. Public keys are identified by\ntheir SHA-256 fingerprint. The fingerprint of the public key is in format\n`users/{user}/sshPublicKeys/{fingerprint}`.",
- "type": "string",
- "required": true,
- "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
- "path": "v1beta/{+name}",
- "id": "oslogin.users.sshPublicKeys.patch"
- },
- "get": {
- "parameters": {
- "name": {
- "description": "The fingerprint of the public key to retrieve. Public keys are identified\nby their SHA-256 fingerprint. The fingerprint of the public key is in\nformat `users/{user}/sshPublicKeys/{fingerprint}`.",
- "type": "string",
- "required": true,
- "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "flatPath": "v1beta/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
- "id": "oslogin.users.sshPublicKeys.get",
- "path": "v1beta/{+name}",
- "description": "Retrieves an SSH public key.",
- "response": {
- "$ref": "SshPublicKey"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET"
- }
- }
- }
- }
- }
- },
- "parameters": {
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- }
- },
- "version": "v1beta",
- "baseUrl": "https://oslogin.googleapis.com/",
- "kind": "discovery#restDescription",
- "servicePath": "",
- "description": "Manages OS login configuration for Directory API users.",
- "basePath": "",
- "id": "oslogin:v1beta",
- "documentationLink": "https://cloud.google.com/compute/docs/oslogin/rest/",
- "revision": "20170929",
- "discoveryVersion": "v1",
- "version_module": true
+ "rootUrl": "https://oslogin.googleapis.com/"
}
diff --git a/partners/v2/partners-api.json b/partners/v2/partners-api.json
index 6a97e5e..90c4a52 100644
--- a/partners/v2/partners-api.json
+++ b/partners/v2/partners-api.json
@@ -1,12 +1,4 @@
{
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "partners",
- "batchPath": "batch",
- "revision": "20171004",
- "documentationLink": "https://developers.google.com/partners/",
- "id": "partners:v2",
- "title": "Google Partners API",
"discoveryVersion": "v1",
"ownerName": "Google",
"version_module": true,
@@ -20,57 +12,57 @@
"parameterOrder": [],
"httpMethod": "GET",
"parameters": {
- "requestMetadata.trafficSource.trafficSourceId": {
- "location": "query",
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string"
- },
- "requestMetadata.locale": {
- "type": "string",
- "location": "query",
- "description": "Locale to use for the current request."
- },
- "requestMetadata.userOverrides.ipAddress": {
- "location": "query",
- "description": "IP address to use instead of the user's geo-located IP address.",
- "type": "string"
- },
"requestMetadata.experimentIds": {
+ "repeated": true,
"location": "query",
"description": "Experiment IDs the current request belongs to.",
- "type": "string",
- "repeated": true
- },
- "requestMetadata.trafficSource.trafficSubId": {
- "location": "query",
- "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
"type": "string"
},
"orderBy": {
- "location": "query",
"description": "How to order Leads. Currently, only `create_time`\nand `create_time desc` are supported",
- "type": "string"
- },
- "requestMetadata.partnersSessionId": {
"type": "string",
- "location": "query",
- "description": "Google Partners session ID."
+ "location": "query"
+ },
+ "requestMetadata.trafficSource.trafficSubId": {
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string",
+ "location": "query"
},
"requestMetadata.userOverrides.userId": {
- "location": "query",
"description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.partnersSessionId": {
+ "location": "query",
+ "description": "Google Partners session ID.",
"type": "string"
},
"pageToken": {
+ "description": "A token identifying a page of results that the server returns.\nTypically, this is the value of `ListLeadsResponse.next_page_token`\nreturned from the previous call to\nListLeads.",
"type": "string",
- "location": "query",
- "description": "A token identifying a page of results that the server returns.\nTypically, this is the value of `ListLeadsResponse.next_page_token`\nreturned from the previous call to\nListLeads."
+ "location": "query"
},
"pageSize": {
- "type": "integer",
"location": "query",
"format": "int32",
- "description": "Requested page size. Server may return fewer leads than requested.\nIf unspecified, server picks an appropriate default."
+ "description": "Requested page size. Server may return fewer leads than requested.\nIf unspecified, server picks an appropriate default.",
+ "type": "integer"
+ },
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.locale": {
+ "description": "Locale to use for the current request.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string",
+ "location": "query"
}
},
"flatPath": "v2/leads",
@@ -81,113 +73,44 @@
}
},
"offers": {
- "methods": {
- "list": {
- "description": "Lists the Offers available for the current user",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListOffersResponse"
- },
- "parameterOrder": [],
- "parameters": {
- "requestMetadata.userOverrides.userId": {
- "type": "string",
- "location": "query",
- "description": "Logged-in user ID to impersonate instead of the user's ID."
- },
- "requestMetadata.partnersSessionId": {
- "location": "query",
- "description": "Google Partners session ID.",
- "type": "string"
- },
- "requestMetadata.trafficSource.trafficSourceId": {
- "location": "query",
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string"
- },
- "requestMetadata.locale": {
- "type": "string",
- "location": "query",
- "description": "Locale to use for the current request."
- },
- "requestMetadata.userOverrides.ipAddress": {
- "location": "query",
- "description": "IP address to use instead of the user's geo-located IP address.",
- "type": "string"
- },
- "requestMetadata.experimentIds": {
- "location": "query",
- "description": "Experiment IDs the current request belongs to.",
- "type": "string",
- "repeated": true
- },
- "requestMetadata.trafficSource.trafficSubId": {
- "location": "query",
- "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string"
- }
- },
- "flatPath": "v2/offers",
- "path": "v2/offers",
- "id": "partners.offers.list"
- }
- },
"resources": {
"history": {
"methods": {
"list": {
+ "path": "v2/offers/history",
+ "id": "partners.offers.history.list",
+ "description": "Lists the Historical Offers for the current user (or user's entire company)",
+ "httpMethod": "GET",
"response": {
"$ref": "ListOffersHistoryResponse"
},
"parameterOrder": [],
- "httpMethod": "GET",
"parameters": {
- "entireCompany": {
- "location": "query",
- "description": "if true, show history for the entire company. Requires user to be admin.",
- "type": "boolean"
- },
- "requestMetadata.experimentIds": {
- "type": "string",
- "repeated": true,
- "location": "query",
- "description": "Experiment IDs the current request belongs to."
- },
- "orderBy": {
- "type": "string",
- "location": "query",
- "description": "Comma-separated list of fields to order by, e.g.: \"foo,bar,baz\".\nUse \"foo desc\" to sort descending.\nList of valid field names is: name, offer_code, expiration_time, status,\n last_modified_time, sender_name, creation_time, country_code,\n offer_type."
- },
- "requestMetadata.trafficSource.trafficSubId": {
- "type": "string",
- "location": "query",
- "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us."
- },
- "requestMetadata.userOverrides.userId": {
- "type": "string",
- "location": "query",
- "description": "Logged-in user ID to impersonate instead of the user's ID."
- },
"requestMetadata.partnersSessionId": {
"location": "query",
"description": "Google Partners session ID.",
"type": "string"
},
- "pageToken": {
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
"type": "string",
+ "location": "query"
+ },
+ "pageToken": {
"location": "query",
- "description": "Token to retrieve a specific page."
+ "description": "Token to retrieve a specific page.",
+ "type": "string"
},
"pageSize": {
- "type": "integer",
"location": "query",
"format": "int32",
- "description": "Maximum number of rows to return per page."
+ "description": "Maximum number of rows to return per page.",
+ "type": "integer"
},
"requestMetadata.trafficSource.trafficSourceId": {
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
"type": "string",
- "location": "query",
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us."
+ "location": "query"
},
"requestMetadata.locale": {
"location": "query",
@@ -198,30 +121,70 @@
"location": "query",
"description": "IP address to use instead of the user's geo-located IP address.",
"type": "string"
+ },
+ "requestMetadata.experimentIds": {
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
+ "entireCompany": {
+ "location": "query",
+ "description": "if true, show history for the entire company. Requires user to be admin.",
+ "type": "boolean"
+ },
+ "requestMetadata.trafficSource.trafficSubId": {
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string",
+ "location": "query"
+ },
+ "orderBy": {
+ "description": "Comma-separated list of fields to order by, e.g.: \"foo,bar,baz\".\nUse \"foo desc\" to sort descending.\nList of valid field names is: name, offer_code, expiration_time, status,\n last_modified_time, sender_name, creation_time, country_code,\n offer_type.",
+ "type": "string",
+ "location": "query"
}
},
- "flatPath": "v2/offers/history",
- "id": "partners.offers.history.list",
- "path": "v2/offers/history",
- "description": "Lists the Historical Offers for the current user (or user's entire company)"
+ "flatPath": "v2/offers/history"
}
}
}
- }
- },
- "userStates": {
+ },
"methods": {
"list": {
- "httpMethod": "GET",
- "parameterOrder": [],
+ "id": "partners.offers.list",
+ "path": "v2/offers",
+ "description": "Lists the Offers available for the current user",
"response": {
- "$ref": "ListUserStatesResponse"
+ "$ref": "ListOffersResponse"
},
+ "parameterOrder": [],
+ "httpMethod": "GET",
"parameters": {
- "requestMetadata.trafficSource.trafficSourceId": {
+ "requestMetadata.experimentIds": {
+ "description": "Experiment IDs the current request belongs to.",
"type": "string",
+ "repeated": true,
+ "location": "query"
+ },
+ "requestMetadata.trafficSource.trafficSubId": {
"location": "query",
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us."
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string"
+ },
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.partnersSessionId": {
+ "location": "query",
+ "description": "Google Partners session ID.",
+ "type": "string"
+ },
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string",
+ "location": "query"
},
"requestMetadata.locale": {
"location": "query",
@@ -232,42 +195,15 @@
"location": "query",
"description": "IP address to use instead of the user's geo-located IP address.",
"type": "string"
- },
- "requestMetadata.experimentIds": {
- "type": "string",
- "repeated": true,
- "location": "query",
- "description": "Experiment IDs the current request belongs to."
- },
- "requestMetadata.trafficSource.trafficSubId": {
- "type": "string",
- "location": "query",
- "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us."
- },
- "requestMetadata.userOverrides.userId": {
- "location": "query",
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
- "type": "string"
- },
- "requestMetadata.partnersSessionId": {
- "location": "query",
- "description": "Google Partners session ID.",
- "type": "string"
}
},
- "flatPath": "v2/userStates",
- "path": "v2/userStates",
- "id": "partners.userStates.list",
- "description": "Lists states for current user."
+ "flatPath": "v2/offers"
}
}
},
"analytics": {
"methods": {
"list": {
- "flatPath": "v2/analytics",
- "id": "partners.analytics.list",
- "path": "v2/analytics",
"description": "Lists analytics data for a user's associated company.\nShould only be called within the context of an authorized logged in user.",
"response": {
"$ref": "ListAnalyticsResponse"
@@ -275,15 +211,36 @@
"parameterOrder": [],
"httpMethod": "GET",
"parameters": {
- "requestMetadata.userOverrides.userId": {
- "type": "string",
+ "requestMetadata.locale": {
"location": "query",
- "description": "Logged-in user ID to impersonate instead of the user's ID."
+ "description": "Locale to use for the current request.",
+ "type": "string"
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.experimentIds": {
+ "repeated": true,
+ "location": "query",
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string"
+ },
+ "requestMetadata.trafficSource.trafficSubId": {
+ "location": "query",
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string"
+ },
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string",
+ "location": "query"
},
"requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
"type": "string",
- "location": "query",
- "description": "Google Partners session ID."
+ "location": "query"
},
"pageToken": {
"location": "query",
@@ -291,10 +248,42 @@
"type": "string"
},
"pageSize": {
- "type": "integer",
"location": "query",
"format": "int32",
- "description": "Requested page size. Server may return fewer analytics than requested.\nIf unspecified or set to 0, default value is 30.\nSpecifies the number of days in the date range when querying analytics.\nThe `page_token` represents the end date of the date range\nand the start date is calculated using the `page_size` as the number\nof days BEFORE the end date.\nMust be a non-negative integer."
+ "description": "Requested page size. Server may return fewer analytics than requested.\nIf unspecified or set to 0, default value is 30.\nSpecifies the number of days in the date range when querying analytics.\nThe `page_token` represents the end date of the date range\nand the start date is calculated using the `page_size` as the number\nof days BEFORE the end date.\nMust be a non-negative integer.",
+ "type": "integer"
+ },
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v2/analytics",
+ "id": "partners.analytics.list",
+ "path": "v2/analytics"
+ }
+ }
+ },
+ "userStates": {
+ "methods": {
+ "list": {
+ "description": "Lists states for current user.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListUserStatesResponse"
+ },
+ "parameterOrder": [],
+ "parameters": {
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
+ "type": "string",
+ "location": "query"
},
"requestMetadata.trafficSource.trafficSourceId": {
"location": "query",
@@ -302,9 +291,9 @@
"type": "string"
},
"requestMetadata.locale": {
- "location": "query",
"description": "Locale to use for the current request.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"requestMetadata.userOverrides.ipAddress": {
"location": "query",
@@ -312,50 +301,56 @@
"type": "string"
},
"requestMetadata.experimentIds": {
- "type": "string",
"repeated": true,
"location": "query",
- "description": "Experiment IDs the current request belongs to."
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string"
},
"requestMetadata.trafficSource.trafficSubId": {
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
"type": "string",
- "location": "query",
- "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us."
+ "location": "query"
}
- }
+ },
+ "flatPath": "v2/userStates",
+ "path": "v2/userStates",
+ "id": "partners.userStates.list"
}
}
},
"v2": {
"methods": {
"updateCompanies": {
- "flatPath": "v2/companies",
- "id": "partners.updateCompanies",
- "path": "v2/companies",
- "request": {
- "$ref": "Company"
- },
- "description": "Update company.\nShould only be called within the context of an authorized logged in user.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [],
"response": {
"$ref": "Company"
},
- "parameterOrder": [],
- "httpMethod": "PATCH",
"parameters": {
- "requestMetadata.trafficSource.trafficSourceId": {
+ "requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
"type": "string",
+ "location": "query"
+ },
+ "requestMetadata.userOverrides.userId": {
"location": "query",
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us."
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string"
+ },
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "location": "query",
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string"
},
"requestMetadata.locale": {
+ "description": "Locale to use for the current request.",
"type": "string",
- "location": "query",
- "description": "Locale to use for the current request."
+ "location": "query"
},
"requestMetadata.userOverrides.ipAddress": {
- "location": "query",
"description": "IP address to use instead of the user's geo-located IP address.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"updateMask": {
"location": "query",
@@ -364,65 +359,62 @@
"type": "string"
},
"requestMetadata.experimentIds": {
+ "description": "Experiment IDs the current request belongs to.",
"type": "string",
"repeated": true,
- "location": "query",
- "description": "Experiment IDs the current request belongs to."
+ "location": "query"
},
"requestMetadata.trafficSource.trafficSubId": {
"location": "query",
"description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
"type": "string"
- },
- "requestMetadata.partnersSessionId": {
- "type": "string",
- "location": "query",
- "description": "Google Partners session ID."
- },
- "requestMetadata.userOverrides.userId": {
- "location": "query",
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
- "type": "string"
}
+ },
+ "flatPath": "v2/companies",
+ "path": "v2/companies",
+ "id": "partners.updateCompanies",
+ "description": "Update company.\nShould only be called within the context of an authorized logged in user.",
+ "request": {
+ "$ref": "Company"
}
},
"getPartnersstatus": {
+ "httpMethod": "GET",
"response": {
"$ref": "GetPartnersStatusResponse"
},
"parameterOrder": [],
- "httpMethod": "GET",
"parameters": {
- "requestMetadata.partnersSessionId": {
- "type": "string",
- "location": "query",
- "description": "Google Partners session ID."
- },
"requestMetadata.userOverrides.userId": {
- "type": "string",
"location": "query",
- "description": "Logged-in user ID to impersonate instead of the user's ID."
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string"
+ },
+ "requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
+ "type": "string",
+ "location": "query"
},
"requestMetadata.trafficSource.trafficSourceId": {
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
"type": "string",
- "location": "query",
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us."
+ "location": "query"
},
"requestMetadata.locale": {
- "location": "query",
"description": "Locale to use for the current request.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"requestMetadata.userOverrides.ipAddress": {
- "location": "query",
"description": "IP address to use instead of the user's geo-located IP address.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"requestMetadata.experimentIds": {
+ "description": "Experiment IDs the current request belongs to.",
"type": "string",
"repeated": true,
- "location": "query",
- "description": "Experiment IDs the current request belongs to."
+ "location": "query"
},
"requestMetadata.trafficSource.trafficSubId": {
"location": "query",
@@ -431,281 +423,48 @@
}
},
"flatPath": "v2/partnersstatus",
- "id": "partners.getPartnersstatus",
"path": "v2/partnersstatus",
+ "id": "partners.getPartnersstatus",
"description": "Gets Partners Status of the logged in user's agency.\nShould only be called if the logged in user is the admin of the agency."
},
"updateLeads": {
- "response": {
- "$ref": "Lead"
- },
- "parameterOrder": [],
- "httpMethod": "PATCH",
- "parameters": {
- "requestMetadata.trafficSource.trafficSourceId": {
- "location": "query",
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string"
- },
- "requestMetadata.locale": {
- "type": "string",
- "location": "query",
- "description": "Locale to use for the current request."
- },
- "requestMetadata.userOverrides.ipAddress": {
- "location": "query",
- "description": "IP address to use instead of the user's geo-located IP address.",
- "type": "string"
- },
- "updateMask": {
- "location": "query",
- "format": "google-fieldmask",
- "description": "Standard field mask for the set of fields to be updated.\nRequired with at least 1 value in FieldMask's paths.\nOnly `state` and `adwords_customer_id` are currently supported.",
- "type": "string"
- },
- "requestMetadata.experimentIds": {
- "type": "string",
- "repeated": true,
- "location": "query",
- "description": "Experiment IDs the current request belongs to."
- },
- "requestMetadata.trafficSource.trafficSubId": {
- "location": "query",
- "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string"
- },
- "requestMetadata.userOverrides.userId": {
- "location": "query",
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
- "type": "string"
- },
- "requestMetadata.partnersSessionId": {
- "type": "string",
- "location": "query",
- "description": "Google Partners session ID."
- }
- },
- "flatPath": "v2/leads",
"id": "partners.updateLeads",
"path": "v2/leads",
"request": {
"$ref": "Lead"
},
- "description": "Updates the specified lead."
- }
- }
- },
- "users": {
- "methods": {
- "deleteCompanyRelation": {
- "description": "Deletes a user's company relation. Unaffiliaites the user from a company.",
+ "description": "Updates the specified lead.",
"response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "userId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "requestMetadata.experimentIds": {
- "location": "query",
- "description": "Experiment IDs the current request belongs to.",
- "type": "string",
- "repeated": true
- },
- "requestMetadata.trafficSource.trafficSubId": {
- "type": "string",
- "location": "query",
- "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us."
- },
- "userId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The ID of the user. Can be set to \u003ccode\u003eme\u003c/code\u003e to mean\nthe currently authenticated user."
- },
- "requestMetadata.userOverrides.userId": {
- "location": "query",
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
- "type": "string"
- },
- "requestMetadata.partnersSessionId": {
- "type": "string",
- "location": "query",
- "description": "Google Partners session ID."
- },
- "requestMetadata.trafficSource.trafficSourceId": {
- "location": "query",
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string"
- },
- "requestMetadata.locale": {
- "location": "query",
- "description": "Locale to use for the current request.",
- "type": "string"
- },
- "requestMetadata.userOverrides.ipAddress": {
- "type": "string",
- "location": "query",
- "description": "IP address to use instead of the user's geo-located IP address."
- }
- },
- "flatPath": "v2/users/{userId}/companyRelation",
- "id": "partners.users.deleteCompanyRelation",
- "path": "v2/users/{userId}/companyRelation"
- },
- "createCompanyRelation": {
- "response": {
- "$ref": "CompanyRelation"
- },
- "parameterOrder": [
- "userId"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "requestMetadata.trafficSource.trafficSourceId": {
- "location": "query",
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string"
- },
- "requestMetadata.locale": {
- "location": "query",
- "description": "Locale to use for the current request.",
- "type": "string"
- },
- "requestMetadata.userOverrides.ipAddress": {
- "type": "string",
- "location": "query",
- "description": "IP address to use instead of the user's geo-located IP address."
- },
- "requestMetadata.experimentIds": {
- "type": "string",
- "repeated": true,
- "location": "query",
- "description": "Experiment IDs the current request belongs to."
- },
- "userId": {
- "location": "path",
- "description": "The ID of the user. Can be set to \u003ccode\u003eme\u003c/code\u003e to mean\nthe currently authenticated user.",
- "type": "string",
- "required": true
- },
- "requestMetadata.trafficSource.trafficSubId": {
- "location": "query",
- "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string"
- },
- "requestMetadata.partnersSessionId": {
- "location": "query",
- "description": "Google Partners session ID.",
- "type": "string"
- },
- "requestMetadata.userOverrides.userId": {
- "location": "query",
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
- "type": "string"
- }
- },
- "flatPath": "v2/users/{userId}/companyRelation",
- "id": "partners.users.createCompanyRelation",
- "path": "v2/users/{userId}/companyRelation",
- "description": "Creates a user's company relation. Affiliates the user to a company.",
- "request": {
- "$ref": "CompanyRelation"
- }
- },
- "get": {
- "flatPath": "v2/users/{userId}",
- "id": "partners.users.get",
- "path": "v2/users/{userId}",
- "description": "Gets a user.",
- "parameterOrder": [
- "userId"
- ],
- "response": {
- "$ref": "User"
- },
- "httpMethod": "GET",
- "parameters": {
- "requestMetadata.experimentIds": {
- "location": "query",
- "description": "Experiment IDs the current request belongs to.",
- "type": "string",
- "repeated": true
- },
- "userId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Identifier of the user. Can be set to \u003ccode\u003eme\u003c/code\u003e to mean the currently\nauthenticated user."
- },
- "requestMetadata.trafficSource.trafficSubId": {
- "location": "query",
- "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string"
- },
- "requestMetadata.userOverrides.userId": {
- "location": "query",
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
- "type": "string"
- },
- "requestMetadata.partnersSessionId": {
- "location": "query",
- "description": "Google Partners session ID.",
- "type": "string"
- },
- "userView": {
- "location": "query",
- "enum": [
- "BASIC",
- "PROFILE",
- "PUBLIC_PROFILE"
- ],
- "description": "Specifies what parts of the user information to return.",
- "type": "string"
- },
- "requestMetadata.trafficSource.trafficSourceId": {
- "type": "string",
- "location": "query",
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us."
- },
- "requestMetadata.locale": {
- "type": "string",
- "location": "query",
- "description": "Locale to use for the current request."
- },
- "requestMetadata.userOverrides.ipAddress": {
- "location": "query",
- "description": "IP address to use instead of the user's geo-located IP address.",
- "type": "string"
- }
- }
- },
- "updateProfile": {
- "request": {
- "$ref": "UserProfile"
- },
- "description": "Updates a user's profile. A user can only update their own profile and\nshould only be called within the context of a logged in user.",
- "response": {
- "$ref": "UserProfile"
+ "$ref": "Lead"
},
"parameterOrder": [],
"httpMethod": "PATCH",
"parameters": {
+ "requestMetadata.experimentIds": {
+ "repeated": true,
+ "location": "query",
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string"
+ },
+ "requestMetadata.trafficSource.trafficSubId": {
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string",
+ "location": "query"
+ },
"requestMetadata.userOverrides.userId": {
"location": "query",
"description": "Logged-in user ID to impersonate instead of the user's ID.",
"type": "string"
},
"requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
"type": "string",
- "location": "query",
- "description": "Google Partners session ID."
+ "location": "query"
},
"requestMetadata.trafficSource.trafficSourceId": {
- "location": "query",
"description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"requestMetadata.locale": {
"location": "query",
@@ -713,54 +472,120 @@
"type": "string"
},
"requestMetadata.userOverrides.ipAddress": {
+ "description": "IP address to use instead of the user's geo-located IP address.",
"type": "string",
- "location": "query",
- "description": "IP address to use instead of the user's geo-located IP address."
+ "location": "query"
},
- "requestMetadata.experimentIds": {
- "location": "query",
- "description": "Experiment IDs the current request belongs to.",
+ "updateMask": {
+ "format": "google-fieldmask",
+ "description": "Standard field mask for the set of fields to be updated.\nRequired with at least 1 value in FieldMask's paths.\nOnly `state` and `adwords_customer_id` are currently supported.",
"type": "string",
- "repeated": true
- },
- "requestMetadata.trafficSource.trafficSubId": {
- "type": "string",
- "location": "query",
- "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us."
+ "location": "query"
}
},
- "flatPath": "v2/users/profile",
- "id": "partners.users.updateProfile",
- "path": "v2/users/profile"
+ "flatPath": "v2/leads"
}
}
},
"companies": {
"methods": {
"list": {
- "flatPath": "v2/companies",
- "path": "v2/companies",
- "id": "partners.companies.list",
- "description": "Lists companies.",
- "httpMethod": "GET",
"response": {
"$ref": "ListCompaniesResponse"
},
"parameterOrder": [],
+ "httpMethod": "GET",
"parameters": {
- "minMonthlyBudget.units": {
- "type": "string",
+ "languageCodes": {
+ "repeated": true,
"location": "query",
+ "description": "List of language codes that company can support. Only primary language\nsubtags are accepted as defined by\n\u003ca href=\"https://tools.ietf.org/html/bcp47\"\u003eBCP 47\u003c/a\u003e\n(IETF BCP 47, \"Tags for Identifying Languages\").",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Requested page size. Server may return fewer companies than requested.\nIf unspecified, server picks an appropriate default.",
+ "type": "integer",
+ "location": "query"
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "location": "query",
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string"
+ },
+ "requestMetadata.experimentIds": {
+ "repeated": true,
+ "location": "query",
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string"
+ },
+ "orderBy": {
+ "location": "query",
+ "description": "How to order addresses within the returned companies. Currently, only\n`address` and `address desc` is supported which will sorted by closest to\nfarthest in distance from given address and farthest to closest distance\nfrom given address respectively.",
+ "type": "string"
+ },
+ "specializations": {
+ "enum": [
+ "BADGE_SPECIALIZATION_UNKNOWN",
+ "BADGE_SPECIALIZATION_ADWORDS_SEARCH",
+ "BADGE_SPECIALIZATION_ADWORDS_DISPLAY",
+ "BADGE_SPECIALIZATION_ADWORDS_MOBILE",
+ "BADGE_SPECIALIZATION_ADWORDS_VIDEO",
+ "BADGE_SPECIALIZATION_ADWORDS_SHOPPING"
+ ],
+ "description": "List of specializations that the returned agencies should provide. If this\nis not empty, any returned agency must have at least one of these\nspecializations, or one of the services in the \"services\" field.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
+ "maxMonthlyBudget.currencyCode": {
+ "description": "The 3-letter currency code defined in ISO 4217.",
+ "type": "string",
+ "location": "query"
+ },
+ "minMonthlyBudget.currencyCode": {
+ "description": "The 3-letter currency code defined in ISO 4217.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.userOverrides.userId": {
+ "location": "query",
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string"
+ },
+ "view": {
+ "enum": [
+ "COMPANY_VIEW_UNSPECIFIED",
+ "CV_GOOGLE_PARTNER_SEARCH"
+ ],
+ "description": "The view of the `Company` resource to be returned. This must not be\n`COMPANY_VIEW_UNSPECIFIED`.",
+ "type": "string",
+ "location": "query"
+ },
+ "address": {
+ "description": "The address to use when searching for companies.\nIf not given, the geo-located address of the request is used.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.locale": {
+ "description": "Locale to use for the current request.",
+ "type": "string",
+ "location": "query"
+ },
+ "minMonthlyBudget.units": {
"format": "int64",
- "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar."
+ "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
+ "type": "string",
+ "location": "query"
},
"maxMonthlyBudget.nanos": {
- "location": "query",
"format": "int32",
"description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
},
"services": {
+ "repeated": true,
"location": "query",
"enum": [
"SERVICE_UNSPECIFIED",
@@ -772,47 +597,47 @@
"S_MOBILE_WEBSITE_SERVICES"
],
"description": "List of services that the returned agencies should provide. If this is\nnot empty, any returned agency must have at least one of these services,\nor one of the specializations in the \"specializations\" field.",
- "type": "string",
- "repeated": true
- },
- "maxMonthlyBudget.units": {
- "location": "query",
- "format": "int64",
- "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
"type": "string"
},
- "requestMetadata.trafficSource.trafficSourceId": {
+ "maxMonthlyBudget.units": {
+ "format": "int64",
+ "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
"type": "string",
- "location": "query",
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us."
+ "location": "query"
},
- "minMonthlyBudget.nanos": {
- "type": "integer",
- "location": "query",
- "format": "int32",
- "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000."
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string",
+ "location": "query"
},
"requestMetadata.trafficSource.trafficSubId": {
"location": "query",
"description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
"type": "string"
},
- "requestMetadata.partnersSessionId": {
- "location": "query",
- "description": "Google Partners session ID.",
- "type": "string"
+ "minMonthlyBudget.nanos": {
+ "format": "int32",
+ "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
+ "type": "integer",
+ "location": "query"
},
- "pageToken": {
+ "requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
"type": "string",
- "location": "query",
- "description": "A token identifying a page of results that the server returns.\nTypically, this is the value of `ListCompaniesResponse.next_page_token`\nreturned from the previous call to\nListCompanies."
+ "location": "query"
},
"companyName": {
- "location": "query",
"description": "Company name to search for.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "A token identifying a page of results that the server returns.\nTypically, this is the value of `ListCompaniesResponse.next_page_token`\nreturned from the previous call to\nListCompanies.",
"type": "string"
},
"industries": {
+ "repeated": true,
"location": "query",
"enum": [
"INDUSTRY_UNSPECIFIED",
@@ -828,16 +653,14 @@
"I_TRAVEL"
],
"description": "List of industries the company can help with.",
- "type": "string",
- "repeated": true
+ "type": "string"
},
"websiteUrl": {
+ "description": "Website URL that will help to find a better matched company.\n.",
"type": "string",
- "location": "query",
- "description": "Website URL that will help to find a better matched company.\n."
+ "location": "query"
},
"gpsMotivations": {
- "type": "string",
"repeated": true,
"location": "query",
"enum": [
@@ -846,121 +669,60 @@
"GPSM_HELP_WITH_WEBSITE",
"GPSM_NO_WEBSITE"
],
- "description": "List of reasons for using Google Partner Search to get companies."
- },
- "languageCodes": {
- "location": "query",
- "description": "List of language codes that company can support. Only primary language\nsubtags are accepted as defined by\n\u003ca href=\"https://tools.ietf.org/html/bcp47\"\u003eBCP 47\u003c/a\u003e\n(IETF BCP 47, \"Tags for Identifying Languages\").",
- "type": "string",
- "repeated": true
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "format": "int32",
- "description": "Requested page size. Server may return fewer companies than requested.\nIf unspecified, server picks an appropriate default."
- },
- "requestMetadata.userOverrides.ipAddress": {
- "location": "query",
- "description": "IP address to use instead of the user's geo-located IP address.",
+ "description": "List of reasons for using Google Partner Search to get companies.",
"type": "string"
- },
- "requestMetadata.experimentIds": {
- "type": "string",
- "repeated": true,
- "location": "query",
- "description": "Experiment IDs the current request belongs to."
- },
- "orderBy": {
- "type": "string",
- "location": "query",
- "description": "How to order addresses within the returned companies. Currently, only\n`address` and `address desc` is supported which will sorted by closest to\nfarthest in distance from given address and farthest to closest distance\nfrom given address respectively."
- },
- "specializations": {
- "location": "query",
- "enum": [
- "BADGE_SPECIALIZATION_UNKNOWN",
- "BADGE_SPECIALIZATION_ADWORDS_SEARCH",
- "BADGE_SPECIALIZATION_ADWORDS_DISPLAY",
- "BADGE_SPECIALIZATION_ADWORDS_MOBILE",
- "BADGE_SPECIALIZATION_ADWORDS_VIDEO",
- "BADGE_SPECIALIZATION_ADWORDS_SHOPPING"
- ],
- "description": "List of specializations that the returned agencies should provide. If this\nis not empty, any returned agency must have at least one of these\nspecializations, or one of the services in the \"services\" field.",
- "type": "string",
- "repeated": true
- },
- "maxMonthlyBudget.currencyCode": {
- "location": "query",
- "description": "The 3-letter currency code defined in ISO 4217.",
- "type": "string"
- },
- "minMonthlyBudget.currencyCode": {
- "type": "string",
- "location": "query",
- "description": "The 3-letter currency code defined in ISO 4217."
- },
- "requestMetadata.userOverrides.userId": {
- "type": "string",
- "location": "query",
- "description": "Logged-in user ID to impersonate instead of the user's ID."
- },
- "view": {
- "type": "string",
- "location": "query",
- "enum": [
- "COMPANY_VIEW_UNSPECIFIED",
- "CV_GOOGLE_PARTNER_SEARCH"
- ],
- "description": "The view of the `Company` resource to be returned. This must not be\n`COMPANY_VIEW_UNSPECIFIED`."
- },
- "requestMetadata.locale": {
- "type": "string",
- "location": "query",
- "description": "Locale to use for the current request."
- },
- "address": {
- "type": "string",
- "location": "query",
- "description": "The address to use when searching for companies.\nIf not given, the geo-located address of the request is used."
}
- }
+ },
+ "flatPath": "v2/companies",
+ "id": "partners.companies.list",
+ "path": "v2/companies",
+ "description": "Lists companies."
},
"get": {
+ "httpMethod": "GET",
"response": {
"$ref": "GetCompanyResponse"
},
"parameterOrder": [
"companyId"
],
- "httpMethod": "GET",
"parameters": {
- "requestMetadata.trafficSource.trafficSourceId": {
- "type": "string",
+ "requestMetadata.locale": {
"location": "query",
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us."
- },
- "requestMetadata.userOverrides.ipAddress": {
- "location": "query",
- "description": "IP address to use instead of the user's geo-located IP address.",
+ "description": "Locale to use for the current request.",
"type": "string"
},
+ "address": {
+ "location": "query",
+ "description": "The address to use for sorting the company's addresses by proximity.\nIf not given, the geo-located address of the request is used.\nUsed when order_by is set.",
+ "type": "string"
+ },
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "location": "query",
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string"
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string",
+ "location": "query"
+ },
"companyId": {
+ "description": "The ID of the company to retrieve.",
"type": "string",
"required": true,
- "location": "path",
- "description": "The ID of the company to retrieve."
+ "location": "path"
},
"currencyCode": {
+ "description": "If the company's budget is in a different currency code than this one, then\nthe converted budget is converted to this currency code.",
"type": "string",
- "location": "query",
- "description": "If the company's budget is in a different currency code than this one, then\nthe converted budget is converted to this currency code."
+ "location": "query"
},
"requestMetadata.experimentIds": {
+ "repeated": true,
"location": "query",
"description": "Experiment IDs the current request belongs to.",
- "type": "string",
- "repeated": true
+ "type": "string"
},
"orderBy": {
"location": "query",
@@ -972,39 +734,29 @@
"description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
"type": "string"
},
- "requestMetadata.userOverrides.userId": {
- "location": "query",
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
- "type": "string"
- },
"requestMetadata.partnersSessionId": {
- "location": "query",
"description": "Google Partners session ID.",
- "type": "string"
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string",
+ "location": "query"
},
"view": {
- "type": "string",
- "location": "query",
"enum": [
"COMPANY_VIEW_UNSPECIFIED",
"CV_GOOGLE_PARTNER_SEARCH"
],
- "description": "The view of `Company` resource to be returned. This must not be\n`COMPANY_VIEW_UNSPECIFIED`."
- },
- "address": {
- "location": "query",
- "description": "The address to use for sorting the company's addresses by proximity.\nIf not given, the geo-located address of the request is used.\nUsed when order_by is set.",
- "type": "string"
- },
- "requestMetadata.locale": {
+ "description": "The view of `Company` resource to be returned. This must not be\n`COMPANY_VIEW_UNSPECIFIED`.",
"type": "string",
- "location": "query",
- "description": "Locale to use for the current request."
+ "location": "query"
}
},
"flatPath": "v2/companies/{companyId}",
- "id": "partners.companies.get",
"path": "v2/companies/{companyId}",
+ "id": "partners.companies.get",
"description": "Gets a company."
}
},
@@ -1012,10 +764,10 @@
"leads": {
"methods": {
"create": {
+ "description": "Creates an advertiser lead for the given company ID.",
"request": {
"$ref": "CreateLeadRequest"
},
- "description": "Creates an advertiser lead for the given company ID.",
"httpMethod": "POST",
"parameterOrder": [
"companyId"
@@ -1025,10 +777,10 @@
},
"parameters": {
"companyId": {
- "type": "string",
- "required": true,
"location": "path",
- "description": "The ID of the company to contact."
+ "description": "The ID of the company to contact.",
+ "type": "string",
+ "required": true
}
},
"flatPath": "v2/companies/{companyId}/leads",
@@ -1039,60 +791,332 @@
}
}
},
+ "users": {
+ "methods": {
+ "updateProfile": {
+ "response": {
+ "$ref": "UserProfile"
+ },
+ "parameterOrder": [],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.partnersSessionId": {
+ "location": "query",
+ "description": "Google Partners session ID.",
+ "type": "string"
+ },
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "location": "query",
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string"
+ },
+ "requestMetadata.locale": {
+ "description": "Locale to use for the current request.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.experimentIds": {
+ "repeated": true,
+ "location": "query",
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string"
+ },
+ "requestMetadata.trafficSource.trafficSubId": {
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v2/users/profile",
+ "id": "partners.users.updateProfile",
+ "path": "v2/users/profile",
+ "request": {
+ "$ref": "UserProfile"
+ },
+ "description": "Updates a user's profile. A user can only update their own profile and\nshould only be called within the context of a logged in user."
+ },
+ "deleteCompanyRelation": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "userId"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "requestMetadata.experimentIds": {
+ "repeated": true,
+ "location": "query",
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string"
+ },
+ "userId": {
+ "location": "path",
+ "description": "The ID of the user. Can be set to \u003ccode\u003eme\u003c/code\u003e to mean\nthe currently authenticated user.",
+ "type": "string",
+ "required": true
+ },
+ "requestMetadata.trafficSource.trafficSubId": {
+ "location": "query",
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string"
+ },
+ "requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "location": "query",
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string"
+ },
+ "requestMetadata.locale": {
+ "location": "query",
+ "description": "Locale to use for the current request.",
+ "type": "string"
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v2/users/{userId}/companyRelation",
+ "id": "partners.users.deleteCompanyRelation",
+ "path": "v2/users/{userId}/companyRelation",
+ "description": "Deletes a user's company relation. Unaffiliaites the user from a company."
+ },
+ "createCompanyRelation": {
+ "response": {
+ "$ref": "CompanyRelation"
+ },
+ "parameterOrder": [
+ "userId"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "location": "query",
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string"
+ },
+ "requestMetadata.locale": {
+ "description": "Locale to use for the current request.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.experimentIds": {
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
+ "requestMetadata.trafficSource.trafficSubId": {
+ "location": "query",
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string"
+ },
+ "userId": {
+ "location": "path",
+ "description": "The ID of the user. Can be set to \u003ccode\u003eme\u003c/code\u003e to mean\nthe currently authenticated user.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v2/users/{userId}/companyRelation",
+ "id": "partners.users.createCompanyRelation",
+ "path": "v2/users/{userId}/companyRelation",
+ "request": {
+ "$ref": "CompanyRelation"
+ },
+ "description": "Creates a user's company relation. Affiliates the user to a company."
+ },
+ "get": {
+ "response": {
+ "$ref": "User"
+ },
+ "parameterOrder": [
+ "userId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "requestMetadata.experimentIds": {
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
+ "userId": {
+ "description": "Identifier of the user. Can be set to \u003ccode\u003eme\u003c/code\u003e to mean the currently\nauthenticated user.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "requestMetadata.trafficSource.trafficSubId": {
+ "location": "query",
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string"
+ },
+ "requestMetadata.partnersSessionId": {
+ "location": "query",
+ "description": "Google Partners session ID.",
+ "type": "string"
+ },
+ "requestMetadata.userOverrides.userId": {
+ "location": "query",
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string"
+ },
+ "userView": {
+ "enum": [
+ "BASIC",
+ "PROFILE",
+ "PUBLIC_PROFILE"
+ ],
+ "description": "Specifies what parts of the user information to return.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "location": "query",
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string"
+ },
+ "requestMetadata.locale": {
+ "location": "query",
+ "description": "Locale to use for the current request.",
+ "type": "string"
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v2/users/{userId}",
+ "id": "partners.users.get",
+ "path": "v2/users/{userId}",
+ "description": "Gets a user."
+ }
+ }
+ },
"userEvents": {
"methods": {
"log": {
+ "id": "partners.userEvents.log",
+ "path": "v2/userEvents:log",
"request": {
"$ref": "LogUserEventRequest"
},
"description": "Logs a user event.",
- "httpMethod": "POST",
- "parameterOrder": [],
"response": {
"$ref": "LogUserEventResponse"
},
+ "parameterOrder": [],
+ "httpMethod": "POST",
"parameters": {},
- "flatPath": "v2/userEvents:log",
- "path": "v2/userEvents:log",
- "id": "partners.userEvents.log"
+ "flatPath": "v2/userEvents:log"
}
}
},
"clientMessages": {
"methods": {
"log": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "LogMessageResponse"
- },
- "parameters": {},
- "flatPath": "v2/clientMessages:log",
- "path": "v2/clientMessages:log",
"id": "partners.clientMessages.log",
+ "path": "v2/clientMessages:log",
"request": {
"$ref": "LogMessageRequest"
},
- "description": "Logs a generic message from the client, such as\n`Failed to render component`, `Profile page is running slow`,\n`More than 500 users have accessed this result.`, etc."
+ "description": "Logs a generic message from the client, such as\n`Failed to render component`, `Profile page is running slow`,\n`More than 500 users have accessed this result.`, etc.",
+ "response": {
+ "$ref": "LogMessageResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "flatPath": "v2/clientMessages:log"
}
}
},
"exams": {
"methods": {
"getToken": {
- "description": "Gets an Exam Token for a Partner's user to take an exam in the Exams System",
- "httpMethod": "GET",
- "parameterOrder": [
- "examType"
- ],
"response": {
"$ref": "ExamToken"
},
+ "parameterOrder": [
+ "examType"
+ ],
+ "httpMethod": "GET",
"parameters": {
- "examType": {
+ "requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
"type": "string",
- "required": true,
- "location": "path",
+ "location": "query"
+ },
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.locale": {
+ "description": "Locale to use for the current request.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "location": "query",
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string"
+ },
+ "requestMetadata.experimentIds": {
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
+ "requestMetadata.trafficSource.trafficSubId": {
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string",
+ "location": "query"
+ },
+ "examType": {
"enum": [
"CERTIFICATION_EXAM_TYPE_UNSPECIFIED",
"CET_ADWORDS_FUNDAMENTALS",
@@ -1106,48 +1130,16 @@
"CET_DIGITAL_SALES",
"CET_MOBILE_SITES"
],
- "description": "The exam type we are requesting a token for."
- },
- "requestMetadata.userOverrides.userId": {
+ "description": "The exam type we are requesting a token for.",
"type": "string",
- "location": "query",
- "description": "Logged-in user ID to impersonate instead of the user's ID."
- },
- "requestMetadata.partnersSessionId": {
- "type": "string",
- "location": "query",
- "description": "Google Partners session ID."
- },
- "requestMetadata.trafficSource.trafficSourceId": {
- "type": "string",
- "location": "query",
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us."
- },
- "requestMetadata.locale": {
- "type": "string",
- "location": "query",
- "description": "Locale to use for the current request."
- },
- "requestMetadata.userOverrides.ipAddress": {
- "type": "string",
- "location": "query",
- "description": "IP address to use instead of the user's geo-located IP address."
- },
- "requestMetadata.experimentIds": {
- "location": "query",
- "description": "Experiment IDs the current request belongs to.",
- "type": "string",
- "repeated": true
- },
- "requestMetadata.trafficSource.trafficSubId": {
- "type": "string",
- "location": "query",
- "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us."
+ "required": true,
+ "location": "path"
}
},
"flatPath": "v2/exams/{examType}/token",
+ "id": "partners.exams.getToken",
"path": "v2/exams/{examType}/token",
- "id": "partners.exams.getToken"
+ "description": "Gets an Exam Token for a Partner's user to take an exam in the Exams System"
}
}
}
@@ -1159,10 +1151,10 @@
"type": "string"
},
"prettyPrint": {
- "default": "true",
- "type": "boolean",
"location": "query",
- "description": "Returns response with indentations and line breaks."
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean"
},
"uploadType": {
"location": "query",
@@ -1170,17 +1162,16 @@
"type": "string"
},
"fields": {
- "type": "string",
"location": "query",
- "description": "Selector specifying which fields to include in a partial response."
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
},
"callback": {
- "type": "string",
"location": "query",
- "description": "JSONP"
+ "description": "JSONP",
+ "type": "string"
},
"$.xgafv": {
- "location": "query",
"enum": [
"1",
"2"
@@ -1190,10 +1181,10 @@
"enumDescriptions": [
"v1 error format",
"v2 error format"
- ]
+ ],
+ "location": "query"
},
"alt": {
- "default": "json",
"enum": [
"json",
"media",
@@ -1206,33 +1197,34 @@
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
- "description": "Data format for response."
+ "description": "Data format for response.",
+ "default": "json"
},
"access_token": {
+ "description": "OAuth access token.",
"type": "string",
- "location": "query",
- "description": "OAuth access token."
+ "location": "query"
},
"key": {
- "type": "string",
"location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string"
},
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
"pp": {
+ "description": "Pretty-print response.",
"default": "true",
"type": "boolean",
- "location": "query",
- "description": "Pretty-print response."
+ "location": "query"
},
"oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
"type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
+ "location": "query"
},
"bearer_token": {
"location": "query",
@@ -1241,505 +1233,18 @@
}
},
"schemas": {
- "Certification": {
- "description": "A user's information on a specific certification.",
- "type": "object",
- "properties": {
- "lastAchieved": {
- "format": "google-datetime",
- "description": "The date the user last achieved certification.",
- "type": "string"
- },
- "warning": {
- "type": "boolean",
- "description": "Whether this certification is in the state of warning."
- },
- "expiration": {
- "type": "string",
- "format": "google-datetime",
- "description": "Date this certification is due to expire."
- },
- "achieved": {
- "type": "boolean",
- "description": "Whether this certification has been achieved."
- },
- "certificationType": {
- "type": "string",
- "enumDescriptions": [
- "Unchosen.",
- "AdWords certified.",
- "YouTube certified.",
- "VideoAds certified.",
- "Analytics certified.",
- "DoubleClick certified.",
- "Shopping certified.",
- "Mobile certified.",
- "Digital sales certified.",
- "AdWords Search certified.",
- "AdWords Display certified.",
- "Mobile Sites certified."
- ],
- "enum": [
- "CERTIFICATION_TYPE_UNSPECIFIED",
- "CT_ADWORDS",
- "CT_YOUTUBE",
- "CT_VIDEOADS",
- "CT_ANALYTICS",
- "CT_DOUBLECLICK",
- "CT_SHOPPING",
- "CT_MOBILE",
- "CT_DIGITAL_SALES",
- "CT_ADWORDS_SEARCH",
- "CT_ADWORDS_DISPLAY",
- "CT_MOBILE_SITES"
- ],
- "description": "The type of certification, the area of expertise."
- }
- },
- "id": "Certification"
- },
- "User": {
- "type": "object",
- "properties": {
- "company": {
- "$ref": "CompanyRelation",
- "description": "The company that the user is associated with.\nIf not present, the user is not associated with any company."
- },
- "profile": {
- "$ref": "UserProfile",
- "description": "The profile information of a Partners user, contains all the directly\neditable user information."
- },
- "lastAccessTime": {
- "type": "string",
- "format": "google-datetime",
- "description": "The most recent time the user interacted with the Partners site.\n@OutputOnly"
- },
- "primaryEmails": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "The list of emails the user has access to/can select as primary.\n@OutputOnly"
- },
- "availableAdwordsManagerAccounts": {
- "description": "This is the list of AdWords Manager Accounts the user has edit access to.\nIf the user has edit access to multiple accounts, the user can choose the\npreferred account and we use this when a personal account is needed. Can\nbe empty meaning the user has access to no accounts.\n@OutputOnly",
- "items": {
- "$ref": "AdWordsManagerAccountInfo"
- },
- "type": "array"
- },
- "internalId": {
- "description": "The internal user ID.\nOnly available for a whitelisted set of api clients.",
- "type": "string"
- },
- "examStatus": {
- "description": "The list of exams the user ever taken. For each type of exam, only one\nentry is listed.",
- "items": {
- "$ref": "ExamStatus"
- },
- "type": "array"
- },
- "id": {
- "description": "The ID of the user.",
- "type": "string"
- },
- "publicProfile": {
- "$ref": "PublicProfile",
- "description": "Information about a user's external public profile outside Google Partners."
- },
- "companyVerificationEmail": {
- "type": "string",
- "description": "The email address used by the user used for company verification.\n@OutputOnly"
- },
- "certificationStatus": {
- "items": {
- "$ref": "Certification"
- },
- "type": "array",
- "description": "The list of achieved certifications. These are calculated based on exam\nresults and other requirements.\n@OutputOnly"
- }
- },
- "id": "User",
- "description": "A resource representing a user of the Partners platform."
- },
- "ListAnalyticsResponse": {
- "type": "object",
- "properties": {
- "analytics": {
- "description": "The list of analytics.\nSorted in ascending order of\nAnalytics.event_date.",
- "items": {
- "$ref": "Analytics"
- },
- "type": "array"
- },
- "nextPageToken": {
- "type": "string",
- "description": "A token to retrieve next page of results.\nPass this value in the `ListAnalyticsRequest.page_token` field in the\nsubsequent call to\nListAnalytics to retrieve the\nnext page of results."
- },
- "analyticsSummary": {
- "$ref": "AnalyticsSummary",
- "description": "Aggregated information across the response's\nanalytics."
- },
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
- }
- },
- "id": "ListAnalyticsResponse",
- "description": "Response message for\nListAnalytics."
- },
- "Company": {
- "type": "object",
- "properties": {
- "industries": {
- "items": {
- "type": "string",
- "enum": [
- "INDUSTRY_UNSPECIFIED",
- "I_AUTOMOTIVE",
- "I_BUSINESS_TO_BUSINESS",
- "I_CONSUMER_PACKAGED_GOODS",
- "I_EDUCATION",
- "I_FINANCE",
- "I_HEALTHCARE",
- "I_MEDIA_AND_ENTERTAINMENT",
- "I_RETAIL",
- "I_TECHNOLOGY",
- "I_TRAVEL"
- ]
- },
- "type": "array",
- "enumDescriptions": [
- "Unchosen.",
- "The automotive industry.",
- "The business-to-business industry.",
- "The consumer packaged goods industry.",
- "The education industry.",
- "The finance industry.",
- "The healthcare industry.",
- "The media and entertainment industry.",
- "The retail industry.",
- "The technology industry.",
- "The travel industry."
- ],
- "description": "Industries the company can help with."
- },
- "additionalWebsites": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "URL of the company's additional websites used to verify the dynamic badges.\nThese are stored as full URLs as entered by the user, but only the TLD will\nbe used for the actual verification."
- },
- "websiteUrl": {
- "type": "string",
- "description": "URL of the company's website."
- },
- "primaryAdwordsManagerAccountId": {
- "type": "string",
- "format": "int64",
- "description": "The Primary AdWords Manager Account id."
- },
- "name": {
- "type": "string",
- "description": "The name of the company."
- },
- "localizedInfos": {
- "items": {
- "$ref": "LocalizedCompanyInfo"
- },
- "type": "array",
- "description": "The list of localized info for the company."
- },
- "certificationStatuses": {
- "items": {
- "$ref": "CertificationStatus"
- },
- "type": "array",
- "description": "The list of Google Partners certification statuses for the company."
- },
- "id": {
- "description": "The ID of the company.",
- "type": "string"
- },
- "primaryLocation": {
- "$ref": "Location",
- "description": "The primary location of the company."
- },
- "services": {
- "items": {
- "enum": [
- "SERVICE_UNSPECIFIED",
- "S_ADVANCED_ADWORDS_SUPPORT",
- "S_ADVERTISING_ON_GOOGLE",
- "S_AN_ENHANCED_WEBSITE",
- "S_AN_ONLINE_MARKETING_PLAN",
- "S_MOBILE_AND_VIDEO_ADS",
- "S_MOBILE_WEBSITE_SERVICES"
- ],
- "type": "string"
- },
- "type": "array",
- "enumDescriptions": [
- "Unchosen.",
- "Help with advanced AdWords support.",
- "Help with advertising on Google.",
- "Help with an enhanced website.",
- "Help with an online marketing plan.",
- "Help with mobile and video ads.",
- "Help with mobile websites."
- ],
- "description": "Services the company can help with."
- },
- "originalMinMonthlyBudget": {
- "$ref": "Money",
- "description": "The unconverted minimum monthly budget that the company accepts for partner\nbusiness."
- },
- "publicProfile": {
- "$ref": "PublicProfile",
- "description": "Basic information from the company's public profile."
- },
- "ranks": {
- "description": "Information related to the ranking of the company within the list of\ncompanies.",
- "items": {
- "$ref": "Rank"
- },
- "type": "array"
- },
- "badgeTier": {
- "enum": [
- "BADGE_TIER_NONE",
- "BADGE_TIER_REGULAR",
- "BADGE_TIER_PREMIER"
- ],
- "description": "Partner badge tier",
- "type": "string",
- "enumDescriptions": [
- "Tier badge is not set.",
- "Agency has regular partner badge.",
- "Agency has premier badge."
- ]
- },
- "specializationStatus": {
- "description": "The list of Google Partners specialization statuses for the company.",
- "items": {
- "$ref": "SpecializationStatus"
- },
- "type": "array"
- },
- "companyTypes": {
- "items": {
- "type": "string",
- "enum": [
- "COMPANY_TYPE_UNSPECIFIED",
- "FULL_SERVICE_AGENCY",
- "MEDIA_AGENCY",
- "CREATIVE_AGENCY",
- "CDIGITAL_AGENCY",
- "SEM_SEO",
- "PERFORMANCE_MARKETING",
- "ADVERTISING_TOOL_DEVELOPMENT",
- "PR",
- "SELF_MANAGED",
- "RESELLER"
- ]
- },
- "type": "array",
- "enumDescriptions": [
- "Unchosen.",
- "Handles all aspects of the advertising process.",
- "Focuses solely on an advertiser's media placement.",
- "Plans/executes advertising campaigns.",
- "Like a\nFULL_SERVICE_AGENCY,\nbut specializing in digital.",
- "Increases visibility in search engine result pages.",
- "Drives promotional efforts for immediate impact.",
- "Focuses on bid management, conversion, reporting.",
- "Establishes favorable relationship with public through low/no-cost\ncommunications.",
- "Does not manage other company's accounts, manages own marketing programs.",
- "Full-service AdWords account management for local businesses."
- ],
- "description": "Company type labels listed on the company's profile."
- },
- "autoApprovalEmailDomains": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "Email domains that allow users with a matching email address to get\nauto-approved for associating with this company."
- },
- "primaryLanguageCode": {
- "type": "string",
- "description": "The primary language code of the company, as defined by\n\u003ca href=\"https://tools.ietf.org/html/bcp47\"\u003eBCP 47\u003c/a\u003e\n(IETF BCP 47, \"Tags for Identifying Languages\")."
- },
- "profileStatus": {
- "type": "string",
- "enumDescriptions": [
- "Unchosen.",
- "Company profile does not show up publicly.",
- "Company profile can only be viewed by the profile's URL\nand not by Google Partner Search.",
- "Company profile can be viewed by the profile's URL\nand by Google Partner Search."
- ],
- "enum": [
- "COMPANY_PROFILE_STATUS_UNSPECIFIED",
- "HIDDEN",
- "PUBLISHED",
- "SEARCHABLE"
- ],
- "description": "The public viewability status of the company's profile."
- },
- "locations": {
- "description": "The list of all company locations.\nIf set, must include the\nprimary_location\nin the list.",
- "items": {
- "$ref": "Location"
- },
- "type": "array"
- },
- "convertedMinMonthlyBudget": {
- "$ref": "Money",
- "description": "The minimum monthly budget that the company accepts for partner business,\nconverted to the requested currency code."
- }
- },
- "id": "Company",
- "description": "A company resource in the Google Partners API. Once certified, it qualifies\nfor being searched by advertisers."
- },
- "ListLeadsResponse": {
- "description": "Response message for ListLeads.",
- "type": "object",
- "properties": {
- "leads": {
- "description": "The list of leads.",
- "items": {
- "$ref": "Lead"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "A token to retrieve next page of results.\nPass this value in the `ListLeadsRequest.page_token` field in the\nsubsequent call to\nListLeads to retrieve the\nnext page of results.",
- "type": "string"
- },
- "totalSize": {
- "format": "int32",
- "description": "The total count of leads for the given company.",
- "type": "integer"
- },
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
- }
- },
- "id": "ListLeadsResponse"
- },
- "CreateLeadResponse": {
- "type": "object",
- "properties": {
- "recaptchaStatus": {
- "enum": [
- "RECAPTCHA_STATUS_UNSPECIFIED",
- "RS_NOT_NEEDED",
- "RS_PASSED",
- "RS_FAILED"
- ],
- "description": "The outcome of \u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e\nvalidation.",
- "type": "string",
- "enumDescriptions": [
- "Unchosen.",
- "No reCaptcha validation needed.",
- "reCaptcha challenge passed.",
- "reCaptcha challenge failed."
- ]
- },
- "lead": {
- "$ref": "Lead",
- "description": "Lead that was created depending on the outcome of\n\u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e validation."
- },
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
- }
- },
- "id": "CreateLeadResponse",
- "description": "Response message for CreateLead."
- },
- "GetCompanyResponse": {
- "description": "Response message for GetCompany.",
- "type": "object",
- "properties": {
- "company": {
- "$ref": "Company",
- "description": "The company."
- },
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
- }
- },
- "id": "GetCompanyResponse"
- },
- "Location": {
- "type": "object",
- "properties": {
- "administrativeArea": {
- "description": "Top-level administrative subdivision of this country.",
- "type": "string"
- },
- "locality": {
- "type": "string",
- "description": "Generally refers to the city/town portion of an address."
- },
- "latLng": {
- "$ref": "LatLng",
- "description": "The latitude and longitude of the location, in degrees."
- },
- "address": {
- "description": "The single string version of the address.",
- "type": "string"
- },
- "regionCode": {
- "type": "string",
- "description": "CLDR (Common Locale Data Repository) region code ."
- },
- "dependentLocality": {
- "description": "Dependent locality or sublocality. Used for UK dependent localities, or\nneighborhoods or boroughs in other locations.",
- "type": "string"
- },
- "postalCode": {
- "type": "string",
- "description": "Values are frequently alphanumeric."
- },
- "languageCode": {
- "description": "Language code of the address. Should be in BCP 47 format.",
- "type": "string"
- },
- "sortingCode": {
- "type": "string",
- "description": "Use of this code is very country-specific, but will refer to a secondary\nclassification code for sorting mail."
- },
- "addressLine": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "The following address lines represent the most specific part of any\naddress."
- }
- },
- "id": "Location",
- "description": "A location with address and geographic coordinates. May optionally contain a\ndetailed (multi-field) version of the address."
- },
"ExamToken": {
- "description": "A token that allows a user to take an exam.",
- "type": "object",
"properties": {
"examId": {
- "type": "string",
"format": "int64",
- "description": "The id of the exam the token is for."
+ "description": "The id of the exam the token is for.",
+ "type": "string"
},
"token": {
- "type": "string",
- "description": "The token, only present if the user has access to the exam."
+ "description": "The token, only present if the user has access to the exam.",
+ "type": "string"
},
"examType": {
- "type": "string",
"enumDescriptions": [
"Unchosen.",
"Adwords Fundamentals exam.",
@@ -1766,15 +1271,23 @@
"CET_DIGITAL_SALES",
"CET_MOBILE_SITES"
],
- "description": "The type of the exam the token belongs to."
+ "description": "The type of the exam the token belongs to.",
+ "type": "string"
}
},
- "id": "ExamToken"
+ "id": "ExamToken",
+ "description": "A token that allows a user to take an exam.",
+ "type": "object"
},
"CertificationExamStatus": {
"description": "Status for a Google Partners certification exam.",
"type": "object",
"properties": {
+ "numberUsersPass": {
+ "format": "int32",
+ "description": "The number of people who have passed the certification exam.",
+ "type": "integer"
+ },
"type": {
"enum": [
"CERTIFICATION_EXAM_TYPE_UNSPECIFIED",
@@ -1804,22 +1317,12 @@
"Digital Sales exam.",
"Mobile Sites exam."
]
- },
- "numberUsersPass": {
- "type": "integer",
- "format": "int32",
- "description": "The number of people who have passed the certification exam."
}
},
"id": "CertificationExamStatus"
},
"OptIns": {
- "type": "object",
"properties": {
- "specialOffers": {
- "description": "An opt-in about receiving email regarding new features and products.",
- "type": "boolean"
- },
"performanceSuggestions": {
"description": "An opt-in about receiving email with customized AdWords campaign management\ntips.",
"type": "boolean"
@@ -1835,15 +1338,23 @@
"marketComm": {
"description": "An opt-in about receiving email from Partners marketing teams. Includes\nmember-only events and special promotional offers for Google products.",
"type": "boolean"
+ },
+ "specialOffers": {
+ "description": "An opt-in about receiving email regarding new features and products.",
+ "type": "boolean"
}
},
"id": "OptIns",
- "description": "A set of opt-ins for a user."
+ "description": "A set of opt-ins for a user.",
+ "type": "object"
},
"Rank": {
- "description": "Information related to ranking of results.",
- "type": "object",
"properties": {
+ "value": {
+ "format": "double",
+ "description": "The numerical value of the rank.",
+ "type": "number"
+ },
"type": {
"enum": [
"RANK_TYPE_UNSPECIFIED",
@@ -1855,30 +1366,73 @@
"Unchosen.",
"Total final score."
]
- },
- "value": {
- "type": "number",
- "format": "double",
- "description": "The numerical value of the rank."
}
},
- "id": "Rank"
- },
- "GetPartnersStatusResponse": {
- "type": "object",
- "properties": {
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
- }
- },
- "id": "GetPartnersStatusResponse",
- "description": "Response message for\nGetPartnersStatus."
+ "id": "Rank",
+ "description": "Information related to ranking of results.",
+ "type": "object"
},
"UserProfile": {
"description": "The profile information of a Partners user.",
"type": "object",
"properties": {
+ "emailOptIns": {
+ "$ref": "OptIns",
+ "description": "The list of opt-ins for the user, related to communication preferences."
+ },
+ "familyName": {
+ "description": "The user's family name.",
+ "type": "string"
+ },
+ "languages": {
+ "description": "The list of languages this user understands.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "markets": {
+ "description": "A list of ids representing which markets the user was interested in.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "phoneNumber": {
+ "description": "The user's phone number.",
+ "type": "string"
+ },
+ "adwordsManagerAccount": {
+ "format": "int64",
+ "description": "If the user has edit access to multiple accounts, the user can choose the\npreferred account and it is used when a personal account is needed. Can\nbe empty.",
+ "type": "string"
+ },
+ "primaryCountryCode": {
+ "description": "The user's primary country, an ISO 2-character code.",
+ "type": "string"
+ },
+ "emailAddress": {
+ "description": "The email address the user has selected on the Partners site as primary.",
+ "type": "string"
+ },
+ "profilePublic": {
+ "description": "Whether the user's public profile is visible to anyone with the URL.",
+ "type": "boolean"
+ },
+ "channels": {
+ "description": "A list of ids representing which channels the user selected they were in.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "jobFunctions": {
+ "description": "A list of ids represnting which job categories the user selected.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
"givenName": {
"description": "The user's given name.",
"type": "string"
@@ -1893,130 +1447,23 @@
"type": "string"
},
"type": "array"
- },
- "languages": {
- "description": "The list of languages this user understands.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "familyName": {
- "type": "string",
- "description": "The user's family name."
- },
- "emailOptIns": {
- "$ref": "OptIns",
- "description": "The list of opt-ins for the user, related to communication preferences."
- },
- "markets": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "A list of ids representing which markets the user was interested in."
- },
- "phoneNumber": {
- "type": "string",
- "description": "The user's phone number."
- },
- "adwordsManagerAccount": {
- "format": "int64",
- "description": "If the user has edit access to multiple accounts, the user can choose the\npreferred account and it is used when a personal account is needed. Can\nbe empty.",
- "type": "string"
- },
- "primaryCountryCode": {
- "type": "string",
- "description": "The user's primary country, an ISO 2-character code."
- },
- "emailAddress": {
- "type": "string",
- "description": "The email address the user has selected on the Partners site as primary."
- },
- "channels": {
- "description": "A list of ids representing which channels the user selected they were in.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "profilePublic": {
- "type": "boolean",
- "description": "Whether the user's public profile is visible to anyone with the URL."
- },
- "jobFunctions": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "A list of ids represnting which job categories the user selected."
}
},
"id": "UserProfile"
},
- "HistoricalOffer": {
- "type": "object",
+ "GetPartnersStatusResponse": {
"properties": {
- "clientEmail": {
- "description": "Email address for client.",
- "type": "string"
- },
- "status": {
- "enum": [
- "OFFER_STATUS_UNSPECIFIED",
- "OFFER_STATUS_DISTRIBUTED",
- "OFFER_STATUS_REDEEMED",
- "OFFER_STATUS_AWARDED",
- "OFFER_STATUS_EXPIRED"
- ],
- "description": "Status of the offer.",
- "type": "string",
- "enumDescriptions": [
- "Unset.",
- "Offer distributed.",
- "Offer redeemed.",
- "Offer awarded.",
- "Offer expired."
- ]
- },
- "clientId": {
- "type": "string",
- "format": "int64",
- "description": "ID of client."
- },
- "clientName": {
- "description": "Name of the client.",
- "type": "string"
- },
- "lastModifiedTime": {
- "format": "google-datetime",
- "description": "Time last action was taken.",
- "type": "string"
- },
- "adwordsUrl": {
- "type": "string",
- "description": "Client's AdWords page URL."
- },
- "offerType": {
- "type": "string",
- "enumDescriptions": [
- "Unset.",
- "AdWords spend X get Y.",
- "Youtube video.",
- "Spend Match up to Y."
- ],
- "enum": [
- "OFFER_TYPE_UNSPECIFIED",
- "OFFER_TYPE_SPEND_X_GET_Y",
- "OFFER_TYPE_VIDEO",
- "OFFER_TYPE_SPEND_MATCH"
- ],
- "description": "Type of offer."
- },
- "senderName": {
- "description": "Name (First + Last) of the partners user to whom the incentive is allocated.",
- "type": "string"
- },
+ "responseMetadata": {
+ "description": "Current response metadata.",
+ "$ref": "ResponseMetadata"
+ }
+ },
+ "id": "GetPartnersStatusResponse",
+ "description": "Response message for\nGetPartnersStatus.",
+ "type": "object"
+ },
+ "HistoricalOffer": {
+ "properties": {
"offerCountryCode": {
"description": "Country Code for the offer country.",
"type": "string"
@@ -2031,63 +1478,92 @@
"type": "string"
},
"creationTime": {
- "type": "string",
"format": "google-datetime",
- "description": "Time offer was first created."
+ "description": "Time offer was first created.",
+ "type": "string"
+ },
+ "status": {
+ "enumDescriptions": [
+ "Unset.",
+ "Offer distributed.",
+ "Offer redeemed.",
+ "Offer awarded.",
+ "Offer expired."
+ ],
+ "enum": [
+ "OFFER_STATUS_UNSPECIFIED",
+ "OFFER_STATUS_DISTRIBUTED",
+ "OFFER_STATUS_REDEEMED",
+ "OFFER_STATUS_AWARDED",
+ "OFFER_STATUS_EXPIRED"
+ ],
+ "description": "Status of the offer.",
+ "type": "string"
+ },
+ "clientEmail": {
+ "description": "Email address for client.",
+ "type": "string"
+ },
+ "clientId": {
+ "format": "int64",
+ "description": "ID of client.",
+ "type": "string"
+ },
+ "clientName": {
+ "description": "Name of the client.",
+ "type": "string"
+ },
+ "lastModifiedTime": {
+ "format": "google-datetime",
+ "description": "Time last action was taken.",
+ "type": "string"
+ },
+ "adwordsUrl": {
+ "description": "Client's AdWords page URL.",
+ "type": "string"
+ },
+ "offerType": {
+ "enumDescriptions": [
+ "Unset.",
+ "AdWords spend X get Y.",
+ "Youtube video.",
+ "Spend Match up to Y."
+ ],
+ "enum": [
+ "OFFER_TYPE_UNSPECIFIED",
+ "OFFER_TYPE_SPEND_X_GET_Y",
+ "OFFER_TYPE_VIDEO",
+ "OFFER_TYPE_SPEND_MATCH"
+ ],
+ "description": "Type of offer.",
+ "type": "string"
+ },
+ "senderName": {
+ "description": "Name (First + Last) of the partners user to whom the incentive is allocated.",
+ "type": "string"
}
},
"id": "HistoricalOffer",
- "description": "Historical information about a Google Partners Offer."
+ "description": "Historical information about a Google Partners Offer.",
+ "type": "object"
},
"UserOverrides": {
"description": "Values to use instead of the user's respective defaults. These are only\nhonored by whitelisted products.",
"type": "object",
"properties": {
- "ipAddress": {
- "description": "IP address to use instead of the user's geo-located IP address.",
- "type": "string"
- },
"userId": {
"description": "Logged-in user ID to impersonate instead of the user's ID.",
"type": "string"
+ },
+ "ipAddress": {
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string"
}
},
"id": "UserOverrides"
},
"LogUserEventRequest": {
- "type": "object",
"properties": {
- "url": {
- "type": "string",
- "description": "The URL where the event occurred."
- },
- "requestMetadata": {
- "$ref": "RequestMetadata",
- "description": "Current request metadata."
- },
- "eventScope": {
- "type": "string",
- "enumDescriptions": [
- "Unchosen.",
- "Based on visitor.",
- "Based on session.",
- "Based on page visit."
- ],
- "enum": [
- "EVENT_SCOPE_UNSPECIFIED",
- "VISITOR",
- "SESSION",
- "PAGE"
- ],
- "description": "The scope of the event."
- },
- "eventDatas": {
- "items": {
- "$ref": "EventData"
- },
- "type": "array",
- "description": "List of event data for the event."
- },
"eventCategory": {
"enum": [
"EVENT_CATEGORY_UNSPECIFIED",
@@ -2133,166 +1609,6 @@
"description": "Advertiser lead information."
},
"eventAction": {
- "type": "string",
- "enumDescriptions": [
- "Unchosen.",
- "Advertiser clicked `Find a partner` bottom button.",
- "Advertiser clicked `Find a partner` top button.",
- "Agency clicked `Join now` bottom button.",
- "Agency clicked `Join now` top button.",
- "Advertiser canceled partner contact form.",
- "Advertiser started partner contact form.",
- "Advertiser completed partner contact form.",
- "Advertiser entered email in contact form.",
- "Advertiser entered name in contact form.",
- "Advertiser entered phone in contact form.",
- "Advertiser failed \u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e\nin contact form.",
- "Company viewed by advertiser.",
- "Advertiser canceled partner contact form on Google Partner Search.",
- "Advertiser changed a top search parameter.",
- "Advertiser started partner contact form on Google Partner Search.",
- "Advertiser clicked `Show more partners` bottom button.",
- "Advertiser completed partner contact form on Google Partner Search.",
- "Advertiser saw no partners available with search criteria.",
- "Advertiser performed search on Google Partner Search.",
- "Advertiser viewed a partner on Google Partner Search.",
- "Advertiser canceled partner contact form on profile page.",
- "Advertiser started partner contact form on profile page.",
- "Advertiser clicked partner website.",
- "Advertiser completed contact form on profile page.",
- "Advertiser viewed a partner profile.",
- "Agency clicked `accept Terms Of Service` button.",
- "Agency changed Terms Of Service country.",
- "Agency added address in profile portal.",
- "Agency added phone number in profile portal.",
- "Agency changed primary account association.",
- "Agency changed primary country association.",
- "Agency clicked `affiliate` button in profile portal.",
- "Agency clicked `give edit access` in profile portal.",
- "Agency clicked `log out` in profile portal.",
- "Agency clicked profile portal left nav.",
- "Agency clicked `save and continue` at bottom of complete profile.",
- "Agency clicked `unaffiliate` in profile portal.",
- "Agency filled out company affiliation in profile portal.",
- "Agency successfully connected with company in profile portal.",
- "Agency clicked create MCC in profile portal.",
- "Agency did not have an MCC associated on profile portal.",
- "Agency had an MCC associated on profile portal.",
- "Agency added job function in profile portal.",
- "Agency looked at job function drop-down.",
- "Agency selected `account manage` as job function.",
- "Agency selected `account planner` as job function.",
- "Agency selected `Analytics` as job function.",
- "Agency selected `creative` as job function.",
- "Agency selected `media buyer` as job function.",
- "Agency selected `media planner` as job function.",
- "Agency selected `other` as job function.",
- "Agency selected `production` as job function.",
- "Agency selected `SEO` as job function.",
- "Agency selected `sales rep` as job function.",
- "Agency selected `search specialist` as job function.",
- "Agency added channels in profile portal.",
- "Agency looked at `add channel` drop-down.",
- "Agency selected `cross channel` from add channel drop-down.",
- "Agency selected `display` from add channel drop-down.",
- "Agency selected `mobile` from add channel drop-down.",
- "Agency selected `search` from add channel drop-down.",
- "Agency selected `social` from add channel drop-down.",
- "Agency selected `tools` from add channel drop-down.",
- "Agency selected `YouTube` from add channel drop-down.",
- "Agency added industries in profile portal.",
- "Agency changed `add industries` drop-down.",
- "Agency added markets in profile portal.",
- "Agency changed `add markets` drop-down.",
- "Agency checked `recieve mail promotions` in profile portal.",
- "Agency checked `recieve mail promotions` in sign-up.",
- "Agency selected `opt-in beta tests and market research`.",
- "Agency selected `opt-in beta tests` in profile portal.",
- "Agency selected `opt-in news` in profile portal.",
- "Agency selected `opt-in news invitations and promotions`.",
- "Agency selected `opt-in performance SUG` in profile portal.",
- "Agency selected `opt-in performance suggestions`.",
- "Agency selected `opt-in select all email notifications`.",
- "Agency selected `select all opt-ins` in profile portal.",
- "Agency clicked back button on `connect with company`.",
- "Agency clicked continue to overview on `connect with company`.",
- "Agency clicked `create MCC connect with company not found`.",
- "Agency clicked `give edit access connect with company not found`.",
- "Agency clicked `log out connect with company not found`.",
- "Agency clicked `skip for now on connect with company page`.",
- "Agency closed connection to company.",
- "Agency completed field connect with company.",
- "Agency found company to connect with.",
- "Agency successfully created company.",
- "Agency added new company location.",
- "Agency clicked community `join now link` in portal notifications.",
- "Agency clicked `connect to company` link in portal notifications.",
- "Agency cliecked `get certified` link in portal notifications.",
- "Agency clicked `get VideoAds certified` link in portal notifications.",
- "Agency clicked `link to MCC` link in portal notifications.",
- "Agency clicked `insight content` in portal.",
- "Agency clicked `insights view now pitch decks` in portal.",
- "Agency clicked `insights` left nav in portal.",
- "Agency clicked `insights upload content`.",
- "Agency clicked `insights viewed deprecated`.",
- "Agency clicked `community` left nav in portal.",
- "Agency clicked `join community` button in community portal.",
- "Agency clicked `certifications` left nav in portal.",
- "Agency clicked `certifications product` left nav in portal.",
- "Agency clicked `partner status` left nav in portal.",
- "Agency clicked `partner status product` left nav in portal.",
- "Agency clicked `offers` left nav in portal.",
- "Agency clicked `send` button on offers page.",
- "Agency clicked `exam details` on certifications AdWords page.",
- "Agency clicked `see exams` certifications main page.",
- "Agency clicked `take exam` on certifications exam page.",
- "Agency opened `last admin` dialog.",
- "Agency opened dialog with no users.",
- "Agency promoted user to admin.",
- "Agency unaffiliated.",
- "Agency changed roles.",
- "Advertiser clicked `company name` link to profile.",
- "Advertiser viewed AdWords certificate.",
- "Advertiser viewed AdWords Search certificate.",
- "Advertiser viewed AdWords Display certificate.",
- "Advertiser clicked AdWords certificate help icon.",
- "Advertiser viewed Analytics certificate.",
- "Advertiser viewed DoubleClick certificate.",
- "Advertiser viewed Mobile Sites certificate.",
- "Advertiser viewed VideoAds certificate.",
- "Advertiser clicked Shopping certificate help icon.",
- "Advertiser clicked VideoAds certificate help icon.",
- "Advertiser viewed Digital Sales certificate.",
- "Clicked `help` at bottom.",
- "Clicked `help` at top.",
- "Client error occurred.",
- "Agency clicked left nav `stories`.",
- "Click occured.",
- "Advertiser clicked Mobile certificate help icon.",
- "Agency failed the company verification.",
- "User visited the landing portion of Google Partners.",
- "User visited the Google Partner Search portion of Google Partners.",
- "User visited the agency portal portion of Google Partners.",
- "User cancelled signing up.",
- "User cancelled signing up their company.",
- "Agency clicked `Sign in` top button.",
- "Agency clicked `save and continue` at bottom of incomplete profile.",
- "Agency unselected `opt-in news invitations and promotions`.",
- "Agency unselected `opt-in beta tests and market research`.",
- "Agency unselected `opt-in performance suggestions`.",
- "Agency selected `opt-out unselect all email notifications`.",
- "Agency linked their individual MCC.",
- "Agency was suggested to user for affiliation.",
- "Agency ignored suggested agencies and begin searching.",
- "Agency picked a suggested agency.",
- "Agency searched for agencies.",
- "Agency picked a searched agency.",
- "Agency dismissed affiliation widget.",
- "Agency clicked on the download link for downloading content.",
- "Agency user is maklingg progress viewing a content item.",
- "Agency clicked `cancel Terms Of Service` button.",
- "Advertiser entered website in contact form."
- ],
"enum": [
"EVENT_ACTION_UNSPECIFIED",
"SMB_CLICKED_FIND_A_PARTNER_BUTTON_BOTTOM",
@@ -2452,27 +1768,219 @@
"AGENCY_CLICKED_CANCEL_ACCEPT_TOS_BUTTON",
"SMB_ENTERED_WEBSITE_IN_CONTACT_PARTNER_FORM"
],
- "description": "The action that occurred."
+ "description": "The action that occurred.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unchosen.",
+ "Advertiser clicked `Find a partner` bottom button.",
+ "Advertiser clicked `Find a partner` top button.",
+ "Agency clicked `Join now` bottom button.",
+ "Agency clicked `Join now` top button.",
+ "Advertiser canceled partner contact form.",
+ "Advertiser started partner contact form.",
+ "Advertiser completed partner contact form.",
+ "Advertiser entered email in contact form.",
+ "Advertiser entered name in contact form.",
+ "Advertiser entered phone in contact form.",
+ "Advertiser failed \u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e\nin contact form.",
+ "Company viewed by advertiser.",
+ "Advertiser canceled partner contact form on Google Partner Search.",
+ "Advertiser changed a top search parameter.",
+ "Advertiser started partner contact form on Google Partner Search.",
+ "Advertiser clicked `Show more partners` bottom button.",
+ "Advertiser completed partner contact form on Google Partner Search.",
+ "Advertiser saw no partners available with search criteria.",
+ "Advertiser performed search on Google Partner Search.",
+ "Advertiser viewed a partner on Google Partner Search.",
+ "Advertiser canceled partner contact form on profile page.",
+ "Advertiser started partner contact form on profile page.",
+ "Advertiser clicked partner website.",
+ "Advertiser completed contact form on profile page.",
+ "Advertiser viewed a partner profile.",
+ "Agency clicked `accept Terms Of Service` button.",
+ "Agency changed Terms Of Service country.",
+ "Agency added address in profile portal.",
+ "Agency added phone number in profile portal.",
+ "Agency changed primary account association.",
+ "Agency changed primary country association.",
+ "Agency clicked `affiliate` button in profile portal.",
+ "Agency clicked `give edit access` in profile portal.",
+ "Agency clicked `log out` in profile portal.",
+ "Agency clicked profile portal left nav.",
+ "Agency clicked `save and continue` at bottom of complete profile.",
+ "Agency clicked `unaffiliate` in profile portal.",
+ "Agency filled out company affiliation in profile portal.",
+ "Agency successfully connected with company in profile portal.",
+ "Agency clicked create MCC in profile portal.",
+ "Agency did not have an MCC associated on profile portal.",
+ "Agency had an MCC associated on profile portal.",
+ "Agency added job function in profile portal.",
+ "Agency looked at job function drop-down.",
+ "Agency selected `account manage` as job function.",
+ "Agency selected `account planner` as job function.",
+ "Agency selected `Analytics` as job function.",
+ "Agency selected `creative` as job function.",
+ "Agency selected `media buyer` as job function.",
+ "Agency selected `media planner` as job function.",
+ "Agency selected `other` as job function.",
+ "Agency selected `production` as job function.",
+ "Agency selected `SEO` as job function.",
+ "Agency selected `sales rep` as job function.",
+ "Agency selected `search specialist` as job function.",
+ "Agency added channels in profile portal.",
+ "Agency looked at `add channel` drop-down.",
+ "Agency selected `cross channel` from add channel drop-down.",
+ "Agency selected `display` from add channel drop-down.",
+ "Agency selected `mobile` from add channel drop-down.",
+ "Agency selected `search` from add channel drop-down.",
+ "Agency selected `social` from add channel drop-down.",
+ "Agency selected `tools` from add channel drop-down.",
+ "Agency selected `YouTube` from add channel drop-down.",
+ "Agency added industries in profile portal.",
+ "Agency changed `add industries` drop-down.",
+ "Agency added markets in profile portal.",
+ "Agency changed `add markets` drop-down.",
+ "Agency checked `recieve mail promotions` in profile portal.",
+ "Agency checked `recieve mail promotions` in sign-up.",
+ "Agency selected `opt-in beta tests and market research`.",
+ "Agency selected `opt-in beta tests` in profile portal.",
+ "Agency selected `opt-in news` in profile portal.",
+ "Agency selected `opt-in news invitations and promotions`.",
+ "Agency selected `opt-in performance SUG` in profile portal.",
+ "Agency selected `opt-in performance suggestions`.",
+ "Agency selected `opt-in select all email notifications`.",
+ "Agency selected `select all opt-ins` in profile portal.",
+ "Agency clicked back button on `connect with company`.",
+ "Agency clicked continue to overview on `connect with company`.",
+ "Agency clicked `create MCC connect with company not found`.",
+ "Agency clicked `give edit access connect with company not found`.",
+ "Agency clicked `log out connect with company not found`.",
+ "Agency clicked `skip for now on connect with company page`.",
+ "Agency closed connection to company.",
+ "Agency completed field connect with company.",
+ "Agency found company to connect with.",
+ "Agency successfully created company.",
+ "Agency added new company location.",
+ "Agency clicked community `join now link` in portal notifications.",
+ "Agency clicked `connect to company` link in portal notifications.",
+ "Agency cliecked `get certified` link in portal notifications.",
+ "Agency clicked `get VideoAds certified` link in portal notifications.",
+ "Agency clicked `link to MCC` link in portal notifications.",
+ "Agency clicked `insight content` in portal.",
+ "Agency clicked `insights view now pitch decks` in portal.",
+ "Agency clicked `insights` left nav in portal.",
+ "Agency clicked `insights upload content`.",
+ "Agency clicked `insights viewed deprecated`.",
+ "Agency clicked `community` left nav in portal.",
+ "Agency clicked `join community` button in community portal.",
+ "Agency clicked `certifications` left nav in portal.",
+ "Agency clicked `certifications product` left nav in portal.",
+ "Agency clicked `partner status` left nav in portal.",
+ "Agency clicked `partner status product` left nav in portal.",
+ "Agency clicked `offers` left nav in portal.",
+ "Agency clicked `send` button on offers page.",
+ "Agency clicked `exam details` on certifications AdWords page.",
+ "Agency clicked `see exams` certifications main page.",
+ "Agency clicked `take exam` on certifications exam page.",
+ "Agency opened `last admin` dialog.",
+ "Agency opened dialog with no users.",
+ "Agency promoted user to admin.",
+ "Agency unaffiliated.",
+ "Agency changed roles.",
+ "Advertiser clicked `company name` link to profile.",
+ "Advertiser viewed AdWords certificate.",
+ "Advertiser viewed AdWords Search certificate.",
+ "Advertiser viewed AdWords Display certificate.",
+ "Advertiser clicked AdWords certificate help icon.",
+ "Advertiser viewed Analytics certificate.",
+ "Advertiser viewed DoubleClick certificate.",
+ "Advertiser viewed Mobile Sites certificate.",
+ "Advertiser viewed VideoAds certificate.",
+ "Advertiser clicked Shopping certificate help icon.",
+ "Advertiser clicked VideoAds certificate help icon.",
+ "Advertiser viewed Digital Sales certificate.",
+ "Clicked `help` at bottom.",
+ "Clicked `help` at top.",
+ "Client error occurred.",
+ "Agency clicked left nav `stories`.",
+ "Click occured.",
+ "Advertiser clicked Mobile certificate help icon.",
+ "Agency failed the company verification.",
+ "User visited the landing portion of Google Partners.",
+ "User visited the Google Partner Search portion of Google Partners.",
+ "User visited the agency portal portion of Google Partners.",
+ "User cancelled signing up.",
+ "User cancelled signing up their company.",
+ "Agency clicked `Sign in` top button.",
+ "Agency clicked `save and continue` at bottom of incomplete profile.",
+ "Agency unselected `opt-in news invitations and promotions`.",
+ "Agency unselected `opt-in beta tests and market research`.",
+ "Agency unselected `opt-in performance suggestions`.",
+ "Agency selected `opt-out unselect all email notifications`.",
+ "Agency linked their individual MCC.",
+ "Agency was suggested to user for affiliation.",
+ "Agency ignored suggested agencies and begin searching.",
+ "Agency picked a suggested agency.",
+ "Agency searched for agencies.",
+ "Agency picked a searched agency.",
+ "Agency dismissed affiliation widget.",
+ "Agency clicked on the download link for downloading content.",
+ "Agency user is maklingg progress viewing a content item.",
+ "Agency clicked `cancel Terms Of Service` button.",
+ "Advertiser entered website in contact form."
+ ]
+ },
+ "url": {
+ "description": "The URL where the event occurred.",
+ "type": "string"
+ },
+ "requestMetadata": {
+ "$ref": "RequestMetadata",
+ "description": "Current request metadata."
+ },
+ "eventDatas": {
+ "description": "List of event data for the event.",
+ "items": {
+ "$ref": "EventData"
+ },
+ "type": "array"
+ },
+ "eventScope": {
+ "enum": [
+ "EVENT_SCOPE_UNSPECIFIED",
+ "VISITOR",
+ "SESSION",
+ "PAGE"
+ ],
+ "description": "The scope of the event.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unchosen.",
+ "Based on visitor.",
+ "Based on session.",
+ "Based on page visit."
+ ]
}
},
"id": "LogUserEventRequest",
- "description": "Request message for\nLogUserEvent."
+ "description": "Request message for\nLogUserEvent.",
+ "type": "object"
},
"AnalyticsDataPoint": {
"description": "Details of the analytics events for a `Company` within a single day.",
"type": "object",
"properties": {
- "eventCount": {
- "format": "int32",
- "description": "Number of times the type of event occurred.\nMeaning depends on context (e.g. profile views, contacts, etc.).",
- "type": "integer"
- },
"eventLocations": {
"description": "Location information of where these events occurred.",
"items": {
"$ref": "LatLng"
},
"type": "array"
+ },
+ "eventCount": {
+ "format": "int32",
+ "description": "Number of times the type of event occurred.\nMeaning depends on context (e.g. profile views, contacts, etc.).",
+ "type": "integer"
}
},
"id": "AnalyticsDataPoint"
@@ -2490,8 +1998,8 @@
"description": "Instances of users viewing the `Company` profile\non the specified date."
},
"eventDate": {
- "$ref": "Date",
- "description": "Date on which these events occurred."
+ "description": "Date on which these events occurred.",
+ "$ref": "Date"
},
"contacts": {
"$ref": "AnalyticsDataPoint",
@@ -2501,8 +2009,21 @@
"id": "Analytics"
},
"PublicProfile": {
+ "description": "Basic information from a public profile.",
"type": "object",
"properties": {
+ "profileImage": {
+ "description": "The URL to the main profile image of the public profile.",
+ "type": "string"
+ },
+ "displayImageUrl": {
+ "description": "The URL to the main display image of the public profile. Being deprecated.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "The display name of the public profile.",
+ "type": "string"
+ },
"url": {
"description": "The URL of the public profile.",
"type": "string"
@@ -2510,91 +2031,54 @@
"id": {
"description": "The ID which can be used to retrieve more details about the public profile.",
"type": "string"
- },
- "profileImage": {
- "type": "string",
- "description": "The URL to the main profile image of the public profile."
- },
- "displayImageUrl": {
- "description": "The URL to the main display image of the public profile. Being deprecated.",
- "type": "string"
- },
- "displayName": {
- "type": "string",
- "description": "The display name of the public profile."
}
},
- "id": "PublicProfile",
- "description": "Basic information from a public profile."
+ "id": "PublicProfile"
},
"AdWordsManagerAccountInfo": {
- "type": "object",
"properties": {
- "customerName": {
- "description": "Name of the customer this account represents.",
- "type": "string"
- },
"id": {
"format": "int64",
"description": "The AdWords Manager Account id.",
"type": "string"
+ },
+ "customerName": {
+ "description": "Name of the customer this account represents.",
+ "type": "string"
}
},
"id": "AdWordsManagerAccountInfo",
- "description": "Information about a particular AdWords Manager Account.\nRead more at https://support.google.com/adwords/answer/6139186"
+ "description": "Information about a particular AdWords Manager Account.\nRead more at https://support.google.com/adwords/answer/6139186",
+ "type": "object"
},
"ResponseMetadata": {
- "description": "Common data that is in each API response.",
- "type": "object",
"properties": {
"debugInfo": {
"$ref": "DebugInfo",
"description": "Debug information about this request."
}
},
- "id": "ResponseMetadata"
+ "id": "ResponseMetadata",
+ "description": "Common data that is in each API response.",
+ "type": "object"
},
"RecaptchaChallenge": {
+ "description": "\u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e challenge info.",
"type": "object",
"properties": {
+ "response": {
+ "description": "The response to the reCaptcha challenge.",
+ "type": "string"
+ },
"id": {
"description": "The ID of the reCaptcha challenge.",
"type": "string"
- },
- "response": {
- "type": "string",
- "description": "The response to the reCaptcha challenge."
}
},
- "id": "RecaptchaChallenge",
- "description": "\u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e challenge info."
+ "id": "RecaptchaChallenge"
},
"AvailableOffer": {
- "type": "object",
"properties": {
- "countryOfferInfos": {
- "items": {
- "$ref": "CountryOfferInfo"
- },
- "type": "array",
- "description": "Offer info by country."
- },
- "offerType": {
- "enum": [
- "OFFER_TYPE_UNSPECIFIED",
- "OFFER_TYPE_SPEND_X_GET_Y",
- "OFFER_TYPE_VIDEO",
- "OFFER_TYPE_SPEND_MATCH"
- ],
- "description": "Type of offer.",
- "type": "string",
- "enumDescriptions": [
- "Unset.",
- "AdWords spend X get Y.",
- "Youtube video.",
- "Spend Match up to Y."
- ]
- },
"maxAccountAge": {
"format": "int32",
"description": "The maximum age of an account [in days] to be eligible.",
@@ -2608,24 +2092,23 @@
"type": "array"
},
"terms": {
- "type": "string",
- "description": "Terms of the offer."
+ "description": "Terms of the offer.",
+ "type": "string"
},
"showSpecialOfferCopy": {
- "type": "boolean",
- "description": "Should special text be shown on the offers page."
+ "description": "Should special text be shown on the offers page.",
+ "type": "boolean"
},
"available": {
- "type": "integer",
"format": "int32",
- "description": "The number of codes for this offer that are available for distribution."
+ "description": "The number of codes for this offer that are available for distribution.",
+ "type": "integer"
},
"description": {
- "type": "string",
- "description": "Description of the offer."
+ "description": "Description of the offer.",
+ "type": "string"
},
"offerLevel": {
- "type": "string",
"enumDescriptions": [
"Unset.",
"Users/Agencies that have no offers because of a problem.",
@@ -2646,28 +2129,51 @@
"OFFER_LEVEL_LIMIT_15",
"OFFER_LEVEL_LIMIT_50"
],
- "description": "Level of this offer."
+ "description": "Level of this offer.",
+ "type": "string"
},
"name": {
"description": "Name of the offer.",
"type": "string"
},
+ "qualifiedCustomersComplete": {
+ "description": "Whether or not the list of qualified customers is definitely complete.",
+ "type": "boolean"
+ },
"id": {
"format": "int64",
"description": "ID of this offer.",
"type": "string"
},
- "qualifiedCustomersComplete": {
- "description": "Whether or not the list of qualified customers is definitely complete.",
- "type": "boolean"
+ "countryOfferInfos": {
+ "description": "Offer info by country.",
+ "items": {
+ "$ref": "CountryOfferInfo"
+ },
+ "type": "array"
+ },
+ "offerType": {
+ "enumDescriptions": [
+ "Unset.",
+ "AdWords spend X get Y.",
+ "Youtube video.",
+ "Spend Match up to Y."
+ ],
+ "enum": [
+ "OFFER_TYPE_UNSPECIFIED",
+ "OFFER_TYPE_SPEND_X_GET_Y",
+ "OFFER_TYPE_VIDEO",
+ "OFFER_TYPE_SPEND_MATCH"
+ ],
+ "description": "Type of offer.",
+ "type": "string"
}
},
"id": "AvailableOffer",
- "description": "Available Offers to be distributed."
+ "description": "Available Offers to be distributed.",
+ "type": "object"
},
"LatLng": {
- "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.\n\nExample of normalization code in Python:\n\n def NormalizeLongitude(longitude):\n \"\"\"Wraps decimal degrees longitude to [-180.0, 180.0].\"\"\"\n q, r = divmod(longitude, 360.0)\n if r \u003e 180.0 or (r == 180.0 and q \u003c= -1.0):\n return r - 360.0\n return r\n\n def NormalizeLatLng(latitude, longitude):\n \"\"\"Wraps decimal degrees latitude and longitude to\n [-90.0, 90.0] and [-180.0, 180.0], respectively.\"\"\"\n r = latitude % 360.0\n if r \u003c= 90.0:\n return r, NormalizeLongitude(longitude)\n elif r \u003e= 270.0:\n return r - 360, NormalizeLongitude(longitude)\n else:\n return 180 - r, NormalizeLongitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLongitude(181.0)\n assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)\n assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)\n assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)\n assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)\n assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)\n assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)\n assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)\n assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)",
- "type": "object",
"properties": {
"latitude": {
"format": "double",
@@ -2675,61 +2181,79 @@
"type": "number"
},
"longitude": {
- "type": "number",
"format": "double",
- "description": "The longitude in degrees. It must be in the range [-180.0, +180.0]."
+ "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
+ "type": "number"
}
},
- "id": "LatLng"
+ "id": "LatLng",
+ "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.\n\nExample of normalization code in Python:\n\n def NormalizeLongitude(longitude):\n \"\"\"Wraps decimal degrees longitude to [-180.0, 180.0].\"\"\"\n q, r = divmod(longitude, 360.0)\n if r \u003e 180.0 or (r == 180.0 and q \u003c= -1.0):\n return r - 360.0\n return r\n\n def NormalizeLatLng(latitude, longitude):\n \"\"\"Wraps decimal degrees latitude and longitude to\n [-90.0, 90.0] and [-180.0, 180.0], respectively.\"\"\"\n r = latitude % 360.0\n if r \u003c= 90.0:\n return r, NormalizeLongitude(longitude)\n elif r \u003e= 270.0:\n return r - 360, NormalizeLongitude(longitude)\n else:\n return 180 - r, NormalizeLongitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLongitude(181.0)\n assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)\n assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)\n assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)\n assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)\n assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)\n assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)\n assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)\n assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)",
+ "type": "object"
},
"Money": {
- "type": "object",
"properties": {
+ "units": {
+ "format": "int64",
+ "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
+ "type": "string"
+ },
"currencyCode": {
- "type": "string",
- "description": "The 3-letter currency code defined in ISO 4217."
+ "description": "The 3-letter currency code defined in ISO 4217.",
+ "type": "string"
},
"nanos": {
- "type": "integer",
"format": "int32",
- "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000."
- },
- "units": {
- "type": "string",
- "format": "int64",
- "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar."
+ "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
+ "type": "integer"
}
},
"id": "Money",
- "description": "Represents an amount of money with its currency type."
+ "description": "Represents an amount of money with its currency type.",
+ "type": "object"
},
"AnalyticsSummary": {
- "description": "Analytics aggregated data for a `Company` for a given date range.",
- "type": "object",
"properties": {
"profileViewsCount": {
- "type": "integer",
"format": "int32",
- "description": "Aggregated number of profile views for the `Company` for given date range."
+ "description": "Aggregated number of profile views for the `Company` for given date range.",
+ "type": "integer"
},
"searchViewsCount": {
- "type": "integer",
"format": "int32",
- "description": "Aggregated number of times users saw the `Company`\nin Google Partners Search results for given date range."
+ "description": "Aggregated number of times users saw the `Company`\nin Google Partners Search results for given date range.",
+ "type": "integer"
},
"contactsCount": {
- "type": "integer",
"format": "int32",
- "description": "Aggregated number of times users contacted the `Company`\nfor given date range."
+ "description": "Aggregated number of times users contacted the `Company`\nfor given date range.",
+ "type": "integer"
}
},
- "id": "AnalyticsSummary"
+ "id": "AnalyticsSummary",
+ "description": "Analytics aggregated data for a `Company` for a given date range.",
+ "type": "object"
},
"LogMessageRequest": {
- "description": "Request message for\nLogClientMessage.",
- "type": "object",
"properties": {
+ "clientInfo": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Map of client info, such as URL, browser navigator, browser platform, etc.",
+ "type": "object"
+ },
+ "requestMetadata": {
+ "description": "Current request metadata.",
+ "$ref": "RequestMetadata"
+ },
"level": {
+ "enumDescriptions": [
+ "Unchosen.",
+ "Message level for tracing information.",
+ "Message level for informational messages.",
+ "Message level for potential problems.",
+ "Message level for serious failures."
+ ],
"enum": [
"MESSAGE_LEVEL_UNSPECIFIED",
"ML_FINE",
@@ -2738,53 +2262,61 @@
"ML_SEVERE"
],
"description": "Message level of client message.",
- "type": "string",
- "enumDescriptions": [
- "Unchosen.",
- "Message level for tracing information.",
- "Message level for informational messages.",
- "Message level for potential problems.",
- "Message level for serious failures."
- ]
+ "type": "string"
},
"details": {
"description": "Details about the client message.",
"type": "string"
- },
- "clientInfo": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "description": "Map of client info, such as URL, browser navigator, browser platform, etc."
- },
- "requestMetadata": {
- "$ref": "RequestMetadata",
- "description": "Current request metadata."
}
},
- "id": "LogMessageRequest"
+ "id": "LogMessageRequest",
+ "description": "Request message for\nLogClientMessage.",
+ "type": "object"
},
"Lead": {
- "type": "object",
"properties": {
- "minMonthlyBudget": {
- "$ref": "Money",
- "description": "The minimum monthly budget lead source is willing to spend."
- },
"givenName": {
- "type": "string",
- "description": "First name of lead source."
+ "description": "First name of lead source.",
+ "type": "string"
},
- "languageCode": {
- "type": "string",
- "description": "Language code of the lead's language preference, as defined by\n\u003ca href=\"https://tools.ietf.org/html/bcp47\"\u003eBCP 47\u003c/a\u003e\n(IETF BCP 47, \"Tags for Identifying Languages\")."
+ "minMonthlyBudget": {
+ "description": "The minimum monthly budget lead source is willing to spend.",
+ "$ref": "Money"
},
"websiteUrl": {
"description": "Website URL of lead source.",
"type": "string"
},
+ "languageCode": {
+ "description": "Language code of the lead's language preference, as defined by\n\u003ca href=\"https://tools.ietf.org/html/bcp47\"\u003eBCP 47\u003c/a\u003e\n(IETF BCP 47, \"Tags for Identifying Languages\").",
+ "type": "string"
+ },
+ "state": {
+ "enumDescriptions": [
+ "Unchosen.",
+ "Lead not yet contacted.",
+ "Lead has been contacted.",
+ "Lead has become a client.",
+ "Lead in a state not covered by other options."
+ ],
+ "enum": [
+ "LEAD_STATE_UNSPECIFIED",
+ "LEAD",
+ "CONTACTED",
+ "CLIENT",
+ "OTHER"
+ ],
+ "description": "The lead's state in relation to the company.",
+ "type": "string"
+ },
"gpsMotivations": {
+ "enumDescriptions": [
+ "Unchosen.",
+ "Advertiser needs help with their advertising.",
+ "Advertiser needs help with their website.",
+ "Advertiser does not have a website."
+ ],
+ "description": "List of reasons for using Google Partner Search and creating a lead.",
"items": {
"enum": [
"GPS_MOTIVATION_UNSPECIFIED",
@@ -2794,69 +2326,43 @@
],
"type": "string"
},
- "type": "array",
- "enumDescriptions": [
- "Unchosen.",
- "Advertiser needs help with their advertising.",
- "Advertiser needs help with their website.",
- "Advertiser does not have a website."
- ],
- "description": "List of reasons for using Google Partner Search and creating a lead."
- },
- "state": {
- "enum": [
- "LEAD_STATE_UNSPECIFIED",
- "LEAD",
- "CONTACTED",
- "CLIENT",
- "OTHER"
- ],
- "description": "The lead's state in relation to the company.",
- "type": "string",
- "enumDescriptions": [
- "Unchosen.",
- "Lead not yet contacted.",
- "Lead has been contacted.",
- "Lead has become a client.",
- "Lead in a state not covered by other options."
- ]
+ "type": "array"
},
"email": {
- "type": "string",
- "description": "Email address of lead source."
+ "description": "Email address of lead source.",
+ "type": "string"
},
"familyName": {
- "type": "string",
- "description": "Last name of lead source."
+ "description": "Last name of lead source.",
+ "type": "string"
},
"id": {
"description": "ID of the lead.",
"type": "string"
},
"comments": {
- "type": "string",
- "description": "Comments lead source gave."
+ "description": "Comments lead source gave.",
+ "type": "string"
},
"adwordsCustomerId": {
- "type": "string",
"format": "int64",
- "description": "The AdWords Customer ID of the lead."
+ "description": "The AdWords Customer ID of the lead.",
+ "type": "string"
},
"phoneNumber": {
- "type": "string",
- "description": "Phone number of lead source."
+ "description": "Phone number of lead source.",
+ "type": "string"
},
"createTime": {
- "type": "string",
"format": "google-datetime",
- "description": "Timestamp of when this lead was created."
+ "description": "Timestamp of when this lead was created.",
+ "type": "string"
},
"marketingOptIn": {
"description": "Whether or not the lead signed up for marketing emails",
"type": "boolean"
},
"type": {
- "type": "string",
"enumDescriptions": [
"Unchosen.",
"Google Partner Search."
@@ -2865,39 +2371,39 @@
"LEAD_TYPE_UNSPECIFIED",
"LT_GPS"
],
- "description": "Type of lead."
+ "description": "Type of lead.",
+ "type": "string"
}
},
"id": "Lead",
- "description": "A lead resource that represents an advertiser contact for a `Company`. These\nare usually generated via Google Partner Search (the advertiser portal)."
+ "description": "A lead resource that represents an advertiser contact for a `Company`. These\nare usually generated via Google Partner Search (the advertiser portal).",
+ "type": "object"
},
"DebugInfo": {
- "description": "Debug information about this request.",
- "type": "object",
"properties": {
"serverTraceInfo": {
"description": "Server-side debug stack trace.",
"type": "string"
},
"serverInfo": {
- "type": "string",
- "description": "Info about the server that serviced this request."
+ "description": "Info about the server that serviced this request.",
+ "type": "string"
},
"serviceUrl": {
- "type": "string",
- "description": "URL of the service that handled this request."
+ "description": "URL of the service that handled this request.",
+ "type": "string"
}
},
- "id": "DebugInfo"
+ "id": "DebugInfo",
+ "description": "Debug information about this request.",
+ "type": "object"
},
"ListUserStatesResponse": {
+ "description": "Response message for\nListUserStates.",
"type": "object",
"properties": {
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
- },
"userStates": {
+ "description": "User's states.",
"items": {
"enum": [
"USER_STATE_UNSPECIFIED",
@@ -2909,48 +2415,55 @@
"enumDescriptions": [
"Unchosen.",
"User must pass \u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e to\ncontact a Partner via Google Partner Search."
- ],
- "description": "User's states."
+ ]
+ },
+ "responseMetadata": {
+ "description": "Current response metadata.",
+ "$ref": "ResponseMetadata"
}
},
- "id": "ListUserStatesResponse",
- "description": "Response message for\nListUserStates."
+ "id": "ListUserStatesResponse"
},
"CompanyRelation": {
+ "description": "A CompanyRelation resource representing information about a user's\naffiliation and standing with a company in Partners.",
"type": "object",
"properties": {
+ "internalCompanyId": {
+ "description": "The internal company ID.\nOnly available for a whitelisted set of api clients.",
+ "type": "string"
+ },
"specializationStatus": {
+ "description": "The list of Google Partners specialization statuses for the company.",
"items": {
"$ref": "SpecializationStatus"
},
- "type": "array",
- "description": "The list of Google Partners specialization statuses for the company."
+ "type": "array"
},
"badgeTier": {
+ "enumDescriptions": [
+ "Tier badge is not set.",
+ "Agency has regular partner badge.",
+ "Agency has premier badge."
+ ],
"enum": [
"BADGE_TIER_NONE",
"BADGE_TIER_REGULAR",
"BADGE_TIER_PREMIER"
],
"description": "Whether the company is a Partner.",
- "type": "string",
- "enumDescriptions": [
- "Tier badge is not set.",
- "Agency has regular partner badge.",
- "Agency has premier badge."
- ]
+ "type": "string"
},
"website": {
"description": "The website URL for this company.",
"type": "string"
},
"phoneNumber": {
- "type": "string",
- "description": "The phone number for the company's primary address."
+ "description": "The phone number for the company's primary address.",
+ "type": "string"
},
"primaryCountryCode": {
- "type": "string",
- "description": "The primary country code of the company."
+ "description": "The primary country code of the company.",
+ "type": "string"
},
"companyId": {
"description": "The ID of the company. There may be no id if this is a\npending company.5",
@@ -2961,8 +2474,8 @@
"type": "string"
},
"logoUrl": {
- "type": "string",
- "description": "A URL to a profile photo, e.g. a G+ profile photo."
+ "description": "A URL to a profile photo, e.g. a G+ profile photo.",
+ "type": "string"
},
"resolvedTimestamp": {
"format": "google-datetime",
@@ -2970,21 +2483,21 @@
"type": "string"
},
"companyAdmin": {
- "type": "boolean",
- "description": "Indicates if the user is an admin for this company."
- },
- "isPending": {
- "type": "boolean",
- "description": "The flag that indicates if the company is pending verification."
+ "description": "Indicates if the user is an admin for this company.",
+ "type": "boolean"
},
"address": {
- "type": "string",
- "description": "The primary address for this company."
+ "description": "The primary address for this company.",
+ "type": "string"
+ },
+ "isPending": {
+ "description": "The flag that indicates if the company is pending verification.",
+ "type": "boolean"
},
"creationTime": {
- "type": "string",
"format": "google-datetime",
- "description": "The timestamp of when affiliation was requested.\n@OutputOnly"
+ "description": "The timestamp of when affiliation was requested.\n@OutputOnly",
+ "type": "string"
},
"state": {
"enum": [
@@ -3007,143 +2520,132 @@
"description": "The primary location of the company."
},
"managerAccount": {
- "type": "string",
"format": "int64",
- "description": "The AdWords manager account # associated this company."
+ "description": "The AdWords manager account # associated this company.",
+ "type": "string"
},
"name": {
- "type": "string",
- "description": "The name (in the company's primary language) for the company."
+ "description": "The name (in the company's primary language) for the company.",
+ "type": "string"
},
"segment": {
- "items": {
- "type": "string",
- "enum": [
- "COMPANY_SEGMENT_UNKNOWN",
- "COMPANY_SEGMENT_NAL",
- "COMPANY_SEGMENT_PSP",
- "COMPANY_SEGMENT_PPSP"
- ]
- },
- "type": "array",
"enumDescriptions": [
"Default segment indicates an unknown.",
"Segment representing a selected group of Partners",
"Segment representing Premier SMB Partners, an AdWords partnership program.",
"A segment of Premier SMB Partners that have relationship with Google."
],
- "description": "The segment the company is classified as."
- },
- "internalCompanyId": {
- "type": "string",
- "description": "The internal company ID.\nOnly available for a whitelisted set of api clients."
+ "description": "The segment the company is classified as.",
+ "items": {
+ "enum": [
+ "COMPANY_SEGMENT_UNKNOWN",
+ "COMPANY_SEGMENT_NAL",
+ "COMPANY_SEGMENT_PSP",
+ "COMPANY_SEGMENT_PPSP"
+ ],
+ "type": "string"
+ },
+ "type": "array"
}
},
- "id": "CompanyRelation",
- "description": "A CompanyRelation resource representing information about a user's\naffiliation and standing with a company in Partners."
+ "id": "CompanyRelation"
},
"Date": {
- "type": "object",
"properties": {
- "month": {
- "type": "integer",
- "format": "int32",
- "description": "Month of year. Must be from 1 to 12."
- },
"day": {
"format": "int32",
"description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.",
"type": "integer"
},
"year": {
- "type": "integer",
"format": "int32",
- "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year."
+ "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
+ "type": "integer"
+ },
+ "month": {
+ "format": "int32",
+ "description": "Month of year. Must be from 1 to 12.",
+ "type": "integer"
}
},
"id": "Date",
- "description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`."
+ "description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
+ "type": "object"
},
"Empty": {
- "type": "object",
"properties": {},
"id": "Empty",
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`."
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object"
},
"TrafficSource": {
+ "description": "Source of traffic for the current request.",
"type": "object",
"properties": {
+ "trafficSourceId": {
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string"
+ },
"trafficSubId": {
"description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
"type": "string"
- },
- "trafficSourceId": {
- "type": "string",
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us."
}
},
- "id": "TrafficSource",
- "description": "Source of traffic for the current request."
- },
- "CreateLeadRequest": {
- "description": "Request message for CreateLead.",
- "type": "object",
- "properties": {
- "recaptchaChallenge": {
- "$ref": "RecaptchaChallenge",
- "description": "\u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e challenge info."
- },
- "lead": {
- "$ref": "Lead",
- "description": "The lead resource. The `LeadType` must not be `LEAD_TYPE_UNSPECIFIED`\nand either `email` or `phone_number` must be provided."
- },
- "requestMetadata": {
- "$ref": "RequestMetadata",
- "description": "Current request metadata."
- }
- },
- "id": "CreateLeadRequest"
+ "id": "TrafficSource"
},
"RequestMetadata": {
- "type": "object",
"properties": {
- "locale": {
- "description": "Locale to use for the current request.",
- "type": "string"
- },
- "partnersSessionId": {
- "type": "string",
- "description": "Google Partners session ID."
- },
- "userOverrides": {
- "$ref": "UserOverrides",
- "description": "Values to use instead of the user's respective defaults for the current\nrequest. These are only honored by whitelisted products."
- },
"trafficSource": {
"$ref": "TrafficSource",
"description": "Source of traffic for the current request."
},
"experimentIds": {
+ "description": "Experiment IDs the current request belongs to.",
"items": {
"type": "string"
},
- "type": "array",
- "description": "Experiment IDs the current request belongs to."
+ "type": "array"
+ },
+ "locale": {
+ "description": "Locale to use for the current request.",
+ "type": "string"
+ },
+ "partnersSessionId": {
+ "description": "Google Partners session ID.",
+ "type": "string"
+ },
+ "userOverrides": {
+ "$ref": "UserOverrides",
+ "description": "Values to use instead of the user's respective defaults for the current\nrequest. These are only honored by whitelisted products."
}
},
"id": "RequestMetadata",
- "description": "Common data that is in each API request."
+ "description": "Common data that is in each API request.",
+ "type": "object"
+ },
+ "CreateLeadRequest": {
+ "properties": {
+ "requestMetadata": {
+ "$ref": "RequestMetadata",
+ "description": "Current request metadata."
+ },
+ "recaptchaChallenge": {
+ "description": "\u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e challenge info.",
+ "$ref": "RecaptchaChallenge"
+ },
+ "lead": {
+ "$ref": "Lead",
+ "description": "The lead resource. The `LeadType` must not be `LEAD_TYPE_UNSPECIFIED`\nand either `email` or `phone_number` must be provided."
+ }
+ },
+ "id": "CreateLeadRequest",
+ "description": "Request message for CreateLead.",
+ "type": "object"
},
"EventData": {
+ "description": "Key value data pair for an event.",
"type": "object",
"properties": {
- "values": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "Data values."
- },
"key": {
"enum": [
"EVENT_DATA_TYPE_UNSPECIFIED",
@@ -3227,35 +2729,22 @@
"Element we wanted user to focus on.",
"Progress when viewing an item \\[0-100\\]."
]
+ },
+ "values": {
+ "description": "Data values.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
},
- "id": "EventData",
- "description": "Key value data pair for an event."
+ "id": "EventData"
},
"ExamStatus": {
"description": "A user's information on a specific exam.",
"type": "object",
"properties": {
- "lastPassed": {
- "type": "string",
- "format": "google-datetime",
- "description": "The date the user last passed this exam."
- },
"examType": {
- "type": "string",
- "enumDescriptions": [
- "Unchosen.",
- "Adwords Fundamentals exam.",
- "AdWords advanced search exam.",
- "AdWords advanced display exam.",
- "VideoAds exam.",
- "DoubleClick exam.",
- "Analytics exam.",
- "Shopping exam.",
- "Mobile exam.",
- "Digital Sales exam.",
- "Mobile Sites exam."
- ],
"enum": [
"CERTIFICATION_EXAM_TYPE_UNSPECIFIED",
"CET_ADWORDS_FUNDAMENTALS",
@@ -3269,25 +2758,44 @@
"CET_DIGITAL_SALES",
"CET_MOBILE_SITES"
],
- "description": "The type of the exam."
+ "description": "The type of the exam.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unchosen.",
+ "Adwords Fundamentals exam.",
+ "AdWords advanced search exam.",
+ "AdWords advanced display exam.",
+ "VideoAds exam.",
+ "DoubleClick exam.",
+ "Analytics exam.",
+ "Shopping exam.",
+ "Mobile exam.",
+ "Digital Sales exam.",
+ "Mobile Sites exam."
+ ]
},
"passed": {
- "type": "boolean",
- "description": "Whether this exam has been passed and not expired."
+ "description": "Whether this exam has been passed and not expired.",
+ "type": "boolean"
},
"taken": {
- "type": "string",
"format": "google-datetime",
- "description": "The date the user last taken this exam."
+ "description": "The date the user last taken this exam.",
+ "type": "string"
},
"warning": {
"description": "Whether this exam is in the state of warning.",
"type": "boolean"
},
"expiration": {
- "type": "string",
"format": "google-datetime",
- "description": "Date this exam is due to expire."
+ "description": "Date this exam is due to expire.",
+ "type": "string"
+ },
+ "lastPassed": {
+ "format": "google-datetime",
+ "description": "The date the user last passed this exam.",
+ "type": "string"
}
},
"id": "ExamStatus"
@@ -3296,11 +2804,24 @@
"description": "Response for ListOffer.",
"type": "object",
"properties": {
+ "availableOffers": {
+ "description": "Available Offers to be distributed.",
+ "items": {
+ "$ref": "AvailableOffer"
+ },
+ "type": "array"
+ },
"responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
+ "description": "Current response metadata.",
+ "$ref": "ResponseMetadata"
},
"noOfferReason": {
+ "enumDescriptions": [
+ "Unset.",
+ "Not an MCC.",
+ "Offer limit has been reached.",
+ "Ineligible for offers."
+ ],
"enum": [
"NO_OFFER_REASON_UNSPECIFIED",
"NO_OFFER_REASON_NO_MCC",
@@ -3308,20 +2829,7 @@
"NO_OFFER_REASON_INELIGIBLE"
],
"description": "Reason why no Offers are available.",
- "type": "string",
- "enumDescriptions": [
- "Unset.",
- "Not an MCC.",
- "Offer limit has been reached.",
- "Ineligible for offers."
- ]
- },
- "availableOffers": {
- "items": {
- "$ref": "AvailableOffer"
- },
- "type": "array",
- "description": "Available Offers to be distributed."
+ "type": "string"
}
},
"id": "ListOffersResponse"
@@ -3330,33 +2838,33 @@
"description": "Offer info by country.",
"type": "object",
"properties": {
- "getYAmount": {
- "type": "string",
- "description": "(localized) Get Y amount for that country's offer."
- },
"spendXAmount": {
- "type": "string",
- "description": "(localized) Spend X amount for that country's offer."
+ "description": "(localized) Spend X amount for that country's offer.",
+ "type": "string"
},
"offerCountryCode": {
"description": "Country code for which offer codes may be requested.",
"type": "string"
},
"offerType": {
- "type": "string",
- "enumDescriptions": [
- "Unset.",
- "AdWords spend X get Y.",
- "Youtube video.",
- "Spend Match up to Y."
- ],
"enum": [
"OFFER_TYPE_UNSPECIFIED",
"OFFER_TYPE_SPEND_X_GET_Y",
"OFFER_TYPE_VIDEO",
"OFFER_TYPE_SPEND_MATCH"
],
- "description": "Type of offer country is eligible for."
+ "description": "Type of offer country is eligible for.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unset.",
+ "AdWords spend X get Y.",
+ "Youtube video.",
+ "Spend Match up to Y."
+ ]
+ },
+ "getYAmount": {
+ "description": "(localized) Get Y amount for that country's offer.",
+ "type": "string"
}
},
"id": "CountryOfferInfo"
@@ -3384,25 +2892,17 @@
"id": "ListCompaniesResponse"
},
"OfferCustomer": {
+ "description": "Customers qualified for an offer.",
"type": "object",
"properties": {
- "adwordsUrl": {
- "description": "URL to the customer's AdWords page.",
- "type": "string"
- },
"countryCode": {
"description": "Country code of the customer.",
"type": "string"
},
- "externalCid": {
- "type": "string",
- "format": "int64",
- "description": "External CID for the customer."
- },
"eligibilityDaysLeft": {
- "type": "integer",
"format": "int32",
- "description": "Days the customer is still eligible."
+ "description": "Days the customer is still eligible.",
+ "type": "integer"
},
"creationTime": {
"format": "google-datetime",
@@ -3410,20 +2910,25 @@
"type": "string"
},
"offerType": {
- "type": "string",
- "enumDescriptions": [
- "Unset.",
- "AdWords spend X get Y.",
- "Youtube video.",
- "Spend Match up to Y."
- ],
"enum": [
"OFFER_TYPE_UNSPECIFIED",
"OFFER_TYPE_SPEND_X_GET_Y",
"OFFER_TYPE_VIDEO",
"OFFER_TYPE_SPEND_MATCH"
],
- "description": "Type of the offer"
+ "description": "Type of the offer",
+ "type": "string",
+ "enumDescriptions": [
+ "Unset.",
+ "AdWords spend X get Y.",
+ "Youtube video.",
+ "Spend Match up to Y."
+ ]
+ },
+ "externalCid": {
+ "format": "int64",
+ "description": "External CID for the customer.",
+ "type": "string"
},
"getYAmount": {
"description": "Formatted Get Y amount with currency code.",
@@ -3434,12 +2939,15 @@
"type": "string"
},
"spendXAmount": {
- "type": "string",
- "description": "Formatted Spend X amount with currency code."
+ "description": "Formatted Spend X amount with currency code.",
+ "type": "string"
+ },
+ "adwordsUrl": {
+ "description": "URL to the customer's AdWords page.",
+ "type": "string"
}
},
- "id": "OfferCustomer",
- "description": "Customers qualified for an offer."
+ "id": "OfferCustomer"
},
"CertificationStatus": {
"description": "Google Partners certification status.",
@@ -3490,14 +2998,13 @@
"type": "integer"
},
"isCertified": {
- "type": "boolean",
- "description": "Whether certification is passing."
+ "description": "Whether certification is passing.",
+ "type": "boolean"
}
},
"id": "CertificationStatus"
},
"LocalizedCompanyInfo": {
- "type": "object",
"properties": {
"languageCode": {
"description": "Language code of the localized company info, as defined by\n\u003ca href=\"https://tools.ietf.org/html/bcp47\"\u003eBCP 47\u003c/a\u003e\n(IETF BCP 47, \"Tags for Identifying Languages\").",
@@ -3511,8 +3018,8 @@
"type": "array"
},
"overview": {
- "type": "string",
- "description": "Localized brief description that the company uses to advertise themselves."
+ "description": "Localized brief description that the company uses to advertise themselves.",
+ "type": "string"
},
"displayName": {
"description": "Localized display name.",
@@ -3520,23 +3027,37 @@
}
},
"id": "LocalizedCompanyInfo",
- "description": "The localized company information."
+ "description": "The localized company information.",
+ "type": "object"
},
"LogUserEventResponse": {
+ "description": "Response message for\nLogUserEvent.",
"type": "object",
"properties": {
"responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
+ "description": "Current response metadata.",
+ "$ref": "ResponseMetadata"
}
},
- "id": "LogUserEventResponse",
- "description": "Response message for\nLogUserEvent."
+ "id": "LogUserEventResponse"
},
"ListOffersHistoryResponse": {
- "description": "Response for ListOfferHistory.",
- "type": "object",
"properties": {
+ "offers": {
+ "description": "Historical offers meeting request.",
+ "items": {
+ "$ref": "HistoricalOffer"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Supply this token in a ListOffersHistoryRequest to retrieve the next page.",
+ "type": "string"
+ },
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
+ },
"canShowEntireCompany": {
"description": "True if the user has the option to show entire company history.",
"type": "boolean"
@@ -3549,49 +3070,26 @@
"showingEntireCompany": {
"description": "True if this response is showing entire company history.",
"type": "boolean"
- },
- "offers": {
- "items": {
- "$ref": "HistoricalOffer"
- },
- "type": "array",
- "description": "Historical offers meeting request."
- },
- "nextPageToken": {
- "description": "Supply this token in a ListOffersHistoryRequest to retrieve the next page.",
- "type": "string"
- },
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
}
},
- "id": "ListOffersHistoryResponse"
+ "id": "ListOffersHistoryResponse",
+ "description": "Response for ListOfferHistory.",
+ "type": "object"
},
"LogMessageResponse": {
"description": "Response message for\nLogClientMessage.",
"type": "object",
"properties": {
"responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
+ "description": "Current response metadata.",
+ "$ref": "ResponseMetadata"
}
},
"id": "LogMessageResponse"
},
"SpecializationStatus": {
- "type": "object",
"properties": {
"badgeSpecialization": {
- "type": "string",
- "enumDescriptions": [
- "Unknown specialization",
- "AdWords Search specialization",
- "AdWords Display specialization",
- "AdWords Mobile specialization",
- "AdWords Video specialization",
- "AdWords Shopping specialization"
- ],
"enum": [
"BADGE_SPECIALIZATION_UNKNOWN",
"BADGE_SPECIALIZATION_ADWORDS_SEARCH",
@@ -3600,39 +3098,541 @@
"BADGE_SPECIALIZATION_ADWORDS_VIDEO",
"BADGE_SPECIALIZATION_ADWORDS_SHOPPING"
],
- "description": "The specialization this status is for."
- },
- "badgeSpecializationState": {
+ "description": "The specialization this status is for.",
"type": "string",
"enumDescriptions": [
- "Unknown state",
- "Specialization passed",
- "Specialization not passed",
- "Specialization in grace"
- ],
+ "Unknown specialization",
+ "AdWords Search specialization",
+ "AdWords Display specialization",
+ "AdWords Mobile specialization",
+ "AdWords Video specialization",
+ "AdWords Shopping specialization"
+ ]
+ },
+ "badgeSpecializationState": {
"enum": [
"BADGE_SPECIALIZATION_STATE_UNKNOWN",
"BADGE_SPECIALIZATION_STATE_PASSED",
"BADGE_SPECIALIZATION_STATE_NOT_PASSED",
"BADGE_SPECIALIZATION_STATE_IN_GRACE"
],
- "description": "State of agency specialization."
+ "description": "State of agency specialization.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown state",
+ "Specialization passed",
+ "Specialization not passed",
+ "Specialization in grace"
+ ]
}
},
"id": "SpecializationStatus",
- "description": "Agency specialization status"
+ "description": "Agency specialization status",
+ "type": "object"
+ },
+ "Certification": {
+ "properties": {
+ "warning": {
+ "description": "Whether this certification is in the state of warning.",
+ "type": "boolean"
+ },
+ "expiration": {
+ "format": "google-datetime",
+ "description": "Date this certification is due to expire.",
+ "type": "string"
+ },
+ "achieved": {
+ "description": "Whether this certification has been achieved.",
+ "type": "boolean"
+ },
+ "certificationType": {
+ "enum": [
+ "CERTIFICATION_TYPE_UNSPECIFIED",
+ "CT_ADWORDS",
+ "CT_YOUTUBE",
+ "CT_VIDEOADS",
+ "CT_ANALYTICS",
+ "CT_DOUBLECLICK",
+ "CT_SHOPPING",
+ "CT_MOBILE",
+ "CT_DIGITAL_SALES",
+ "CT_ADWORDS_SEARCH",
+ "CT_ADWORDS_DISPLAY",
+ "CT_MOBILE_SITES"
+ ],
+ "description": "The type of certification, the area of expertise.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unchosen.",
+ "AdWords certified.",
+ "YouTube certified.",
+ "VideoAds certified.",
+ "Analytics certified.",
+ "DoubleClick certified.",
+ "Shopping certified.",
+ "Mobile certified.",
+ "Digital sales certified.",
+ "AdWords Search certified.",
+ "AdWords Display certified.",
+ "Mobile Sites certified."
+ ]
+ },
+ "lastAchieved": {
+ "format": "google-datetime",
+ "description": "The date the user last achieved certification.",
+ "type": "string"
+ }
+ },
+ "id": "Certification",
+ "description": "A user's information on a specific certification.",
+ "type": "object"
+ },
+ "User": {
+ "properties": {
+ "company": {
+ "description": "The company that the user is associated with.\nIf not present, the user is not associated with any company.",
+ "$ref": "CompanyRelation"
+ },
+ "profile": {
+ "$ref": "UserProfile",
+ "description": "The profile information of a Partners user, contains all the directly\neditable user information."
+ },
+ "lastAccessTime": {
+ "format": "google-datetime",
+ "description": "The most recent time the user interacted with the Partners site.\n@OutputOnly",
+ "type": "string"
+ },
+ "availableAdwordsManagerAccounts": {
+ "description": "This is the list of AdWords Manager Accounts the user has edit access to.\nIf the user has edit access to multiple accounts, the user can choose the\npreferred account and we use this when a personal account is needed. Can\nbe empty meaning the user has access to no accounts.\n@OutputOnly",
+ "items": {
+ "$ref": "AdWordsManagerAccountInfo"
+ },
+ "type": "array"
+ },
+ "primaryEmails": {
+ "description": "The list of emails the user has access to/can select as primary.\n@OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "internalId": {
+ "description": "The internal user ID.\nOnly available for a whitelisted set of api clients.",
+ "type": "string"
+ },
+ "examStatus": {
+ "description": "The list of exams the user ever taken. For each type of exam, only one\nentry is listed.",
+ "items": {
+ "$ref": "ExamStatus"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "The ID of the user.",
+ "type": "string"
+ },
+ "publicProfile": {
+ "$ref": "PublicProfile",
+ "description": "Information about a user's external public profile outside Google Partners."
+ },
+ "certificationStatus": {
+ "description": "The list of achieved certifications. These are calculated based on exam\nresults and other requirements.\n@OutputOnly",
+ "items": {
+ "$ref": "Certification"
+ },
+ "type": "array"
+ },
+ "companyVerificationEmail": {
+ "description": "The email address used by the user used for company verification.\n@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "User",
+ "description": "A resource representing a user of the Partners platform.",
+ "type": "object"
+ },
+ "ListAnalyticsResponse": {
+ "properties": {
+ "analytics": {
+ "description": "The list of analytics.\nSorted in ascending order of\nAnalytics.event_date.",
+ "items": {
+ "$ref": "Analytics"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve next page of results.\nPass this value in the `ListAnalyticsRequest.page_token` field in the\nsubsequent call to\nListAnalytics to retrieve the\nnext page of results.",
+ "type": "string"
+ },
+ "analyticsSummary": {
+ "description": "Aggregated information across the response's\nanalytics.",
+ "$ref": "AnalyticsSummary"
+ },
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
+ }
+ },
+ "id": "ListAnalyticsResponse",
+ "description": "Response message for\nListAnalytics.",
+ "type": "object"
+ },
+ "ListLeadsResponse": {
+ "description": "Response message for ListLeads.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "A token to retrieve next page of results.\nPass this value in the `ListLeadsRequest.page_token` field in the\nsubsequent call to\nListLeads to retrieve the\nnext page of results.",
+ "type": "string"
+ },
+ "totalSize": {
+ "format": "int32",
+ "description": "The total count of leads for the given company.",
+ "type": "integer"
+ },
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
+ },
+ "leads": {
+ "description": "The list of leads.",
+ "items": {
+ "$ref": "Lead"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListLeadsResponse"
+ },
+ "Company": {
+ "description": "A company resource in the Google Partners API. Once certified, it qualifies\nfor being searched by advertisers.",
+ "type": "object",
+ "properties": {
+ "convertedMinMonthlyBudget": {
+ "$ref": "Money",
+ "description": "The minimum monthly budget that the company accepts for partner business,\nconverted to the requested currency code."
+ },
+ "industries": {
+ "description": "Industries the company can help with.",
+ "items": {
+ "enum": [
+ "INDUSTRY_UNSPECIFIED",
+ "I_AUTOMOTIVE",
+ "I_BUSINESS_TO_BUSINESS",
+ "I_CONSUMER_PACKAGED_GOODS",
+ "I_EDUCATION",
+ "I_FINANCE",
+ "I_HEALTHCARE",
+ "I_MEDIA_AND_ENTERTAINMENT",
+ "I_RETAIL",
+ "I_TECHNOLOGY",
+ "I_TRAVEL"
+ ],
+ "type": "string"
+ },
+ "type": "array",
+ "enumDescriptions": [
+ "Unchosen.",
+ "The automotive industry.",
+ "The business-to-business industry.",
+ "The consumer packaged goods industry.",
+ "The education industry.",
+ "The finance industry.",
+ "The healthcare industry.",
+ "The media and entertainment industry.",
+ "The retail industry.",
+ "The technology industry.",
+ "The travel industry."
+ ]
+ },
+ "additionalWebsites": {
+ "description": "URL of the company's additional websites used to verify the dynamic badges.\nThese are stored as full URLs as entered by the user, but only the TLD will\nbe used for the actual verification.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "websiteUrl": {
+ "description": "URL of the company's website.",
+ "type": "string"
+ },
+ "primaryAdwordsManagerAccountId": {
+ "format": "int64",
+ "description": "The Primary AdWords Manager Account id.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the company.",
+ "type": "string"
+ },
+ "localizedInfos": {
+ "description": "The list of localized info for the company.",
+ "items": {
+ "$ref": "LocalizedCompanyInfo"
+ },
+ "type": "array"
+ },
+ "certificationStatuses": {
+ "description": "The list of Google Partners certification statuses for the company.",
+ "items": {
+ "$ref": "CertificationStatus"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "The ID of the company.",
+ "type": "string"
+ },
+ "services": {
+ "description": "Services the company can help with.",
+ "items": {
+ "enum": [
+ "SERVICE_UNSPECIFIED",
+ "S_ADVANCED_ADWORDS_SUPPORT",
+ "S_ADVERTISING_ON_GOOGLE",
+ "S_AN_ENHANCED_WEBSITE",
+ "S_AN_ONLINE_MARKETING_PLAN",
+ "S_MOBILE_AND_VIDEO_ADS",
+ "S_MOBILE_WEBSITE_SERVICES"
+ ],
+ "type": "string"
+ },
+ "type": "array",
+ "enumDescriptions": [
+ "Unchosen.",
+ "Help with advanced AdWords support.",
+ "Help with advertising on Google.",
+ "Help with an enhanced website.",
+ "Help with an online marketing plan.",
+ "Help with mobile and video ads.",
+ "Help with mobile websites."
+ ]
+ },
+ "primaryLocation": {
+ "description": "The primary location of the company.",
+ "$ref": "Location"
+ },
+ "publicProfile": {
+ "description": "Basic information from the company's public profile.",
+ "$ref": "PublicProfile"
+ },
+ "originalMinMonthlyBudget": {
+ "description": "The unconverted minimum monthly budget that the company accepts for partner\nbusiness.",
+ "$ref": "Money"
+ },
+ "ranks": {
+ "description": "Information related to the ranking of the company within the list of\ncompanies.",
+ "items": {
+ "$ref": "Rank"
+ },
+ "type": "array"
+ },
+ "badgeTier": {
+ "enumDescriptions": [
+ "Tier badge is not set.",
+ "Agency has regular partner badge.",
+ "Agency has premier badge."
+ ],
+ "enum": [
+ "BADGE_TIER_NONE",
+ "BADGE_TIER_REGULAR",
+ "BADGE_TIER_PREMIER"
+ ],
+ "description": "Partner badge tier",
+ "type": "string"
+ },
+ "specializationStatus": {
+ "description": "The list of Google Partners specialization statuses for the company.",
+ "items": {
+ "$ref": "SpecializationStatus"
+ },
+ "type": "array"
+ },
+ "companyTypes": {
+ "description": "Company type labels listed on the company's profile.",
+ "items": {
+ "enum": [
+ "COMPANY_TYPE_UNSPECIFIED",
+ "FULL_SERVICE_AGENCY",
+ "MEDIA_AGENCY",
+ "CREATIVE_AGENCY",
+ "CDIGITAL_AGENCY",
+ "SEM_SEO",
+ "PERFORMANCE_MARKETING",
+ "ADVERTISING_TOOL_DEVELOPMENT",
+ "PR",
+ "SELF_MANAGED",
+ "RESELLER"
+ ],
+ "type": "string"
+ },
+ "type": "array",
+ "enumDescriptions": [
+ "Unchosen.",
+ "Handles all aspects of the advertising process.",
+ "Focuses solely on an advertiser's media placement.",
+ "Plans/executes advertising campaigns.",
+ "Like a\nFULL_SERVICE_AGENCY,\nbut specializing in digital.",
+ "Increases visibility in search engine result pages.",
+ "Drives promotional efforts for immediate impact.",
+ "Focuses on bid management, conversion, reporting.",
+ "Establishes favorable relationship with public through low/no-cost\ncommunications.",
+ "Does not manage other company's accounts, manages own marketing programs.",
+ "Full-service AdWords account management for local businesses."
+ ]
+ },
+ "autoApprovalEmailDomains": {
+ "description": "Email domains that allow users with a matching email address to get\nauto-approved for associating with this company.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "profileStatus": {
+ "enum": [
+ "COMPANY_PROFILE_STATUS_UNSPECIFIED",
+ "HIDDEN",
+ "PUBLISHED",
+ "SEARCHABLE"
+ ],
+ "description": "The public viewability status of the company's profile.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unchosen.",
+ "Company profile does not show up publicly.",
+ "Company profile can only be viewed by the profile's URL\nand not by Google Partner Search.",
+ "Company profile can be viewed by the profile's URL\nand by Google Partner Search."
+ ]
+ },
+ "primaryLanguageCode": {
+ "description": "The primary language code of the company, as defined by\n\u003ca href=\"https://tools.ietf.org/html/bcp47\"\u003eBCP 47\u003c/a\u003e\n(IETF BCP 47, \"Tags for Identifying Languages\").",
+ "type": "string"
+ },
+ "locations": {
+ "description": "The list of all company locations.\nIf set, must include the\nprimary_location\nin the list.",
+ "items": {
+ "$ref": "Location"
+ },
+ "type": "array"
+ }
+ },
+ "id": "Company"
+ },
+ "CreateLeadResponse": {
+ "properties": {
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
+ },
+ "recaptchaStatus": {
+ "enumDescriptions": [
+ "Unchosen.",
+ "No reCaptcha validation needed.",
+ "reCaptcha challenge passed.",
+ "reCaptcha challenge failed."
+ ],
+ "enum": [
+ "RECAPTCHA_STATUS_UNSPECIFIED",
+ "RS_NOT_NEEDED",
+ "RS_PASSED",
+ "RS_FAILED"
+ ],
+ "description": "The outcome of \u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e\nvalidation.",
+ "type": "string"
+ },
+ "lead": {
+ "$ref": "Lead",
+ "description": "Lead that was created depending on the outcome of\n\u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e validation."
+ }
+ },
+ "id": "CreateLeadResponse",
+ "description": "Response message for CreateLead.",
+ "type": "object"
+ },
+ "GetCompanyResponse": {
+ "description": "Response message for GetCompany.",
+ "type": "object",
+ "properties": {
+ "company": {
+ "$ref": "Company",
+ "description": "The company."
+ },
+ "responseMetadata": {
+ "description": "Current response metadata.",
+ "$ref": "ResponseMetadata"
+ }
+ },
+ "id": "GetCompanyResponse"
+ },
+ "Location": {
+ "properties": {
+ "administrativeArea": {
+ "description": "Top-level administrative subdivision of this country.",
+ "type": "string"
+ },
+ "locality": {
+ "description": "Generally refers to the city/town portion of an address.",
+ "type": "string"
+ },
+ "latLng": {
+ "description": "The latitude and longitude of the location, in degrees.",
+ "$ref": "LatLng"
+ },
+ "dependentLocality": {
+ "description": "Dependent locality or sublocality. Used for UK dependent localities, or\nneighborhoods or boroughs in other locations.",
+ "type": "string"
+ },
+ "address": {
+ "description": "The single string version of the address.",
+ "type": "string"
+ },
+ "regionCode": {
+ "description": "CLDR (Common Locale Data Repository) region code .",
+ "type": "string"
+ },
+ "postalCode": {
+ "description": "Values are frequently alphanumeric.",
+ "type": "string"
+ },
+ "languageCode": {
+ "description": "Language code of the address. Should be in BCP 47 format.",
+ "type": "string"
+ },
+ "sortingCode": {
+ "description": "Use of this code is very country-specific, but will refer to a secondary\nclassification code for sorting mail.",
+ "type": "string"
+ },
+ "addressLine": {
+ "description": "The following address lines represent the most specific part of any\naddress.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "Location",
+ "description": "A location with address and geographic coordinates. May optionally contain a\ndetailed (multi-field) version of the address.",
+ "type": "object"
}
},
- "icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
"protocol": "rest",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
"version": "v2",
"baseUrl": "https://partners.googleapis.com/",
"canonicalName": "Partners",
- "kind": "discovery#restDescription",
- "description": "Searches certified companies and creates contact leads with them, and also audits the usage of clients.",
"servicePath": "",
- "rootUrl": "https://partners.googleapis.com/"
+ "description": "Searches certified companies and creates contact leads with them, and also audits the usage of clients.",
+ "kind": "discovery#restDescription",
+ "rootUrl": "https://partners.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "partners",
+ "batchPath": "batch",
+ "revision": "20171004",
+ "id": "partners:v2",
+ "documentationLink": "https://developers.google.com/partners/",
+ "title": "Google Partners API"
}
diff --git a/people/v1/people-api.json b/people/v1/people-api.json
index 1bc98bf..ff0db28 100644
--- a/people/v1/people-api.json
+++ b/people/v1/people-api.json
@@ -1,25 +1,611 @@
{
- "revision": "20171009",
- "documentationLink": "https://developers.google.com/people/",
+ "parameters": {
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "alt": {
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://people.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Provides access to information about profiles and contacts.",
+ "servicePath": "",
+ "basePath": "",
"id": "people:v1",
+ "revision": "20171011",
+ "documentationLink": "https://developers.google.com/people/",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "Name": {
+ "id": "Name",
+ "description": "A person's name. If the name is a mononym, the family name is empty.",
+ "type": "object",
+ "properties": {
+ "phoneticFullName": {
+ "description": "The full name spelled as it sounds.",
+ "type": "string"
+ },
+ "displayNameLastFirst": {
+ "description": "The read-only display name with the last name first formatted according to\nthe locale specified by the viewer's account or the\n`Accept-Language` HTTP header.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "The read-only display name formatted according to the locale specified by\nthe viewer's account or the `Accept-Language` HTTP header.",
+ "type": "string"
+ },
+ "honorificSuffix": {
+ "description": "The honorific suffixes, such as `Jr.`",
+ "type": "string"
+ },
+ "honorificPrefix": {
+ "description": "The honorific prefixes, such as `Mrs.` or `Dr.`",
+ "type": "string"
+ },
+ "phoneticHonorificSuffix": {
+ "description": "The honorific suffixes spelled as they sound.",
+ "type": "string"
+ },
+ "middleName": {
+ "description": "The middle name(s).",
+ "type": "string"
+ },
+ "givenName": {
+ "description": "The given name.",
+ "type": "string"
+ },
+ "phoneticHonorificPrefix": {
+ "description": "The honorific prefixes spelled as they sound.",
+ "type": "string"
+ },
+ "phoneticGivenName": {
+ "description": "The given name spelled as it sounds.",
+ "type": "string"
+ },
+ "phoneticFamilyName": {
+ "description": "The family name spelled as it sounds.",
+ "type": "string"
+ },
+ "familyName": {
+ "description": "The family name.",
+ "type": "string"
+ },
+ "phoneticMiddleName": {
+ "description": "The middle name(s) spelled as they sound.",
+ "type": "string"
+ },
+ "metadata": {
+ "description": "Metadata about the name.",
+ "$ref": "FieldMetadata"
+ }
+ }
+ },
+ "Locale": {
+ "description": "A person's locale preference.",
+ "type": "object",
+ "properties": {
+ "metadata": {
+ "description": "Metadata about the locale.",
+ "$ref": "FieldMetadata"
+ },
+ "value": {
+ "description": "The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47)\nlanguage tag representing the locale.",
+ "type": "string"
+ }
+ },
+ "id": "Locale"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
+ },
+ "UserDefined": {
+ "description": "Arbitrary user data that is populated by the end users.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The end user specified value of the user defined data.",
+ "type": "string"
+ },
+ "key": {
+ "description": "The end user specified key of the user defined data.",
+ "type": "string"
+ },
+ "metadata": {
+ "description": "Metadata about the user defined data.",
+ "$ref": "FieldMetadata"
+ }
+ },
+ "id": "UserDefined"
+ },
+ "Biography": {
+ "description": "A person's short biography.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The short biography.",
+ "type": "string"
+ },
+ "contentType": {
+ "description": "The content type of the biography.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified.",
+ "Plain text.",
+ "HTML text."
+ ],
+ "enum": [
+ "CONTENT_TYPE_UNSPECIFIED",
+ "TEXT_PLAIN",
+ "TEXT_HTML"
+ ]
+ },
+ "metadata": {
+ "description": "Metadata about the biography.",
+ "$ref": "FieldMetadata"
+ }
+ },
+ "id": "Biography"
+ },
+ "FieldMetadata": {
+ "id": "FieldMetadata",
+ "description": "Metadata about a field.",
+ "type": "object",
+ "properties": {
+ "source": {
+ "description": "The source of the field.",
+ "$ref": "Source"
+ },
+ "verified": {
+ "description": "True if the field is verified; false if the field is unverified. A\nverified field is typically a name, email address, phone number, or\nwebsite that has been confirmed to be owned by the person.",
+ "type": "boolean"
+ },
+ "primary": {
+ "description": "True if the field is the primary field; false if the field is a secondary\nfield.",
+ "type": "boolean"
+ }
+ }
+ },
+ "RelationshipInterest": {
+ "description": "A person's read-only relationship interest .",
+ "type": "object",
+ "properties": {
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the relationship interest."
+ },
+ "value": {
+ "description": "The kind of relationship the person is looking for. The value can be custom\nor predefined. Possible values include, but are not limited to, the\nfollowing values:\n\n* `friend`\n* `date`\n* `relationship`\n* `networking`",
+ "type": "string"
+ },
+ "formattedValue": {
+ "description": "The value of the relationship interest translated and formatted in the\nviewer's account locale or the locale specified in the Accept-Language\nHTTP header.",
+ "type": "string"
+ }
+ },
+ "id": "RelationshipInterest"
+ },
+ "Source": {
+ "description": "The source of a field.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "enumDescriptions": [
+ "Unspecified.",
+ "[Google Account](https://accounts.google.com).",
+ "[Google profile](https://profiles.google.com). You can view the\nprofile at https://profiles.google.com/\u003cvar\u003eid\u003c/var\u003e where\n\u003cvar\u003eid\u003c/var\u003e is the source id.",
+ "[Google Apps domain profile](https://admin.google.com).",
+ "[Google contact](https://contacts.google.com). You can view the\ncontact at https://contact.google.com/\u003cvar\u003eid\u003c/var\u003e where \u003cvar\u003eid\u003c/var\u003e\nis the source id."
+ ],
+ "enum": [
+ "SOURCE_TYPE_UNSPECIFIED",
+ "ACCOUNT",
+ "PROFILE",
+ "DOMAIN_PROFILE",
+ "CONTACT"
+ ],
+ "description": "The source type.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "**Only populated in `person.metadata.sources`.**\n\nThe [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\nsource. Used for web cache validation.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The unique identifier within the source type generated by the server.",
+ "type": "string"
+ },
+ "profileMetadata": {
+ "$ref": "ProfileMetadata",
+ "description": "**Only populated in `person.metadata.sources`.**\n\nMetadata about a source of type PROFILE."
+ },
+ "updateTime": {
+ "description": "**Only populated in `person.metadata.sources`.**\n\nLast update timestamp of this source.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "Source"
+ },
+ "GetPeopleResponse": {
+ "type": "object",
+ "properties": {
+ "responses": {
+ "description": "The response for each requested resource name.",
+ "type": "array",
+ "items": {
+ "$ref": "PersonResponse"
+ }
+ }
+ },
+ "id": "GetPeopleResponse"
+ },
+ "PhoneNumber": {
+ "description": "A person's phone number.",
+ "type": "object",
+ "properties": {
+ "metadata": {
+ "description": "Metadata about the phone number.",
+ "$ref": "FieldMetadata"
+ },
+ "type": {
+ "description": "The type of the phone number. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `mobile`\n* `homeFax`\n* `workFax`\n* `otherFax`\n* `pager`\n* `workMobile`\n* `workPager`\n* `main`\n* `googleVoice`\n* `other`",
+ "type": "string"
+ },
+ "value": {
+ "description": "The phone number.",
+ "type": "string"
+ },
+ "formattedType": {
+ "description": "The read-only type of the phone number translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
+ "type": "string"
+ },
+ "canonicalForm": {
+ "description": "The read-only canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)\nform of the phone number.",
+ "type": "string"
+ }
+ },
+ "id": "PhoneNumber"
+ },
+ "Photo": {
+ "description": "A person's read-only photo. A picture shown next to the person's name to\nhelp others recognize the person.",
+ "type": "object",
+ "properties": {
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the photo."
+ },
+ "default": {
+ "description": "True if the photo is a default photo;\nfalse if the photo is a user-provided photo.",
+ "type": "boolean"
+ },
+ "url": {
+ "description": "The URL of the photo. You can change the desired size by appending a query\nparameter `sz=`\u003cvar\u003esize\u003c/var\u003e at the end of the url. Example:\n`https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50`",
+ "type": "string"
+ }
+ },
+ "id": "Photo"
+ },
+ "ListConnectionsResponse": {
+ "type": "object",
+ "properties": {
+ "connections": {
+ "description": "The list of people that the requestor is connected to.",
+ "type": "array",
+ "items": {
+ "$ref": "Person"
+ }
+ },
+ "nextSyncToken": {
+ "description": "The token that can be used to retrieve changes since the last request.",
+ "type": "string"
+ },
+ "totalItems": {
+ "description": "The total number of items in the list without pagination.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalPeople": {
+ "description": "**DEPRECATED** (Please use totalItems)\nThe total number of people in the list without pagination.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "nextPageToken": {
+ "description": "The token that can be used to retrieve the next page of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListConnectionsResponse"
+ },
+ "Birthday": {
+ "id": "Birthday",
+ "description": "A person's birthday. At least one of the `date` and `text` fields are\nspecified. The `date` and `text` fields typically represent the same\ndate, but are not guaranteed to.",
+ "type": "object",
+ "properties": {
+ "metadata": {
+ "description": "Metadata about the birthday.",
+ "$ref": "FieldMetadata"
+ },
+ "text": {
+ "description": "A free-form string representing the user's birthday.",
+ "type": "string"
+ },
+ "date": {
+ "$ref": "Date",
+ "description": "The date of the birthday."
+ }
+ }
+ },
+ "CreateContactGroupRequest": {
+ "id": "CreateContactGroupRequest",
+ "description": "A request to create a new contact group.",
+ "type": "object",
+ "properties": {
+ "contactGroup": {
+ "$ref": "ContactGroup",
+ "description": "The contact group to create."
+ }
+ }
+ },
+ "Address": {
+ "id": "Address",
+ "description": "A person's physical address. May be a P.O. box or street address. All fields\nare optional.",
+ "type": "object",
+ "properties": {
+ "countryCode": {
+ "description": "The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country\ncode of the address.",
+ "type": "string"
+ },
+ "formattedType": {
+ "description": "The read-only type of the address translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header locale.",
+ "type": "string"
+ },
+ "city": {
+ "description": "The city of the address.",
+ "type": "string"
+ },
+ "formattedValue": {
+ "description": "The unstructured value of the address. If this is not set by the user it\nwill be automatically constructed from structured values.",
+ "type": "string"
+ },
+ "country": {
+ "description": "The country of the address.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of the address. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `other`",
+ "type": "string"
+ },
+ "extendedAddress": {
+ "description": "The extended address of the address; for example, the apartment number.",
+ "type": "string"
+ },
+ "poBox": {
+ "description": "The P.O. box of the address.",
+ "type": "string"
+ },
+ "postalCode": {
+ "description": "The postal code of the address.",
+ "type": "string"
+ },
+ "region": {
+ "description": "The region of the address; for example, the state or province.",
+ "type": "string"
+ },
+ "streetAddress": {
+ "description": "The street address.",
+ "type": "string"
+ },
+ "metadata": {
+ "description": "Metadata about the address.",
+ "$ref": "FieldMetadata"
+ }
+ }
+ },
+ "Status": {
+ "id": "Status",
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
+ "properties": {
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ }
+ }
+ }
+ },
+ "ContactGroupMembership": {
+ "description": "A Google contact group membership.",
+ "type": "object",
+ "properties": {
+ "contactGroupId": {
+ "description": "The contact group ID for the contact group membership. The contact group\nID can be custom or predefined. Possible values include, but are not\nlimited to, the following:\n\n* `myContacts`\n* `starred`\n* A numerical ID for user-created groups.",
+ "type": "string"
+ }
+ },
+ "id": "ContactGroupMembership"
+ },
+ "PersonMetadata": {
+ "id": "PersonMetadata",
+ "description": "The read-only metadata about a person.",
+ "type": "object",
+ "properties": {
+ "objectType": {
+ "description": "**DEPRECATED** (Please use\n`person.metadata.sources.profileMetadata.objectType` instead)\n\nThe type of the person object.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified.",
+ "Person.",
+ "[Google+ Page.](http://www.google.com/+/brands/)"
+ ],
+ "enum": [
+ "OBJECT_TYPE_UNSPECIFIED",
+ "PERSON",
+ "PAGE"
+ ]
+ },
+ "linkedPeopleResourceNames": {
+ "description": "Resource names of people linked to this resource.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "sources": {
+ "description": "The sources of data for the person.",
+ "type": "array",
+ "items": {
+ "$ref": "Source"
+ }
+ },
+ "previousResourceNames": {
+ "description": "Any former resource names this person has had. Populated only for\n[`connections.list`](/people/api/rest/v1/people.connections/list) requests\nthat include a sync token.\n\nThe resource name may change when adding or removing fields that link a\ncontact and profile such as a verified email, verified phone number, or\nprofile URL.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "deleted": {
+ "description": "True if the person resource has been deleted. Populated only for\n[`connections.list`](/people/api/rest/v1/people.connections/list) requests\nthat include a sync token.",
+ "type": "boolean"
+ }
+ }
+ },
+ "ModifyContactGroupMembersRequest": {
+ "id": "ModifyContactGroupMembersRequest",
+ "description": "A request to modify an existing contact group's members.",
+ "type": "object",
+ "properties": {
+ "resourceNamesToAdd": {
+ "description": "The resource names of the contact people to add in the form of in the form\n`people/`\u003cvar\u003eperson_id\u003c/var\u003e.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "resourceNamesToRemove": {
+ "description": "The resource names of the contact people to remove in the form of in the\nform of `people/`\u003cvar\u003eperson_id\u003c/var\u003e.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
"ContactGroupResponse": {
"description": "The response for a specific contact group.",
"type": "object",
"properties": {
- "status": {
- "description": "The status of the response.",
- "$ref": "Status"
- },
"requestedResourceName": {
"description": "The original requested resource name.",
"type": "string"
},
"contactGroup": {
- "$ref": "ContactGroup",
- "description": "The contact group."
+ "description": "The contact group.",
+ "$ref": "ContactGroup"
+ },
+ "status": {
+ "$ref": "Status",
+ "description": "The status of the response."
}
},
"id": "ContactGroupResponse"
@@ -28,21 +614,21 @@
"description": "A person's associated URLs.",
"type": "object",
"properties": {
+ "value": {
+ "description": "The URL.",
+ "type": "string"
+ },
"formattedType": {
"description": "The read-only type of the URL translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header locale.",
"type": "string"
},
"metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the URL."
+ "description": "Metadata about the URL.",
+ "$ref": "FieldMetadata"
},
"type": {
"description": "The type of the URL. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `blog`\n* `profile`\n* `homePage`\n* `ftp`\n* `reservations`\n* `appInstallPage`: website for a Google+ application.\n* `other`",
"type": "string"
- },
- "value": {
- "description": "The URL.",
- "type": "string"
}
},
"id": "Url"
@@ -51,10 +637,6 @@
"description": "A person's instant messaging client.",
"type": "object",
"properties": {
- "username": {
- "description": "The user name used in the IM client.",
- "type": "string"
- },
"formattedProtocol": {
"description": "The read-only protocol of the IM client formatted in the viewer's account\nlocale or the `Accept-Language` HTTP header locale.",
"type": "string"
@@ -74,39 +656,24 @@
"protocol": {
"description": "The protocol of the IM client. The protocol can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `aim`\n* `msn`\n* `yahoo`\n* `skype`\n* `qq`\n* `googleTalk`\n* `icq`\n* `jabber`\n* `netMeeting`",
"type": "string"
+ },
+ "username": {
+ "description": "The user name used in the IM client.",
+ "type": "string"
}
},
"id": "ImClient"
},
"DomainMembership": {
+ "id": "DomainMembership",
+ "description": "A Google Apps Domain membership.",
+ "type": "object",
"properties": {
"inViewerDomain": {
"description": "True if the person is in the viewer's Google Apps domain.",
"type": "boolean"
}
- },
- "id": "DomainMembership",
- "description": "A Google Apps Domain membership.",
- "type": "object"
- },
- "Membership": {
- "properties": {
- "contactGroupMembership": {
- "description": "The contact group membership.",
- "$ref": "ContactGroupMembership"
- },
- "domainMembership": {
- "$ref": "DomainMembership",
- "description": "The domain membership."
- },
- "metadata": {
- "description": "Metadata about the membership.",
- "$ref": "FieldMetadata"
- }
- },
- "id": "Membership",
- "description": "A person's read-only membership in a group.",
- "type": "object"
+ }
},
"BatchGetContactGroupsResponse": {
"description": "The response to a batch get contact groups request.",
@@ -122,12 +689,30 @@
},
"id": "BatchGetContactGroupsResponse"
},
- "RelationshipStatus": {
+ "Membership": {
+ "description": "A person's read-only membership in a group.",
+ "type": "object",
"properties": {
"metadata": {
- "description": "Metadata about the relationship status.",
+ "description": "Metadata about the membership.",
"$ref": "FieldMetadata"
},
+ "contactGroupMembership": {
+ "$ref": "ContactGroupMembership",
+ "description": "The contact group membership."
+ },
+ "domainMembership": {
+ "description": "The domain membership.",
+ "$ref": "DomainMembership"
+ }
+ },
+ "id": "Membership"
+ },
+ "RelationshipStatus": {
+ "id": "RelationshipStatus",
+ "description": "A person's read-only relationship status.",
+ "type": "object",
+ "properties": {
"value": {
"description": "The relationship status. The value can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `single`\n* `inARelationship`\n* `engaged`\n* `married`\n* `itsComplicated`\n* `openRelationship`\n* `widowed`\n* `inDomesticPartnership`\n* `inCivilUnion`",
"type": "string"
@@ -135,11 +720,12 @@
"formattedValue": {
"description": "The read-only value of the relationship status translated and formatted in\nthe viewer's account locale or the `Accept-Language` HTTP header locale.",
"type": "string"
+ },
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the relationship status."
}
- },
- "id": "RelationshipStatus",
- "description": "A person's read-only relationship status.",
- "type": "object"
+ }
},
"BraggingRights": {
"description": "A person's bragging rights.",
@@ -157,12 +743,29 @@
"id": "BraggingRights"
},
"Organization": {
+ "id": "Organization",
"description": "A person's past or current organization. Overlapping date ranges are\npermitted.",
"type": "object",
"properties": {
+ "department": {
+ "description": "The person's department at the organization.",
+ "type": "string"
+ },
+ "phoneticName": {
+ "description": "The phonetic name of the organization.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of the organization. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `work`\n* `school`",
+ "type": "string"
+ },
+ "jobDescription": {
+ "description": "The person's job description at the organization.",
+ "type": "string"
+ },
"endDate": {
- "description": "The end date when the person left the organization.",
- "$ref": "Date"
+ "$ref": "Date",
+ "description": "The end date when the person left the organization."
},
"symbol": {
"description": "The symbol associated with the organization; for example, a stock ticker\nsymbol, abbreviation, or acronym.",
@@ -176,48 +779,31 @@
"description": "Metadata about the organization.",
"$ref": "FieldMetadata"
},
- "title": {
- "description": "The person's job title at the organization.",
- "type": "string"
- },
"location": {
"description": "The location of the organization office the person works at.",
"type": "string"
},
+ "title": {
+ "description": "The person's job title at the organization.",
+ "type": "string"
+ },
"current": {
"description": "True if the organization is the person's current organization;\nfalse if the organization is a past organization.",
"type": "boolean"
},
- "formattedType": {
- "description": "The read-only type of the organization translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
- "type": "string"
- },
"startDate": {
"$ref": "Date",
"description": "The start date when the person joined the organization."
},
+ "formattedType": {
+ "description": "The read-only type of the organization translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
+ "type": "string"
+ },
"domain": {
"description": "The domain name associated with the organization; for example, `google.com`.",
"type": "string"
- },
- "department": {
- "description": "The person's department at the organization.",
- "type": "string"
- },
- "type": {
- "description": "The type of the organization. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `work`\n* `school`",
- "type": "string"
- },
- "phoneticName": {
- "description": "The phonetic name of the organization.",
- "type": "string"
- },
- "jobDescription": {
- "description": "The person's job description at the organization.",
- "type": "string"
}
- },
- "id": "Organization"
+ }
},
"AgeRangeType": {
"description": "A person's age range.",
@@ -228,8 +814,6 @@
"description": "Metadata about the age range."
},
"ageRange": {
- "description": "The age range.",
- "type": "string",
"enumDescriptions": [
"Unspecified.",
"Younger than eighteen.",
@@ -241,7 +825,9 @@
"LESS_THAN_EIGHTEEN",
"EIGHTEEN_TO_TWENTY",
"TWENTY_ONE_OR_OLDER"
- ]
+ ],
+ "description": "The age range.",
+ "type": "string"
}
},
"id": "AgeRangeType"
@@ -277,22 +863,22 @@
"description": "The response for a single person",
"type": "object",
"properties": {
+ "requestedResourceName": {
+ "description": "The original requested resource name. May be different than the resource\nname on the returned person.\n\nThe resource name can change when adding or removing fields that link a\ncontact and profile such as a verified email, verified phone number, or a\nprofile URL.",
+ "type": "string"
+ },
"person": {
"$ref": "Person",
"description": "The person."
},
"status": {
- "$ref": "Status",
- "description": "The status of the response."
+ "description": "The status of the response.",
+ "$ref": "Status"
},
"httpStatusCode": {
"description": "**DEPRECATED** (Please use status instead)\n\n[HTTP 1.1 status code]\n(http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).",
"format": "int32",
"type": "integer"
- },
- "requestedResourceName": {
- "description": "The original requested resource name. May be different than the resource\nname on the returned person.\n\nThe resource name can change when adding or removing fields that link a\ncontact and profile such as a verified email, verified phone number, or a\nprofile URL.",
- "type": "string"
}
},
"id": "PersonResponse"
@@ -301,6 +887,14 @@
"description": "A person's relation to another person.",
"type": "object",
"properties": {
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the relation."
+ },
+ "type": {
+ "description": "The person's relation to the other person. The type can be custom or predefined.\nPossible values include, but are not limited to, the following values:\n\n* `spouse`\n* `child`\n* `mother`\n* `father`\n* `parent`\n* `brother`\n* `sister`\n* `friend`\n* `relative`\n* `domesticPartner`\n* `manager`\n* `assistant`\n* `referredBy`\n* `partner`",
+ "type": "string"
+ },
"person": {
"description": "The name of the other person this relation refers to.",
"type": "string"
@@ -308,19 +902,13 @@
"formattedType": {
"description": "The type of the relation translated and formatted in the viewer's account\nlocale or the locale specified in the Accept-Language HTTP header.",
"type": "string"
- },
- "metadata": {
- "description": "Metadata about the relation.",
- "$ref": "FieldMetadata"
- },
- "type": {
- "description": "The person's relation to the other person. The type can be custom or predefined.\nPossible values include, but are not limited to, the following values:\n\n* `spouse`\n* `child`\n* `mother`\n* `father`\n* `parent`\n* `brother`\n* `sister`\n* `friend`\n* `relative`\n* `domesticPartner`\n* `manager`\n* `assistant`\n* `referredBy`\n* `partner`",
- "type": "string"
}
},
"id": "Relation"
},
"Occupation": {
+ "description": "A person's occupation.",
+ "type": "object",
"properties": {
"value": {
"description": "The occupation; for example, `carpenter`.",
@@ -331,44 +919,13 @@
"$ref": "FieldMetadata"
}
},
- "id": "Occupation",
- "description": "A person's occupation.",
- "type": "object"
+ "id": "Occupation"
},
"ContactGroup": {
+ "id": "ContactGroup",
"description": "A contact group.",
"type": "object",
"properties": {
- "resourceName": {
- "description": "The resource name for the contact group, assigned by the server. An ASCII\nstring, in the form of `contactGroups/`\u003cvar\u003econtact_group_id\u003c/var\u003e.",
- "type": "string"
- },
- "etag": {
- "description": "The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\nresource. Used for web cache validation.",
- "type": "string"
- },
- "groupType": {
- "enumDescriptions": [
- "Unspecified.",
- "User defined contact group.",
- "System defined contact group."
- ],
- "enum": [
- "GROUP_TYPE_UNSPECIFIED",
- "USER_CONTACT_GROUP",
- "SYSTEM_CONTACT_GROUP"
- ],
- "description": "The read-only contact group type.",
- "type": "string"
- },
- "formattedName": {
- "description": "The read-only name translated and formatted in the viewer's account locale\nor the `Accept-Language` HTTP header locale for system groups names.\nGroup names set by the owner are the same as name.",
- "type": "string"
- },
- "name": {
- "description": "The contact group name set by the group owner or a system provided name\nfor system groups.",
- "type": "string"
- },
"memberResourceNames": {
"description": "The list of contact person resource names that are members of the contact\ngroup. The field is not populated for LIST requests and can only be updated\nthrough the\n[ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).",
"type": "array",
@@ -376,6 +933,10 @@
"type": "string"
}
},
+ "name": {
+ "description": "The contact group name set by the group owner or a system provided name\nfor system groups.",
+ "type": "string"
+ },
"memberCount": {
"description": "The total number of contacts in the group irrespective of max members in\nspecified in the request.",
"format": "int32",
@@ -384,14 +945,82 @@
"metadata": {
"description": "Metadata about the contact group.",
"$ref": "ContactGroupMetadata"
+ },
+ "resourceName": {
+ "description": "The resource name for the contact group, assigned by the server. An ASCII\nstring, in the form of `contactGroups/`\u003cvar\u003econtact_group_id\u003c/var\u003e.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\nresource. Used for web cache validation.",
+ "type": "string"
+ },
+ "groupType": {
+ "description": "The read-only contact group type.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified.",
+ "User defined contact group.",
+ "System defined contact group."
+ ],
+ "enum": [
+ "GROUP_TYPE_UNSPECIFIED",
+ "USER_CONTACT_GROUP",
+ "SYSTEM_CONTACT_GROUP"
+ ]
+ },
+ "formattedName": {
+ "description": "The read-only name translated and formatted in the viewer's account locale\nor the `Accept-Language` HTTP header locale for system groups names.\nGroup names set by the owner are the same as name.",
+ "type": "string"
}
- },
- "id": "ContactGroup"
+ }
},
"Person": {
+ "id": "Person",
"description": "Information about a person merged from various data sources such as the\nauthenticated user's contacts and profile data.\n\nMost fields can have multiple items. The items in a field have no guaranteed\norder, but each non-empty field is guaranteed to have exactly one field with\n`metadata.primary` set to true.",
"type": "object",
"properties": {
+ "imClients": {
+ "description": "The person's instant messaging clients.",
+ "type": "array",
+ "items": {
+ "$ref": "ImClient"
+ }
+ },
+ "birthdays": {
+ "description": "The person's birthdays.",
+ "type": "array",
+ "items": {
+ "$ref": "Birthday"
+ }
+ },
+ "userDefined": {
+ "description": "The person's user defined data.",
+ "type": "array",
+ "items": {
+ "$ref": "UserDefined"
+ }
+ },
+ "locales": {
+ "description": "The person's locale preferences.",
+ "type": "array",
+ "items": {
+ "$ref": "Locale"
+ }
+ },
+ "relationshipInterests": {
+ "description": "The person's read-only relationship interests.",
+ "type": "array",
+ "items": {
+ "$ref": "RelationshipInterest"
+ }
+ },
+ "urls": {
+ "description": "The person's associated URLs.",
+ "type": "array",
+ "items": {
+ "$ref": "Url"
+ }
+ },
"nicknames": {
"description": "The person's nicknames.",
"type": "array",
@@ -399,13 +1028,6 @@
"$ref": "Nickname"
}
},
- "names": {
- "description": "The person's names.",
- "type": "array",
- "items": {
- "$ref": "Name"
- }
- },
"relations": {
"description": "The person's relations.",
"type": "array",
@@ -413,6 +1035,13 @@
"$ref": "Relation"
}
},
+ "names": {
+ "description": "The person's names.",
+ "type": "array",
+ "items": {
+ "$ref": "Name"
+ }
+ },
"occupations": {
"description": "The person's occupations.",
"type": "array",
@@ -566,64 +1195,24 @@
"items": {
"$ref": "CoverPhoto"
}
- },
- "imClients": {
- "description": "The person's instant messaging clients.",
- "type": "array",
- "items": {
- "$ref": "ImClient"
- }
- },
- "birthdays": {
- "description": "The person's birthdays.",
- "type": "array",
- "items": {
- "$ref": "Birthday"
- }
- },
- "userDefined": {
- "description": "The person's user defined data.",
- "type": "array",
- "items": {
- "$ref": "UserDefined"
- }
- },
- "locales": {
- "description": "The person's locale preferences.",
- "type": "array",
- "items": {
- "$ref": "Locale"
- }
- },
- "relationshipInterests": {
- "description": "The person's read-only relationship interests.",
- "type": "array",
- "items": {
- "$ref": "RelationshipInterest"
- }
- },
- "urls": {
- "description": "The person's associated URLs.",
- "type": "array",
- "items": {
- "$ref": "Url"
- }
}
- },
- "id": "Person"
+ }
},
"UpdateContactGroupRequest": {
+ "id": "UpdateContactGroupRequest",
"description": "A request to update an existing contact group. Only the name can be updated.",
"type": "object",
"properties": {
"contactGroup": {
- "description": "The contact group to update.",
- "$ref": "ContactGroup"
+ "$ref": "ContactGroup",
+ "description": "The contact group to update."
}
- },
- "id": "UpdateContactGroupRequest"
+ }
},
"ContactGroupMetadata": {
+ "id": "ContactGroupMetadata",
+ "description": "The read-only metadata about a contact group.",
+ "type": "object",
"properties": {
"updateTime": {
"description": "The time the group was last updated.",
@@ -634,12 +1223,10 @@
"description": "True if the contact group resource has been deleted. Populated only for\n[`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests\nthat include a sync token.",
"type": "boolean"
}
- },
- "id": "ContactGroupMetadata",
- "description": "The read-only metadata about a contact group.",
- "type": "object"
+ }
},
"Residence": {
+ "id": "Residence",
"description": "A person's past or current residence.",
"type": "object",
"properties": {
@@ -655,21 +1242,12 @@
"description": "The address of the residence.",
"type": "string"
}
- },
- "id": "Residence"
+ }
},
"Event": {
"description": "An event related to the person.",
"type": "object",
"properties": {
- "date": {
- "description": "The date of the event.",
- "$ref": "Date"
- },
- "formattedType": {
- "description": "The read-only type of the event translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
- "type": "string"
- },
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the event."
@@ -677,11 +1255,20 @@
"type": {
"description": "The type of the event. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `anniversary`\n* `other`",
"type": "string"
+ },
+ "date": {
+ "$ref": "Date",
+ "description": "The date of the event."
+ },
+ "formattedType": {
+ "description": "The read-only type of the event translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
+ "type": "string"
}
},
"id": "Event"
},
"ModifyContactGroupMembersResponse": {
+ "id": "ModifyContactGroupMembersResponse",
"description": "The response to a modify contact group members request.",
"type": "object",
"properties": {
@@ -692,20 +1279,27 @@
"type": "string"
}
}
- },
- "id": "ModifyContactGroupMembersResponse"
+ }
},
"ProfileMetadata": {
"description": "The read-only metadata about a profile.",
"type": "object",
"properties": {
- "userTypes": {
+ "objectType": {
"enumDescriptions": [
- "The user type is not known.",
- "The user is a Google user.",
- "The user is a Google+ user.",
- "The user is a Google Apps for Work user."
+ "Unspecified.",
+ "Person.",
+ "[Google+ Page.](http://www.google.com/+/brands/)"
],
+ "enum": [
+ "OBJECT_TYPE_UNSPECIFIED",
+ "PERSON",
+ "PAGE"
+ ],
+ "description": "The profile object type.",
+ "type": "string"
+ },
+ "userTypes": {
"description": "The user types.",
"type": "array",
"items": {
@@ -716,27 +1310,25 @@
"GOOGLE_APPS_USER"
],
"type": "string"
- }
- },
- "objectType": {
- "enum": [
- "OBJECT_TYPE_UNSPECIFIED",
- "PERSON",
- "PAGE"
- ],
- "description": "The profile object type.",
- "type": "string",
+ },
"enumDescriptions": [
- "Unspecified.",
- "Person.",
- "[Google+ Page.](http://www.google.com/+/brands/)"
+ "The user type is not known.",
+ "The user is a Google user.",
+ "The user is a Google+ user.",
+ "The user is a Google Apps for Work user."
]
}
},
"id": "ProfileMetadata"
},
"Gender": {
+ "description": "A person's gender.",
+ "type": "object",
"properties": {
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the gender."
+ },
"value": {
"description": "The gender for the person. The gender can be custom or predefined.\nPossible values include, but are not limited to, the\nfollowing:\n\n* `male`\n* `female`\n* `other`\n* `unknown`",
"type": "string"
@@ -744,17 +1336,12 @@
"formattedValue": {
"description": "The read-only value of the gender translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header locale.",
"type": "string"
- },
- "metadata": {
- "description": "Metadata about the gender.",
- "$ref": "FieldMetadata"
}
},
- "id": "Gender",
- "description": "A person's gender.",
- "type": "object"
+ "id": "Gender"
},
"CoverPhoto": {
+ "id": "CoverPhoto",
"description": "A person's read-only cover photo. A large image shown on the person's\nprofile page that represents who they are or what they care about.",
"type": "object",
"properties": {
@@ -770,23 +1357,22 @@
"description": "True if the cover photo is the default cover photo;\nfalse if the cover photo is a user-provided cover photo.",
"type": "boolean"
}
- },
- "id": "CoverPhoto"
+ }
},
"Interest": {
+ "id": "Interest",
"description": "One of the person's interests.",
"type": "object",
"properties": {
- "metadata": {
- "description": "Metadata about the interest.",
- "$ref": "FieldMetadata"
- },
"value": {
"description": "The interest; for example, `stargazing`.",
"type": "string"
+ },
+ "metadata": {
+ "description": "Metadata about the interest.",
+ "$ref": "FieldMetadata"
}
- },
- "id": "Interest"
+ }
},
"EmailAddress": {
"description": "A person's email address.",
@@ -797,8 +1383,8 @@
"type": "string"
},
"metadata": {
- "description": "Metadata about the email address.",
- "$ref": "FieldMetadata"
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the email address."
},
"type": {
"description": "The type of the email address. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `other`",
@@ -816,6 +1402,7 @@
"id": "EmailAddress"
},
"Nickname": {
+ "id": "Nickname",
"description": "A person's nickname.",
"type": "object",
"properties": {
@@ -824,17 +1411,10 @@
"type": "string"
},
"metadata": {
- "description": "Metadata about the nickname.",
- "$ref": "FieldMetadata"
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the nickname."
},
"type": {
- "enum": [
- "DEFAULT",
- "MAIDEN_NAME",
- "INITIALS",
- "GPLUS",
- "OTHER_NAME"
- ],
"description": "The type of the nickname.",
"type": "string",
"enumDescriptions": [
@@ -843,27 +1423,34 @@
"Initials.",
"Google+ profile nickname.",
"A professional affiliation or other name; for example, `Dr. Smith.`"
+ ],
+ "enum": [
+ "DEFAULT",
+ "MAIDEN_NAME",
+ "INITIALS",
+ "GPLUS",
+ "OTHER_NAME"
]
}
- },
- "id": "Nickname"
+ }
},
"Skill": {
"description": "A skill that the person has.",
"type": "object",
"properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the skill."
- },
"value": {
"description": "The skill; for example, `underwater basket weaving`.",
"type": "string"
+ },
+ "metadata": {
+ "description": "Metadata about the skill.",
+ "$ref": "FieldMetadata"
}
},
"id": "Skill"
},
"Tagline": {
+ "id": "Tagline",
"description": "A read-only brief one-line description of the person.",
"type": "object",
"properties": {
@@ -875,10 +1462,10 @@
"description": "Metadata about the tagline.",
"$ref": "FieldMetadata"
}
- },
- "id": "Tagline"
+ }
},
"Date": {
+ "id": "Date",
"description": "Represents a whole calendar date, for example a date of birth. The time\nof day and time zone are either specified elsewhere or are not\nsignificant. The date is relative to the\n[Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).\nThe day may be 0 to represent a year and month where the day is not\nsignificant. The year may be 0 to represent a month and day independent\nof year; for example, anniversary date.",
"type": "object",
"properties": {
@@ -897,500 +1484,7 @@
"format": "int32",
"type": "integer"
}
- },
- "id": "Date"
- },
- "Name": {
- "properties": {
- "honorificPrefix": {
- "description": "The honorific prefixes, such as `Mrs.` or `Dr.`",
- "type": "string"
- },
- "phoneticHonorificSuffix": {
- "description": "The honorific suffixes spelled as they sound.",
- "type": "string"
- },
- "givenName": {
- "description": "The given name.",
- "type": "string"
- },
- "middleName": {
- "description": "The middle name(s).",
- "type": "string"
- },
- "phoneticHonorificPrefix": {
- "description": "The honorific prefixes spelled as they sound.",
- "type": "string"
- },
- "phoneticGivenName": {
- "description": "The given name spelled as it sounds.",
- "type": "string"
- },
- "phoneticFamilyName": {
- "description": "The family name spelled as it sounds.",
- "type": "string"
- },
- "familyName": {
- "description": "The family name.",
- "type": "string"
- },
- "metadata": {
- "description": "Metadata about the name.",
- "$ref": "FieldMetadata"
- },
- "phoneticMiddleName": {
- "description": "The middle name(s) spelled as they sound.",
- "type": "string"
- },
- "phoneticFullName": {
- "description": "The full name spelled as it sounds.",
- "type": "string"
- },
- "displayNameLastFirst": {
- "description": "The read-only display name with the last name first formatted according to\nthe locale specified by the viewer's account or the\n`Accept-Language` HTTP header.",
- "type": "string"
- },
- "displayName": {
- "description": "The read-only display name formatted according to the locale specified by\nthe viewer's account or the `Accept-Language` HTTP header.",
- "type": "string"
- },
- "honorificSuffix": {
- "description": "The honorific suffixes, such as `Jr.`",
- "type": "string"
- }
- },
- "id": "Name",
- "description": "A person's name. If the name is a mononym, the family name is empty.",
- "type": "object"
- },
- "Locale": {
- "description": "A person's locale preference.",
- "type": "object",
- "properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the locale."
- },
- "value": {
- "description": "The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47)\nlanguage tag representing the locale.",
- "type": "string"
- }
- },
- "id": "Locale"
- },
- "Empty": {
- "properties": {},
- "id": "Empty",
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object"
- },
- "UserDefined": {
- "description": "Arbitrary user data that is populated by the end users.",
- "type": "object",
- "properties": {
- "value": {
- "description": "The end user specified value of the user defined data.",
- "type": "string"
- },
- "key": {
- "description": "The end user specified key of the user defined data.",
- "type": "string"
- },
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the user defined data."
- }
- },
- "id": "UserDefined"
- },
- "Biography": {
- "description": "A person's short biography.",
- "type": "object",
- "properties": {
- "contentType": {
- "enumDescriptions": [
- "Unspecified.",
- "Plain text.",
- "HTML text."
- ],
- "enum": [
- "CONTENT_TYPE_UNSPECIFIED",
- "TEXT_PLAIN",
- "TEXT_HTML"
- ],
- "description": "The content type of the biography.",
- "type": "string"
- },
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the biography."
- },
- "value": {
- "description": "The short biography.",
- "type": "string"
- }
- },
- "id": "Biography"
- },
- "FieldMetadata": {
- "description": "Metadata about a field.",
- "type": "object",
- "properties": {
- "source": {
- "$ref": "Source",
- "description": "The source of the field."
- },
- "verified": {
- "description": "True if the field is verified; false if the field is unverified. A\nverified field is typically a name, email address, phone number, or\nwebsite that has been confirmed to be owned by the person.",
- "type": "boolean"
- },
- "primary": {
- "description": "True if the field is the primary field; false if the field is a secondary\nfield.",
- "type": "boolean"
- }
- },
- "id": "FieldMetadata"
- },
- "RelationshipInterest": {
- "description": "A person's read-only relationship interest .",
- "type": "object",
- "properties": {
- "metadata": {
- "description": "Metadata about the relationship interest.",
- "$ref": "FieldMetadata"
- },
- "value": {
- "description": "The kind of relationship the person is looking for. The value can be custom\nor predefined. Possible values include, but are not limited to, the\nfollowing values:\n\n* `friend`\n* `date`\n* `relationship`\n* `networking`",
- "type": "string"
- },
- "formattedValue": {
- "description": "The value of the relationship interest translated and formatted in the\nviewer's account locale or the locale specified in the Accept-Language\nHTTP header.",
- "type": "string"
- }
- },
- "id": "RelationshipInterest"
- },
- "Source": {
- "description": "The source of a field.",
- "type": "object",
- "properties": {
- "etag": {
- "description": "**Only populated in `person.metadata.sources`.**\n\nThe [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\nsource. Used for web cache validation.",
- "type": "string"
- },
- "id": {
- "description": "The unique identifier within the source type generated by the server.",
- "type": "string"
- },
- "profileMetadata": {
- "$ref": "ProfileMetadata",
- "description": "**Only populated in `person.metadata.sources`.**\n\nMetadata about a source of type PROFILE."
- },
- "updateTime": {
- "description": "**Only populated in `person.metadata.sources`.**\n\nLast update timestamp of this source.",
- "format": "google-datetime",
- "type": "string"
- },
- "type": {
- "enumDescriptions": [
- "Unspecified.",
- "[Google Account](https://accounts.google.com).",
- "[Google profile](https://profiles.google.com). You can view the\nprofile at https://profiles.google.com/\u003cvar\u003eid\u003c/var\u003e where\n\u003cvar\u003eid\u003c/var\u003e is the source id.",
- "[Google Apps domain profile](https://admin.google.com).",
- "[Google contact](https://contacts.google.com). You can view the\ncontact at https://contact.google.com/\u003cvar\u003eid\u003c/var\u003e where \u003cvar\u003eid\u003c/var\u003e\nis the source id."
- ],
- "enum": [
- "SOURCE_TYPE_UNSPECIFIED",
- "ACCOUNT",
- "PROFILE",
- "DOMAIN_PROFILE",
- "CONTACT"
- ],
- "description": "The source type.",
- "type": "string"
- }
- },
- "id": "Source"
- },
- "GetPeopleResponse": {
- "type": "object",
- "properties": {
- "responses": {
- "description": "The response for each requested resource name.",
- "type": "array",
- "items": {
- "$ref": "PersonResponse"
- }
- }
- },
- "id": "GetPeopleResponse"
- },
- "Photo": {
- "description": "A person's read-only photo. A picture shown next to the person's name to\nhelp others recognize the person.",
- "type": "object",
- "properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the photo."
- },
- "default": {
- "description": "True if the photo is a default photo;\nfalse if the photo is a user-provided photo.",
- "type": "boolean"
- },
- "url": {
- "description": "The URL of the photo. You can change the desired size by appending a query\nparameter `sz=`\u003cvar\u003esize\u003c/var\u003e at the end of the url. Example:\n`https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50`",
- "type": "string"
- }
- },
- "id": "Photo"
- },
- "PhoneNumber": {
- "description": "A person's phone number.",
- "type": "object",
- "properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the phone number."
- },
- "type": {
- "description": "The type of the phone number. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `mobile`\n* `homeFax`\n* `workFax`\n* `otherFax`\n* `pager`\n* `workMobile`\n* `workPager`\n* `main`\n* `googleVoice`\n* `other`",
- "type": "string"
- },
- "value": {
- "description": "The phone number.",
- "type": "string"
- },
- "formattedType": {
- "description": "The read-only type of the phone number translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
- "type": "string"
- },
- "canonicalForm": {
- "description": "The read-only canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)\nform of the phone number.",
- "type": "string"
- }
- },
- "id": "PhoneNumber"
- },
- "ListConnectionsResponse": {
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "The token that can be used to retrieve the next page of results.",
- "type": "string"
- },
- "connections": {
- "description": "The list of people that the requestor is connected to.",
- "type": "array",
- "items": {
- "$ref": "Person"
- }
- },
- "nextSyncToken": {
- "description": "The token that can be used to retrieve changes since the last request.",
- "type": "string"
- },
- "totalItems": {
- "description": "The total number of items in the list without pagination.",
- "format": "int32",
- "type": "integer"
- },
- "totalPeople": {
- "description": "**DEPRECATED** (Please use totalItems)\nThe total number of people in the list without pagination.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ListConnectionsResponse"
- },
- "Birthday": {
- "description": "A person's birthday. At least one of the `date` and `text` fields are\nspecified. The `date` and `text` fields typically represent the same\ndate, but are not guaranteed to.",
- "type": "object",
- "properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the birthday."
- },
- "text": {
- "description": "A free-form string representing the user's birthday.",
- "type": "string"
- },
- "date": {
- "description": "The date of the birthday.",
- "$ref": "Date"
- }
- },
- "id": "Birthday"
- },
- "CreateContactGroupRequest": {
- "description": "A request to create a new contact group.",
- "type": "object",
- "properties": {
- "contactGroup": {
- "description": "The contact group to create.",
- "$ref": "ContactGroup"
- }
- },
- "id": "CreateContactGroupRequest"
- },
- "Address": {
- "properties": {
- "formattedType": {
- "description": "The read-only type of the address translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header locale.",
- "type": "string"
- },
- "city": {
- "description": "The city of the address.",
- "type": "string"
- },
- "formattedValue": {
- "description": "The unstructured value of the address. If this is not set by the user it\nwill be automatically constructed from structured values.",
- "type": "string"
- },
- "country": {
- "description": "The country of the address.",
- "type": "string"
- },
- "type": {
- "description": "The type of the address. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `other`",
- "type": "string"
- },
- "extendedAddress": {
- "description": "The extended address of the address; for example, the apartment number.",
- "type": "string"
- },
- "poBox": {
- "description": "The P.O. box of the address.",
- "type": "string"
- },
- "postalCode": {
- "description": "The postal code of the address.",
- "type": "string"
- },
- "region": {
- "description": "The region of the address; for example, the state or province.",
- "type": "string"
- },
- "streetAddress": {
- "description": "The street address.",
- "type": "string"
- },
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the address."
- },
- "countryCode": {
- "description": "The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country\ncode of the address.",
- "type": "string"
- }
- },
- "id": "Address",
- "description": "A person's physical address. May be a P.O. box or street address. All fields\nare optional.",
- "type": "object"
- },
- "ContactGroupMembership": {
- "description": "A Google contact group membership.",
- "type": "object",
- "properties": {
- "contactGroupId": {
- "description": "The contact group ID for the contact group membership. The contact group\nID can be custom or predefined. Possible values include, but are not\nlimited to, the following:\n\n* `myContacts`\n* `starred`\n* A numerical ID for user-created groups.",
- "type": "string"
- }
- },
- "id": "ContactGroupMembership"
- },
- "Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "type": "array",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- }
- }
- },
- "id": "Status"
- },
- "PersonMetadata": {
- "description": "The read-only metadata about a person.",
- "type": "object",
- "properties": {
- "objectType": {
- "enumDescriptions": [
- "Unspecified.",
- "Person.",
- "[Google+ Page.](http://www.google.com/+/brands/)"
- ],
- "enum": [
- "OBJECT_TYPE_UNSPECIFIED",
- "PERSON",
- "PAGE"
- ],
- "description": "**DEPRECATED** (Please use\n`person.metadata.sources.profileMetadata.objectType` instead)\n\nThe type of the person object.",
- "type": "string"
- },
- "linkedPeopleResourceNames": {
- "description": "Resource names of people linked to this resource.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "sources": {
- "description": "The sources of data for the person.",
- "type": "array",
- "items": {
- "$ref": "Source"
- }
- },
- "previousResourceNames": {
- "description": "Any former resource names this person has had. Populated only for\n[`connections.list`](/people/api/rest/v1/people.connections/list) requests\nthat include a sync token.\n\nThe resource name may change when adding or removing fields that link a\ncontact and profile such as a verified email, verified phone number, or\nprofile URL.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "deleted": {
- "description": "True if the person resource has been deleted. Populated only for\n[`connections.list`](/people/api/rest/v1/people.connections/list) requests\nthat include a sync token.",
- "type": "boolean"
- }
- },
- "id": "PersonMetadata"
- },
- "ModifyContactGroupMembersRequest": {
- "description": "A request to modify an existing contact group's members.",
- "type": "object",
- "properties": {
- "resourceNamesToRemove": {
- "description": "The resource names of the contact people to remove in the form of in the\nform of `people/`\u003cvar\u003eperson_id\u003c/var\u003e.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "resourceNamesToAdd": {
- "description": "The resource names of the contact people to add in the form of in the form\n`people/`\u003cvar\u003eperson_id\u003c/var\u003e.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "ModifyContactGroupMembersRequest"
+ }
}
},
"icons": {
@@ -1402,12 +1496,6 @@
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/plus.login": {
- "description": "Know the list of people in your circles, your age range, and language"
- },
- "https://www.googleapis.com/auth/userinfo.profile": {
- "description": "View your basic profile info"
- },
"https://www.googleapis.com/auth/user.emails.read": {
"description": "View your email addresses"
},
@@ -1417,17 +1505,23 @@
"https://www.googleapis.com/auth/user.addresses.read": {
"description": "View your street addresses"
},
- "https://www.googleapis.com/auth/user.phonenumbers.read": {
- "description": "View your phone numbers"
- },
"https://www.googleapis.com/auth/userinfo.email": {
"description": "View your email address"
},
+ "https://www.googleapis.com/auth/user.phonenumbers.read": {
+ "description": "View your phone numbers"
+ },
"https://www.googleapis.com/auth/user.birthday.read": {
"description": "View your complete date of birth"
},
"https://www.googleapis.com/auth/contacts.readonly": {
"description": "View your contacts"
+ },
+ "https://www.googleapis.com/auth/plus.login": {
+ "description": "Know the list of people in your circles, your age range, and language"
+ },
+ "https://www.googleapis.com/auth/userinfo.profile": {
+ "description": "View your basic profile info"
}
}
}
@@ -1441,8 +1535,56 @@
"resources": {
"people": {
"methods": {
+ "createContact": {
+ "path": "v1/people:createContact",
+ "id": "people.people.createContact",
+ "description": "Create a new contact and return the person resource for that contact.",
+ "request": {
+ "$ref": "Person"
+ },
+ "response": {
+ "$ref": "Person"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts"
+ ],
+ "parameters": {
+ "parent": {
+ "location": "query",
+ "description": "The resource name of the owning person resource.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/people:createContact"
+ },
+ "deleteContact": {
+ "path": "v1/{+resourceName}:deleteContact",
+ "id": "people.people.deleteContact",
+ "description": "Delete a contact person. Any non-contact data will not be deleted.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "resourceName"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "resourceName": {
+ "pattern": "^people/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the contact to delete.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts"
+ ],
+ "flatPath": "v1/people/{peopleId}:deleteContact"
+ },
"getBatchGet": {
- "description": "Provides information about a list of specific people by specifying a list\nof requested resource names. Use `people/me` to indicate the authenticated\nuser.\n\u003cbr\u003e\nThe request throws a 400 error if 'personFields' is not specified.",
"httpMethod": "GET",
"response": {
"$ref": "GetPeopleResponse"
@@ -1450,10 +1592,10 @@
"parameterOrder": [],
"parameters": {
"personFields": {
- "location": "query",
"description": "**Required.** A field mask to restrict which fields on each person are\nreturned. Valid values are:\n\n* addresses\n* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* emailAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* memberships\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n* residences\n* skills\n* taglines\n* urls",
"format": "google-fieldmask",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"requestMask.includeField": {
"description": "**Required.** Comma-separated list of person fields to be included in the\nresponse. Each path should start with `person.`: for example,\n`person.names` or `person.photos`.",
@@ -1462,10 +1604,10 @@
"location": "query"
},
"resourceNames": {
+ "repeated": true,
"location": "query",
"description": "The resource names of the people to provide information about.\n\n- To get information about the authenticated user, specify `people/me`.\n- To get information about a google account, specify\n `people/`\u003cvar\u003eaccount_id\u003c/var\u003e.\n- To get information about a contact, specify the resource name that\n identifies the contact as returned by\n[`people.connections.list`](/people/api/rest/v1/people.connections/list).\n\nYou can include up to 50 resource names in one request.",
- "type": "string",
- "repeated": true
+ "type": "string"
}
},
"scopes": [
@@ -1481,38 +1623,20 @@
],
"flatPath": "v1/people:batchGet",
"id": "people.people.getBatchGet",
- "path": "v1/people:batchGet"
+ "path": "v1/people:batchGet",
+ "description": "Provides information about a list of specific people by specifying a list\nof requested resource names. Use `people/me` to indicate the authenticated\nuser.\n\u003cbr\u003e\nThe request throws a 400 error if 'personFields' is not specified."
},
"get": {
+ "path": "v1/{+resourceName}",
+ "id": "people.people.get",
"description": "Provides information about a person by specifying a resource name. Use\n`people/me` to indicate the authenticated user.\n\u003cbr\u003e\nThe request throws a 400 error if 'personFields' is not specified.",
- "httpMethod": "GET",
- "parameterOrder": [
- "resourceName"
- ],
"response": {
"$ref": "Person"
},
- "parameters": {
- "resourceName": {
- "pattern": "^people/[^/]+$",
- "location": "path",
- "description": "The resource name of the person to provide information about.\n\n- To get information about the authenticated user, specify `people/me`.\n- To get information about a google account, specify\n `people/`\u003cvar\u003eaccount_id\u003c/var\u003e.\n- To get information about a contact, specify the resource name that\n identifies the contact as returned by\n[`people.connections.list`](/people/api/rest/v1/people.connections/list).",
- "required": true,
- "type": "string"
- },
- "personFields": {
- "location": "query",
- "description": "**Required.** A field mask to restrict which fields on the person are\nreturned. Valid values are:\n\n* addresses\n* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* emailAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* memberships\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n* residences\n* skills\n* taglines\n* urls",
- "format": "google-fieldmask",
- "type": "string"
- },
- "requestMask.includeField": {
- "location": "query",
- "description": "**Required.** Comma-separated list of person fields to be included in the\nresponse. Each path should start with `person.`: for example,\n`person.names` or `person.photos`.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
+ "parameterOrder": [
+ "resourceName"
+ ],
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/contacts",
"https://www.googleapis.com/auth/contacts.readonly",
@@ -1524,34 +1648,46 @@
"https://www.googleapis.com/auth/userinfo.email",
"https://www.googleapis.com/auth/userinfo.profile"
],
- "flatPath": "v1/people/{peopleId}",
- "id": "people.people.get",
- "path": "v1/{+resourceName}"
- },
- "updateContact": {
- "response": {
- "$ref": "Person"
- },
- "parameterOrder": [
- "resourceName"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/contacts"
- ],
"parameters": {
"resourceName": {
- "description": "The resource name for the person, assigned by the server. An ASCII string\nwith a max length of 27 characters, in the form of\n`people/`\u003cvar\u003eperson_id\u003c/var\u003e.",
+ "description": "The resource name of the person to provide information about.\n\n- To get information about the authenticated user, specify `people/me`.\n- To get information about a google account, specify\n `people/`\u003cvar\u003eaccount_id\u003c/var\u003e.\n- To get information about a contact, specify the resource name that\n identifies the contact as returned by\n[`people.connections.list`](/people/api/rest/v1/people.connections/list).",
"required": true,
"type": "string",
"pattern": "^people/[^/]+$",
"location": "path"
},
- "updatePersonFields": {
- "description": "**Required.** A field mask to restrict which fields on the person are\nupdated. Valid values are:\n\n* addresses\n* biographies\n* birthdays\n* braggingRights\n* emailAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* relations\n* residences\n* skills\n* urls",
+ "personFields": {
+ "description": "**Required.** A field mask to restrict which fields on the person are\nreturned. Valid values are:\n\n* addresses\n* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* emailAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* memberships\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n* residences\n* skills\n* taglines\n* urls",
"format": "google-fieldmask",
"type": "string",
"location": "query"
+ },
+ "requestMask.includeField": {
+ "description": "**Required.** Comma-separated list of person fields to be included in the\nresponse. Each path should start with `person.`: for example,\n`person.names` or `person.photos`.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/people/{peopleId}"
+ },
+ "updateContact": {
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts"
+ ],
+ "parameters": {
+ "resourceName": {
+ "pattern": "^people/[^/]+$",
+ "location": "path",
+ "description": "The resource name for the person, assigned by the server. An ASCII string\nwith a max length of 27 characters, in the form of\n`people/`\u003cvar\u003eperson_id\u003c/var\u003e.",
+ "required": true,
+ "type": "string"
+ },
+ "updatePersonFields": {
+ "location": "query",
+ "description": "**Required.** A field mask to restrict which fields on the person are\nupdated. Valid values are:\n\n* addresses\n* biographies\n* birthdays\n* braggingRights\n* emailAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* relations\n* residences\n* skills\n* urls",
+ "format": "google-fieldmask",
+ "type": "string"
}
},
"flatPath": "v1/people/{peopleId}:updateContact",
@@ -1560,86 +1696,67 @@
"description": "Update contact data for an existing contact person. Any non-contact data\nwill not be modified.\n\nThe request throws a 400 error if `updatePersonFields` is not specified.\n\u003cbr\u003e\nThe request throws a 400 error if `person.metadata.sources` is not\nspecified for the contact to be updated.\n\u003cbr\u003e\nThe request throws a 412 error if `person.metadata.sources.etag` is\ndifferent than the contact's etag, which indicates the contact has changed\nsince its data was read. Clients should get the latest person and re-apply\ntheir updates to the latest person.",
"request": {
"$ref": "Person"
- }
- },
- "createContact": {
- "flatPath": "v1/people:createContact",
- "id": "people.people.createContact",
- "path": "v1/people:createContact",
- "request": {
- "$ref": "Person"
},
- "description": "Create a new contact and return the person resource for that contact.",
- "httpMethod": "POST",
- "parameterOrder": [],
"response": {
"$ref": "Person"
},
- "parameters": {
- "parent": {
- "description": "The resource name of the owning person resource.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/contacts"
- ]
- },
- "deleteContact": {
- "description": "Delete a contact person. Any non-contact data will not be deleted.",
- "response": {
- "$ref": "Empty"
- },
"parameterOrder": [
"resourceName"
],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/contacts"
- ],
- "parameters": {
- "resourceName": {
- "pattern": "^people/[^/]+$",
- "location": "path",
- "description": "The resource name of the contact to delete.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/people/{peopleId}:deleteContact",
- "path": "v1/{+resourceName}:deleteContact",
- "id": "people.people.deleteContact"
+ "httpMethod": "PATCH"
}
},
"resources": {
"connections": {
"methods": {
"list": {
+ "description": "Provides a list of the authenticated user's contacts merged with any\nconnected profiles.\n\u003cbr\u003e\nThe request throws a 400 error if 'personFields' is not specified.",
+ "httpMethod": "GET",
"response": {
"$ref": "ListConnectionsResponse"
},
"parameterOrder": [
"resourceName"
],
- "httpMethod": "GET",
"parameters": {
+ "personFields": {
+ "description": "**Required.** A field mask to restrict which fields on each person are\nreturned. Valid values are:\n\n* addresses\n* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* emailAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* memberships\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n* residences\n* skills\n* taglines\n* urls",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ },
+ "sortOrder": {
+ "description": "The order in which the connections should be sorted. Defaults to\n`LAST_MODIFIED_ASCENDING`.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "LAST_MODIFIED_ASCENDING",
+ "FIRST_NAME_ASCENDING",
+ "LAST_NAME_ASCENDING"
+ ]
+ },
"requestSyncToken": {
"location": "query",
"description": "Whether the response should include a sync token, which can be used to get\nall changes since the last request.",
"type": "boolean"
},
+ "resourceName": {
+ "pattern": "^people/[^/]+$",
+ "location": "path",
+ "description": "The resource name to return connections for. Only `people/me` is valid.",
+ "required": true,
+ "type": "string"
+ },
"pageToken": {
"description": "The token of the page to be returned.",
"type": "string",
"location": "query"
},
- "resourceName": {
- "description": "The resource name to return connections for. Only `people/me` is valid.",
- "required": true,
- "type": "string",
- "pattern": "^people/[^/]+$",
- "location": "path"
+ "requestMask.includeField": {
+ "location": "query",
+ "description": "**Required.** Comma-separated list of person fields to be included in the\nresponse. Each path should start with `person.`: for example,\n`person.names` or `person.photos`.",
+ "format": "google-fieldmask",
+ "type": "string"
},
"pageSize": {
"location": "query",
@@ -1647,32 +1764,10 @@
"format": "int32",
"type": "integer"
},
- "requestMask.includeField": {
- "description": "**Required.** Comma-separated list of person fields to be included in the\nresponse. Each path should start with `person.`: for example,\n`person.names` or `person.photos`.",
- "format": "google-fieldmask",
+ "syncToken": {
+ "description": "A sync token, returned by a previous call to `people.connections.list`.\nOnly resources changed since the sync token was created will be returned.",
"type": "string",
"location": "query"
- },
- "syncToken": {
- "location": "query",
- "description": "A sync token, returned by a previous call to `people.connections.list`.\nOnly resources changed since the sync token was created will be returned.",
- "type": "string"
- },
- "personFields": {
- "location": "query",
- "description": "**Required.** A field mask to restrict which fields on each person are\nreturned. Valid values are:\n\n* addresses\n* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* emailAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* memberships\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n* residences\n* skills\n* taglines\n* urls",
- "format": "google-fieldmask",
- "type": "string"
- },
- "sortOrder": {
- "location": "query",
- "enum": [
- "LAST_MODIFIED_ASCENDING",
- "FIRST_NAME_ASCENDING",
- "LAST_NAME_ASCENDING"
- ],
- "description": "The order in which the connections should be sorted. Defaults to\n`LAST_MODIFIED_ASCENDING`.",
- "type": "string"
}
},
"scopes": [
@@ -1680,9 +1775,8 @@
"https://www.googleapis.com/auth/contacts.readonly"
],
"flatPath": "v1/people/{peopleId}/connections",
- "path": "v1/{+resourceName}/connections",
"id": "people.people.connections.list",
- "description": "Provides a list of the authenticated user's contacts merged with any\nconnected profiles.\n\u003cbr\u003e\nThe request throws a 400 error if 'personFields' is not specified."
+ "path": "v1/{+resourceName}/connections"
}
}
}
@@ -1690,7 +1784,88 @@
},
"contactGroups": {
"methods": {
+ "batchGet": {
+ "path": "v1/contactGroups:batchGet",
+ "id": "people.contactGroups.batchGet",
+ "description": "Get a list of contact groups owned by the authenticated user by specifying\na list of contact group resource names.",
+ "response": {
+ "$ref": "BatchGetContactGroupsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts",
+ "https://www.googleapis.com/auth/contacts.readonly"
+ ],
+ "parameters": {
+ "maxMembers": {
+ "location": "query",
+ "description": "Specifies the maximum number of members to return for each group.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "resourceNames": {
+ "description": "The resource names of the contact groups to get.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/contactGroups:batchGet"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "resourceName"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "resourceName": {
+ "pattern": "^contactGroups/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the contact group to delete.",
+ "required": true,
+ "type": "string"
+ },
+ "deleteContacts": {
+ "description": "Set to true to also delete the contacts in the specified group.",
+ "type": "boolean",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts"
+ ],
+ "flatPath": "v1/contactGroups/{contactGroupsId}",
+ "path": "v1/{+resourceName}",
+ "id": "people.contactGroups.delete",
+ "description": "Delete an existing contact group owned by the authenticated user by\nspecifying a contact group resource name."
+ },
"list": {
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts",
+ "https://www.googleapis.com/auth/contacts.readonly"
+ ],
+ "parameters": {
+ "syncToken": {
+ "location": "query",
+ "description": "A sync token, returned by a previous call to `contactgroups.list`.\nOnly resources changed since the sync token was created will be returned.",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The next_page_token value returned from a previous call to\n[ListContactGroups](/people/api/rest/v1/contactgroups/list).\nRequests the next page of resources.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The maximum number of resources to return.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
"flatPath": "v1/contactGroups",
"path": "v1/contactGroups",
"id": "people.contactGroups.list",
@@ -1699,31 +1874,13 @@
"$ref": "ListContactGroupsResponse"
},
"parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "The next_page_token value returned from a previous call to\n[ListContactGroups](/people/api/rest/v1/contactgroups/list).\nRequests the next page of resources.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "The maximum number of resources to return.",
- "format": "int32",
- "type": "integer"
- },
- "syncToken": {
- "description": "A sync token, returned by a previous call to `contactgroups.list`.\nOnly resources changed since the sync token was created will be returned.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/contacts",
- "https://www.googleapis.com/auth/contacts.readonly"
- ]
+ "httpMethod": "GET"
},
"create": {
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts"
+ ],
"flatPath": "v1/contactGroups",
"id": "people.contactGroups.create",
"path": "v1/contactGroups",
@@ -1735,45 +1892,47 @@
"parameterOrder": [],
"response": {
"$ref": "ContactGroup"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/contacts"
- ]
+ }
},
"get": {
- "description": "Get a specific contact group owned by the authenticated user by specifying\na contact group resource name.",
+ "httpMethod": "GET",
"response": {
"$ref": "ContactGroup"
},
"parameterOrder": [
"resourceName"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/contacts",
- "https://www.googleapis.com/auth/contacts.readonly"
- ],
"parameters": {
- "maxMembers": {
- "description": "Specifies the maximum number of members to return.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
"resourceName": {
"description": "The resource name of the contact group to get.",
"required": true,
"type": "string",
"pattern": "^contactGroups/[^/]+$",
"location": "path"
+ },
+ "maxMembers": {
+ "location": "query",
+ "description": "Specifies the maximum number of members to return.",
+ "format": "int32",
+ "type": "integer"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts",
+ "https://www.googleapis.com/auth/contacts.readonly"
+ ],
"flatPath": "v1/contactGroups/{contactGroupsId}",
+ "id": "people.contactGroups.get",
"path": "v1/{+resourceName}",
- "id": "people.contactGroups.get"
+ "description": "Get a specific contact group owned by the authenticated user by specifying\na contact group resource name."
},
"update": {
+ "path": "v1/{+resourceName}",
+ "id": "people.contactGroups.update",
+ "description": "Update the name of an existing contact group owned by the authenticated\nuser.",
+ "request": {
+ "$ref": "UpdateContactGroupRequest"
+ },
"response": {
"$ref": "ContactGroup"
},
@@ -1781,6 +1940,9 @@
"resourceName"
],
"httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts"
+ ],
"parameters": {
"resourceName": {
"description": "The resource name for the contact group, assigned by the server. An ASCII\nstring, in the form of `contactGroups/`\u003cvar\u003econtact_group_id\u003c/var\u003e.",
@@ -1790,205 +1952,43 @@
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/contacts"
- ],
- "flatPath": "v1/contactGroups/{contactGroupsId}",
- "path": "v1/{+resourceName}",
- "id": "people.contactGroups.update",
- "request": {
- "$ref": "UpdateContactGroupRequest"
- },
- "description": "Update the name of an existing contact group owned by the authenticated\nuser."
- },
- "batchGet": {
- "description": "Get a list of contact groups owned by the authenticated user by specifying\na list of contact group resource names.",
- "httpMethod": "GET",
- "parameterOrder": [],
- "response": {
- "$ref": "BatchGetContactGroupsResponse"
- },
- "parameters": {
- "resourceNames": {
- "description": "The resource names of the contact groups to get.",
- "type": "string",
- "repeated": true,
- "location": "query"
- },
- "maxMembers": {
- "location": "query",
- "description": "Specifies the maximum number of members to return for each group.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/contacts",
- "https://www.googleapis.com/auth/contacts.readonly"
- ],
- "flatPath": "v1/contactGroups:batchGet",
- "id": "people.contactGroups.batchGet",
- "path": "v1/contactGroups:batchGet"
- },
- "delete": {
- "flatPath": "v1/contactGroups/{contactGroupsId}",
- "path": "v1/{+resourceName}",
- "id": "people.contactGroups.delete",
- "description": "Delete an existing contact group owned by the authenticated user by\nspecifying a contact group resource name.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "resourceName"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "resourceName": {
- "location": "path",
- "description": "The resource name of the contact group to delete.",
- "required": true,
- "type": "string",
- "pattern": "^contactGroups/[^/]+$"
- },
- "deleteContacts": {
- "description": "Set to true to also delete the contacts in the specified group.",
- "type": "boolean",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/contacts"
- ]
+ "flatPath": "v1/contactGroups/{contactGroupsId}"
}
},
"resources": {
"members": {
"methods": {
"modify": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resourceName"
- ],
"response": {
"$ref": "ModifyContactGroupMembersResponse"
},
- "parameters": {
- "resourceName": {
- "location": "path",
- "description": "The resource name of the contact group to modify.",
- "required": true,
- "type": "string",
- "pattern": "^contactGroups/[^/]+$"
- }
- },
+ "parameterOrder": [
+ "resourceName"
+ ],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/contacts"
],
+ "parameters": {
+ "resourceName": {
+ "description": "The resource name of the contact group to modify.",
+ "required": true,
+ "type": "string",
+ "pattern": "^contactGroups/[^/]+$",
+ "location": "path"
+ }
+ },
"flatPath": "v1/contactGroups/{contactGroupsId}/members:modify",
- "id": "people.contactGroups.members.modify",
"path": "v1/{+resourceName}/members:modify",
+ "id": "people.contactGroups.members.modify",
+ "description": "Modify the members of a contact group owned by the authenticated user.",
"request": {
"$ref": "ModifyContactGroupMembersRequest"
- },
- "description": "Modify the members of a contact group owned by the authenticated user."
+ }
}
}
}
}
}
- },
- "parameters": {
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "alt": {
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- }
- },
- "version": "v1",
- "baseUrl": "https://people.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Provides access to information about profiles and contacts.",
- "servicePath": "",
- "basePath": ""
+ }
}
diff --git a/playmoviespartner/v1/playmoviespartner-api.json b/playmoviespartner/v1/playmoviespartner-api.json
index 9a75a4b..1bf0439 100644
--- a/playmoviespartner/v1/playmoviespartner-api.json
+++ b/playmoviespartner/v1/playmoviespartner-api.json
@@ -1,7 +1,7 @@
{
"title": "Google Play Movies Partner API",
- "discoveryVersion": "v1",
"ownerName": "Google",
+ "discoveryVersion": "v1",
"resources": {
"accounts": {
"resources": {
@@ -15,28 +15,15 @@
"accountId"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/playmovies_partner.readonly"
+ ],
"parameters": {
- "videoIds": {
- "description": "Filter Orders that match any of the given `video_id`s.",
- "type": "string",
- "repeated": true,
- "location": "query"
- },
- "customId": {
- "description": "Filter Orders that match a case-insensitive, partner-specific custom id.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "description": "See _List methods rules_ for info about this field.",
- "type": "string",
- "location": "query"
- },
"pageSize": {
+ "location": "query",
"format": "int32",
"description": "See _List methods rules_ for info about this field.",
- "type": "integer",
- "location": "query"
+ "type": "integer"
},
"pphNames": {
"description": "See _List methods rules_ for info about this field.",
@@ -58,50 +45,64 @@
"STATUS_NOT_AVAILABLE"
]
},
- "name": {
- "description": "Filter that matches Orders with a `name`, `show`, `season` or `episode`\nthat contains the given case-insensitive name.",
- "type": "string",
- "location": "query"
- },
"studioNames": {
"description": "See _List methods rules_ for info about this field.",
"type": "string",
"repeated": true,
"location": "query"
},
+ "name": {
+ "location": "query",
+ "description": "Filter that matches Orders with a `name`, `show`, `season` or `episode`\nthat contains the given case-insensitive name.",
+ "type": "string"
+ },
"accountId": {
+ "location": "path",
"description": "REQUIRED. See _General rules_ for more information about this field.",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
+ },
+ "pageToken": {
+ "description": "See _List methods rules_ for info about this field.",
+ "type": "string",
+ "location": "query"
+ },
+ "customId": {
+ "location": "query",
+ "description": "Filter Orders that match a case-insensitive, partner-specific custom id.",
+ "type": "string"
+ },
+ "videoIds": {
+ "location": "query",
+ "description": "Filter Orders that match any of the given `video_id`s.",
+ "type": "string",
+ "repeated": true
}
},
- "scopes": [
- "https://www.googleapis.com/auth/playmovies_partner.readonly"
- ],
"flatPath": "v1/accounts/{accountId}/orders",
"id": "playmoviespartner.accounts.orders.list",
"path": "v1/accounts/{accountId}/orders",
"description": "List Orders owned or managed by the partner.\n\nSee _Authentication and Authorization rules_ and\n_List methods rules_ for more information about this method."
},
"get": {
- "httpMethod": "GET",
+ "description": "Get an Order given its id.\n\nSee _Authentication and Authorization rules_ and\n_Get methods rules_ for more information about this method.",
+ "response": {
+ "$ref": "Order"
+ },
"parameterOrder": [
"accountId",
"orderId"
],
- "response": {
- "$ref": "Order"
- },
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/playmovies_partner.readonly"
],
"parameters": {
"orderId": {
- "location": "path",
"description": "REQUIRED. Order ID.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
},
"accountId": {
"location": "path",
@@ -111,56 +112,54 @@
}
},
"flatPath": "v1/accounts/{accountId}/orders/{orderId}",
- "path": "v1/accounts/{accountId}/orders/{orderId}",
"id": "playmoviespartner.accounts.orders.get",
- "description": "Get an Order given its id.\n\nSee _Authentication and Authorization rules_ and\n_Get methods rules_ for more information about this method."
+ "path": "v1/accounts/{accountId}/orders/{orderId}"
}
}
},
"avails": {
"methods": {
"list": {
- "flatPath": "v1/accounts/{accountId}/avails",
- "id": "playmoviespartner.accounts.avails.list",
- "path": "v1/accounts/{accountId}/avails",
- "description": "List Avails owned or managed by the partner.\n\nSee _Authentication and Authorization rules_ and\n_List methods rules_ for more information about this method.",
- "response": {
- "$ref": "ListAvailsResponse"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"accountId"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "ListAvailsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/playmovies_partner.readonly"
+ ],
"parameters": {
"pageSize": {
- "location": "query",
"format": "int32",
"description": "See _List methods rules_ for info about this field.",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
},
"altIds": {
+ "location": "query",
"description": "Filter Avails that match (case-insensitive) any of the given partner-specific custom ids.",
"type": "string",
+ "repeated": true
+ },
+ "pphNames": {
+ "description": "See _List methods rules_ for info about this field.",
+ "type": "string",
"repeated": true,
"location": "query"
},
- "pphNames": {
+ "altId": {
+ "location": "query",
+ "description": "Filter Avails that match a case-insensitive, partner-specific custom id.\nNOTE: this field is deprecated and will be removed on V2; `alt_ids`\nshould be used instead.",
+ "type": "string"
+ },
+ "studioNames": {
"location": "query",
"description": "See _List methods rules_ for info about this field.",
"type": "string",
"repeated": true
},
- "altId": {
- "description": "Filter Avails that match a case-insensitive, partner-specific custom id.\nNOTE: this field is deprecated and will be removed on V2; `alt_ids`\nshould be used instead.",
- "type": "string",
- "location": "query"
- },
- "studioNames": {
- "description": "See _List methods rules_ for info about this field.",
- "type": "string",
- "repeated": true,
- "location": "query"
- },
"accountId": {
"location": "path",
"description": "REQUIRED. See _General rules_ for more information about this field.",
@@ -168,31 +167,32 @@
"required": true
},
"territories": {
- "location": "query",
"description": "Filter Avails that match (case-insensitive) any of the given country codes,\nusing the \"ISO 3166-1 alpha-2\" format (examples: \"US\", \"us\", \"Us\").",
"type": "string",
- "repeated": true
- },
- "title": {
- "location": "query",
- "description": "Filter that matches Avails with a `title_internal_alias`,\n`series_title_internal_alias`, `season_title_internal_alias`,\nor `episode_title_internal_alias` that contains the given\ncase-insensitive title.",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "See _List methods rules_ for info about this field.",
- "type": "string"
- },
- "videoIds": {
- "description": "Filter Avails that match any of the given `video_id`s.",
- "type": "string",
"repeated": true,
"location": "query"
+ },
+ "title": {
+ "description": "Filter that matches Avails with a `title_internal_alias`,\n`series_title_internal_alias`, `season_title_internal_alias`,\nor `episode_title_internal_alias` that contains the given\ncase-insensitive title.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "description": "See _List methods rules_ for info about this field.",
+ "type": "string",
+ "location": "query"
+ },
+ "videoIds": {
+ "location": "query",
+ "description": "Filter Avails that match any of the given `video_id`s.",
+ "type": "string",
+ "repeated": true
}
},
- "scopes": [
- "https://www.googleapis.com/auth/playmovies_partner.readonly"
- ]
+ "flatPath": "v1/accounts/{accountId}/avails",
+ "path": "v1/accounts/{accountId}/avails",
+ "id": "playmoviespartner.accounts.avails.list",
+ "description": "List Avails owned or managed by the partner.\n\nSee _Authentication and Authorization rules_ and\n_List methods rules_ for more information about this method."
},
"get": {
"description": "Get an Avail given its avail group id and avail id.",
@@ -208,17 +208,17 @@
"https://www.googleapis.com/auth/playmovies_partner.readonly"
],
"parameters": {
- "accountId": {
- "location": "path",
- "description": "REQUIRED. See _General rules_ for more information about this field.",
- "type": "string",
- "required": true
- },
"availId": {
- "location": "path",
"description": "REQUIRED. Avail ID.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
+ },
+ "accountId": {
+ "description": "REQUIRED. See _General rules_ for more information about this field.",
+ "type": "string",
+ "required": true,
+ "location": "path"
}
},
"flatPath": "v1/accounts/{accountId}/avails/{availId}",
@@ -230,9 +230,6 @@
"storeInfos": {
"methods": {
"list": {
- "flatPath": "v1/accounts/{accountId}/storeInfos",
- "id": "playmoviespartner.accounts.storeInfos.list",
- "path": "v1/accounts/{accountId}/storeInfos",
"description": "List StoreInfos owned or managed by the partner.\n\nSee _Authentication and Authorization rules_ and\n_List methods rules_ for more information about this method.",
"response": {
"$ref": "ListStoreInfosResponse"
@@ -241,50 +238,65 @@
"accountId"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/playmovies_partner.readonly"
+ ],
"parameters": {
+ "accountId": {
+ "description": "REQUIRED. See _General rules_ for more information about this field.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
"seasonIds": {
- "location": "query",
"description": "Filter StoreInfos that match any of the given `season_id`s.",
"type": "string",
- "repeated": true
- },
- "pageToken": {
- "description": "See _List methods rules_ for info about this field.",
- "type": "string",
+ "repeated": true,
"location": "query"
},
+ "videoIds": {
+ "location": "query",
+ "description": "Filter StoreInfos that match any of the given `video_id`s.",
+ "type": "string",
+ "repeated": true
+ },
"videoId": {
"description": "Filter StoreInfos that match a given `video_id`.\nNOTE: this field is deprecated and will be removed on V2; `video_ids`\nshould be used instead.",
"type": "string",
"location": "query"
},
- "videoIds": {
- "description": "Filter StoreInfos that match any of the given `video_id`s.",
+ "pageToken": {
+ "description": "See _List methods rules_ for info about this field.",
"type": "string",
- "repeated": true,
"location": "query"
},
"pageSize": {
- "location": "query",
"format": "int32",
"description": "See _List methods rules_ for info about this field.",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
},
"mids": {
+ "location": "query",
"description": "Filter StoreInfos that match any of the given `mid`s.",
"type": "string",
- "repeated": true,
- "location": "query"
+ "repeated": true
},
"pphNames": {
+ "location": "query",
"description": "See _List methods rules_ for info about this field.",
"type": "string",
- "repeated": true,
- "location": "query"
+ "repeated": true
},
"countries": {
+ "location": "query",
"description": "Filter StoreInfos that match (case-insensitive) any of the given country\ncodes, using the \"ISO 3166-1 alpha-2\" format (examples: \"US\", \"us\", \"Us\").",
"type": "string",
+ "repeated": true
+ },
+ "studioNames": {
+ "description": "See _List methods rules_ for info about this field.",
+ "type": "string",
"repeated": true,
"location": "query"
},
@@ -292,29 +304,21 @@
"location": "query",
"description": "Filter that matches StoreInfos with a `name` or `show_name`\nthat contains the given case-insensitive name.",
"type": "string"
- },
- "studioNames": {
- "description": "See _List methods rules_ for info about this field.",
- "type": "string",
- "repeated": true,
- "location": "query"
- },
- "accountId": {
- "description": "REQUIRED. See _General rules_ for more information about this field.",
- "type": "string",
- "required": true,
- "location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/playmovies_partner.readonly"
- ]
+ "flatPath": "v1/accounts/{accountId}/storeInfos",
+ "id": "playmoviespartner.accounts.storeInfos.list",
+ "path": "v1/accounts/{accountId}/storeInfos"
}
},
"resources": {
"country": {
"methods": {
"get": {
+ "flatPath": "v1/accounts/{accountId}/storeInfos/{videoId}/country/{country}",
+ "path": "v1/accounts/{accountId}/storeInfos/{videoId}/country/{country}",
+ "id": "playmoviespartner.accounts.storeInfos.country.get",
+ "description": "Get a StoreInfo given its video id and country.\n\nSee _Authentication and Authorization rules_ and\n_Get methods rules_ for more information about this method.",
"httpMethod": "GET",
"parameterOrder": [
"accountId",
@@ -329,16 +333,16 @@
],
"parameters": {
"accountId": {
+ "location": "path",
"description": "REQUIRED. See _General rules_ for more information about this field.",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
},
"country": {
+ "location": "path",
"description": "REQUIRED. Edit country.",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
},
"videoId": {
"location": "path",
@@ -346,11 +350,7 @@
"type": "string",
"required": true
}
- },
- "flatPath": "v1/accounts/{accountId}/storeInfos/{videoId}/country/{country}",
- "path": "v1/accounts/{accountId}/storeInfos/{videoId}/country/{country}",
- "id": "playmoviespartner.accounts.storeInfos.country.get",
- "description": "Get a StoreInfo given its video id and country.\n\nSee _Authentication and Authorization rules_ and\n_Get methods rules_ for more information about this method."
+ }
}
}
}
@@ -360,6 +360,27 @@
}
},
"parameters": {
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
"callback": {
"location": "query",
"description": "JSONP",
@@ -379,12 +400,6 @@
]
},
"alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -392,7 +407,13 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json"
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string"
},
"access_token": {
"description": "OAuth access token.",
@@ -400,20 +421,20 @@
"location": "query"
},
"key": {
+ "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"quotaUser": {
+ "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pp": {
+ "location": "query",
"description": "Pretty-print response.",
"default": "true",
- "type": "boolean",
- "location": "query"
+ "type": "boolean"
},
"oauth_token": {
"location": "query",
@@ -424,27 +445,6 @@
"description": "OAuth bearer token.",
"type": "string",
"location": "query"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
- },
- "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"
}
},
"schemas": {
@@ -452,6 +452,27 @@
"description": "An Order tracks the fulfillment of an Edit when delivered using the\nlegacy, non-component-based delivery.\n\nEach Order is uniquely identified by an `order_id`, which is generated\nby Google.\n\nExternally, Orders can also be identified by partners using its `custom_id`\n(when provided).",
"type": "object",
"properties": {
+ "seasonName": {
+ "description": "Default Season name,\nusually in the language of the country of origin.\nOnly available for TV Edits\nExample: \"Googlers, The - A Brave New World\".",
+ "type": "string"
+ },
+ "customId": {
+ "description": "ID that can be used to externally identify an Order.\nThis ID is provided by partners when submitting the Avails.\nExample: 'GOOGLER_2006'",
+ "type": "string"
+ },
+ "channelName": {
+ "description": "YouTube Channel Name that should be used to fulfill the Order.\nExample: \"Google_channel\".",
+ "type": "string"
+ },
+ "approvedTime": {
+ "format": "google-datetime",
+ "description": "Timestamp when the Order was approved.",
+ "type": "string"
+ },
+ "showName": {
+ "description": "Default Show name,\nusually in the language of the country of origin.\nOnly available for TV Edits\nExample: \"Googlers, The\".",
+ "type": "string"
+ },
"normalizedPriority": {
"enumDescriptions": [
"Value could not be determined, please contact technical support if\nit should.",
@@ -535,6 +556,8 @@
"type": "string"
},
"status": {
+ "description": "High-level status of the order.",
+ "type": "string",
"enumDescriptions": [
"Value could not be determined, please contact technical support if\nit should.",
"Approved by Google.",
@@ -550,11 +573,11 @@
"STATUS_PROCESSING",
"STATUS_UNFULFILLED",
"STATUS_NOT_AVAILABLE"
- ],
- "description": "High-level status of the order.",
- "type": "string"
+ ]
},
"statusDetail": {
+ "description": "Detailed status of the order",
+ "type": "string",
"enumDescriptions": [
"Value could not be determined, please contact technical support if\nit should.",
"Approved by Google's Quality Control team.",
@@ -576,9 +599,7 @@
"ORDER_STATUS_AWAITING_REDELIVERY",
"ORDER_STATUS_READY_FOR_QC",
"ORDER_STATUS_FILE_PROCESSING"
- ],
- "description": "Detailed status of the order",
- "type": "string"
+ ]
},
"name": {
"description": "Default Edit name,\nusually in the language of the country of origin.\nExample: \"Googlers, The\".",
@@ -592,27 +613,6 @@
"format": "google-datetime",
"description": "Timestamp when the Order was fulfilled.",
"type": "string"
- },
- "seasonName": {
- "description": "Default Season name,\nusually in the language of the country of origin.\nOnly available for TV Edits\nExample: \"Googlers, The - A Brave New World\".",
- "type": "string"
- },
- "customId": {
- "description": "ID that can be used to externally identify an Order.\nThis ID is provided by partners when submitting the Avails.\nExample: 'GOOGLER_2006'",
- "type": "string"
- },
- "channelName": {
- "description": "YouTube Channel Name that should be used to fulfill the Order.\nExample: \"Google_channel\".",
- "type": "string"
- },
- "approvedTime": {
- "format": "google-datetime",
- "description": "Timestamp when the Order was approved.",
- "type": "string"
- },
- "showName": {
- "description": "Default Show name,\nusually in the language of the country of origin.\nOnly available for TV Edits\nExample: \"Googlers, The\".",
- "type": "string"
}
},
"id": "Order"
@@ -667,50 +667,6 @@
"description": "Information about a playable sequence (video) associated with an Edit\nand available at the Google Play Store.\n\nInternally, each StoreInfo is uniquely identified by a `video_id`\nand `country`.\n\nExternally, Title-level EIDR or Edit-level EIDR, if provided,\ncan also be used to identify a specific title or edit in a country.",
"type": "object",
"properties": {
- "hasEstOffer": {
- "description": "Whether the Edit has a EST offer.",
- "type": "boolean"
- },
- "editLevelEidr": {
- "description": "Edit-level EIDR ID.\nExample: \"10.5240/1489-49A2-3956-4B2D-FE16-6\".",
- "type": "string"
- },
- "hasSdOffer": {
- "description": "Whether the Edit has a SD offer.",
- "type": "boolean"
- },
- "videoId": {
- "description": "Google-generated ID identifying the video linked to the Edit.\nExample: 'gtry456_xc'",
- "type": "string"
- },
- "liveTime": {
- "format": "google-datetime",
- "description": "Timestamp when the Edit went live on the Store.",
- "type": "string"
- },
- "hasInfoCards": {
- "description": "Whether the Edit has info cards.",
- "type": "boolean"
- },
- "hasVodOffer": {
- "description": "Whether the Edit has a VOD offer.",
- "type": "boolean"
- },
- "pphNames": {
- "description": "Name of the post-production houses that manage the Edit.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "episodeNumber": {
- "description": "The number assigned to the episode within a season.\nOnly available on TV Edits.\nExample: \"1\".",
- "type": "string"
- },
- "studioName": {
- "description": "Name of the studio that owns the Edit ordered.",
- "type": "string"
- },
"subtitles": {
"description": "Subtitles available for this Edit.",
"items": {
@@ -738,6 +694,8 @@
"type": "string"
},
"type": {
+ "description": "Edit type, like Movie, Episode or Season.",
+ "type": "string",
"enumDescriptions": [
"Value could not be determined, please contact technical support if\nit should.",
"A movie picture.",
@@ -751,9 +709,7 @@
"SEASON",
"EPISODE",
"BUNDLE"
- ],
- "description": "Edit type, like Movie, Episode or Season.",
- "type": "string"
+ ]
},
"trailerId": {
"description": "Google-generated ID identifying the trailer linked to the Edit.\nExample: 'bhd_4e_cx'",
@@ -790,6 +746,50 @@
"seasonNumber": {
"description": "The number assigned to the season within a show.\nOnly available on TV Edits.\nExample: \"1\".",
"type": "string"
+ },
+ "editLevelEidr": {
+ "description": "Edit-level EIDR ID.\nExample: \"10.5240/1489-49A2-3956-4B2D-FE16-6\".",
+ "type": "string"
+ },
+ "hasEstOffer": {
+ "description": "Whether the Edit has a EST offer.",
+ "type": "boolean"
+ },
+ "hasSdOffer": {
+ "description": "Whether the Edit has a SD offer.",
+ "type": "boolean"
+ },
+ "liveTime": {
+ "format": "google-datetime",
+ "description": "Timestamp when the Edit went live on the Store.",
+ "type": "string"
+ },
+ "videoId": {
+ "description": "Google-generated ID identifying the video linked to the Edit.\nExample: 'gtry456_xc'",
+ "type": "string"
+ },
+ "hasInfoCards": {
+ "description": "Whether the Edit has info cards.",
+ "type": "boolean"
+ },
+ "hasVodOffer": {
+ "description": "Whether the Edit has a VOD offer.",
+ "type": "boolean"
+ },
+ "pphNames": {
+ "description": "Name of the post-production houses that manage the Edit.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "episodeNumber": {
+ "description": "The number assigned to the episode within a season.\nOnly available on TV Edits.\nExample: \"1\".",
+ "type": "string"
+ },
+ "studioName": {
+ "description": "Name of the studio that owns the Edit ordered.",
+ "type": "string"
}
},
"id": "StoreInfo"
@@ -798,6 +798,18 @@
"description": "An Avail describes the Availability Window of a specific Edit in a given\ncountry, which means the period Google is allowed to sell or rent the Edit.\n\nAvails are exposed in EMA format Version 1.6b (available at\nhttp://www.movielabs.com/md/avails/)\n\nStudios can see the Avails for the Titles they own.\nPost-production houses cannot see any Avails.",
"type": "object",
"properties": {
+ "releaseDate": {
+ "description": "Release date of the Title in earliest released territory.\nTypically it is just the year, but it is free-form as per EMA spec.\nExamples: \"1979\", \"Oct 2014\"",
+ "type": "string"
+ },
+ "end": {
+ "description": "End of term in YYYY-MM-DD format in the timezone of the country\nof the Avail.\n\"Open\" if no end date is available.\nExample: \"2019-02-17\"",
+ "type": "string"
+ },
+ "videoId": {
+ "description": "Google-generated ID identifying the video linked to this Avail, once\ndelivered.\nNot part of EMA Specs.\nExample: 'gtry456_xc'",
+ "type": "string"
+ },
"start": {
"description": "Start of term in YYYY-MM-DD format in the timezone of the\ncountry of the Avail.\nExample: \"2013-05-14\".",
"type": "string"
@@ -845,30 +857,30 @@
"description": "Indicates the format profile covered by the transaction.",
"type": "string"
},
- "contentId": {
- "description": "Title Identifier. This should be the Title Level EIDR.\nExample: \"10.5240/1489-49A2-3956-4B2D-FE16-5\".",
+ "ratingValue": {
+ "description": "Value representing the rating.\nRatings should be formatted as per http://www.movielabs.com/md/ratings/\nExample: \"PG\"",
"type": "string"
},
"titleInternalAlias": {
"description": "Title used by involved parties to refer to this content.\nExample: \"Googlers, The\".\nOnly available on Movie Avails.",
"type": "string"
},
- "ratingValue": {
- "description": "Value representing the rating.\nRatings should be formatted as per http://www.movielabs.com/md/ratings/\nExample: \"PG\"",
+ "contentId": {
+ "description": "Title Identifier. This should be the Title Level EIDR.\nExample: \"10.5240/1489-49A2-3956-4B2D-FE16-5\".",
"type": "string"
},
"storeLanguage": {
"description": "Spoken language of the intended audience.\nLanguage shall be encoded in accordance with RFC 5646.\nExample: \"fr\".",
"type": "string"
},
- "captionExemption": {
- "description": "Communicating an exempt category as defined by FCC regulations.\nIt is not required for non-US Avails.\nExample: \"1\"",
- "type": "string"
- },
"displayName": {
"description": "The name of the studio that owns the Edit referred in the Avail.\nThis is the equivalent of `studio_name` in other resources, but it follows\nthe EMA nomenclature.\nExample: \"Google Films\".",
"type": "string"
},
+ "captionExemption": {
+ "description": "Communicating an exempt category as defined by FCC regulations.\nIt is not required for non-US Avails.\nExample: \"1\"",
+ "type": "string"
+ },
"productId": {
"description": "Edit Identifier. This should be the Edit Level EIDR.\nExample: \"10.2340/1489-49A2-3956-4B2D-FE16-6\"",
"type": "string"
@@ -877,26 +889,18 @@
"description": "Title used by involved parties to refer to this season.\nOnly available on TV Avails.\nExample: \"Googlers, The\".",
"type": "string"
},
- "priceValue": {
- "description": "Value to be applied to the pricing type.\nExample: \"4\" or \"2.99\"",
- "type": "string"
- },
"episodeAltId": {
"description": "Other identifier referring to the episode, as defined by partner.\nOnly available on TV avails.\nExample: \"rs_googlers_s1_3\".",
"type": "string"
},
+ "priceValue": {
+ "description": "Value to be applied to the pricing type.\nExample: \"4\" or \"2.99\"",
+ "type": "string"
+ },
"territory": {
"description": "ISO 3166-1 alpha-2 country code for the country or territory\nof this Avail.\nFor Avails, we use Territory in lieu of Country to comply with\nEMA specifications.\nBut please note that Territory and Country identify the same thing.\nExample: \"US\".",
"type": "string"
},
- "ratingReason": {
- "description": "Value representing the rating reason.\nRating reasons should be formatted as per\n[EMA ratings spec](http://www.movielabs.com/md/ratings/)\nand comma-separated for inclusion of multiple reasons.\nExample: \"L, S, V\"",
- "type": "string"
- },
- "availId": {
- "description": "ID internally generated by Google to uniquely identify an Avail.\nNot part of EMA Specs.",
- "type": "string"
- },
"workType": {
"description": "Work type as enumerated in EMA.",
"type": "string",
@@ -915,6 +919,14 @@
"BUNDLE"
]
},
+ "availId": {
+ "description": "ID internally generated by Google to uniquely identify an Avail.\nNot part of EMA Specs.",
+ "type": "string"
+ },
+ "ratingReason": {
+ "description": "Value representing the rating reason.\nRating reasons should be formatted as per\n[EMA ratings spec](http://www.movielabs.com/md/ratings/)\nand comma-separated for inclusion of multiple reasons.\nExample: \"L, S, V\"",
+ "type": "string"
+ },
"episodeTitleInternalAlias": {
"description": "OPTIONAL.TV Only. Title used by involved parties to refer to this episode.\nOnly available on TV Avails.\nExample: \"Coding at Google\".",
"type": "string"
@@ -939,13 +951,7 @@
"description": "Communicating if caption file will be delivered.",
"type": "boolean"
},
- "seasonNumber": {
- "description": "The number assigned to the season within a series.\nOnly available on TV Avails.\nExample: \"1\".",
- "type": "string"
- },
"licenseType": {
- "description": "Type of transaction.",
- "type": "string",
"enumDescriptions": [
"Value could not be determined, please contact technical support if\nit should.",
"Electronic Sell Through - purchase policy for unlimited viewing.",
@@ -959,18 +965,12 @@
"VOD",
"SVOD",
"POEST"
- ]
- },
- "releaseDate": {
- "description": "Release date of the Title in earliest released territory.\nTypically it is just the year, but it is free-form as per EMA spec.\nExamples: \"1979\", \"Oct 2014\"",
+ ],
+ "description": "Type of transaction.",
"type": "string"
},
- "end": {
- "description": "End of term in YYYY-MM-DD format in the timezone of the country\nof the Avail.\n\"Open\" if no end date is available.\nExample: \"2019-02-17\"",
- "type": "string"
- },
- "videoId": {
- "description": "Google-generated ID identifying the video linked to this Avail, once\ndelivered.\nNot part of EMA Specs.\nExample: 'gtry456_xc'",
+ "seasonNumber": {
+ "description": "The number assigned to the season within a series.\nOnly available on TV Avails.\nExample: \"1\".",
"type": "string"
}
},
@@ -1000,11 +1000,11 @@
"id": "ListOrdersResponse"
}
},
+ "protocol": "rest",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
- "protocol": "rest",
"version": "v1",
"baseUrl": "https://playmoviespartner.googleapis.com/",
"canonicalName": "Play Movies",
@@ -1027,5 +1027,5 @@
"batchPath": "batch",
"id": "playmoviespartner:v1",
"documentationLink": "https://developers.google.com/playmoviespartner/",
- "revision": "20171003"
+ "revision": "20171010"
}
diff --git a/proximitybeacon/v1beta1/proximitybeacon-api.json b/proximitybeacon/v1beta1/proximitybeacon-api.json
index 8e3ddc4..1e54ec3 100644
--- a/proximitybeacon/v1beta1/proximitybeacon-api.json
+++ b/proximitybeacon/v1beta1/proximitybeacon-api.json
@@ -1,716 +1,5 @@
{
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "proximitybeacon",
- "batchPath": "batch",
- "id": "proximitybeacon:v1beta1",
- "documentationLink": "https://developers.google.com/beacons/proximity/",
- "revision": "20171003",
- "title": "Google Proximity Beacon API",
- "ownerName": "Google",
- "discoveryVersion": "v1",
- "version_module": true,
- "resources": {
- "beaconinfo": {
- "methods": {
- "getforobserved": {
- "description": "Given one or more beacon observations, returns any beacon information\nand attachments accessible to your application. Authorize by using the\n[API key](https://developers.google.com/beacons/proximity/get-started#request_a_browser_api_key)\nfor the application.",
- "request": {
- "$ref": "GetInfoForObservedBeaconsRequest"
- },
- "response": {
- "$ref": "GetInfoForObservedBeaconsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "flatPath": "v1beta1/beaconinfo:getforobserved",
- "id": "proximitybeacon.beaconinfo.getforobserved",
- "path": "v1beta1/beaconinfo:getforobserved"
- }
- }
- },
- "namespaces": {
- "methods": {
- "list": {
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "parameters": {
- "projectId": {
- "type": "string",
- "location": "query",
- "description": "The project id to list namespaces under.\nOptional."
- }
- },
- "flatPath": "v1beta1/namespaces",
- "id": "proximitybeacon.namespaces.list",
- "path": "v1beta1/namespaces",
- "description": "Lists all attachment namespaces owned by your Google Developers Console\nproject. Attachment data associated with a beacon must include a\nnamespaced type, and the namespace must be owned by your project.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project.",
- "response": {
- "$ref": "ListNamespacesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET"
- },
- "update": {
- "flatPath": "v1beta1/namespaces/{namespacesId}",
- "id": "proximitybeacon.namespaces.update",
- "path": "v1beta1/{+namespaceName}",
- "request": {
- "$ref": "Namespace"
- },
- "description": "Updates the information about the specified namespace. Only the namespace\nvisibility can be updated.",
- "response": {
- "$ref": "Namespace"
- },
- "parameterOrder": [
- "namespaceName"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "parameters": {
- "namespaceName": {
- "location": "path",
- "description": "Resource name of this namespace. Namespaces names have the format:\n\u003ccode\u003enamespaces/\u003cvar\u003enamespace\u003c/var\u003e\u003c/code\u003e.",
- "type": "string",
- "required": true,
- "pattern": "^namespaces/[^/]+$"
- },
- "projectId": {
- "location": "query",
- "description": "The project id of the namespace to update. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.",
- "type": "string"
- }
- }
- }
- }
- },
- "v1beta1": {
- "methods": {
- "getEidparams": {
- "description": "Gets the Proximity Beacon API's current public key and associated\nparameters used to initiate the Diffie-Hellman key exchange required to\nregister a beacon that broadcasts the Eddystone-EID format. This key\nchanges periodically; clients may cache it and re-use the same public key\nto provision and register multiple beacons. However, clients should be\nprepared to refresh this key when they encounter an error registering an\nEddystone-EID beacon.",
- "response": {
- "$ref": "EphemeralIdRegistrationParams"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "flatPath": "v1beta1/eidparams",
- "id": "proximitybeacon.getEidparams",
- "path": "v1beta1/eidparams"
- }
- }
- },
- "beacons": {
- "methods": {
- "decommission": {
- "description": "Decommissions the specified beacon in the service. This beacon will no\nlonger be returned from `beaconinfo.getforobserved`. This operation is\npermanent -- you will not be able to re-register a beacon with this ID\nagain.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
- "httpMethod": "POST",
- "parameterOrder": [
- "beaconName"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "projectId": {
- "description": "The project id of the beacon to decommission. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.",
- "type": "string",
- "location": "query"
- },
- "beaconName": {
- "location": "path",
- "description": "Beacon that should be decommissioned. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID of the beacon's \"stable\" UID.\nRequired.",
- "type": "string",
- "required": true,
- "pattern": "^beacons/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "flatPath": "v1beta1/beacons/{beaconsId}:decommission",
- "path": "v1beta1/{+beaconName}:decommission",
- "id": "proximitybeacon.beacons.decommission"
- },
- "deactivate": {
- "id": "proximitybeacon.beacons.deactivate",
- "path": "v1beta1/{+beaconName}:deactivate",
- "description": "Deactivates a beacon. Once deactivated, the API will not return\ninformation nor attachment data for the beacon when queried via\n`beaconinfo.getforobserved`. Calling this method on an already inactive\nbeacon will do nothing (but will return a successful response code).\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "beaconName"
- ],
- "httpMethod": "POST",
- "parameters": {
- "beaconName": {
- "location": "path",
- "description": "Beacon that should be deactivated. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
- "type": "string",
- "required": true,
- "pattern": "^beacons/[^/]+$"
- },
- "projectId": {
- "description": "The project id of the beacon to deactivate. If the project id is not\nspecified then the project making the request is used. The project id must\nmatch the project that owns the beacon.\nOptional.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "flatPath": "v1beta1/beacons/{beaconsId}:deactivate"
- },
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "beaconName"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "parameters": {
- "beaconName": {
- "type": "string",
- "required": true,
- "pattern": "^beacons/[^/]+$",
- "location": "path",
- "description": "Beacon that should be deleted. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired."
- },
- "projectId": {
- "description": "The project id of the beacon to delete. If not provided, the project\nthat is making the request is used.\nOptional.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1beta1/beacons/{beaconsId}",
- "path": "v1beta1/{+beaconName}",
- "id": "proximitybeacon.beacons.delete",
- "description": "Deletes the specified beacon including all diagnostics data for the beacon\nas well as any attachments on the beacon (including those belonging to\nother projects). This operation cannot be undone.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project."
- },
- "list": {
- "description": "Searches the beacon registry for beacons that match the given search\ncriteria. Only those beacons that the client has permission to list\nwill be returned.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project.",
- "httpMethod": "GET",
- "parameterOrder": [],
- "response": {
- "$ref": "ListBeaconsResponse"
- },
- "parameters": {
- "pageToken": {
- "description": "A pagination token obtained from a previous request to list beacons.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The maximum number of records to return for this request, up to a\nserver-defined upper limit.",
- "type": "integer"
- },
- "q": {
- "location": "query",
- "description": "Filter query string that supports the following field filters:\n\n* **description:`\"\u003cstring\u003e\"`**\n For example: **description:\"Room 3\"**\n Returns beacons whose description matches tokens in the string \"Room 3\"\n (not necessarily that exact string).\n The string must be double-quoted.\n* **status:`\u003cenum\u003e`**\n For example: **status:active**\n Returns beacons whose status matches the given value. Values must be\n one of the Beacon.Status enum values (case insensitive). Accepts\n multiple filters which will be combined with OR logic.\n* **stability:`\u003cenum\u003e`**\n For example: **stability:mobile**\n Returns beacons whose expected stability matches the given value.\n Values must be one of the Beacon.Stability enum values (case\n insensitive). Accepts multiple filters which will be combined with\n OR logic.\n* **place\\_id:`\"\u003cstring\u003e\"`**\n For example: **place\\_id:\"ChIJVSZzVR8FdkgRXGmmm6SslKw=\"**\n Returns beacons explicitly registered at the given place, expressed as\n a Place ID obtained from [Google Places API](/places/place-id). Does not\n match places inside the given place. Does not consider the beacon's\n actual location (which may be different from its registered place).\n Accepts multiple filters that will be combined with OR logic. The place\n ID must be double-quoted.\n* **registration\\_time`[\u003c|\u003e|\u003c=|\u003e=]\u003cinteger\u003e`**\n For example: **registration\\_time\u003e=1433116800**\n Returns beacons whose registration time matches the given filter.\n Supports the operators: \u003c, \u003e, \u003c=, and \u003e=. Timestamp must be expressed as\n an integer number of seconds since midnight January 1, 1970 UTC. Accepts\n at most two filters that will be combined with AND logic, to support\n \"between\" semantics. If more than two are supplied, the latter ones are\n ignored.\n* **lat:`\u003cdouble\u003e lng:\u003cdouble\u003e radius:\u003cinteger\u003e`**\n For example: **lat:51.1232343 lng:-1.093852 radius:1000**\n Returns beacons whose registered location is within the given circle.\n When any of these fields are given, all are required. Latitude and\n longitude must be decimal degrees between -90.0 and 90.0 and between\n -180.0 and 180.0 respectively. Radius must be an integer number of\n meters between 10 and 1,000,000 (1000 km).\n* **property:`\"\u003cstring\u003e=\u003cstring\u003e\"`**\n For example: **property:\"battery-type=CR2032\"**\n Returns beacons which have a property of the given name and value.\n Supports multiple filters which will be combined with OR logic.\n The entire name=value string must be double-quoted as one string.\n* **attachment\\_type:`\"\u003cstring\u003e\"`**\n For example: **attachment_type:\"my-namespace/my-type\"**\n Returns beacons having at least one attachment of the given namespaced\n type. Supports \"any within this namespace\" via the partial wildcard\n syntax: \"my-namespace/*\". Supports multiple filters which will be\n combined with OR logic. The string must be double-quoted.\n* **indoor\\_level:`\"\u003cstring\u003e\"`**\n For example: **indoor\\_level:\"1\"**\n Returns beacons which are located on the given indoor level. Accepts\n multiple filters that will be combined with OR logic.\n\nMultiple filters on the same field are combined with OR logic (except\nregistration_time which is combined with AND logic).\nMultiple filters on different fields are combined with AND logic.\nFilters should be separated by spaces.\n\nAs with any HTTP query string parameter, the whole filter expression must\nbe URL-encoded.\n\nExample REST request:\n`GET /v1beta1/beacons?q=status:active%20lat:51.123%20lng:-1.095%20radius:1000`",
- "type": "string"
- },
- "projectId": {
- "location": "query",
- "description": "The project id to list beacons under. If not present then the project\ncredential that made the request is used as the project.\nOptional.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "flatPath": "v1beta1/beacons",
- "path": "v1beta1/beacons",
- "id": "proximitybeacon.beacons.list"
- },
- "register": {
- "description": "Registers a previously unregistered beacon given its `advertisedId`.\nThese IDs are unique within the system. An ID can be registered only once.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
- "request": {
- "$ref": "Beacon"
- },
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Beacon"
- },
- "parameters": {
- "projectId": {
- "description": "The project id of the project the beacon will be registered to. If\nthe project id is not specified then the project making the request\nis used.\nOptional.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "flatPath": "v1beta1/beacons:register",
- "path": "v1beta1/beacons:register",
- "id": "proximitybeacon.beacons.register"
- },
- "activate": {
- "httpMethod": "POST",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "beaconName"
- ],
- "parameters": {
- "projectId": {
- "description": "The project id of the beacon to activate. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.",
- "type": "string",
- "location": "query"
- },
- "beaconName": {
- "location": "path",
- "description": "Beacon that should be activated. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
- "type": "string",
- "required": true,
- "pattern": "^beacons/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "flatPath": "v1beta1/beacons/{beaconsId}:activate",
- "path": "v1beta1/{+beaconName}:activate",
- "id": "proximitybeacon.beacons.activate",
- "description": "Activates a beacon. A beacon that is active will return information\nand attachment data when queried via `beaconinfo.getforobserved`.\nCalling this method on an already active beacon will do nothing (but\nwill return a successful response code).\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project."
- },
- "get": {
- "description": "Returns detailed information about the specified beacon.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project.\n\nRequests may supply an Eddystone-EID beacon name in the form:\n`beacons/4!beaconId` where the `beaconId` is the base16 ephemeral ID\nbroadcast by the beacon. The returned `Beacon` object will contain the\nbeacon's stable Eddystone-UID. Clients not authorized to resolve the\nbeacon's ephemeral Eddystone-EID broadcast will receive an error.",
- "response": {
- "$ref": "Beacon"
- },
- "parameterOrder": [
- "beaconName"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "parameters": {
- "projectId": {
- "location": "query",
- "description": "The project id of the beacon to request. If the project id is not specified\nthen the project making the request is used. The project id must match the\nproject that owns the beacon.\nOptional.",
- "type": "string"
- },
- "beaconName": {
- "pattern": "^beacons/[^/]+$",
- "location": "path",
- "description": "Resource name of this beacon. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta1/beacons/{beaconsId}",
- "id": "proximitybeacon.beacons.get",
- "path": "v1beta1/{+beaconName}"
- },
- "update": {
- "description": "Updates the information about the specified beacon. **Any field that you do\nnot populate in the submitted beacon will be permanently erased**, so you\nshould follow the \"read, modify, write\" pattern to avoid inadvertently\ndestroying data.\n\nChanges to the beacon status via this method will be silently ignored.\nTo update beacon status, use the separate methods on this API for\nactivation, deactivation, and decommissioning.\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
- "request": {
- "$ref": "Beacon"
- },
- "httpMethod": "PUT",
- "parameterOrder": [
- "beaconName"
- ],
- "response": {
- "$ref": "Beacon"
- },
- "parameters": {
- "beaconName": {
- "description": "Resource name of this beacon. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon.\n\nThis field must be left empty when registering. After reading a beacon,\nclients can use the name for future operations.",
- "type": "string",
- "required": true,
- "pattern": "^beacons/[^/]+$",
- "location": "path"
- },
- "projectId": {
- "location": "query",
- "description": "The project id of the beacon to update. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "flatPath": "v1beta1/beacons/{beaconsId}",
- "path": "v1beta1/{+beaconName}",
- "id": "proximitybeacon.beacons.update"
- }
- },
- "resources": {
- "diagnostics": {
- "methods": {
- "list": {
- "description": "List the diagnostics for a single beacon. You can also list diagnostics for\nall the beacons owned by your Google Developers Console project by using\nthe beacon name `beacons/-`.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListDiagnosticsResponse"
- },
- "parameterOrder": [
- "beaconName"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "parameters": {
- "beaconName": {
- "pattern": "^beacons/[^/]+$",
- "location": "path",
- "description": "Beacon that the diagnostics are for.",
- "type": "string",
- "required": true
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "Requests results that occur after the `page_token`, obtained from the\nresponse to a previous request. Optional."
- },
- "alertFilter": {
- "description": "Requests only beacons that have the given alert. For example, to find\nbeacons that have low batteries use `alert_filter=LOW_BATTERY`.",
- "type": "string",
- "location": "query",
- "enum": [
- "ALERT_UNSPECIFIED",
- "WRONG_LOCATION",
- "LOW_BATTERY"
- ]
- },
- "pageSize": {
- "format": "int32",
- "description": "Specifies the maximum number of results to return. Defaults to\n10. Maximum 1000. Optional.",
- "type": "integer",
- "location": "query"
- },
- "projectId": {
- "description": "Requests only diagnostic records for the given project id. If not set,\nthen the project making the request will be used for looking up\ndiagnostic records. Optional.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1beta1/beacons/{beaconsId}/diagnostics",
- "path": "v1beta1/{+beaconName}/diagnostics",
- "id": "proximitybeacon.beacons.diagnostics.list"
- }
- }
- },
- "attachments": {
- "methods": {
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "attachmentName"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "parameters": {
- "projectId": {
- "description": "The project id of the attachment to delete. If not provided, the project\nthat is making the request is used.\nOptional.",
- "type": "string",
- "location": "query"
- },
- "attachmentName": {
- "description": "The attachment name (`attachmentName`) of\nthe attachment to remove. For example:\n`beacons/3!893737abc9/attachments/c5e937-af0-494-959-ec49d12738`. For\nEddystone-EID beacons, the beacon ID portion (`3!893737abc9`) may be the\nbeacon's current EID, or its \"stable\" Eddystone-UID.\nRequired.",
- "type": "string",
- "required": true,
- "pattern": "^beacons/[^/]+/attachments/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/beacons/{beaconsId}/attachments/{attachmentsId}",
- "id": "proximitybeacon.beacons.attachments.delete",
- "path": "v1beta1/{+attachmentName}",
- "description": "Deletes the specified attachment for the given beacon. Each attachment has\na unique attachment name (`attachmentName`) which is returned when you\nfetch the attachment data via this API. You specify this with the delete\nrequest to control which attachment is removed. This operation cannot be\nundone.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project."
- },
- "list": {
- "response": {
- "$ref": "ListBeaconAttachmentsResponse"
- },
- "parameterOrder": [
- "beaconName"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "parameters": {
- "namespacedType": {
- "description": "Specifies the namespace and type of attachment to include in response in\n\u003cvar\u003enamespace/type\u003c/var\u003e format. Accepts `*/*` to specify\n\"all types in all namespaces\".",
- "type": "string",
- "location": "query"
- },
- "beaconName": {
- "description": "Beacon whose attachments should be fetched. A beacon name has the\nformat \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast\nby the beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
- "type": "string",
- "required": true,
- "pattern": "^beacons/[^/]+$",
- "location": "path"
- },
- "projectId": {
- "description": "The project id to list beacon attachments under. This field can be\nused when \"*\" is specified to mean all attachment namespaces. Projects\nmay have multiple attachments with multiple namespaces. If \"*\" is\nspecified and the projectId string is empty, then the project\nmaking the request is used.\nOptional.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1beta1/beacons/{beaconsId}/attachments",
- "id": "proximitybeacon.beacons.attachments.list",
- "path": "v1beta1/{+beaconName}/attachments",
- "description": "Returns the attachments for the specified beacon that match the specified\nnamespaced-type pattern.\n\nTo control which namespaced types are returned, you add the\n`namespacedType` query parameter to the request. You must either use\n`*/*`, to return all attachments, or the namespace must be one of\nthe ones returned from the `namespaces` endpoint.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project."
- },
- "batchDelete": {
- "httpMethod": "POST",
- "parameterOrder": [
- "beaconName"
- ],
- "response": {
- "$ref": "DeleteAttachmentsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "parameters": {
- "projectId": {
- "location": "query",
- "description": "The project id to delete beacon attachments under. This field can be\nused when \"*\" is specified to mean all attachment namespaces. Projects\nmay have multiple attachments with multiple namespaces. If \"*\" is\nspecified and the projectId string is empty, then the project\nmaking the request is used.\nOptional.",
- "type": "string"
- },
- "namespacedType": {
- "type": "string",
- "location": "query",
- "description": "Specifies the namespace and type of attachments to delete in\n`namespace/type` format. Accepts `*/*` to specify\n\"all types in all namespaces\".\nOptional."
- },
- "beaconName": {
- "pattern": "^beacons/[^/]+$",
- "location": "path",
- "description": "The beacon whose attachments should be deleted. A beacon name has the\nformat \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast\nby the beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta1/beacons/{beaconsId}/attachments:batchDelete",
- "path": "v1beta1/{+beaconName}/attachments:batchDelete",
- "id": "proximitybeacon.beacons.attachments.batchDelete",
- "description": "Deletes multiple attachments on a given beacon. This operation is\npermanent and cannot be undone.\n\nYou can optionally specify `namespacedType` to choose which attachments\nshould be deleted. If you do not specify `namespacedType`, all your\nattachments on the given beacon will be deleted. You also may explicitly\nspecify `*/*` to delete all.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project."
- },
- "create": {
- "response": {
- "$ref": "BeaconAttachment"
- },
- "parameterOrder": [
- "beaconName"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "parameters": {
- "beaconName": {
- "pattern": "^beacons/[^/]+$",
- "location": "path",
- "description": "Beacon on which the attachment should be created. A beacon name has the\nformat \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast\nby the beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
- "type": "string",
- "required": true
- },
- "projectId": {
- "location": "query",
- "description": "The project id of the project the attachment will belong to. If\nthe project id is not specified then the project making the request\nis used.\nOptional.",
- "type": "string"
- }
- },
- "flatPath": "v1beta1/beacons/{beaconsId}/attachments",
- "id": "proximitybeacon.beacons.attachments.create",
- "path": "v1beta1/{+beaconName}/attachments",
- "request": {
- "$ref": "BeaconAttachment"
- },
- "description": "Associates the given data with the specified beacon. Attachment data must\ncontain two parts:\n\u003cul\u003e\n\u003cli\u003eA namespaced type.\u003c/li\u003e\n\u003cli\u003eThe actual attachment data itself.\u003c/li\u003e\n\u003c/ul\u003e\nThe namespaced type consists of two parts, the namespace and the type.\nThe namespace must be one of the values returned by the `namespaces`\nendpoint, while the type can be a string of any characters except for the\nforward slash (`/`) up to 100 characters in length.\n\nAttachment data can be up to 1024 bytes long.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project."
- }
- }
- }
- }
- }
- },
- "parameters": {
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "alt": {
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- }
- },
"schemas": {
- "LatLng": {
- "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.\n\nExample of normalization code in Python:\n\n def NormalizeLongitude(longitude):\n \"\"\"Wraps decimal degrees longitude to [-180.0, 180.0].\"\"\"\n q, r = divmod(longitude, 360.0)\n if r \u003e 180.0 or (r == 180.0 and q \u003c= -1.0):\n return r - 360.0\n return r\n\n def NormalizeLatLng(latitude, longitude):\n \"\"\"Wraps decimal degrees latitude and longitude to\n [-90.0, 90.0] and [-180.0, 180.0], respectively.\"\"\"\n r = latitude % 360.0\n if r \u003c= 90.0:\n return r, NormalizeLongitude(longitude)\n elif r \u003e= 270.0:\n return r - 360, NormalizeLongitude(longitude)\n else:\n return 180 - r, NormalizeLongitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLongitude(181.0)\n assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)\n assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)\n assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)\n assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)\n assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)\n assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)\n assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)\n assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)",
- "type": "object",
- "properties": {
- "latitude": {
- "format": "double",
- "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
- "type": "number"
- },
- "longitude": {
- "type": "number",
- "format": "double",
- "description": "The longitude in degrees. It must be in the range [-180.0, +180.0]."
- }
- },
- "id": "LatLng"
- },
- "ListBeaconAttachmentsResponse": {
- "type": "object",
- "properties": {
- "attachments": {
- "description": "The attachments that corresponded to the request params.",
- "items": {
- "$ref": "BeaconAttachment"
- },
- "type": "array"
- }
- },
- "id": "ListBeaconAttachmentsResponse",
- "description": "Response to `ListBeaconAttachments` that contains the requested attachments."
- },
- "Namespace": {
- "description": "An attachment namespace defines read and write access for all the attachments\ncreated under it. Each namespace is globally unique, and owned by one\nproject which is the only project that can create attachments under it.",
- "type": "object",
- "properties": {
- "namespaceName": {
- "description": "Resource name of this namespace. Namespaces names have the format:\n\u003ccode\u003enamespaces/\u003cvar\u003enamespace\u003c/var\u003e\u003c/code\u003e.",
- "type": "string"
- },
- "servingVisibility": {
- "enumDescriptions": [
- "Do not use this value.",
- "Served only to the project that owns the namespace.",
- "Any project can subscribe to attachments under the namespace."
- ],
- "enum": [
- "VISIBILITY_UNSPECIFIED",
- "UNLISTED",
- "PUBLIC"
- ],
- "description": "Specifies what clients may receive attachments under this namespace\nvia `beaconinfo.getforobserved`.",
- "type": "string"
- }
- },
- "id": "Namespace"
- },
- "AttachmentInfo": {
- "type": "object",
- "properties": {
- "data": {
- "format": "byte",
- "description": "An opaque data container for client-provided data.",
- "type": "string"
- },
- "namespacedType": {
- "description": "Specifies what kind of attachment this is. Tells a client how to\ninterpret the `data` field. Format is \u003cvar\u003enamespace/type\u003c/var\u003e, for\nexample \u003ccode\u003escrupulous-wombat-12345/welcome-message\u003c/code\u003e",
- "type": "string"
- }
- },
- "id": "AttachmentInfo",
- "description": "A subset of attachment information served via the\n`beaconinfo.getforobserved` method, used when your users encounter your\nbeacons."
- },
"BeaconInfo": {
"description": "A subset of beacon information served via the `beaconinfo.getforobserved`\nmethod, which you call when users of your app encounter your beacons.",
"type": "object",
@@ -723,8 +12,8 @@
"type": "array"
},
"advertisedId": {
- "$ref": "AdvertisedId",
- "description": "The ID advertised by the beacon."
+ "description": "The ID advertised by the beacon.",
+ "$ref": "AdvertisedId"
},
"beaconName": {
"description": "The name under which the beacon is registered.",
@@ -733,6 +22,34 @@
},
"id": "BeaconInfo"
},
+ "AttachmentInfo": {
+ "description": "A subset of attachment information served via the\n`beaconinfo.getforobserved` method, used when your users encounter your\nbeacons.",
+ "type": "object",
+ "properties": {
+ "namespacedType": {
+ "description": "Specifies what kind of attachment this is. Tells a client how to\ninterpret the `data` field. Format is \u003cvar\u003enamespace/type\u003c/var\u003e, for\nexample \u003ccode\u003escrupulous-wombat-12345/welcome-message\u003c/code\u003e",
+ "type": "string"
+ },
+ "data": {
+ "format": "byte",
+ "description": "An opaque data container for client-provided data.",
+ "type": "string"
+ }
+ },
+ "id": "AttachmentInfo"
+ },
+ "DeleteAttachmentsResponse": {
+ "description": "Response for a request to delete attachments.",
+ "type": "object",
+ "properties": {
+ "numDeleted": {
+ "format": "int32",
+ "description": "The number of attachments that were deleted.",
+ "type": "integer"
+ }
+ },
+ "id": "DeleteAttachmentsResponse"
+ },
"EphemeralIdRegistrationParams": {
"description": "Information a client needs to provision and register beacons that\nbroadcast Eddystone-EID format beacon IDs, using Elliptic curve\nDiffie-Hellman key exchange. See\n[the Eddystone specification](https://github.com/google/eddystone/tree/master/eddystone-eid) at GitHub.",
"type": "object",
@@ -755,25 +72,10 @@
},
"id": "EphemeralIdRegistrationParams"
},
- "DeleteAttachmentsResponse": {
- "description": "Response for a request to delete attachments.",
- "type": "object",
- "properties": {
- "numDeleted": {
- "format": "int32",
- "description": "The number of attachments that were deleted.",
- "type": "integer"
- }
- },
- "id": "DeleteAttachmentsResponse"
- },
"Observation": {
+ "description": "Represents one beacon observed once.",
"type": "object",
"properties": {
- "advertisedId": {
- "description": "The ID advertised by the beacon the client has encountered.\n\nIf the submitted `advertised_id` type is Eddystone-EID, then the client\nmust be authorized to resolve the given beacon. Otherwise no data will be\nreturned for that beacon.\nRequired.",
- "$ref": "AdvertisedId"
- },
"telemetry": {
"format": "byte",
"description": "The array of telemetry bytes received from the beacon. The server is\nresponsible for parsing it. This field may frequently be empty, as\nwith a beacon that transmits telemetry only occasionally.",
@@ -783,10 +85,13 @@
"format": "google-datetime",
"description": "Time when the beacon was observed.",
"type": "string"
+ },
+ "advertisedId": {
+ "$ref": "AdvertisedId",
+ "description": "The ID advertised by the beacon the client has encountered.\n\nIf the submitted `advertised_id` type is Eddystone-EID, then the client\nmust be authorized to resolve the given beacon. Otherwise no data will be\nreturned for that beacon.\nRequired."
}
},
- "id": "Observation",
- "description": "Represents one beacon observed once."
+ "id": "Observation"
},
"ListDiagnosticsResponse": {
"description": "Response that contains the requested diagnostics.",
@@ -800,8 +105,8 @@
"type": "array"
},
"nextPageToken": {
- "type": "string",
- "description": "Token that can be used for pagination. Returned only if the\nrequest matches more beacons than can be returned in this response."
+ "description": "Token that can be used for pagination. Returned only if the\nrequest matches more beacons than can be returned in this response.",
+ "type": "string"
}
},
"id": "ListDiagnosticsResponse"
@@ -825,6 +130,8 @@
"type": "object",
"properties": {
"status": {
+ "description": "Current status of the beacon.\nRequired.",
+ "type": "string",
"enumDescriptions": [
"Do not use this value.",
"The \"normal\" in-use state of a beacon.",
@@ -836,19 +143,19 @@
"ACTIVE",
"DECOMMISSIONED",
"INACTIVE"
- ],
- "description": "Current status of the beacon.\nRequired.",
- "type": "string"
+ ]
},
"indoorLevel": {
- "$ref": "IndoorLevel",
- "description": "The indoor level information for this beacon, if known. As returned by the\nGoogle Maps API.\nOptional."
+ "description": "The indoor level information for this beacon, if known. As returned by the\nGoogle Maps API.\nOptional.",
+ "$ref": "IndoorLevel"
},
"beaconName": {
"description": "Resource name of this beacon. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon.\n\nThis field must be left empty when registering. After reading a beacon,\nclients can use the name for future operations.",
"type": "string"
},
"expectedStability": {
+ "description": "Expected location stability. This is set when the beacon is registered or\nupdated, not automatically detected in any way.\nOptional.",
+ "type": "string",
"enumDescriptions": [
"Do not use this value.",
"Not expected to move, for example a store's front door.",
@@ -862,23 +169,25 @@
"PORTABLE",
"MOBILE",
"ROVING"
- ],
- "description": "Expected location stability. This is set when the beacon is registered or\nupdated, not automatically detected in any way.\nOptional.",
- "type": "string"
+ ]
},
"advertisedId": {
- "description": "The identifier of a beacon as advertised by it. This field must be\npopulated when registering. It may be empty when updating a beacon\nrecord because it is ignored in updates.\n\nWhen registering a beacon that broadcasts Eddystone-EID, this field\nshould contain a \"stable\" Eddystone-UID that identifies the beacon and\nlinks it to its attachments. The stable Eddystone-UID is only used for\nadministering the beacon.",
- "$ref": "AdvertisedId"
- },
- "ephemeralIdRegistration": {
- "description": "Write-only registration parameters for beacons using Eddystone-EID\n(remotely resolved ephemeral ID) format. This information will not be\npopulated in API responses. When submitting this data, the `advertised_id`\nfield must contain an ID of type Eddystone-UID. Any other ID type will\nresult in an error.",
- "$ref": "EphemeralIdRegistration"
+ "$ref": "AdvertisedId",
+ "description": "The identifier of a beacon as advertised by it. This field must be\npopulated when registering. It may be empty when updating a beacon\nrecord because it is ignored in updates.\n\nWhen registering a beacon that broadcasts Eddystone-EID, this field\nshould contain a \"stable\" Eddystone-UID that identifies the beacon and\nlinks it to its attachments. The stable Eddystone-UID is only used for\nadministering the beacon."
},
"provisioningKey": {
"format": "byte",
"description": "Some beacons may require a user to provide an authorization key before\nchanging any of its configuration (e.g. broadcast frames, transmit power).\nThis field provides a place to store and control access to that key.\nThis field is populated in responses to `GET /v1beta1/beacons/3!beaconId`\nfrom users with write access to the given beacon. That is to say: If the\nuser is authorized to write the beacon's confidential data in the service,\nthe service considers them authorized to configure the beacon. Note\nthat this key grants nothing on the service, only on the beacon itself.",
"type": "string"
},
+ "ephemeralIdRegistration": {
+ "$ref": "EphemeralIdRegistration",
+ "description": "Write-only registration parameters for beacons using Eddystone-EID\n(remotely resolved ephemeral ID) format. This information will not be\npopulated in API responses. When submitting this data, the `advertised_id`\nfield must contain an ID of type Eddystone-UID. Any other ID type will\nresult in an error."
+ },
+ "latLng": {
+ "$ref": "LatLng",
+ "description": "The location of the beacon, expressed as a latitude and longitude pair.\nThis location is given when the beacon is registered or updated. It does\nnot necessarily indicate the actual current location of the beacon.\nOptional."
+ },
"placeId": {
"description": "The [Google Places API](/places/place-id) Place ID of the place where\nthe beacon is deployed. This is given when the beacon is registered or\nupdated, not automatically detected in any way.\nOptional.",
"type": "string"
@@ -887,16 +196,12 @@
"description": "Free text used to identify and describe the beacon. Maximum length 140\ncharacters.\nOptional.",
"type": "string"
},
- "latLng": {
- "$ref": "LatLng",
- "description": "The location of the beacon, expressed as a latitude and longitude pair.\nThis location is given when the beacon is registered or updated. It does\nnot necessarily indicate the actual current location of the beacon.\nOptional."
- },
"properties": {
+ "description": "Properties of the beacon device, for example battery type or firmware\nversion.\nOptional.",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "Properties of the beacon device, for example battery type or firmware\nversion.\nOptional.",
- "type": "object"
+ }
}
},
"id": "Beacon"
@@ -932,11 +237,13 @@
"id": "AdvertisedId"
},
"Date": {
+ "description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
+ "type": "object",
"properties": {
"day": {
- "type": "integer",
"format": "int32",
- "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant."
+ "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.",
+ "type": "integer"
},
"year": {
"format": "int32",
@@ -944,14 +251,12 @@
"type": "integer"
},
"month": {
- "type": "integer",
"format": "int32",
- "description": "Month of year. Must be from 1 to 12."
+ "description": "Month of year. Must be from 1 to 12.",
+ "type": "integer"
}
},
- "id": "Date",
- "description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
- "type": "object"
+ "id": "Date"
},
"IndoorLevel": {
"description": "Indoor level, a human-readable string as returned by Google Maps APIs,\nuseful to indicate which floor of a building a beacon is located on.",
@@ -979,38 +284,40 @@
"id": "ListNamespacesResponse"
},
"Diagnostics": {
- "id": "Diagnostics",
"description": "Diagnostics for a single beacon.",
"type": "object",
"properties": {
- "beaconName": {
- "description": "Resource name of the beacon. For Eddystone-EID beacons, this may\nbe the beacon's current EID, or the beacon's \"stable\" Eddystone-UID.",
- "type": "string"
- },
"alerts": {
- "enumDescriptions": [
- "Invalid value. Should never appear.",
- "The beacon has been reported in a location different than its registered\nlocation. This may indicate that the beacon has been moved. This signal\nis not 100% accurate, but indicates that further investigation is worth\nwhile.",
- "The battery level for the beacon is low enough that, given the beacon's\ncurrent use, its battery will run out with in the next 60 days. This\nindicates that the battery should be replaced soon."
- ],
"description": "An unordered list of Alerts that the beacon has.",
"items": {
+ "type": "string",
"enum": [
"ALERT_UNSPECIFIED",
"WRONG_LOCATION",
"LOW_BATTERY"
- ],
- "type": "string"
+ ]
},
- "type": "array"
+ "type": "array",
+ "enumDescriptions": [
+ "Invalid value. Should never appear.",
+ "The beacon has been reported in a location different than its registered\nlocation. This may indicate that the beacon has been moved. This signal\nis not 100% accurate, but indicates that further investigation is worth\nwhile.",
+ "The battery level for the beacon is low enough that, given the beacon's\ncurrent use, its battery will run out with in the next 60 days. This\nindicates that the battery should be replaced soon."
+ ]
},
"estimatedLowBatteryDate": {
"$ref": "Date",
"description": "The date when the battery is expected to be low. If the value is missing\nthen there is no estimate for when the battery will be low.\nThis value is only an estimate, not an exact date."
+ },
+ "beaconName": {
+ "description": "Resource name of the beacon. For Eddystone-EID beacons, this may\nbe the beacon's current EID, or the beacon's \"stable\" Eddystone-UID.",
+ "type": "string"
}
- }
+ },
+ "id": "Diagnostics"
},
"ListBeaconsResponse": {
+ "description": "Response that contains list beacon results and pagination help.",
+ "type": "object",
"properties": {
"nextPageToken": {
"description": "An opaque pagination token that the client may provide in their next\nrequest to retrieve the next page of results.",
@@ -1029,9 +336,7 @@
"type": "array"
}
},
- "id": "ListBeaconsResponse",
- "description": "Response that contains list beacon results and pagination help.",
- "type": "object"
+ "id": "ListBeaconsResponse"
},
"GetInfoForObservedBeaconsRequest": {
"description": "Request for beacon and attachment information about beacons that\na mobile client has encountered \"in the wild\".",
@@ -1073,9 +378,9 @@
"type": "string"
},
"data": {
- "type": "string",
"format": "byte",
- "description": "An opaque data container for client-provided data. Must be\n[base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP\nrequests, and will be so encoded (with padding) in responses.\nRequired."
+ "description": "An opaque data container for client-provided data. Must be\n[base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP\nrequests, and will be so encoded (with padding) in responses.\nRequired.",
+ "type": "string"
},
"creationTimeMs": {
"format": "google-datetime",
@@ -1094,10 +399,20 @@
"description": "Write-only registration parameters for beacons using Eddystone-EID format.\nTwo ways of securely registering an Eddystone-EID beacon with the service\nare supported:\n\n1. Perform an ECDH key exchange via this API, including a previous call\n to `GET /v1beta1/eidparams`. In this case the fields\n `beacon_ecdh_public_key` and `service_ecdh_public_key` should be\n populated and `beacon_identity_key` should not be populated. This\n method ensures that only the two parties in the ECDH key exchange can\n compute the identity key, which becomes a secret between them.\n2. Derive or obtain the beacon's identity key via other secure means\n (perhaps an ECDH key exchange between the beacon and a mobile device\n or any other secure method), and then submit the resulting identity key\n to the service. In this case `beacon_identity_key` field should be\n populated, and neither of `beacon_ecdh_public_key` nor\n `service_ecdh_public_key` fields should be. The security of this method\n depends on how securely the parties involved (in particular the\n bluetooth client) handle the identity key, and obviously on how\n securely the identity key was generated.\n\nSee [the Eddystone specification](https://github.com/google/eddystone/tree/master/eddystone-eid) at GitHub.",
"type": "object",
"properties": {
+ "beaconEcdhPublicKey": {
+ "format": "byte",
+ "description": "The beacon's public key used for the Elliptic curve Diffie-Hellman\nkey exchange. When this field is populated, `service_ecdh_public_key`\nmust also be populated, and `beacon_identity_key` must not be.",
+ "type": "string"
+ },
+ "initialClockValue": {
+ "format": "uint64",
+ "description": "The initial clock value of the beacon. The beacon's clock must have\nbegun counting at this value immediately prior to transmitting this\nvalue to the resolving service. Significant delay in transmitting this\nvalue to the service risks registration or resolution failures. If a\nvalue is not provided, the default is zero.",
+ "type": "string"
+ },
"rotationPeriodExponent": {
- "type": "integer",
"format": "uint32",
- "description": "Indicates the nominal period between each rotation of the beacon's\nephemeral ID. \"Nominal\" because the beacon should randomize the\nactual interval. See [the spec at github](https://github.com/google/eddystone/tree/master/eddystone-eid)\nfor details. This value corresponds to a power-of-two scaler on the\nbeacon's clock: when the scaler value is K, the beacon will begin\nbroadcasting a new ephemeral ID on average every 2^K seconds."
+ "description": "Indicates the nominal period between each rotation of the beacon's\nephemeral ID. \"Nominal\" because the beacon should randomize the\nactual interval. See [the spec at github](https://github.com/google/eddystone/tree/master/eddystone-eid)\nfor details. This value corresponds to a power-of-two scaler on the\nbeacon's clock: when the scaler value is K, the beacon will begin\nbroadcasting a new ephemeral ID on average every 2^K seconds.",
+ "type": "integer"
},
"serviceEcdhPublicKey": {
"format": "byte",
@@ -1113,26 +428,72 @@
"format": "byte",
"description": "An initial ephemeral ID calculated using the clock value submitted as\n`initial_clock_value`, and the secret key generated by the\nDiffie-Hellman key exchange using `service_ecdh_public_key` and\n`service_ecdh_public_key`. This initial EID value will be used by the\nservice to confirm that the key exchange process was successful.",
"type": "string"
- },
- "initialClockValue": {
- "format": "uint64",
- "description": "The initial clock value of the beacon. The beacon's clock must have\nbegun counting at this value immediately prior to transmitting this\nvalue to the resolving service. Significant delay in transmitting this\nvalue to the service risks registration or resolution failures. If a\nvalue is not provided, the default is zero.",
- "type": "string"
- },
- "beaconEcdhPublicKey": {
- "format": "byte",
- "description": "The beacon's public key used for the Elliptic curve Diffie-Hellman\nkey exchange. When this field is populated, `service_ecdh_public_key`\nmust also be populated, and `beacon_identity_key` must not be.",
- "type": "string"
}
},
"id": "EphemeralIdRegistration"
+ },
+ "LatLng": {
+ "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.\n\nExample of normalization code in Python:\n\n def NormalizeLongitude(longitude):\n \"\"\"Wraps decimal degrees longitude to [-180.0, 180.0].\"\"\"\n q, r = divmod(longitude, 360.0)\n if r \u003e 180.0 or (r == 180.0 and q \u003c= -1.0):\n return r - 360.0\n return r\n\n def NormalizeLatLng(latitude, longitude):\n \"\"\"Wraps decimal degrees latitude and longitude to\n [-90.0, 90.0] and [-180.0, 180.0], respectively.\"\"\"\n r = latitude % 360.0\n if r \u003c= 90.0:\n return r, NormalizeLongitude(longitude)\n elif r \u003e= 270.0:\n return r - 360, NormalizeLongitude(longitude)\n else:\n return 180 - r, NormalizeLongitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLongitude(181.0)\n assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)\n assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)\n assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)\n assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)\n assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)\n assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)\n assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)\n assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)",
+ "type": "object",
+ "properties": {
+ "latitude": {
+ "format": "double",
+ "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
+ "type": "number"
+ },
+ "longitude": {
+ "format": "double",
+ "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
+ "type": "number"
+ }
+ },
+ "id": "LatLng"
+ },
+ "ListBeaconAttachmentsResponse": {
+ "description": "Response to `ListBeaconAttachments` that contains the requested attachments.",
+ "type": "object",
+ "properties": {
+ "attachments": {
+ "description": "The attachments that corresponded to the request params.",
+ "items": {
+ "$ref": "BeaconAttachment"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListBeaconAttachmentsResponse"
+ },
+ "Namespace": {
+ "description": "An attachment namespace defines read and write access for all the attachments\ncreated under it. Each namespace is globally unique, and owned by one\nproject which is the only project that can create attachments under it.",
+ "type": "object",
+ "properties": {
+ "namespaceName": {
+ "description": "Resource name of this namespace. Namespaces names have the format:\n\u003ccode\u003enamespaces/\u003cvar\u003enamespace\u003c/var\u003e\u003c/code\u003e.",
+ "type": "string"
+ },
+ "servingVisibility": {
+ "enumDescriptions": [
+ "Do not use this value.",
+ "Served only to the project that owns the namespace.",
+ "Any project can subscribe to attachments under the namespace."
+ ],
+ "enum": [
+ "VISIBILITY_UNSPECIFIED",
+ "UNLISTED",
+ "PUBLIC"
+ ],
+ "description": "Specifies what clients may receive attachments under this namespace\nvia `beaconinfo.getforobserved`.",
+ "type": "string"
+ }
+ },
+ "id": "Namespace"
}
},
- "protocol": "rest",
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
+ "protocol": "rest",
"version": "v1beta1",
"baseUrl": "https://proximitybeacon.googleapis.com/",
"auth": {
@@ -1147,5 +508,644 @@
"servicePath": "",
"description": "Registers, manages, indexes, and searches beacons.",
"kind": "discovery#restDescription",
- "rootUrl": "https://proximitybeacon.googleapis.com/"
+ "rootUrl": "https://proximitybeacon.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "proximitybeacon",
+ "batchPath": "batch",
+ "id": "proximitybeacon:v1beta1",
+ "documentationLink": "https://developers.google.com/beacons/proximity/",
+ "revision": "20171012",
+ "title": "Google Proximity Beacon API",
+ "discoveryVersion": "v1",
+ "ownerName": "Google",
+ "version_module": true,
+ "resources": {
+ "beaconinfo": {
+ "methods": {
+ "getforobserved": {
+ "flatPath": "v1beta1/beaconinfo:getforobserved",
+ "id": "proximitybeacon.beaconinfo.getforobserved",
+ "path": "v1beta1/beaconinfo:getforobserved",
+ "description": "Given one or more beacon observations, returns any beacon information\nand attachments accessible to your application. Authorize by using the\n[API key](https://developers.google.com/beacons/proximity/get-started#request_a_browser_api_key)\nfor the application.",
+ "request": {
+ "$ref": "GetInfoForObservedBeaconsRequest"
+ },
+ "response": {
+ "$ref": "GetInfoForObservedBeaconsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {}
+ }
+ }
+ },
+ "namespaces": {
+ "methods": {
+ "list": {
+ "description": "Lists all attachment namespaces owned by your Google Developers Console\nproject. Attachment data associated with a beacon must include a\nnamespaced type, and the namespace must be owned by your project.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project.",
+ "response": {
+ "$ref": "ListNamespacesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "projectId": {
+ "description": "The project id to list namespaces under.\nOptional.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "flatPath": "v1beta1/namespaces",
+ "id": "proximitybeacon.namespaces.list",
+ "path": "v1beta1/namespaces"
+ },
+ "update": {
+ "description": "Updates the information about the specified namespace. Only the namespace\nvisibility can be updated.",
+ "request": {
+ "$ref": "Namespace"
+ },
+ "response": {
+ "$ref": "Namespace"
+ },
+ "parameterOrder": [
+ "namespaceName"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "namespaceName": {
+ "location": "path",
+ "description": "Resource name of this namespace. Namespaces names have the format:\n\u003ccode\u003enamespaces/\u003cvar\u003enamespace\u003c/var\u003e\u003c/code\u003e.",
+ "type": "string",
+ "required": true,
+ "pattern": "^namespaces/[^/]+$"
+ },
+ "projectId": {
+ "description": "The project id of the namespace to update. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "flatPath": "v1beta1/namespaces/{namespacesId}",
+ "id": "proximitybeacon.namespaces.update",
+ "path": "v1beta1/{+namespaceName}"
+ }
+ }
+ },
+ "v1beta1": {
+ "methods": {
+ "getEidparams": {
+ "description": "Gets the Proximity Beacon API's current public key and associated\nparameters used to initiate the Diffie-Hellman key exchange required to\nregister a beacon that broadcasts the Eddystone-EID format. This key\nchanges periodically; clients may cache it and re-use the same public key\nto provision and register multiple beacons. However, clients should be\nprepared to refresh this key when they encounter an error registering an\nEddystone-EID beacon.",
+ "response": {
+ "$ref": "EphemeralIdRegistrationParams"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "flatPath": "v1beta1/eidparams",
+ "id": "proximitybeacon.getEidparams",
+ "path": "v1beta1/eidparams"
+ }
+ }
+ },
+ "beacons": {
+ "methods": {
+ "register": {
+ "response": {
+ "$ref": "Beacon"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The project id of the project the beacon will be registered to. If\nthe project id is not specified then the project making the request\nis used.\nOptional.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta1/beacons:register",
+ "id": "proximitybeacon.beacons.register",
+ "path": "v1beta1/beacons:register",
+ "request": {
+ "$ref": "Beacon"
+ },
+ "description": "Registers a previously unregistered beacon given its `advertisedId`.\nThese IDs are unique within the system. An ID can be registered only once.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project."
+ },
+ "list": {
+ "description": "Searches the beacon registry for beacons that match the given search\ncriteria. Only those beacons that the client has permission to list\nwill be returned.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project.",
+ "response": {
+ "$ref": "ListBeaconsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "A pagination token obtained from a previous request to list beacons.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The maximum number of records to return for this request, up to a\nserver-defined upper limit.",
+ "type": "integer",
+ "location": "query"
+ },
+ "q": {
+ "location": "query",
+ "description": "Filter query string that supports the following field filters:\n\n* **description:`\"\u003cstring\u003e\"`**\n For example: **description:\"Room 3\"**\n Returns beacons whose description matches tokens in the string \"Room 3\"\n (not necessarily that exact string).\n The string must be double-quoted.\n* **status:`\u003cenum\u003e`**\n For example: **status:active**\n Returns beacons whose status matches the given value. Values must be\n one of the Beacon.Status enum values (case insensitive). Accepts\n multiple filters which will be combined with OR logic.\n* **stability:`\u003cenum\u003e`**\n For example: **stability:mobile**\n Returns beacons whose expected stability matches the given value.\n Values must be one of the Beacon.Stability enum values (case\n insensitive). Accepts multiple filters which will be combined with\n OR logic.\n* **place\\_id:`\"\u003cstring\u003e\"`**\n For example: **place\\_id:\"ChIJVSZzVR8FdkgRXGmmm6SslKw=\"**\n Returns beacons explicitly registered at the given place, expressed as\n a Place ID obtained from [Google Places API](/places/place-id). Does not\n match places inside the given place. Does not consider the beacon's\n actual location (which may be different from its registered place).\n Accepts multiple filters that will be combined with OR logic. The place\n ID must be double-quoted.\n* **registration\\_time`[\u003c|\u003e|\u003c=|\u003e=]\u003cinteger\u003e`**\n For example: **registration\\_time\u003e=1433116800**\n Returns beacons whose registration time matches the given filter.\n Supports the operators: \u003c, \u003e, \u003c=, and \u003e=. Timestamp must be expressed as\n an integer number of seconds since midnight January 1, 1970 UTC. Accepts\n at most two filters that will be combined with AND logic, to support\n \"between\" semantics. If more than two are supplied, the latter ones are\n ignored.\n* **lat:`\u003cdouble\u003e lng:\u003cdouble\u003e radius:\u003cinteger\u003e`**\n For example: **lat:51.1232343 lng:-1.093852 radius:1000**\n Returns beacons whose registered location is within the given circle.\n When any of these fields are given, all are required. Latitude and\n longitude must be decimal degrees between -90.0 and 90.0 and between\n -180.0 and 180.0 respectively. Radius must be an integer number of\n meters between 10 and 1,000,000 (1000 km).\n* **property:`\"\u003cstring\u003e=\u003cstring\u003e\"`**\n For example: **property:\"battery-type=CR2032\"**\n Returns beacons which have a property of the given name and value.\n Supports multiple filters which will be combined with OR logic.\n The entire name=value string must be double-quoted as one string.\n* **attachment\\_type:`\"\u003cstring\u003e\"`**\n For example: **attachment_type:\"my-namespace/my-type\"**\n Returns beacons having at least one attachment of the given namespaced\n type. Supports \"any within this namespace\" via the partial wildcard\n syntax: \"my-namespace/*\". Supports multiple filters which will be\n combined with OR logic. The string must be double-quoted.\n* **indoor\\_level:`\"\u003cstring\u003e\"`**\n For example: **indoor\\_level:\"1\"**\n Returns beacons which are located on the given indoor level. Accepts\n multiple filters that will be combined with OR logic.\n\nMultiple filters on the same field are combined with OR logic (except\nregistration_time which is combined with AND logic).\nMultiple filters on different fields are combined with AND logic.\nFilters should be separated by spaces.\n\nAs with any HTTP query string parameter, the whole filter expression must\nbe URL-encoded.\n\nExample REST request:\n`GET /v1beta1/beacons?q=status:active%20lat:51.123%20lng:-1.095%20radius:1000`",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The project id to list beacons under. If not present then the project\ncredential that made the request is used as the project.\nOptional.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "flatPath": "v1beta1/beacons",
+ "id": "proximitybeacon.beacons.list",
+ "path": "v1beta1/beacons"
+ },
+ "activate": {
+ "flatPath": "v1beta1/beacons/{beaconsId}:activate",
+ "path": "v1beta1/{+beaconName}:activate",
+ "id": "proximitybeacon.beacons.activate",
+ "description": "Activates a beacon. A beacon that is active will return information\nand attachment data when queried via `beaconinfo.getforobserved`.\nCalling this method on an already active beacon will do nothing (but\nwill return a successful response code).\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "query",
+ "description": "The project id of the beacon to activate. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.",
+ "type": "string"
+ },
+ "beaconName": {
+ "location": "path",
+ "description": "Beacon that should be activated. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
+ "type": "string",
+ "required": true,
+ "pattern": "^beacons/[^/]+$"
+ }
+ }
+ },
+ "get": {
+ "description": "Returns detailed information about the specified beacon.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project.\n\nRequests may supply an Eddystone-EID beacon name in the form:\n`beacons/4!beaconId` where the `beaconId` is the base16 ephemeral ID\nbroadcast by the beacon. The returned `Beacon` object will contain the\nbeacon's stable Eddystone-UID. Clients not authorized to resolve the\nbeacon's ephemeral Eddystone-EID broadcast will receive an error.",
+ "response": {
+ "$ref": "Beacon"
+ },
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "projectId": {
+ "description": "The project id of the beacon to request. If the project id is not specified\nthen the project making the request is used. The project id must match the\nproject that owns the beacon.\nOptional.",
+ "type": "string",
+ "location": "query"
+ },
+ "beaconName": {
+ "description": "Resource name of this beacon. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
+ "type": "string",
+ "required": true,
+ "pattern": "^beacons/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "flatPath": "v1beta1/beacons/{beaconsId}",
+ "id": "proximitybeacon.beacons.get",
+ "path": "v1beta1/{+beaconName}"
+ },
+ "update": {
+ "flatPath": "v1beta1/beacons/{beaconsId}",
+ "id": "proximitybeacon.beacons.update",
+ "path": "v1beta1/{+beaconName}",
+ "request": {
+ "$ref": "Beacon"
+ },
+ "description": "Updates the information about the specified beacon. **Any field that you do\nnot populate in the submitted beacon will be permanently erased**, so you\nshould follow the \"read, modify, write\" pattern to avoid inadvertently\ndestroying data.\n\nChanges to the beacon status via this method will be silently ignored.\nTo update beacon status, use the separate methods on this API for\nactivation, deactivation, and decommissioning.\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
+ "response": {
+ "$ref": "Beacon"
+ },
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "parameters": {
+ "beaconName": {
+ "description": "Resource name of this beacon. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon.\n\nThis field must be left empty when registering. After reading a beacon,\nclients can use the name for future operations.",
+ "type": "string",
+ "required": true,
+ "pattern": "^beacons/[^/]+$",
+ "location": "path"
+ },
+ "projectId": {
+ "location": "query",
+ "description": "The project id of the beacon to update. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.",
+ "type": "string"
+ }
+ }
+ },
+ "decommission": {
+ "flatPath": "v1beta1/beacons/{beaconsId}:decommission",
+ "id": "proximitybeacon.beacons.decommission",
+ "path": "v1beta1/{+beaconName}:decommission",
+ "description": "Decommissions the specified beacon in the service. This beacon will no\nlonger be returned from `beaconinfo.getforobserved`. This operation is\npermanent -- you will not be able to re-register a beacon with this ID\nagain.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "projectId": {
+ "description": "The project id of the beacon to decommission. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.",
+ "type": "string",
+ "location": "query"
+ },
+ "beaconName": {
+ "location": "path",
+ "description": "Beacon that should be decommissioned. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID of the beacon's \"stable\" UID.\nRequired.",
+ "type": "string",
+ "required": true,
+ "pattern": "^beacons/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ]
+ },
+ "deactivate": {
+ "flatPath": "v1beta1/beacons/{beaconsId}:deactivate",
+ "id": "proximitybeacon.beacons.deactivate",
+ "path": "v1beta1/{+beaconName}:deactivate",
+ "description": "Deactivates a beacon. Once deactivated, the API will not return\ninformation nor attachment data for the beacon when queried via\n`beaconinfo.getforobserved`. Calling this method on an already inactive\nbeacon will do nothing (but will return a successful response code).\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "projectId": {
+ "description": "The project id of the beacon to deactivate. If the project id is not\nspecified then the project making the request is used. The project id must\nmatch the project that owns the beacon.\nOptional.",
+ "type": "string",
+ "location": "query"
+ },
+ "beaconName": {
+ "location": "path",
+ "description": "Beacon that should be deactivated. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
+ "type": "string",
+ "required": true,
+ "pattern": "^beacons/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ]
+ },
+ "delete": {
+ "description": "Deletes the specified beacon including all diagnostics data for the beacon\nas well as any attachments on the beacon (including those belonging to\nother projects). This operation cannot be undone.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "parameters": {
+ "beaconName": {
+ "location": "path",
+ "description": "Beacon that should be deleted. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
+ "type": "string",
+ "required": true,
+ "pattern": "^beacons/[^/]+$"
+ },
+ "projectId": {
+ "description": "The project id of the beacon to delete. If not provided, the project\nthat is making the request is used.\nOptional.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta1/beacons/{beaconsId}",
+ "id": "proximitybeacon.beacons.delete",
+ "path": "v1beta1/{+beaconName}"
+ }
+ },
+ "resources": {
+ "attachments": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListBeaconAttachmentsResponse"
+ },
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "namespacedType": {
+ "description": "Specifies the namespace and type of attachment to include in response in\n\u003cvar\u003enamespace/type\u003c/var\u003e format. Accepts `*/*` to specify\n\"all types in all namespaces\".",
+ "type": "string",
+ "location": "query"
+ },
+ "beaconName": {
+ "description": "Beacon whose attachments should be fetched. A beacon name has the\nformat \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast\nby the beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
+ "type": "string",
+ "required": true,
+ "pattern": "^beacons/[^/]+$",
+ "location": "path"
+ },
+ "projectId": {
+ "description": "The project id to list beacon attachments under. This field can be\nused when \"*\" is specified to mean all attachment namespaces. Projects\nmay have multiple attachments with multiple namespaces. If \"*\" is\nspecified and the projectId string is empty, then the project\nmaking the request is used.\nOptional.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "flatPath": "v1beta1/beacons/{beaconsId}/attachments",
+ "id": "proximitybeacon.beacons.attachments.list",
+ "path": "v1beta1/{+beaconName}/attachments",
+ "description": "Returns the attachments for the specified beacon that match the specified\nnamespaced-type pattern.\n\nTo control which namespaced types are returned, you add the\n`namespacedType` query parameter to the request. You must either use\n`*/*`, to return all attachments, or the namespace must be one of\nthe ones returned from the `namespaces` endpoint.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project."
+ },
+ "batchDelete": {
+ "response": {
+ "$ref": "DeleteAttachmentsResponse"
+ },
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The project id to delete beacon attachments under. This field can be\nused when \"*\" is specified to mean all attachment namespaces. Projects\nmay have multiple attachments with multiple namespaces. If \"*\" is\nspecified and the projectId string is empty, then the project\nmaking the request is used.\nOptional.",
+ "type": "string",
+ "location": "query"
+ },
+ "namespacedType": {
+ "description": "Specifies the namespace and type of attachments to delete in\n`namespace/type` format. Accepts `*/*` to specify\n\"all types in all namespaces\".\nOptional.",
+ "type": "string",
+ "location": "query"
+ },
+ "beaconName": {
+ "location": "path",
+ "description": "The beacon whose attachments should be deleted. A beacon name has the\nformat \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast\nby the beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
+ "type": "string",
+ "required": true,
+ "pattern": "^beacons/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta1/beacons/{beaconsId}/attachments:batchDelete",
+ "id": "proximitybeacon.beacons.attachments.batchDelete",
+ "path": "v1beta1/{+beaconName}/attachments:batchDelete",
+ "description": "Deletes multiple attachments on a given beacon. This operation is\npermanent and cannot be undone.\n\nYou can optionally specify `namespacedType` to choose which attachments\nshould be deleted. If you do not specify `namespacedType`, all your\nattachments on the given beacon will be deleted. You also may explicitly\nspecify `*/*` to delete all.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project."
+ },
+ "create": {
+ "flatPath": "v1beta1/beacons/{beaconsId}/attachments",
+ "path": "v1beta1/{+beaconName}/attachments",
+ "id": "proximitybeacon.beacons.attachments.create",
+ "request": {
+ "$ref": "BeaconAttachment"
+ },
+ "description": "Associates the given data with the specified beacon. Attachment data must\ncontain two parts:\n\u003cul\u003e\n\u003cli\u003eA namespaced type.\u003c/li\u003e\n\u003cli\u003eThe actual attachment data itself.\u003c/li\u003e\n\u003c/ul\u003e\nThe namespaced type consists of two parts, the namespace and the type.\nThe namespace must be one of the values returned by the `namespaces`\nendpoint, while the type can be a string of any characters except for the\nforward slash (`/`) up to 100 characters in length.\n\nAttachment data can be up to 1024 bytes long.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "response": {
+ "$ref": "BeaconAttachment"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "parameters": {
+ "beaconName": {
+ "location": "path",
+ "description": "Beacon on which the attachment should be created. A beacon name has the\nformat \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast\nby the beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
+ "type": "string",
+ "required": true,
+ "pattern": "^beacons/[^/]+$"
+ },
+ "projectId": {
+ "description": "The project id of the project the attachment will belong to. If\nthe project id is not specified then the project making the request\nis used.\nOptional.",
+ "type": "string",
+ "location": "query"
+ }
+ }
+ },
+ "delete": {
+ "flatPath": "v1beta1/beacons/{beaconsId}/attachments/{attachmentsId}",
+ "id": "proximitybeacon.beacons.attachments.delete",
+ "path": "v1beta1/{+attachmentName}",
+ "description": "Deletes the specified attachment for the given beacon. Each attachment has\na unique attachment name (`attachmentName`) which is returned when you\nfetch the attachment data via this API. You specify this with the delete\nrequest to control which attachment is removed. This operation cannot be\nundone.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "attachmentName"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "parameters": {
+ "attachmentName": {
+ "description": "The attachment name (`attachmentName`) of\nthe attachment to remove. For example:\n`beacons/3!893737abc9/attachments/c5e937-af0-494-959-ec49d12738`. For\nEddystone-EID beacons, the beacon ID portion (`3!893737abc9`) may be the\nbeacon's current EID, or its \"stable\" Eddystone-UID.\nRequired.",
+ "type": "string",
+ "required": true,
+ "pattern": "^beacons/[^/]+/attachments/[^/]+$",
+ "location": "path"
+ },
+ "projectId": {
+ "location": "query",
+ "description": "The project id of the attachment to delete. If not provided, the project\nthat is making the request is used.\nOptional.",
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "diagnostics": {
+ "methods": {
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListDiagnosticsResponse"
+ },
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "parameters": {
+ "beaconName": {
+ "description": "Beacon that the diagnostics are for.",
+ "type": "string",
+ "required": true,
+ "pattern": "^beacons/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Requests results that occur after the `page_token`, obtained from the\nresponse to a previous request. Optional.",
+ "type": "string"
+ },
+ "alertFilter": {
+ "description": "Requests only beacons that have the given alert. For example, to find\nbeacons that have low batteries use `alert_filter=LOW_BATTERY`.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "ALERT_UNSPECIFIED",
+ "WRONG_LOCATION",
+ "LOW_BATTERY"
+ ]
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Specifies the maximum number of results to return. Defaults to\n10. Maximum 1000. Optional.",
+ "type": "integer"
+ },
+ "projectId": {
+ "description": "Requests only diagnostic records for the given project id. If not set,\nthen the project making the request will be used for looking up\ndiagnostic records. Optional.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "flatPath": "v1beta1/beacons/{beaconsId}/diagnostics",
+ "path": "v1beta1/{+beaconName}/diagnostics",
+ "id": "proximitybeacon.beacons.diagnostics.list",
+ "description": "List the diagnostics for a single beacon. You can also list diagnostics for\nall the beacons owned by your Google Developers Console project by using\nthe beacon name `beacons/-`.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project."
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "alt": {
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ }
+ }
}
diff --git a/pubsub/v1/pubsub-api.json b/pubsub/v1/pubsub-api.json
index 50f979f..e43455b 100644
--- a/pubsub/v1/pubsub-api.json
+++ b/pubsub/v1/pubsub-api.json
@@ -1,102 +1,63 @@
{
- "baseUrl": "https://pubsub.googleapis.com/",
- "canonicalName": "Pubsub",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/pubsub": {
- "description": "View and manage Pub/Sub topics and subscriptions"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "servicePath": "",
- "description": "Provides reliable, many-to-many, asynchronous messaging between applications.\n",
- "kind": "discovery#restDescription",
- "rootUrl": "https://pubsub.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "pubsub",
- "batchPath": "batch",
- "revision": "20170918",
- "documentationLink": "https://cloud.google.com/pubsub/docs",
- "id": "pubsub:v1",
- "title": "Google Cloud Pub/Sub API",
- "discoveryVersion": "v1",
- "ownerName": "Google",
"resources": {
"projects": {
"resources": {
- "topics": {
+ "snapshots": {
"methods": {
- "list": {
- "description": "Lists matching topics.",
+ "testIamPermissions": {
"response": {
- "$ref": "ListTopicsResponse"
+ "$ref": "TestIamPermissionsResponse"
},
"parameterOrder": [
- "project"
+ "resource"
],
- "httpMethod": "GET",
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
"parameters": {
- "pageToken": {
- "location": "query",
- "description": "The value returned by the last `ListTopicsResponse`; indicates that this is\na continuation of a prior `ListTopics` call, and that the system should\nreturn the next page of data.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Maximum number of topics to return.",
- "type": "integer"
- },
- "project": {
- "description": "The name of the cloud project that topics belong to.\nFormat is `projects/{project}`.",
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/snapshots/[^/]+$"
}
},
- "flatPath": "v1/projects/{projectsId}/topics",
- "id": "pubsub.projects.topics.list",
- "path": "v1/{+project}/topics"
- },
- "create": {
+ "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}:testIamPermissions",
+ "id": "pubsub.projects.snapshots.testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
"request": {
- "$ref": "Topic"
+ "$ref": "TestIamPermissionsRequest"
},
- "description": "Creates the given topic with the given name.",
- "response": {
- "$ref": "Topic"
- },
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning."
+ },
+ "getIamPolicy": {
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
+ "httpMethod": "GET",
"parameterOrder": [
- "name"
+ "resource"
],
- "httpMethod": "PUT",
+ "response": {
+ "$ref": "Policy"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
"parameters": {
- "name": {
- "description": "The name of the topic. It must have the format\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter,\nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),\nunderscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent\nsigns (`%`). It must be between 3 and 255 characters in length, and it\nmust not start with `\"goog\"`.",
+ "resource": {
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/snapshots/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field."
}
},
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}",
- "id": "pubsub.projects.topics.create",
- "path": "v1/{+name}"
+ "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}:getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "id": "pubsub.projects.snapshots.getIamPolicy"
},
"setIamPolicy": {
"request": {
@@ -116,16 +77,136 @@
],
"parameters": {
"resource": {
- "location": "path",
"description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+/topics/[^/]+$"
+ "pattern": "^projects/[^/]+/snapshots/[^/]+$",
+ "location": "path"
}
},
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:setIamPolicy",
- "id": "pubsub.projects.topics.setIamPolicy",
+ "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}:setIamPolicy",
+ "id": "pubsub.projects.snapshots.setIamPolicy",
"path": "v1/{+resource}:setIamPolicy"
+ }
+ }
+ },
+ "subscriptions": {
+ "methods": {
+ "setIamPolicy": {
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:setIamPolicy",
+ "id": "pubsub.projects.subscriptions.setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy."
+ },
+ "create": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path",
+ "description": "The name of the subscription. It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characters\nin length, and it must not start with `\"goog\"`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}",
+ "id": "pubsub.projects.subscriptions.create",
+ "path": "v1/{+name}",
+ "request": {
+ "$ref": "Subscription"
+ },
+ "description": "Creates a subscription to a given topic.\nIf the subscription already exists, returns `ALREADY_EXISTS`.\nIf the corresponding topic doesn't exist, returns `NOT_FOUND`.\n\nIf the name is not provided in the request, the server will assign a random\nname for this subscription on the same project as the topic, conforming\nto the\n[resource name format](https://cloud.google.com/pubsub/docs/overview#names).\nThe generated name is populated in the returned Subscription object.\nNote that for REST API requests, you must specify a name in the request.",
+ "response": {
+ "$ref": "Subscription"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT"
+ },
+ "acknowledge": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "subscription"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "subscription": {
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path",
+ "description": "The subscription whose message is being acknowledged.\nFormat is `projects/{project}/subscriptions/{sub}`."
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:acknowledge",
+ "id": "pubsub.projects.subscriptions.acknowledge",
+ "path": "v1/{+subscription}:acknowledge",
+ "request": {
+ "$ref": "AcknowledgeRequest"
+ },
+ "description": "Acknowledges the messages associated with the `ack_ids` in the\n`AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages\nfrom the subscription.\n\nAcknowledging a message whose ack deadline has expired may succeed,\nbut such a message may be redelivered later. Acknowledging a message more\nthan once will not result in an error."
+ },
+ "modifyAckDeadline": {
+ "description": "Modifies the ack deadline for a specific message. This method is useful\nto indicate that more time is needed to process a message by the\nsubscriber, or to make the message available for redelivery if the\nprocessing was interrupted. Note that this does not modify the\nsubscription-level `ackDeadlineSeconds` used for subsequent messages.",
+ "request": {
+ "$ref": "ModifyAckDeadlineRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "subscription"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "subscription": {
+ "location": "path",
+ "description": "The name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyAckDeadline",
+ "path": "v1/{+subscription}:modifyAckDeadline",
+ "id": "pubsub.projects.subscriptions.modifyAckDeadline"
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
@@ -142,51 +223,254 @@
],
"parameters": {
"resource": {
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field."
}
},
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:getIamPolicy",
- "id": "pubsub.projects.topics.getIamPolicy",
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:getIamPolicy",
+ "id": "pubsub.projects.subscriptions.getIamPolicy",
"path": "v1/{+resource}:getIamPolicy"
},
"get": {
- "description": "Gets the configuration of a topic.",
- "response": {
- "$ref": "Topic"
- },
- "parameterOrder": [
- "topic"
- ],
- "httpMethod": "GET",
"parameters": {
- "topic": {
- "location": "path",
- "description": "The name of the topic to get.\nFormat is `projects/{project}/topics/{topic}`.",
+ "subscription": {
+ "description": "The name of the subscription to get.\nFormat is `projects/{project}/subscriptions/{sub}`.",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+/topics/[^/]+$"
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}",
+ "id": "pubsub.projects.subscriptions.get",
+ "path": "v1/{+subscription}",
+ "description": "Gets the configuration details of a subscription.",
+ "response": {
+ "$ref": "Subscription"
+ },
+ "parameterOrder": [
+ "subscription"
+ ],
+ "httpMethod": "GET"
+ },
+ "testIamPermissions": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "pubsub.projects.subscriptions.testIamPermissions",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning."
+ },
+ "modifyPushConfig": {
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyPushConfig",
+ "id": "pubsub.projects.subscriptions.modifyPushConfig",
+ "path": "v1/{+subscription}:modifyPushConfig",
+ "request": {
+ "$ref": "ModifyPushConfigRequest"
+ },
+ "description": "Modifies the `PushConfig` for a specified subscription.\n\nThis may be used to change a push subscription to a pull one (signified by\nan empty `PushConfig`) or vice versa, or change the endpoint URL and other\nattributes of a push subscription. Messages will accumulate for delivery\ncontinuously through the call regardless of changes to the `PushConfig`.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "subscription"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "subscription": {
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path",
+ "description": "The name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`."
+ }
+ }
+ },
+ "pull": {
+ "request": {
+ "$ref": "PullRequest"
+ },
+ "description": "Pulls messages from the server. Returns an empty list if there are no\nmessages available in the backlog. The server may return `UNAVAILABLE` if\nthere are too many concurrent pull requests pending for the given\nsubscription.",
+ "response": {
+ "$ref": "PullResponse"
+ },
+ "parameterOrder": [
+ "subscription"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "subscription": {
+ "description": "The subscription from which messages should be pulled.\nFormat is `projects/{project}/subscriptions/{sub}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:pull",
+ "id": "pubsub.projects.subscriptions.pull",
+ "path": "v1/{+subscription}:pull"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "subscription"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "subscription": {
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path",
+ "description": "The subscription to delete.\nFormat is `projects/{project}/subscriptions/{sub}`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}",
+ "id": "pubsub.projects.subscriptions.delete",
+ "path": "v1/{+subscription}",
+ "description": "Deletes an existing subscription. All messages retained in the subscription\nare immediately dropped. Calls to `Pull` after deletion will return\n`NOT_FOUND`. After a subscription is deleted, a new one may be created with\nthe same name, but the new one has no association with the old\nsubscription or its topic unless the same topic is specified."
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListSubscriptionsResponse"
+ },
+ "parameterOrder": [
+ "project"
+ ],
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Maximum number of subscriptions to return.",
+ "type": "integer"
+ },
+ "project": {
+ "description": "The name of the cloud project that subscriptions belong to.\nFormat is `projects/{project}`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The value returned by the last `ListSubscriptionsResponse`; indicates that\nthis is a continuation of a prior `ListSubscriptions` call, and that the\nsystem should return the next page of data.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/subscriptions",
+ "path": "v1/{+project}/subscriptions",
+ "id": "pubsub.projects.subscriptions.list",
+ "description": "Lists matching subscriptions."
+ }
+ }
+ },
+ "topics": {
+ "methods": {
+ "getIamPolicy": {
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/topics/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:getIamPolicy",
+ "id": "pubsub.projects.topics.getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset."
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Topic"
+ },
+ "parameterOrder": [
+ "topic"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "topic": {
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path",
+ "description": "The name of the topic to get.\nFormat is `projects/{project}/topics/{topic}`.",
+ "type": "string",
+ "required": true
+ }
+ },
"flatPath": "v1/projects/{projectsId}/topics/{topicsId}",
+ "path": "v1/{+topic}",
"id": "pubsub.projects.topics.get",
- "path": "v1/{+topic}"
+ "description": "Gets the configuration of a topic."
},
"publish": {
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:publish",
- "path": "v1/{+topic}:publish",
- "id": "pubsub.projects.topics.publish",
+ "description": "Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic\ndoes not exist. The message payload must not be empty; it must contain\n either a non-empty data field, or at least one attribute.",
"request": {
"$ref": "PublishRequest"
},
- "description": "Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic\ndoes not exist. The message payload must not be empty; it must contain\n either a non-empty data field, or at least one attribute.",
"httpMethod": "POST",
"parameterOrder": [
"topic"
@@ -194,10 +478,6 @@
"response": {
"$ref": "PublishResponse"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
"parameters": {
"topic": {
"description": "The messages in the request will be published on this topic.\nFormat is `projects/{project}/topics/{topic}`.",
@@ -206,9 +486,19 @@
"pattern": "^projects/[^/]+/topics/[^/]+$",
"location": "path"
}
- }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:publish",
+ "path": "v1/{+topic}:publish",
+ "id": "pubsub.projects.topics.publish"
},
"testIamPermissions": {
+ "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:testIamPermissions",
+ "id": "pubsub.projects.topics.testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
"description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
"request": {
"$ref": "TestIamPermissionsRequest"
@@ -232,12 +522,10 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:testIamPermissions",
- "id": "pubsub.projects.topics.testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions"
+ ]
},
"delete": {
+ "description": "Deletes the topic with the given name. Returns `NOT_FOUND` if the topic\ndoes not exist. After a topic is deleted, a new topic may be created with\nthe same name; this is an entirely new topic with none of the old\nconfiguration or subscriptions. Existing subscriptions to this topic are\nnot deleted, but their `topic` field is set to `_deleted-topic_`.",
"response": {
"$ref": "Empty"
},
@@ -260,182 +548,49 @@
},
"flatPath": "v1/projects/{projectsId}/topics/{topicsId}",
"id": "pubsub.projects.topics.delete",
- "path": "v1/{+topic}",
- "description": "Deletes the topic with the given name. Returns `NOT_FOUND` if the topic\ndoes not exist. After a topic is deleted, a new topic may be created with\nthe same name; this is an entirely new topic with none of the old\nconfiguration or subscriptions. Existing subscriptions to this topic are\nnot deleted, but their `topic` field is set to `_deleted-topic_`."
- }
- },
- "resources": {
- "subscriptions": {
- "methods": {
- "list": {
- "description": "Lists the name of the subscriptions for this topic.",
- "httpMethod": "GET",
- "parameterOrder": [
- "topic"
- ],
- "response": {
- "$ref": "ListTopicSubscriptionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "pageSize": {
- "format": "int32",
- "description": "Maximum number of subscription names to return.",
- "type": "integer",
- "location": "query"
- },
- "topic": {
- "description": "The name of the topic that subscriptions are attached to.\nFormat is `projects/{project}/topics/{topic}`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "The value returned by the last `ListTopicSubscriptionsResponse`; indicates\nthat this is a continuation of a prior `ListTopicSubscriptions` call, and\nthat the system should return the next page of data.",
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}/subscriptions",
- "path": "v1/{+topic}/subscriptions",
- "id": "pubsub.projects.topics.subscriptions.list"
- }
- }
- }
- }
- },
- "snapshots": {
- "methods": {
- "testIamPermissions": {
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/snapshots/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "id": "pubsub.projects.snapshots.testIamPermissions"
+ "path": "v1/{+topic}"
},
- "getIamPolicy": {
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "GET",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/snapshots/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}:getIamPolicy",
- "id": "pubsub.projects.snapshots.getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy"
- },
- "setIamPolicy": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/snapshots/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "id": "pubsub.projects.snapshots.setIamPolicy",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy."
- }
- }
- },
- "subscriptions": {
- "methods": {
"list": {
- "description": "Lists matching subscriptions.",
+ "flatPath": "v1/projects/{projectsId}/topics",
+ "path": "v1/{+project}/topics",
+ "id": "pubsub.projects.topics.list",
+ "description": "Lists matching topics.",
"httpMethod": "GET",
"parameterOrder": [
"project"
],
"response": {
- "$ref": "ListSubscriptionsResponse"
+ "$ref": "ListTopicsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
"parameters": {
- "pageToken": {
- "description": "The value returned by the last `ListSubscriptionsResponse`; indicates that\nthis is a continuation of a prior `ListSubscriptions` call, and that the\nsystem should return the next page of data.",
- "type": "string",
+ "pageSize": {
+ "format": "int32",
+ "description": "Maximum number of topics to return.",
+ "type": "integer",
"location": "query"
},
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Maximum number of subscriptions to return.",
- "type": "integer"
- },
"project": {
- "location": "path",
- "description": "The name of the cloud project that subscriptions belong to.\nFormat is `projects/{project}`.",
+ "description": "The name of the cloud project that topics belong to.\nFormat is `projects/{project}`.",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+$"
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "The value returned by the last `ListTopicsResponse`; indicates that this is\na continuation of a prior `ListTopics` call, and that the system should\nreturn the next page of data."
}
- },
- "flatPath": "v1/projects/{projectsId}/subscriptions",
- "path": "v1/{+project}/subscriptions",
- "id": "pubsub.projects.subscriptions.list"
+ }
},
"setIamPolicy": {
+ "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:setIamPolicy",
+ "id": "pubsub.projects.topics.setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "SetIamPolicyRequest"
},
@@ -453,266 +608,83 @@
],
"parameters": {
"resource": {
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
"location": "path",
"description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
"type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
+ "required": true
}
- },
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:setIamPolicy",
- "id": "pubsub.projects.subscriptions.setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy"
+ }
},
"create": {
+ "flatPath": "v1/projects/{projectsId}/topics/{topicsId}",
+ "id": "pubsub.projects.topics.create",
+ "path": "v1/{+name}",
+ "request": {
+ "$ref": "Topic"
+ },
+ "description": "Creates the given topic with the given name.",
"response": {
- "$ref": "Subscription"
+ "$ref": "Topic"
},
"parameterOrder": [
"name"
],
"httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
"parameters": {
"name": {
- "description": "The name of the subscription. It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characters\nin length, and it must not start with `\"goog\"`.",
+ "location": "path",
+ "description": "The name of the topic. It must have the format\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter,\nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),\nunderscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent\nsigns (`%`). It must be between 3 and 255 characters in length, and it\nmust not start with `\"goog\"`.",
"type": "string",
"required": true,
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}",
- "id": "pubsub.projects.subscriptions.create",
- "path": "v1/{+name}",
- "description": "Creates a subscription to a given topic.\nIf the subscription already exists, returns `ALREADY_EXISTS`.\nIf the corresponding topic doesn't exist, returns `NOT_FOUND`.\n\nIf the name is not provided in the request, the server will assign a random\nname for this subscription on the same project as the topic, conforming\nto the\n[resource name format](https://cloud.google.com/pubsub/docs/overview#names).\nThe generated name is populated in the returned Subscription object.\nNote that for REST API requests, you must specify a name in the request.",
- "request": {
- "$ref": "Subscription"
- }
- },
- "acknowledge": {
- "description": "Acknowledges the messages associated with the `ack_ids` in the\n`AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages\nfrom the subscription.\n\nAcknowledging a message whose ack deadline has expired may succeed,\nbut such a message may be redelivered later. Acknowledging a message more\nthan once will not result in an error.",
- "request": {
- "$ref": "AcknowledgeRequest"
- },
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "subscription"
- ],
- "httpMethod": "POST",
- "parameters": {
- "subscription": {
- "description": "The subscription whose message is being acknowledged.\nFormat is `projects/{project}/subscriptions/{sub}`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:acknowledge",
- "id": "pubsub.projects.subscriptions.acknowledge",
- "path": "v1/{+subscription}:acknowledge"
- },
- "modifyAckDeadline": {
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyAckDeadline",
- "id": "pubsub.projects.subscriptions.modifyAckDeadline",
- "path": "v1/{+subscription}:modifyAckDeadline",
- "request": {
- "$ref": "ModifyAckDeadlineRequest"
- },
- "description": "Modifies the ack deadline for a specific message. This method is useful\nto indicate that more time is needed to process a message by the\nsubscriber, or to make the message available for redelivery if the\nprocessing was interrupted. Note that this does not modify the\nsubscription-level `ackDeadlineSeconds` used for subsequent messages.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "subscription"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "subscription": {
- "description": "The name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/topics/[^/]+$"
}
}
- },
- "getIamPolicy": {
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "GET",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:getIamPolicy",
- "id": "pubsub.projects.subscriptions.getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy"
- },
- "get": {
- "response": {
- "$ref": "Subscription"
- },
- "parameterOrder": [
- "subscription"
- ],
- "httpMethod": "GET",
- "parameters": {
- "subscription": {
- "description": "The name of the subscription to get.\nFormat is `projects/{project}/subscriptions/{sub}`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}",
- "id": "pubsub.projects.subscriptions.get",
- "path": "v1/{+subscription}",
- "description": "Gets the configuration details of a subscription."
- },
- "testIamPermissions": {
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:testIamPermissions",
- "id": "pubsub.projects.subscriptions.testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions"
- },
- "modifyPushConfig": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "subscription"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "subscription": {
- "location": "path",
- "description": "The name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyPushConfig",
- "id": "pubsub.projects.subscriptions.modifyPushConfig",
- "path": "v1/{+subscription}:modifyPushConfig",
- "request": {
- "$ref": "ModifyPushConfigRequest"
- },
- "description": "Modifies the `PushConfig` for a specified subscription.\n\nThis may be used to change a push subscription to a pull one (signified by\nan empty `PushConfig`) or vice versa, or change the endpoint URL and other\nattributes of a push subscription. Messages will accumulate for delivery\ncontinuously through the call regardless of changes to the `PushConfig`."
- },
- "pull": {
- "description": "Pulls messages from the server. Returns an empty list if there are no\nmessages available in the backlog. The server may return `UNAVAILABLE` if\nthere are too many concurrent pull requests pending for the given\nsubscription.",
- "request": {
- "$ref": "PullRequest"
- },
- "response": {
- "$ref": "PullResponse"
- },
- "parameterOrder": [
- "subscription"
- ],
- "httpMethod": "POST",
- "parameters": {
- "subscription": {
- "description": "The subscription from which messages should be pulled.\nFormat is `projects/{project}/subscriptions/{sub}`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:pull",
- "id": "pubsub.projects.subscriptions.pull",
- "path": "v1/{+subscription}:pull"
- },
- "delete": {
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}",
- "id": "pubsub.projects.subscriptions.delete",
- "path": "v1/{+subscription}",
- "description": "Deletes an existing subscription. All messages retained in the subscription\nare immediately dropped. Calls to `Pull` after deletion will return\n`NOT_FOUND`. After a subscription is deleted, a new one may be created with\nthe same name, but the new one has no association with the old\nsubscription or its topic unless the same topic is specified.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "subscription"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "subscription": {
- "description": "The subscription to delete.\nFormat is `projects/{project}/subscriptions/{sub}`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path"
+ }
+ },
+ "resources": {
+ "subscriptions": {
+ "methods": {
+ "list": {
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "The value returned by the last `ListTopicSubscriptionsResponse`; indicates\nthat this is a continuation of a prior `ListTopicSubscriptions` call, and\nthat the system should return the next page of data.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Maximum number of subscription names to return.",
+ "type": "integer"
+ },
+ "topic": {
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path",
+ "description": "The name of the topic that subscriptions are attached to.\nFormat is `projects/{project}/topics/{topic}`."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/topics/{topicsId}/subscriptions",
+ "path": "v1/{+topic}/subscriptions",
+ "id": "pubsub.projects.topics.subscriptions.list",
+ "description": "Lists the name of the subscriptions for this topic.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListTopicSubscriptionsResponse"
+ },
+ "parameterOrder": [
+ "topic"
+ ]
}
}
}
@@ -722,35 +694,51 @@
}
},
"parameters": {
- "uploadType": {
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
"location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean"
},
"fields": {
- "location": "query",
"description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "uploadType": {
+ "type": "string",
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
"type": "string"
},
"$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
"type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
"location": "query"
},
"alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
@@ -759,92 +747,41 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
+ "default": "json"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string",
"location": "query"
},
- "quotaUser": {
+ "access_token": {
"location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "description": "OAuth access token.",
"type": "string"
},
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
"pp": {
- "location": "query",
- "description": "Pretty-print response.",
"default": "true",
- "type": "boolean"
+ "type": "boolean",
+ "location": "query",
+ "description": "Pretty-print response."
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
},
"bearer_token": {
"description": "OAuth bearer token.",
"type": "string",
"location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "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.",
- "default": "true",
- "type": "boolean"
}
},
"schemas": {
- "Policy": {
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
- "type": "object",
- "properties": {
- "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": {
- "format": "byte",
- "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.",
- "type": "string"
- },
- "version": {
- "format": "int32",
- "description": "Version of the `Policy`. The default version is 0.",
- "type": "integer"
- }
- },
- "id": "Policy"
- },
- "Topic": {
- "description": "A topic resource.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The name of the topic. It must have the format\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter,\nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),\nunderscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent\nsigns (`%`). It must be between 3 and 255 characters in length, and it\nmust not start with `\"goog\"`.",
- "type": "string"
- }
- },
- "id": "Topic"
- },
"ModifyAckDeadlineRequest": {
"description": "Request for the ModifyAckDeadline method.",
"type": "object",
@@ -875,34 +812,6 @@
},
"id": "SetIamPolicyRequest"
},
- "PubsubMessage": {
- "description": "A message data and its attributes. The message payload must not be empty;\nit must contain either a non-empty data field, or at least one attribute.",
- "type": "object",
- "properties": {
- "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"
- },
- "attributes": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional attributes for this message.",
- "type": "object"
- },
- "publishTime": {
- "format": "google-datetime",
- "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.",
- "type": "string"
- },
- "data": {
- "format": "byte",
- "description": "The message payload.",
- "type": "string"
- }
- },
- "id": "PubsubMessage"
- },
"ModifyPushConfigRequest": {
"description": "Request for the ModifyPushConfig method.",
"type": "object",
@@ -914,6 +823,34 @@
},
"id": "ModifyPushConfigRequest"
},
+ "PubsubMessage": {
+ "description": "A message data and its attributes. The message payload must not be empty;\nit must contain either a non-empty data field, or at least one attribute.",
+ "type": "object",
+ "properties": {
+ "data": {
+ "format": "byte",
+ "description": "The message payload.",
+ "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"
+ },
+ "attributes": {
+ "description": "Optional attributes for this message.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "publishTime": {
+ "format": "google-datetime",
+ "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.",
+ "type": "string"
+ }
+ },
+ "id": "PubsubMessage"
+ },
"Binding": {
"description": "Associates `members` with a `role`.",
"type": "object",
@@ -932,31 +869,8 @@
},
"id": "Binding"
},
- "ListTopicsResponse": {
- "description": "Response for the `ListTopics` method.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "If not empty, indicates that there may be more topics that match the\nrequest; this value should be passed in a new `ListTopicsRequest`.",
- "type": "string"
- },
- "topics": {
- "description": "The resulting topics.",
- "items": {
- "$ref": "Topic"
- },
- "type": "array"
- }
- },
- "id": "ListTopicsResponse"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
"AcknowledgeRequest": {
+ "id": "AcknowledgeRequest",
"description": "Request for the Acknowledge method.",
"type": "object",
"properties": {
@@ -967,11 +881,33 @@
},
"type": "array"
}
+ }
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
+ },
+ "ListTopicsResponse": {
+ "type": "object",
+ "properties": {
+ "topics": {
+ "description": "The resulting topics.",
+ "items": {
+ "$ref": "Topic"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "If not empty, indicates that there may be more topics that match the\nrequest; this value should be passed in a new `ListTopicsRequest`.",
+ "type": "string"
+ }
},
- "id": "AcknowledgeRequest"
+ "id": "ListTopicsResponse",
+ "description": "Response for the `ListTopics` method."
},
"ListTopicSubscriptionsResponse": {
- "description": "Response for the `ListTopicSubscriptions` method.",
"type": "object",
"properties": {
"nextPageToken": {
@@ -979,14 +915,15 @@
"type": "string"
},
"subscriptions": {
- "description": "The names of the subscriptions that match the request.",
"items": {
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "description": "The names of the subscriptions that match the request."
}
},
- "id": "ListTopicSubscriptionsResponse"
+ "id": "ListTopicSubscriptionsResponse",
+ "description": "Response for the `ListTopicSubscriptions` method."
},
"PullResponse": {
"description": "Response for the `Pull` method.",
@@ -1003,34 +940,34 @@
"id": "PullResponse"
},
"ReceivedMessage": {
- "description": "A message and its corresponding acknowledgment ID.",
- "type": "object",
"properties": {
- "message": {
- "description": "The message.",
- "$ref": "PubsubMessage"
- },
"ackId": {
- "description": "This ID can be used to acknowledge the received message.",
- "type": "string"
+ "type": "string",
+ "description": "This ID can be used to acknowledge the received message."
+ },
+ "message": {
+ "$ref": "PubsubMessage",
+ "description": "The message."
}
},
- "id": "ReceivedMessage"
+ "id": "ReceivedMessage",
+ "description": "A message and its corresponding acknowledgment ID.",
+ "type": "object"
},
"PushConfig": {
"description": "Configuration for a push delivery endpoint.",
"type": "object",
"properties": {
"attributes": {
- "description": "Endpoint configuration attributes.\n\nEvery endpoint has a set of API supported attributes that can be used to\ncontrol different aspects of the message delivery.\n\nThe currently supported attribute is `x-goog-version`, which you can\nuse to change the format of the pushed message. This attribute\nindicates the version of the data expected by the endpoint. This\ncontrols the shape of the pushed message (i.e., its fields and metadata).\nThe endpoint version is based on the version of the Pub/Sub API.\n\nIf not present during the `CreateSubscription` call, it will default to\nthe version of the API used to make such call. If not present during a\n`ModifyPushConfig` call, its value will not be changed. `GetSubscription`\ncalls will always return a valid version, even if the subscription was\ncreated without this attribute.\n\nThe possible values for this attribute are:\n\n* `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.\n* `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.",
- "type": "object",
"additionalProperties": {
"type": "string"
- }
+ },
+ "description": "Endpoint configuration attributes.\n\nEvery endpoint has a set of API supported attributes that can be used to\ncontrol different aspects of the message delivery.\n\nThe currently supported attribute is `x-goog-version`, which you can\nuse to change the format of the pushed message. This attribute\nindicates the version of the data expected by the endpoint. This\ncontrols the shape of the pushed message (i.e., its fields and metadata).\nThe endpoint version is based on the version of the Pub/Sub API.\n\nIf not present during the `CreateSubscription` call, it will default to\nthe version of the API used to make such call. If not present during a\n`ModifyPushConfig` call, its value will not be changed. `GetSubscription`\ncalls will always return a valid version, even if the subscription was\ncreated without this attribute.\n\nThe possible values for this attribute are:\n\n* `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.\n* `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.",
+ "type": "object"
},
"pushEndpoint": {
- "description": "A URL locating the endpoint to which messages should be pushed.\nFor example, a Webhook endpoint might use \"https://example.com/push\".",
- "type": "string"
+ "type": "string",
+ "description": "A URL locating the endpoint to which messages should be pushed.\nFor example, a Webhook endpoint might use \"https://example.com/push\"."
}
},
"id": "PushConfig"
@@ -1066,26 +1003,24 @@
"id": "PullRequest"
},
"ListSubscriptionsResponse": {
- "description": "Response for the `ListSubscriptions` method.",
- "type": "object",
"properties": {
"nextPageToken": {
"description": "If not empty, indicates that there may be more subscriptions that match\nthe request; this value should be passed in a new\n`ListSubscriptionsRequest` to get more subscriptions.",
"type": "string"
},
"subscriptions": {
- "description": "The subscriptions that match the request.",
"items": {
"$ref": "Subscription"
},
- "type": "array"
+ "type": "array",
+ "description": "The subscriptions that match the request."
}
},
- "id": "ListSubscriptionsResponse"
+ "id": "ListSubscriptionsResponse",
+ "description": "Response for the `ListSubscriptions` method.",
+ "type": "object"
},
"PublishRequest": {
- "description": "Request for the Publish method.",
- "type": "object",
"properties": {
"messages": {
"description": "The messages to publish.",
@@ -1095,7 +1030,9 @@
"type": "array"
}
},
- "id": "PublishRequest"
+ "id": "PublishRequest",
+ "description": "Request for the Publish method.",
+ "type": "object"
},
"PublishResponse": {
"description": "Response for the `Publish` method.",
@@ -1140,20 +1077,83 @@
"type": "object",
"properties": {
"permissions": {
- "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
"items": {
"type": "string"
},
+ "type": "array",
+ "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions)."
+ }
+ },
+ "id": "TestIamPermissionsRequest"
+ },
+ "Policy": {
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
+ "type": "object",
+ "properties": {
+ "etag": {
+ "format": "byte",
+ "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.",
+ "type": "string"
+ },
+ "version": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Version of the `Policy`. The default version is 0."
+ },
+ "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"
}
},
- "id": "TestIamPermissionsRequest"
+ "id": "Policy"
+ },
+ "Topic": {
+ "description": "A topic resource.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the topic. It must have the format\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter,\nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),\nunderscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent\nsigns (`%`). It must be between 3 and 255 characters in length, and it\nmust not start with `\"goog\"`.",
+ "type": "string"
+ }
+ },
+ "id": "Topic"
}
},
"protocol": "rest",
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
- "version": "v1"
+ "version": "v1",
+ "baseUrl": "https://pubsub.googleapis.com/",
+ "canonicalName": "Pubsub",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/pubsub": {
+ "description": "View and manage Pub/Sub topics and subscriptions"
+ }
+ }
+ }
+ },
+ "description": "Provides reliable, many-to-many, asynchronous messaging between applications.\n",
+ "servicePath": "",
+ "kind": "discovery#restDescription",
+ "rootUrl": "https://pubsub.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "pubsub",
+ "batchPath": "batch",
+ "revision": "20170918",
+ "documentationLink": "https://cloud.google.com/pubsub/docs",
+ "id": "pubsub:v1",
+ "title": "Google Cloud Pub/Sub API",
+ "discoveryVersion": "v1",
+ "ownerName": "Google"
}
diff --git a/pubsub/v1beta1a/pubsub-api.json b/pubsub/v1beta1a/pubsub-api.json
index b154fd8..6040e92 100644
--- a/pubsub/v1beta1a/pubsub-api.json
+++ b/pubsub/v1beta1a/pubsub-api.json
@@ -1,14 +1,9 @@
{
"schemas": {
"ModifyAckDeadlineRequest": {
+ "description": "Request for the ModifyAckDeadline method.",
+ "type": "object",
"properties": {
- "ackIds": {
- "description": "List of acknowledgment IDs. Either this field or ack_id\nshould be populated, not both.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
"subscription": {
"description": "Next Index: 5\nThe name of the subscription from which messages are being pulled.",
"type": "string"
@@ -21,11 +16,16 @@
"format": "int32",
"description": "The new ack deadline with respect to the time this request was sent to the\nPub/Sub system. Must be \u003e= 0. For example, if the value is 10, the new ack\ndeadline will expire 10 seconds after the ModifyAckDeadline call was made.\nSpecifying zero may immediately make the message available for another pull\nrequest.",
"type": "integer"
+ },
+ "ackIds": {
+ "description": "List of acknowledgment IDs. Either this field or ack_id\nshould be populated, not both.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
},
- "id": "ModifyAckDeadlineRequest",
- "description": "Request for the ModifyAckDeadline method.",
- "type": "object"
+ "id": "ModifyAckDeadlineRequest"
},
"PullBatchRequest": {
"description": "Request for the PullBatch method.",
@@ -48,6 +48,8 @@
"id": "PullBatchRequest"
},
"ModifyPushConfigRequest": {
+ "description": "Request for the ModifyPushConfig method.",
+ "type": "object",
"properties": {
"pushConfig": {
"$ref": "PushConfig",
@@ -58,12 +60,17 @@
"type": "string"
}
},
- "id": "ModifyPushConfigRequest",
- "description": "Request for the ModifyPushConfig method.",
- "type": "object"
+ "id": "ModifyPushConfigRequest"
},
"PubsubMessage": {
+ "description": "A message data and its labels.",
+ "type": "object",
"properties": {
+ "data": {
+ "format": "byte",
+ "description": "The message payload.",
+ "type": "string"
+ },
"messageId": {
"description": "ID of this message assigned by the server at publication time. Guaranteed\nto be unique within the topic. This value may be read by a subscriber\nthat receives a PubsubMessage via a Pull call or a push delivery. It must\nnot be populated by a publisher in a Publish call.",
"type": "string"
@@ -79,36 +86,51 @@
"$ref": "Label"
},
"type": "array"
- },
- "data": {
- "format": "byte",
- "description": "The message payload.",
- "type": "string"
}
},
- "id": "PubsubMessage",
- "description": "A message data and its labels.",
- "type": "object"
+ "id": "PubsubMessage"
},
- "ListTopicsResponse": {
+ "AcknowledgeRequest": {
+ "description": "Request for the Acknowledge method.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "If not empty, indicates that there are more topics that match the request,\nand this value should be passed to the next \u003ccode\u003eListTopicsRequest\u003c/code\u003e\nto continue.",
+ "subscription": {
+ "description": "The subscription whose message is being acknowledged.",
"type": "string"
},
- "topic": {
+ "ackId": {
+ "description": "The acknowledgment ID for the message being acknowledged. This was\nreturned by the Pub/Sub system in the Pull response.",
"items": {
- "$ref": "Topic"
+ "type": "string"
},
- "type": "array",
- "description": "The resulting topics."
+ "type": "array"
}
},
- "id": "ListTopicsResponse",
- "description": "Response for the ListTopics method."
+ "id": "AcknowledgeRequest"
+ },
+ "PullBatchResponse": {
+ "description": "Response for the PullBatch method.",
+ "type": "object",
+ "properties": {
+ "pullResponses": {
+ "description": "Received Pub/Sub messages or status events. The Pub/Sub system will return\nzero messages if there are no more messages available in the backlog. The\nPub/Sub system may return fewer than the max_events requested even if\nthere are more messages available in the backlog.",
+ "items": {
+ "$ref": "PullResponse"
+ },
+ "type": "array"
+ }
+ },
+ "id": "PullBatchResponse"
+ },
+ "Empty": {
+ "description": "An empty message that you can re-use to avoid defining duplicated empty\nmessages in your project. A typical example is to use it as argument or the\nreturn value of a service API. For instance:\n\n service Foo {\n rpc Bar (proto2.Empty) returns (proto2.Empty) { };\n };\n\nBEGIN GOOGLE-INTERNAL\nThe difference between this one and net/rpc/empty-message.proto is that\n1) The generated message here is in proto2 C++ API.\n2) The proto2.Empty has minimum dependencies\n (no message_set or net/rpc dependencies)\nEND GOOGLE-INTERNAL",
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
},
"PublishBatchRequest": {
+ "description": "Request for the PublishBatch method.",
+ "type": "object",
"properties": {
"messages": {
"description": "The messages to publish.",
@@ -122,49 +144,28 @@
"type": "string"
}
},
- "id": "PublishBatchRequest",
- "description": "Request for the PublishBatch method.",
- "type": "object"
+ "id": "PublishBatchRequest"
},
- "Empty": {
- "properties": {},
- "id": "Empty",
- "description": "An empty message that you can re-use to avoid defining duplicated empty\nmessages in your project. A typical example is to use it as argument or the\nreturn value of a service API. For instance:\n\n service Foo {\n rpc Bar (proto2.Empty) returns (proto2.Empty) { };\n };\n\nBEGIN GOOGLE-INTERNAL\nThe difference between this one and net/rpc/empty-message.proto is that\n1) The generated message here is in proto2 C++ API.\n2) The proto2.Empty has minimum dependencies\n (no message_set or net/rpc dependencies)\nEND GOOGLE-INTERNAL",
- "type": "object"
- },
- "PullBatchResponse": {
+ "ListTopicsResponse": {
+ "description": "Response for the ListTopics method.",
"type": "object",
"properties": {
- "pullResponses": {
- "description": "Received Pub/Sub messages or status events. The Pub/Sub system will return\nzero messages if there are no more messages available in the backlog. The\nPub/Sub system may return fewer than the max_events requested even if\nthere are more messages available in the backlog.",
+ "topic": {
+ "description": "The resulting topics.",
"items": {
- "$ref": "PullResponse"
+ "$ref": "Topic"
},
"type": "array"
- }
- },
- "id": "PullBatchResponse",
- "description": "Response for the PullBatch method."
- },
- "AcknowledgeRequest": {
- "description": "Request for the Acknowledge method.",
- "type": "object",
- "properties": {
- "subscription": {
- "type": "string",
- "description": "The subscription whose message is being acknowledged."
},
- "ackId": {
- "description": "The acknowledgment ID for the message being acknowledged. This was\nreturned by the Pub/Sub system in the Pull response.",
- "items": {
- "type": "string"
- },
- "type": "array"
+ "nextPageToken": {
+ "description": "If not empty, indicates that there are more topics that match the request,\nand this value should be passed to the next \u003ccode\u003eListTopicsRequest\u003c/code\u003e\nto continue.",
+ "type": "string"
}
},
- "id": "AcknowledgeRequest"
+ "id": "ListTopicsResponse"
},
"PullResponse": {
+ "description": "Either a \u003ccode\u003ePubsubMessage\u003c/code\u003e or a truncation event. One of these two\nmust be populated.",
"type": "object",
"properties": {
"ackId": {
@@ -172,12 +173,11 @@
"type": "string"
},
"pubsubEvent": {
- "description": "A pubsub message or truncation event.",
- "$ref": "PubsubEvent"
+ "$ref": "PubsubEvent",
+ "description": "A pubsub message or truncation event."
}
},
- "id": "PullResponse",
- "description": "Either a \u003ccode\u003ePubsubMessage\u003c/code\u003e or a truncation event. One of these two\nmust be populated."
+ "id": "PullResponse"
},
"PushConfig": {
"description": "Configuration for a push delivery endpoint.",
@@ -209,6 +209,10 @@
"description": "An event indicating a received message or truncation event.",
"type": "object",
"properties": {
+ "subscription": {
+ "description": "The subscription that received the event.",
+ "type": "string"
+ },
"deleted": {
"description": "Indicates that this subscription has been deleted. (Note that pull\nsubscribers will always receive NOT_FOUND in response in their pull\nrequest on the subscription, rather than seeing this boolean.)",
"type": "boolean"
@@ -220,10 +224,6 @@
"message": {
"$ref": "PubsubMessage",
"description": "A received message."
- },
- "subscription": {
- "type": "string",
- "description": "The subscription that received the event."
}
},
"id": "PubsubEvent"
@@ -247,7 +247,6 @@
"id": "ListSubscriptionsResponse"
},
"PublishRequest": {
- "id": "PublishRequest",
"description": "Request for the Publish method.",
"type": "object",
"properties": {
@@ -259,10 +258,24 @@
"description": "The message to publish.",
"$ref": "PubsubMessage"
}
- }
+ },
+ "id": "PublishRequest"
+ },
+ "PublishBatchResponse": {
+ "description": "Response for the PublishBatch method.",
+ "type": "object",
+ "properties": {
+ "messageIds": {
+ "description": "The server-assigned ID of each published message, in the same order as\nthe messages in the request. IDs are guaranteed to be unique within\nthe topic.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "PublishBatchResponse"
},
"Subscription": {
- "id": "Subscription",
"description": "A subscription resource.",
"type": "object",
"properties": {
@@ -283,21 +296,8 @@
"$ref": "PushConfig",
"description": "If push delivery is used with this subscription, this field is\nused to configure it."
}
- }
- },
- "PublishBatchResponse": {
- "description": "Response for the PublishBatch method.",
- "type": "object",
- "properties": {
- "messageIds": {
- "description": "The server-assigned ID of each published message, in the same order as\nthe messages in the request. IDs are guaranteed to be unique within\nthe topic.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
},
- "id": "PublishBatchResponse"
+ "id": "Subscription"
},
"Topic": {
"description": "A topic resource.",
@@ -314,6 +314,10 @@
"description": "A key-value pair applied to a given object.",
"type": "object",
"properties": {
+ "strValue": {
+ "description": "A string value.",
+ "type": "string"
+ },
"numValue": {
"format": "int64",
"description": "An integer value.",
@@ -322,20 +326,16 @@
"key": {
"description": "The key of a label is a syntactically valid URL (as per RFC 1738) with\nthe \"scheme\" and initial slashes omitted and with the additional\nrestrictions noted below. Each key should be globally unique. The\n\"host\" portion is called the \"namespace\" and is not necessarily\nresolvable to a network endpoint. Instead, the namespace indicates what\nsystem or entity defines the semantics of the label. Namespaces do not\nrestrict the set of objects to which a label may be associated.\n\nKeys are defined by the following grammar:\n\n key = hostname \"/\" kpath\n kpath = ksegment *[ \"/\" ksegment ]\n ksegment = alphadigit | *[ alphadigit | \"-\" | \"_\" | \".\" ]\n\nwhere \"hostname\" and \"alphadigit\" are defined as in RFC 1738.\n\nExample key:\n spanner.google.com/universe",
"type": "string"
- },
- "strValue": {
- "description": "A string value.",
- "type": "string"
}
},
"id": "Label"
}
},
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
"protocol": "rest",
+ "icons": {
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ },
"version": "v1beta1a",
"baseUrl": "https://pubsub.googleapis.com/",
"canonicalName": "Pubsub",
@@ -351,41 +351,284 @@
}
}
},
- "servicePath": "",
"description": "Provides reliable, many-to-many, asynchronous messaging between applications.\n",
"kind": "discovery#restDescription",
+ "servicePath": "",
"rootUrl": "https://pubsub.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "pubsub",
"batchPath": "batch",
- "revision": "20170918",
- "documentationLink": "https://cloud.google.com/pubsub/docs",
"id": "pubsub:v1beta1a",
+ "documentationLink": "https://cloud.google.com/pubsub/docs",
+ "revision": "20170918",
"title": "Google Cloud Pub/Sub API",
- "discoveryVersion": "v1",
"ownerName": "Google",
+ "discoveryVersion": "v1",
"resources": {
- "subscriptions": {
+ "topics": {
"methods": {
- "create": {
- "path": "v1beta1a/subscriptions",
- "id": "pubsub.subscriptions.create",
- "description": "Creates a subscription on a given topic for a given subscriber.\nIf the subscription already exists, returns ALREADY_EXISTS.\nIf the corresponding topic doesn't exist, returns NOT_FOUND.\n\nIf the name is not provided in the request, the server will assign a random\nname for this subscription on the same project as the topic.",
- "request": {
- "$ref": "Subscription"
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "topic"
+ ],
+ "response": {
+ "$ref": "Empty"
},
+ "parameters": {
+ "topic": {
+ "location": "path",
+ "description": "Name of the topic to delete.",
+ "type": "string",
+ "required": true,
+ "pattern": "^.+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta1a/topics/{topicsId}",
+ "path": "v1beta1a/topics/{+topic}",
+ "id": "pubsub.topics.delete",
+ "description": "Deletes the topic with the given name. Returns NOT_FOUND if the topic does\nnot exist. After a topic is deleted, a new topic may be created with the\nsame name."
+ },
+ "publishBatch": {
+ "request": {
+ "$ref": "PublishBatchRequest"
+ },
+ "description": "Adds one or more messages to the topic. Returns NOT_FOUND if the topic does\nnot exist.",
"httpMethod": "POST",
"parameterOrder": [],
"response": {
- "$ref": "Subscription"
+ "$ref": "PublishBatchResponse"
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {},
+ "flatPath": "v1beta1a/topics/publishBatch",
+ "path": "v1beta1a/topics/publishBatch",
+ "id": "pubsub.topics.publishBatch"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ListTopicsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "maxResults": {
+ "location": "query",
+ "format": "int32",
+ "description": "Maximum number of topics to return.",
+ "type": "integer"
+ },
+ "query": {
+ "location": "query",
+ "description": "A valid label query expression.",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The value obtained in the last \u003ccode\u003eListTopicsResponse\u003c/code\u003e\nfor continuation.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta1a/topics",
+ "path": "v1beta1a/topics",
+ "id": "pubsub.topics.list",
+ "description": "Lists matching topics."
+ },
+ "create": {
+ "description": "Creates the given topic with the given name.",
+ "request": {
+ "$ref": "Topic"
+ },
+ "response": {
+ "$ref": "Topic"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
- "flatPath": "v1beta1a/subscriptions"
+ "flatPath": "v1beta1a/topics",
+ "id": "pubsub.topics.create",
+ "path": "v1beta1a/topics"
+ },
+ "get": {
+ "flatPath": "v1beta1a/topics/{topicsId}",
+ "id": "pubsub.topics.get",
+ "path": "v1beta1a/topics/{+topic}",
+ "description": "Gets the configuration of a topic. Since the topic only has the name\nattribute, this method is only useful to check the existence of a topic.\nIf other attributes are added in the future, they will be returned here.",
+ "response": {
+ "$ref": "Topic"
+ },
+ "parameterOrder": [
+ "topic"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "topic": {
+ "description": "The name of the topic to get.",
+ "type": "string",
+ "required": true,
+ "pattern": "^.+$",
+ "location": "path"
+ }
+ }
+ },
+ "publish": {
+ "flatPath": "v1beta1a/topics/publish",
+ "id": "pubsub.topics.publish",
+ "path": "v1beta1a/topics/publish",
+ "request": {
+ "$ref": "PublishRequest"
+ },
+ "description": "Adds a message to the topic. Returns NOT_FOUND if the topic does not\nexist.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {}
+ }
+ }
+ },
+ "subscriptions": {
+ "methods": {
+ "modifyPushConfig": {
+ "request": {
+ "$ref": "ModifyPushConfigRequest"
+ },
+ "description": "Modifies the \u003ccode\u003ePushConfig\u003c/code\u003e for a specified subscription.\nThis method can be used to suspend the flow of messages to an endpoint\nby clearing the \u003ccode\u003ePushConfig\u003c/code\u003e field in the request. Messages\nwill be accumulated for delivery even if no push configuration is\ndefined or while the configuration is modified.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {},
+ "flatPath": "v1beta1a/subscriptions/modifyPushConfig",
+ "path": "v1beta1a/subscriptions/modifyPushConfig",
+ "id": "pubsub.subscriptions.modifyPushConfig"
+ },
+ "pull": {
+ "description": "Pulls a single message from the server.\nIf return_immediately is true, and no messages are available in the\nsubscription, this method returns FAILED_PRECONDITION. The system is free\nto return an UNAVAILABLE error if no messages are available in a\nreasonable amount of time (to reduce system load).",
+ "request": {
+ "$ref": "PullRequest"
+ },
+ "response": {
+ "$ref": "PullResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta1a/subscriptions/pull",
+ "id": "pubsub.subscriptions.pull",
+ "path": "v1beta1a/subscriptions/pull"
+ },
+ "delete": {
+ "flatPath": "v1beta1a/subscriptions/{subscriptionsId}",
+ "id": "pubsub.subscriptions.delete",
+ "path": "v1beta1a/subscriptions/{+subscription}",
+ "description": "Deletes an existing subscription. All pending messages in the subscription\nare immediately dropped. Calls to Pull after deletion will return\nNOT_FOUND.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "subscription"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "subscription": {
+ "description": "The subscription to delete.",
+ "type": "string",
+ "required": true,
+ "pattern": "^.+$",
+ "location": "path"
+ }
+ }
+ },
+ "list": {
+ "response": {
+ "$ref": "ListSubscriptionsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "The value obtained in the last \u003ccode\u003eListSubscriptionsResponse\u003c/code\u003e\nfor continuation.",
+ "type": "string"
+ },
+ "maxResults": {
+ "format": "int32",
+ "description": "Maximum number of subscriptions to return.",
+ "type": "integer",
+ "location": "query"
+ },
+ "query": {
+ "location": "query",
+ "description": "A valid label query expression.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta1a/subscriptions",
+ "id": "pubsub.subscriptions.list",
+ "path": "v1beta1a/subscriptions",
+ "description": "Lists matching subscriptions."
+ },
+ "create": {
+ "response": {
+ "$ref": "Subscription"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {},
+ "flatPath": "v1beta1a/subscriptions",
+ "id": "pubsub.subscriptions.create",
+ "path": "v1beta1a/subscriptions",
+ "request": {
+ "$ref": "Subscription"
+ },
+ "description": "Creates a subscription on a given topic for a given subscriber.\nIf the subscription already exists, returns ALREADY_EXISTS.\nIf the corresponding topic doesn't exist, returns NOT_FOUND.\n\nIf the name is not provided in the request, the server will assign a random\nname for this subscription on the same project as the topic."
},
"acknowledge": {
"httpMethod": "POST",
@@ -407,337 +650,73 @@
"description": "Acknowledges a particular received message: the Pub/Sub system can remove\nthe given message from the subscription. Acknowledging a message whose\nAck deadline has expired may succeed, but the message could have been\nalready redelivered. Acknowledging a message more than once will not\nresult in an error. This is only used for messages received via pull."
},
"modifyAckDeadline": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {},
- "flatPath": "v1beta1a/subscriptions/modifyAckDeadline",
- "path": "v1beta1a/subscriptions/modifyAckDeadline",
- "id": "pubsub.subscriptions.modifyAckDeadline",
+ "description": "Modifies the Ack deadline for a message received from a pull request.",
"request": {
"$ref": "ModifyAckDeadlineRequest"
},
- "description": "Modifies the Ack deadline for a message received from a pull request."
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta1a/subscriptions/modifyAckDeadline",
+ "id": "pubsub.subscriptions.modifyAckDeadline",
+ "path": "v1beta1a/subscriptions/modifyAckDeadline"
},
"get": {
"description": "Gets the configuration details of a subscription.",
- "httpMethod": "GET",
- "parameterOrder": [
- "subscription"
- ],
"response": {
"$ref": "Subscription"
},
- "parameters": {
- "subscription": {
- "description": "The name of the subscription to get.",
- "type": "string",
- "required": true,
- "pattern": "^.+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta1a/subscriptions/{subscriptionsId}",
- "path": "v1beta1a/subscriptions/{+subscription}",
- "id": "pubsub.subscriptions.get"
- },
- "pullBatch": {
- "response": {
- "$ref": "PullBatchResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {},
- "flatPath": "v1beta1a/subscriptions/pullBatch",
- "id": "pubsub.subscriptions.pullBatch",
- "path": "v1beta1a/subscriptions/pullBatch",
- "request": {
- "$ref": "PullBatchRequest"
- },
- "description": "Pulls messages from the server. Returns an empty list if there are no\nmessages available in the backlog. The system is free to return UNAVAILABLE\nif there are too many pull requests outstanding for the given subscription."
- },
- "modifyPushConfig": {
- "request": {
- "$ref": "ModifyPushConfigRequest"
- },
- "description": "Modifies the \u003ccode\u003ePushConfig\u003c/code\u003e for a specified subscription.\nThis method can be used to suspend the flow of messages to an endpoint\nby clearing the \u003ccode\u003ePushConfig\u003c/code\u003e field in the request. Messages\nwill be accumulated for delivery even if no push configuration is\ndefined or while the configuration is modified.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {},
- "flatPath": "v1beta1a/subscriptions/modifyPushConfig",
- "id": "pubsub.subscriptions.modifyPushConfig",
- "path": "v1beta1a/subscriptions/modifyPushConfig"
- },
- "pull": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "PullResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {},
- "flatPath": "v1beta1a/subscriptions/pull",
- "path": "v1beta1a/subscriptions/pull",
- "id": "pubsub.subscriptions.pull",
- "request": {
- "$ref": "PullRequest"
- },
- "description": "Pulls a single message from the server.\nIf return_immediately is true, and no messages are available in the\nsubscription, this method returns FAILED_PRECONDITION. The system is free\nto return an UNAVAILABLE error if no messages are available in a\nreasonable amount of time (to reduce system load)."
- },
- "delete": {
- "description": "Deletes an existing subscription. All pending messages in the subscription\nare immediately dropped. Calls to Pull after deletion will return\nNOT_FOUND.",
- "httpMethod": "DELETE",
"parameterOrder": [
"subscription"
],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
+ "httpMethod": "GET",
"parameters": {
"subscription": {
- "pattern": "^.+$",
"location": "path",
- "description": "The subscription to delete.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta1a/subscriptions/{subscriptionsId}",
- "path": "v1beta1a/subscriptions/{+subscription}",
- "id": "pubsub.subscriptions.delete"
- },
- "list": {
- "response": {
- "$ref": "ListSubscriptionsResponse"
- },
- "httpMethod": "GET",
- "parameterOrder": [],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "maxResults": {
- "location": "query",
- "format": "int32",
- "description": "Maximum number of subscriptions to return.",
- "type": "integer"
- },
- "query": {
- "description": "A valid label query expression.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "description": "The value obtained in the last \u003ccode\u003eListSubscriptionsResponse\u003c/code\u003e\nfor continuation.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1beta1a/subscriptions",
- "id": "pubsub.subscriptions.list",
- "path": "v1beta1a/subscriptions",
- "description": "Lists matching subscriptions."
- }
- }
- },
- "topics": {
- "methods": {
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "Topic"
- },
- "parameterOrder": [
- "topic"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "topic": {
- "location": "path",
- "description": "The name of the topic to get.",
+ "description": "The name of the subscription to get.",
"type": "string",
"required": true,
"pattern": "^.+$"
}
},
- "flatPath": "v1beta1a/topics/{topicsId}",
- "path": "v1beta1a/topics/{+topic}",
- "id": "pubsub.topics.get",
- "description": "Gets the configuration of a topic. Since the topic only has the name\nattribute, this method is only useful to check the existence of a topic.\nIf other attributes are added in the future, they will be returned here."
- },
- "publish": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
- "flatPath": "v1beta1a/topics/publish",
- "path": "v1beta1a/topics/publish",
- "id": "pubsub.topics.publish",
- "description": "Adds a message to the topic. Returns NOT_FOUND if the topic does not\nexist.",
- "request": {
- "$ref": "PublishRequest"
- }
+ "flatPath": "v1beta1a/subscriptions/{subscriptionsId}",
+ "id": "pubsub.subscriptions.get",
+ "path": "v1beta1a/subscriptions/{+subscription}"
},
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "topic"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "topic": {
- "description": "Name of the topic to delete.",
- "type": "string",
- "required": true,
- "pattern": "^.+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta1a/topics/{topicsId}",
- "id": "pubsub.topics.delete",
- "path": "v1beta1a/topics/{+topic}",
- "description": "Deletes the topic with the given name. Returns NOT_FOUND if the topic does\nnot exist. After a topic is deleted, a new topic may be created with the\nsame name."
- },
- "publishBatch": {
- "flatPath": "v1beta1a/topics/publishBatch",
- "path": "v1beta1a/topics/publishBatch",
- "id": "pubsub.topics.publishBatch",
+ "pullBatch": {
+ "flatPath": "v1beta1a/subscriptions/pullBatch",
+ "path": "v1beta1a/subscriptions/pullBatch",
+ "id": "pubsub.subscriptions.pullBatch",
"request": {
- "$ref": "PublishBatchRequest"
+ "$ref": "PullBatchRequest"
},
- "description": "Adds one or more messages to the topic. Returns NOT_FOUND if the topic does\nnot exist.",
+ "description": "Pulls messages from the server. Returns an empty list if there are no\nmessages available in the backlog. The system is free to return UNAVAILABLE\nif there are too many pull requests outstanding for the given subscription.",
"httpMethod": "POST",
"parameterOrder": [],
"response": {
- "$ref": "PublishBatchResponse"
+ "$ref": "PullBatchResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
"parameters": {}
- },
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [],
- "response": {
- "$ref": "ListTopicsResponse"
- },
- "parameters": {
- "pageToken": {
- "description": "The value obtained in the last \u003ccode\u003eListTopicsResponse\u003c/code\u003e\nfor continuation.",
- "type": "string",
- "location": "query"
- },
- "maxResults": {
- "format": "int32",
- "description": "Maximum number of topics to return.",
- "type": "integer",
- "location": "query"
- },
- "query": {
- "description": "A valid label query expression.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta1a/topics",
- "path": "v1beta1a/topics",
- "id": "pubsub.topics.list",
- "description": "Lists matching topics."
- },
- "create": {
- "response": {
- "$ref": "Topic"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta1a/topics",
- "id": "pubsub.topics.create",
- "path": "v1beta1a/topics",
- "description": "Creates the given topic with the given name.",
- "request": {
- "$ref": "Topic"
- }
}
}
}
},
"parameters": {
- "key": {
- "type": "string",
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
- },
- "access_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth access token."
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
- },
"bearer_token": {
"location": "query",
"description": "OAuth bearer token.",
@@ -759,28 +738,28 @@
"type": "boolean",
"location": "query"
},
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
"uploadType": {
+ "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "type": "string"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
},
"$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
+ "type": "string"
},
"callback": {
"location": "query",
@@ -802,6 +781,27 @@
"location": "query",
"description": "Data format for response.",
"default": "json"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
}
}
}
diff --git a/pubsub/v1beta2/pubsub-api.json b/pubsub/v1beta2/pubsub-api.json
index 70d5885..a695983 100644
--- a/pubsub/v1beta2/pubsub-api.json
+++ b/pubsub/v1beta2/pubsub-api.json
@@ -1,898 +1,17 @@
{
- "ownerName": "Google",
- "discoveryVersion": "v1",
- "resources": {
- "projects": {
- "resources": {
- "subscriptions": {
- "methods": {
- "testIamPermissions": {
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:testIamPermissions",
- "id": "pubsub.projects.subscriptions.testIamPermissions",
- "path": "v1beta2/{+resource}:testIamPermissions",
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- }
- },
- "modifyPushConfig": {
- "description": "Modifies the `PushConfig` for a specified subscription.\n\nThis may be used to change a push subscription to a pull one (signified by\nan empty `PushConfig`) or vice versa, or change the endpoint URL and other\nattributes of a push subscription. Messages will accumulate for delivery\ncontinuously through the call regardless of changes to the `PushConfig`.",
- "request": {
- "$ref": "ModifyPushConfigRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "subscription"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "subscription": {
- "description": "The name of the subscription.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyPushConfig",
- "path": "v1beta2/{+subscription}:modifyPushConfig",
- "id": "pubsub.projects.subscriptions.modifyPushConfig"
- },
- "pull": {
- "id": "pubsub.projects.subscriptions.pull",
- "path": "v1beta2/{+subscription}:pull",
- "request": {
- "$ref": "PullRequest"
- },
- "description": "Pulls messages from the server. Returns an empty list if there are no\nmessages available in the backlog. The server may return `UNAVAILABLE` if\nthere are too many concurrent pull requests pending for the given\nsubscription.",
- "response": {
- "$ref": "PullResponse"
- },
- "parameterOrder": [
- "subscription"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "subscription": {
- "description": "The subscription from which messages should be pulled.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:pull"
- },
- "delete": {
- "id": "pubsub.projects.subscriptions.delete",
- "path": "v1beta2/{+subscription}",
- "description": "Deletes an existing subscription. All pending messages in the subscription\nare immediately dropped. Calls to `Pull` after deletion will return\n`NOT_FOUND`. After a subscription is deleted, a new one may be created with\nthe same name, but the new one has no association with the old\nsubscription, or its topic unless the same topic is specified.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "subscription"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "subscription": {
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path",
- "description": "The subscription to delete.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}"
- },
- "list": {
- "response": {
- "$ref": "ListSubscriptionsResponse"
- },
- "parameterOrder": [
- "project"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "description": "The value returned by the last `ListSubscriptionsResponse`; indicates that\nthis is a continuation of a prior `ListSubscriptions` call, and that the\nsystem should return the next page of data.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "format": "int32",
- "description": "Maximum number of subscriptions to return.",
- "type": "integer",
- "location": "query"
- },
- "project": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The name of the cloud project that subscriptions belong to.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions",
- "id": "pubsub.projects.subscriptions.list",
- "path": "v1beta2/{+project}/subscriptions",
- "description": "Lists matching subscriptions."
- },
- "setIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:setIamPolicy",
- "id": "pubsub.projects.subscriptions.setIamPolicy",
- "path": "v1beta2/{+resource}:setIamPolicy",
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "request": {
- "$ref": "SetIamPolicyRequest"
- }
- },
- "create": {
- "response": {
- "$ref": "Subscription"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path",
- "description": "The name of the subscription. It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characters\nin length, and it must not start with `\"goog\"`.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}",
- "id": "pubsub.projects.subscriptions.create",
- "path": "v1beta2/{+name}",
- "description": "Creates a subscription to a given topic.\nIf the subscription already exists, returns `ALREADY_EXISTS`.\nIf the corresponding topic doesn't exist, returns `NOT_FOUND`.\n\nIf the name is not provided in the request, the server will assign a random\nname for this subscription on the same project as the topic. Note that\nfor REST API requests, you must specify a name.",
- "request": {
- "$ref": "Subscription"
- }
- },
- "acknowledge": {
- "httpMethod": "POST",
- "parameterOrder": [
- "subscription"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "subscription": {
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path",
- "description": "The subscription whose message is being acknowledged.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:acknowledge",
- "path": "v1beta2/{+subscription}:acknowledge",
- "id": "pubsub.projects.subscriptions.acknowledge",
- "request": {
- "$ref": "AcknowledgeRequest"
- },
- "description": "Acknowledges the messages associated with the `ack_ids` in the\n`AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages\nfrom the subscription.\n\nAcknowledging a message whose ack deadline has expired may succeed,\nbut such a message may be redelivered later. Acknowledging a message more\nthan once will not result in an error."
- },
- "modifyAckDeadline": {
- "path": "v1beta2/{+subscription}:modifyAckDeadline",
- "id": "pubsub.projects.subscriptions.modifyAckDeadline",
- "description": "Modifies the ack deadline for a specific message. This method is useful\nto indicate that more time is needed to process a message by the\nsubscriber, or to make the message available for redelivery if the\nprocessing was interrupted. Note that this does not modify the\nsubscription-level `ackDeadlineSeconds` used for subsequent messages.",
- "request": {
- "$ref": "ModifyAckDeadlineRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "subscription"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "subscription": {
- "description": "The name of the subscription.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyAckDeadline"
- },
- "getIamPolicy": {
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:getIamPolicy",
- "id": "pubsub.projects.subscriptions.getIamPolicy",
- "path": "v1beta2/{+resource}:getIamPolicy"
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "Subscription"
- },
- "parameterOrder": [
- "subscription"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "subscription": {
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path",
- "description": "The name of the subscription to get.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}",
- "path": "v1beta2/{+subscription}",
- "id": "pubsub.projects.subscriptions.get",
- "description": "Gets the configuration details of a subscription."
- }
- }
- },
- "topics": {
- "resources": {
- "subscriptions": {
- "methods": {
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "topic"
- ],
- "response": {
- "$ref": "ListTopicSubscriptionsResponse"
- },
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "The value returned by the last `ListTopicSubscriptionsResponse`; indicates\nthat this is a continuation of a prior `ListTopicSubscriptions` call, and\nthat the system should return the next page of data.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Maximum number of subscription names to return.",
- "type": "integer"
- },
- "topic": {
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path",
- "description": "The name of the topic that subscriptions are attached to.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}/subscriptions",
- "path": "v1beta2/{+topic}/subscriptions",
- "id": "pubsub.projects.topics.subscriptions.list",
- "description": "Lists the name of the subscriptions for this topic."
- }
- }
- }
- },
- "methods": {
- "publish": {
- "request": {
- "$ref": "PublishRequest"
- },
- "description": "Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic\ndoes not exist. The message payload must not be empty; it must contain\n either a non-empty data field, or at least one attribute.",
- "httpMethod": "POST",
- "parameterOrder": [
- "topic"
- ],
- "response": {
- "$ref": "PublishResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "topic": {
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path",
- "description": "The messages in the request will be published on this topic.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:publish",
- "path": "v1beta2/{+topic}:publish",
- "id": "pubsub.projects.topics.publish"
- },
- "testIamPermissions": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:testIamPermissions",
- "path": "v1beta2/{+resource}:testIamPermissions",
- "id": "pubsub.projects.topics.testIamPermissions",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning."
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "httpMethod": "DELETE",
- "parameterOrder": [
- "topic"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "topic": {
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path",
- "description": "Name of the topic to delete.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}",
- "id": "pubsub.projects.topics.delete",
- "path": "v1beta2/{+topic}",
- "description": "Deletes the topic with the given name. Returns `NOT_FOUND` if the topic\ndoes not exist. After a topic is deleted, a new topic may be created with\nthe same name; this is an entirely new topic with none of the old\nconfiguration or subscriptions. Existing subscriptions to this topic are\nnot deleted, but their `topic` field is set to `_deleted-topic_`."
- },
- "list": {
- "response": {
- "$ref": "ListTopicsResponse"
- },
- "parameterOrder": [
- "project"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "description": "The value returned by the last `ListTopicsResponse`; indicates that this is\na continuation of a prior `ListTopics` call, and that the system should\nreturn the next page of data.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "format": "int32",
- "description": "Maximum number of topics to return.",
- "type": "integer",
- "location": "query"
- },
- "project": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The name of the cloud project that topics belong to.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/topics",
- "id": "pubsub.projects.topics.list",
- "path": "v1beta2/{+project}/topics",
- "description": "Lists matching topics."
- },
- "create": {
- "httpMethod": "PUT",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Topic"
- },
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path",
- "description": "The name of the topic. It must have the format\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter,\nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),\nunderscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent\nsigns (`%`). It must be between 3 and 255 characters in length, and it\nmust not start with `\"goog\"`.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}",
- "path": "v1beta2/{+name}",
- "id": "pubsub.projects.topics.create",
- "description": "Creates the given topic with the given name.",
- "request": {
- "$ref": "Topic"
- }
- },
- "setIamPolicy": {
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:setIamPolicy",
- "path": "v1beta2/{+resource}:setIamPolicy",
- "id": "pubsub.projects.topics.setIamPolicy"
- },
- "getIamPolicy": {
- "httpMethod": "GET",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:getIamPolicy",
- "path": "v1beta2/{+resource}:getIamPolicy",
- "id": "pubsub.projects.topics.getIamPolicy",
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset."
- },
- "get": {
- "description": "Gets the configuration of a topic.",
- "response": {
- "$ref": "Topic"
- },
- "parameterOrder": [
- "topic"
- ],
- "httpMethod": "GET",
- "parameters": {
- "topic": {
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path",
- "description": "The name of the topic to get.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}",
- "id": "pubsub.projects.topics.get",
- "path": "v1beta2/{+topic}"
- }
- }
- }
- }
- }
- },
- "parameters": {
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- },
- "alt": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- }
- },
"schemas": {
- "SetIamPolicyRequest": {
- "properties": {
- "policy": {
- "$ref": "Policy",
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
- }
- },
- "id": "SetIamPolicyRequest",
- "description": "Request message for `SetIamPolicy` method.",
- "type": "object"
- },
- "PubsubMessage": {
- "description": "A message data and its attributes. The message payload must not be empty;\nit must contain either a non-empty data field, or at least one attribute.",
- "type": "object",
- "properties": {
- "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"
- },
- "attributes": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional attributes for this message.",
- "type": "object"
- },
- "publishTime": {
- "format": "google-datetime",
- "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.",
- "type": "string"
- },
- "data": {
- "format": "byte",
- "description": "The message payload. For JSON requests, the value of this field must be\n[base64-encoded](https://tools.ietf.org/html/rfc4648).",
- "type": "string"
- }
- },
- "id": "PubsubMessage"
- },
- "ModifyPushConfigRequest": {
- "properties": {
- "pushConfig": {
- "description": "The push configuration for future deliveries.\n\nAn empty `pushConfig` indicates that the Pub/Sub system should\nstop pushing messages from the given subscription and allow\nmessages to be pulled and acknowledged - effectively pausing\nthe subscription if `Pull` is not called.",
- "$ref": "PushConfig"
- }
- },
- "id": "ModifyPushConfigRequest",
- "description": "Request for the ModifyPushConfig method.",
- "type": "object"
- },
- "Binding": {
- "description": "Associates `members` with a `role`.",
- "type": "object",
- "properties": {
- "members": {
- "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "role": {
- "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
- "type": "string"
- }
- },
- "id": "Binding"
- },
- "Empty": {
- "properties": {},
- "id": "Empty",
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object"
- },
- "ListTopicsResponse": {
- "properties": {
- "nextPageToken": {
- "description": "If not empty, indicates that there may be more topics that match the\nrequest; this value should be passed in a new `ListTopicsRequest`.",
- "type": "string"
- },
- "topics": {
- "description": "The resulting topics.",
- "items": {
- "$ref": "Topic"
- },
- "type": "array"
- }
- },
- "id": "ListTopicsResponse",
- "description": "Response for the `ListTopics` method.",
- "type": "object"
- },
- "AcknowledgeRequest": {
- "properties": {
- "ackIds": {
- "description": "The acknowledgment ID for the messages being acknowledged that was returned\nby the Pub/Sub system in the `Pull` response. Must not be empty.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "AcknowledgeRequest",
- "description": "Request for the Acknowledge method.",
- "type": "object"
- },
- "ListTopicSubscriptionsResponse": {
- "description": "Response for the `ListTopicSubscriptions` method.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "If not empty, indicates that there may be more subscriptions that match\nthe request; this value should be passed in a new\n`ListTopicSubscriptionsRequest` to get more subscriptions.",
- "type": "string"
- },
- "subscriptions": {
- "description": "The names of the subscriptions that match the request.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "ListTopicSubscriptionsResponse"
- },
- "PullResponse": {
- "properties": {
- "receivedMessages": {
- "description": "Received Pub/Sub messages. The Pub/Sub system will return zero messages if\nthere are no more available in the backlog. The Pub/Sub system may return\nfewer than the `maxMessages` requested even if there are more messages\navailable in the backlog.",
- "items": {
- "$ref": "ReceivedMessage"
- },
- "type": "array"
- }
- },
- "id": "PullResponse",
- "description": "Response for the `Pull` method.",
- "type": "object"
- },
- "ReceivedMessage": {
- "properties": {
- "message": {
- "$ref": "PubsubMessage",
- "description": "The message."
- },
- "ackId": {
- "description": "This ID can be used to acknowledge the received message.",
- "type": "string"
- }
- },
- "id": "ReceivedMessage",
- "description": "A message and its corresponding acknowledgment ID.",
- "type": "object"
- },
- "PushConfig": {
- "description": "Configuration for a push delivery endpoint.",
- "type": "object",
- "properties": {
- "attributes": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Endpoint configuration attributes.\n\nEvery endpoint has a set of API supported attributes that can be used to\ncontrol different aspects of the message delivery.\n\nThe currently supported attribute is `x-goog-version`, which you can\nuse to change the format of the push message. This attribute\nindicates the version of the data expected by the endpoint. This\ncontrols the shape of the envelope (i.e. its fields and metadata).\nThe endpoint version is based on the version of the Pub/Sub\nAPI.\n\nIf not present during the `CreateSubscription` call, it will default to\nthe version of the API used to make such call. If not present during a\n`ModifyPushConfig` call, its value will not be changed. `GetSubscription`\ncalls will always return a valid version, even if the subscription was\ncreated without this attribute.\n\nThe possible values for this attribute are:\n\n* `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.\n* `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.",
- "type": "object"
- },
- "pushEndpoint": {
- "description": "A URL locating the endpoint to which messages should be pushed.\nFor example, a Webhook endpoint might use \"https://example.com/push\".",
- "type": "string"
- }
- },
- "id": "PushConfig"
- },
- "TestIamPermissionsResponse": {
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "TestIamPermissionsResponse"
- },
"PullRequest": {
"description": "Request for the `Pull` method.",
"type": "object",
"properties": {
- "returnImmediately": {
- "description": "If this is specified as true the system will respond immediately even if\nit is not able to return a message in the `Pull` response. Otherwise the\nsystem is allowed to wait until at least one message is available rather\nthan returning no messages. The client may cancel the request if it does\nnot wish to wait any longer for the response.",
- "type": "boolean"
- },
"maxMessages": {
"format": "int32",
"description": "The maximum number of messages returned for this request. The Pub/Sub\nsystem may return fewer than the number specified.",
"type": "integer"
+ },
+ "returnImmediately": {
+ "description": "If this is specified as true the system will respond immediately even if\nit is not able to return a message in the `Pull` response. Otherwise the\nsystem is allowed to wait until at least one message is available rather\nthan returning no messages. The client may cancel the request if it does\nnot wish to wait any longer for the response.",
+ "type": "boolean"
}
},
"id": "PullRequest"
@@ -947,9 +66,13 @@
"description": "A subscription resource.",
"type": "object",
"properties": {
+ "topic": {
+ "description": "The name of the topic from which this subscription is receiving messages.\nThe value of this field will be `_deleted-topic_` if the topic has been\ndeleted.",
+ "type": "string"
+ },
"pushConfig": {
- "$ref": "PushConfig",
- "description": "If push delivery is used with this subscription, this field is\nused to configure it. An empty `pushConfig` signifies that the subscriber\nwill pull and ack messages using API methods."
+ "description": "If push delivery is used with this subscription, this field is\nused to configure it. An empty `pushConfig` signifies that the subscriber\nwill pull and ack messages using API methods.",
+ "$ref": "PushConfig"
},
"ackDeadlineSeconds": {
"format": "int32",
@@ -959,10 +82,6 @@
"name": {
"description": "The name of the subscription. It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characters\nin length, and it must not start with `\"goog\"`.",
"type": "string"
- },
- "topic": {
- "description": "The name of the topic from which this subscription is receiving messages.\nThe value of this field will be `_deleted-topic_` if the topic has been\ndeleted.",
- "type": "string"
}
},
"id": "Subscription"
@@ -981,10 +100,28 @@
},
"id": "TestIamPermissionsRequest"
},
+ "Topic": {
+ "description": "A topic resource.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the topic. It must have the format\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter,\nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),\nunderscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent\nsigns (`%`). It must be between 3 and 255 characters in length, and it\nmust not start with `\"goog\"`.",
+ "type": "string"
+ }
+ },
+ "id": "Topic"
+ },
"Policy": {
"description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
"type": "object",
"properties": {
+ "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": {
"format": "byte",
"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.",
@@ -994,32 +131,21 @@
"format": "int32",
"description": "Version of the `Policy`. The default version is 0.",
"type": "integer"
- },
- "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"
}
},
"id": "Policy"
},
- "Topic": {
- "properties": {
- "name": {
- "description": "The name of the topic. It must have the format\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter,\nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),\nunderscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent\nsigns (`%`). It must be between 3 and 255 characters in length, and it\nmust not start with `\"goog\"`.",
- "type": "string"
- }
- },
- "id": "Topic",
- "description": "A topic resource.",
- "type": "object"
- },
"ModifyAckDeadlineRequest": {
"description": "Request for the ModifyAckDeadline method.",
"type": "object",
"properties": {
+ "ackIds": {
+ "description": "List of acknowledgment IDs.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
"ackId": {
"description": "The acknowledgment ID. Either this or ack_ids must be populated, but not\nboth.",
"type": "string"
@@ -1028,41 +154,219 @@
"format": "int32",
"description": "The new ack deadline with respect to the time this request was sent to\nthe Pub/Sub system. Must be \u003e= 0. For example, if the value is 10, the new\nack deadline will expire 10 seconds after the `ModifyAckDeadline` call\nwas made. Specifying zero may immediately make the message available for\nanother pull request.",
"type": "integer"
+ }
+ },
+ "id": "ModifyAckDeadlineRequest"
+ },
+ "SetIamPolicyRequest": {
+ "description": "Request message for `SetIamPolicy` method.",
+ "type": "object",
+ "properties": {
+ "policy": {
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.",
+ "$ref": "Policy"
+ }
+ },
+ "id": "SetIamPolicyRequest"
+ },
+ "ModifyPushConfigRequest": {
+ "description": "Request for the ModifyPushConfig method.",
+ "type": "object",
+ "properties": {
+ "pushConfig": {
+ "$ref": "PushConfig",
+ "description": "The push configuration for future deliveries.\n\nAn empty `pushConfig` indicates that the Pub/Sub system should\nstop pushing messages from the given subscription and allow\nmessages to be pulled and acknowledged - effectively pausing\nthe subscription if `Pull` is not called."
+ }
+ },
+ "id": "ModifyPushConfigRequest"
+ },
+ "PubsubMessage": {
+ "description": "A message data and its attributes. The message payload must not be empty;\nit must contain either a non-empty data field, or at least one attribute.",
+ "type": "object",
+ "properties": {
+ "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"
},
+ "attributes": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional attributes for this message.",
+ "type": "object"
+ },
+ "publishTime": {
+ "format": "google-datetime",
+ "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.",
+ "type": "string"
+ },
+ "data": {
+ "format": "byte",
+ "description": "The message payload. For JSON requests, the value of this field must be\n[base64-encoded](https://tools.ietf.org/html/rfc4648).",
+ "type": "string"
+ }
+ },
+ "id": "PubsubMessage"
+ },
+ "Binding": {
+ "description": "Associates `members` with a `role`.",
+ "type": "object",
+ "properties": {
+ "members": {
+ "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "role": {
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
+ "type": "string"
+ }
+ },
+ "id": "Binding"
+ },
+ "ListTopicsResponse": {
+ "description": "Response for the `ListTopics` method.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "If not empty, indicates that there may be more topics that match the\nrequest; this value should be passed in a new `ListTopicsRequest`.",
+ "type": "string"
+ },
+ "topics": {
+ "description": "The resulting topics.",
+ "items": {
+ "$ref": "Topic"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListTopicsResponse"
+ },
+ "AcknowledgeRequest": {
+ "description": "Request for the Acknowledge method.",
+ "type": "object",
+ "properties": {
"ackIds": {
- "description": "List of acknowledgment IDs.",
+ "description": "The acknowledgment ID for the messages being acknowledged that was returned\nby the Pub/Sub system in the `Pull` response. Must not be empty.",
"items": {
"type": "string"
},
"type": "array"
}
},
- "id": "ModifyAckDeadlineRequest"
+ "id": "AcknowledgeRequest"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
+ },
+ "ListTopicSubscriptionsResponse": {
+ "description": "Response for the `ListTopicSubscriptions` method.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "If not empty, indicates that there may be more subscriptions that match\nthe request; this value should be passed in a new\n`ListTopicSubscriptionsRequest` to get more subscriptions.",
+ "type": "string"
+ },
+ "subscriptions": {
+ "description": "The names of the subscriptions that match the request.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListTopicSubscriptionsResponse"
+ },
+ "PullResponse": {
+ "description": "Response for the `Pull` method.",
+ "type": "object",
+ "properties": {
+ "receivedMessages": {
+ "description": "Received Pub/Sub messages. The Pub/Sub system will return zero messages if\nthere are no more available in the backlog. The Pub/Sub system may return\nfewer than the `maxMessages` requested even if there are more messages\navailable in the backlog.",
+ "items": {
+ "$ref": "ReceivedMessage"
+ },
+ "type": "array"
+ }
+ },
+ "id": "PullResponse"
+ },
+ "ReceivedMessage": {
+ "description": "A message and its corresponding acknowledgment ID.",
+ "type": "object",
+ "properties": {
+ "message": {
+ "description": "The message.",
+ "$ref": "PubsubMessage"
+ },
+ "ackId": {
+ "description": "This ID can be used to acknowledge the received message.",
+ "type": "string"
+ }
+ },
+ "id": "ReceivedMessage"
+ },
+ "PushConfig": {
+ "description": "Configuration for a push delivery endpoint.",
+ "type": "object",
+ "properties": {
+ "attributes": {
+ "description": "Endpoint configuration attributes.\n\nEvery endpoint has a set of API supported attributes that can be used to\ncontrol different aspects of the message delivery.\n\nThe currently supported attribute is `x-goog-version`, which you can\nuse to change the format of the push message. This attribute\nindicates the version of the data expected by the endpoint. This\ncontrols the shape of the envelope (i.e. its fields and metadata).\nThe endpoint version is based on the version of the Pub/Sub\nAPI.\n\nIf not present during the `CreateSubscription` call, it will default to\nthe version of the API used to make such call. If not present during a\n`ModifyPushConfig` call, its value will not be changed. `GetSubscription`\ncalls will always return a valid version, even if the subscription was\ncreated without this attribute.\n\nThe possible values for this attribute are:\n\n* `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.\n* `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "pushEndpoint": {
+ "description": "A URL locating the endpoint to which messages should be pushed.\nFor example, a Webhook endpoint might use \"https://example.com/push\".",
+ "type": "string"
+ }
+ },
+ "id": "PushConfig"
+ },
+ "TestIamPermissionsResponse": {
+ "description": "Response message for `TestIamPermissions` method.",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "TestIamPermissionsResponse"
}
},
+ "protocol": "rest",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
- "protocol": "rest",
"version": "v1beta2",
"baseUrl": "https://pubsub.googleapis.com/",
"canonicalName": "Pubsub",
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
"https://www.googleapis.com/auth/pubsub": {
"description": "View and manage Pub/Sub topics and subscriptions"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
"servicePath": "",
- "kind": "discovery#restDescription",
"description": "Provides reliable, many-to-many, asynchronous messaging between applications.\n",
+ "kind": "discovery#restDescription",
"rootUrl": "https://pubsub.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
@@ -1071,5 +375,701 @@
"id": "pubsub:v1beta2",
"documentationLink": "https://cloud.google.com/pubsub/docs",
"revision": "20170918",
- "title": "Google Cloud Pub/Sub API"
+ "title": "Google Cloud Pub/Sub API",
+ "ownerName": "Google",
+ "discoveryVersion": "v1",
+ "resources": {
+ "projects": {
+ "resources": {
+ "subscriptions": {
+ "methods": {
+ "list": {
+ "description": "Lists matching subscriptions.",
+ "response": {
+ "$ref": "ListSubscriptionsResponse"
+ },
+ "parameterOrder": [
+ "project"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "description": "The value returned by the last `ListSubscriptionsResponse`; indicates that\nthis is a continuation of a prior `ListSubscriptions` call, and that the\nsystem should return the next page of data.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Maximum number of subscriptions to return.",
+ "type": "integer",
+ "location": "query"
+ },
+ "project": {
+ "description": "The name of the cloud project that subscriptions belong to.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions",
+ "id": "pubsub.projects.subscriptions.list",
+ "path": "v1beta2/{+project}/subscriptions"
+ },
+ "setIamPolicy": {
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:setIamPolicy",
+ "path": "v1beta2/{+resource}:setIamPolicy",
+ "id": "pubsub.projects.subscriptions.setIamPolicy"
+ },
+ "create": {
+ "description": "Creates a subscription to a given topic.\nIf the subscription already exists, returns `ALREADY_EXISTS`.\nIf the corresponding topic doesn't exist, returns `NOT_FOUND`.\n\nIf the name is not provided in the request, the server will assign a random\nname for this subscription on the same project as the topic. Note that\nfor REST API requests, you must specify a name.",
+ "request": {
+ "$ref": "Subscription"
+ },
+ "response": {
+ "$ref": "Subscription"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "name": {
+ "description": "The name of the subscription. It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characters\nin length, and it must not start with `\"goog\"`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}",
+ "id": "pubsub.projects.subscriptions.create",
+ "path": "v1beta2/{+name}"
+ },
+ "acknowledge": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "subscription"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "subscription": {
+ "location": "path",
+ "description": "The subscription whose message is being acknowledged.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:acknowledge",
+ "path": "v1beta2/{+subscription}:acknowledge",
+ "id": "pubsub.projects.subscriptions.acknowledge",
+ "description": "Acknowledges the messages associated with the `ack_ids` in the\n`AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages\nfrom the subscription.\n\nAcknowledging a message whose ack deadline has expired may succeed,\nbut such a message may be redelivered later. Acknowledging a message more\nthan once will not result in an error.",
+ "request": {
+ "$ref": "AcknowledgeRequest"
+ }
+ },
+ "modifyAckDeadline": {
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyAckDeadline",
+ "path": "v1beta2/{+subscription}:modifyAckDeadline",
+ "id": "pubsub.projects.subscriptions.modifyAckDeadline",
+ "description": "Modifies the ack deadline for a specific message. This method is useful\nto indicate that more time is needed to process a message by the\nsubscriber, or to make the message available for redelivery if the\nprocessing was interrupted. Note that this does not modify the\nsubscription-level `ackDeadlineSeconds` used for subsequent messages.",
+ "request": {
+ "$ref": "ModifyAckDeadlineRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "subscription"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "subscription": {
+ "location": "path",
+ "description": "The name of the subscription.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ]
+ },
+ "getIamPolicy": {
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:getIamPolicy",
+ "path": "v1beta2/{+resource}:getIamPolicy",
+ "id": "pubsub.projects.subscriptions.getIamPolicy",
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
+ }
+ }
+ },
+ "get": {
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}",
+ "id": "pubsub.projects.subscriptions.get",
+ "path": "v1beta2/{+subscription}",
+ "description": "Gets the configuration details of a subscription.",
+ "response": {
+ "$ref": "Subscription"
+ },
+ "parameterOrder": [
+ "subscription"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "subscription": {
+ "location": "path",
+ "description": "The name of the subscription to get.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
+ }
+ }
+ },
+ "testIamPermissions": {
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:testIamPermissions",
+ "id": "pubsub.projects.subscriptions.testIamPermissions",
+ "path": "v1beta2/{+resource}:testIamPermissions",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning."
+ },
+ "modifyPushConfig": {
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyPushConfig",
+ "path": "v1beta2/{+subscription}:modifyPushConfig",
+ "id": "pubsub.projects.subscriptions.modifyPushConfig",
+ "request": {
+ "$ref": "ModifyPushConfigRequest"
+ },
+ "description": "Modifies the `PushConfig` for a specified subscription.\n\nThis may be used to change a push subscription to a pull one (signified by\nan empty `PushConfig`) or vice versa, or change the endpoint URL and other\nattributes of a push subscription. Messages will accumulate for delivery\ncontinuously through the call regardless of changes to the `PushConfig`.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "subscription"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "subscription": {
+ "location": "path",
+ "description": "The name of the subscription.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
+ }
+ }
+ },
+ "pull": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "subscription"
+ ],
+ "response": {
+ "$ref": "PullResponse"
+ },
+ "parameters": {
+ "subscription": {
+ "description": "The subscription from which messages should be pulled.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:pull",
+ "path": "v1beta2/{+subscription}:pull",
+ "id": "pubsub.projects.subscriptions.pull",
+ "description": "Pulls messages from the server. Returns an empty list if there are no\nmessages available in the backlog. The server may return `UNAVAILABLE` if\nthere are too many concurrent pull requests pending for the given\nsubscription.",
+ "request": {
+ "$ref": "PullRequest"
+ }
+ },
+ "delete": {
+ "description": "Deletes an existing subscription. All pending messages in the subscription\nare immediately dropped. Calls to `Pull` after deletion will return\n`NOT_FOUND`. After a subscription is deleted, a new one may be created with\nthe same name, but the new one has no association with the old\nsubscription, or its topic unless the same topic is specified.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "subscription"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "subscription": {
+ "description": "The subscription to delete.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}",
+ "path": "v1beta2/{+subscription}",
+ "id": "pubsub.projects.subscriptions.delete"
+ }
+ }
+ },
+ "topics": {
+ "methods": {
+ "getIamPolicy": {
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:getIamPolicy",
+ "id": "pubsub.projects.topics.getIamPolicy",
+ "path": "v1beta2/{+resource}:getIamPolicy",
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset."
+ },
+ "get": {
+ "description": "Gets the configuration of a topic.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Topic"
+ },
+ "parameterOrder": [
+ "topic"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "topic": {
+ "location": "path",
+ "description": "The name of the topic to get.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/topics/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}",
+ "path": "v1beta2/{+topic}",
+ "id": "pubsub.projects.topics.get"
+ },
+ "publish": {
+ "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:publish",
+ "id": "pubsub.projects.topics.publish",
+ "path": "v1beta2/{+topic}:publish",
+ "description": "Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic\ndoes not exist. The message payload must not be empty; it must contain\n either a non-empty data field, or at least one attribute.",
+ "request": {
+ "$ref": "PublishRequest"
+ },
+ "response": {
+ "$ref": "PublishResponse"
+ },
+ "parameterOrder": [
+ "topic"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "topic": {
+ "location": "path",
+ "description": "The messages in the request will be published on this topic.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/topics/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ]
+ },
+ "testIamPermissions": {
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/topics/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:testIamPermissions",
+ "id": "pubsub.projects.topics.testIamPermissions",
+ "path": "v1beta2/{+resource}:testIamPermissions",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning."
+ },
+ "delete": {
+ "description": "Deletes the topic with the given name. Returns `NOT_FOUND` if the topic\ndoes not exist. After a topic is deleted, a new topic may be created with\nthe same name; this is an entirely new topic with none of the old\nconfiguration or subscriptions. Existing subscriptions to this topic are\nnot deleted, but their `topic` field is set to `_deleted-topic_`.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "topic"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "topic": {
+ "description": "Name of the topic to delete.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}",
+ "id": "pubsub.projects.topics.delete",
+ "path": "v1beta2/{+topic}"
+ },
+ "list": {
+ "description": "Lists matching topics.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListTopicsResponse"
+ },
+ "parameterOrder": [
+ "project"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "The value returned by the last `ListTopicsResponse`; indicates that this is\na continuation of a prior `ListTopics` call, and that the system should\nreturn the next page of data.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Maximum number of topics to return.",
+ "type": "integer",
+ "location": "query"
+ },
+ "project": {
+ "location": "path",
+ "description": "The name of the cloud project that topics belong to.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/topics",
+ "path": "v1beta2/{+project}/topics",
+ "id": "pubsub.projects.topics.list"
+ },
+ "create": {
+ "request": {
+ "$ref": "Topic"
+ },
+ "description": "Creates the given topic with the given name.",
+ "response": {
+ "$ref": "Topic"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the topic. It must have the format\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter,\nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),\nunderscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent\nsigns (`%`). It must be between 3 and 255 characters in length, and it\nmust not start with `\"goog\"`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/topics/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}",
+ "id": "pubsub.projects.topics.create",
+ "path": "v1beta2/{+name}"
+ },
+ "setIamPolicy": {
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:setIamPolicy",
+ "id": "pubsub.projects.topics.setIamPolicy",
+ "path": "v1beta2/{+resource}:setIamPolicy"
+ }
+ },
+ "resources": {
+ "subscriptions": {
+ "methods": {
+ "list": {
+ "description": "Lists the name of the subscriptions for this topic.",
+ "response": {
+ "$ref": "ListTopicSubscriptionsResponse"
+ },
+ "parameterOrder": [
+ "topic"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "pageSize": {
+ "format": "int32",
+ "description": "Maximum number of subscription names to return.",
+ "type": "integer",
+ "location": "query"
+ },
+ "topic": {
+ "description": "The name of the topic that subscriptions are attached to.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "The value returned by the last `ListTopicSubscriptionsResponse`; indicates\nthat this is a continuation of a prior `ListTopicSubscriptions` call, and\nthat the system should return the next page of data.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}/subscriptions",
+ "id": "pubsub.projects.topics.subscriptions.list",
+ "path": "v1beta2/{+topic}/subscriptions"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "alt": {
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ }
+ }
}
diff --git a/runtimeconfig/v1/runtimeconfig-api.json b/runtimeconfig/v1/runtimeconfig-api.json
index 53689a9..2f0fed4 100644
--- a/runtimeconfig/v1/runtimeconfig-api.json
+++ b/runtimeconfig/v1/runtimeconfig-api.json
@@ -1,252 +1,11 @@
{
- "canonicalName": "Cloud RuntimeConfig",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloudruntimeconfig": {
- "description": "Manage your Google Cloud Platform services' runtime configuration"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "rootUrl": "https://runtimeconfig.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "runtimeconfig",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Google Cloud Runtime Configuration API",
- "ownerName": "Google",
- "resources": {
- "operations": {
- "methods": {
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "name": {
- "pattern": "^operations$",
- "location": "path",
- "description": "The name of the operation's parent resource.",
- "type": "string",
- "required": true
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer"
- },
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1/operations",
- "path": "v1/{+name}",
- "id": "runtimeconfig.operations.list",
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id."
- },
- "cancel": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "name": {
- "description": "The name of the operation resource to be cancelled.",
- "type": "string",
- "required": true,
- "pattern": "^operations/.+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1/operations/{operationsId}:cancel",
- "path": "v1/{+name}:cancel",
- "id": "runtimeconfig.operations.cancel",
- "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
- "request": {
- "$ref": "CancelOperationRequest"
- }
- },
- "delete": {
- "flatPath": "v1/operations/{operationsId}",
- "id": "runtimeconfig.operations.delete",
- "path": "v1/{+name}",
- "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "parameters": {
- "name": {
- "type": "string",
- "required": true,
- "pattern": "^operations/.+$",
- "location": "path",
- "description": "The name of the operation resource to be deleted."
- }
- }
- }
- }
- }
- },
- "parameters": {
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "callback": {
- "type": "string",
- "location": "query",
- "description": "JSONP"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
- },
- "alt": {
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ]
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "quotaUser": {
- "type": "string",
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
- }
- },
- "version": "v1",
- "baseUrl": "https://runtimeconfig.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "The Runtime Configurator allows you to dynamically configure and expose variables through Google Cloud Platform. In addition, you can also set Watchers and Waiters that will watch for changes to your data and return based on certain conditions.",
- "servicePath": "",
- "basePath": "",
- "documentationLink": "https://cloud.google.com/deployment-manager/runtime-configurator/",
- "id": "runtimeconfig:v1",
- "revision": "20171002",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "CancelOperationRequest": {
- "description": "The request message for Operations.CancelOperation.",
- "type": "object",
- "properties": {},
- "id": "CancelOperationRequest"
- },
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
- "code": {
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
@@ -257,21 +16,28 @@
"type": "object"
},
"type": "array"
+ },
+ "code": {
+ "format": "int32",
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "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"
},
"Operation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
"properties": {
"response": {
- "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`."
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object"
},
"name": {
"description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
@@ -294,7 +60,9 @@
"type": "boolean"
}
},
- "id": "Operation"
+ "id": "Operation",
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object"
},
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
@@ -313,11 +81,243 @@
}
},
"id": "ListOperationsResponse"
+ },
+ "Empty": {
+ "properties": {},
+ "id": "Empty",
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object"
+ },
+ "CancelOperationRequest": {
+ "description": "The request message for Operations.CancelOperation.",
+ "type": "object",
+ "properties": {},
+ "id": "CancelOperationRequest"
}
},
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
- "protocol": "rest"
+ "protocol": "rest",
+ "canonicalName": "Cloud RuntimeConfig",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/cloudruntimeconfig": {
+ "description": "Manage your Google Cloud Platform services' runtime configuration"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://runtimeconfig.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "runtimeconfig",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Google Cloud Runtime Configuration API",
+ "ownerName": "Google",
+ "resources": {
+ "operations": {
+ "methods": {
+ "cancel": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "pattern": "^operations/.+$",
+ "location": "path",
+ "description": "The name of the operation resource to be cancelled.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1/operations/{operationsId}:cancel",
+ "id": "runtimeconfig.operations.cancel",
+ "path": "v1/{+name}:cancel",
+ "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
+ "request": {
+ "$ref": "CancelOperationRequest"
+ }
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^operations/.+$",
+ "location": "path",
+ "description": "The name of the operation resource to be deleted.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1/operations/{operationsId}",
+ "path": "v1/{+name}",
+ "id": "runtimeconfig.operations.delete",
+ "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`."
+ },
+ "list": {
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the operation's parent resource.",
+ "type": "string",
+ "required": true,
+ "pattern": "^operations$",
+ "location": "path"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer",
+ "location": "query"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1/operations",
+ "path": "v1/{+name}",
+ "id": "runtimeconfig.operations.list"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://runtimeconfig.googleapis.com/",
+ "description": "The Runtime Configurator allows you to dynamically configure and expose variables through Google Cloud Platform. In addition, you can also set Watchers and Waiters that will watch for changes to your data and return based on certain conditions.",
+ "kind": "discovery#restDescription",
+ "servicePath": "",
+ "basePath": "",
+ "revision": "20171002",
+ "documentationLink": "https://cloud.google.com/deployment-manager/runtime-configurator/",
+ "id": "runtimeconfig:v1"
}
diff --git a/runtimeconfig/v1beta1/runtimeconfig-api.json b/runtimeconfig/v1beta1/runtimeconfig-api.json
index 8a3a6a2..66b4cc7 100644
--- a/runtimeconfig/v1beta1/runtimeconfig-api.json
+++ b/runtimeconfig/v1beta1/runtimeconfig-api.json
@@ -1,857 +1,8 @@
{
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "configs": {
- "resources": {
- "variables": {
- "methods": {
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "parameters": {
- "recursive": {
- "description": "Set to `true` to recursively delete multiple variables with the same\nprefix.",
- "type": "boolean",
- "location": "query"
- },
- "name": {
- "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
- "location": "path",
- "description": "The name of the variable to delete, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]`",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}",
- "id": "runtimeconfig.projects.configs.variables.delete",
- "path": "v1beta1/{+name}",
- "description": "Deletes a variable or multiple variables.\n\nIf you specify a variable name, then that variable is deleted. If you\nspecify a prefix and `recursive` is true, then all variables with that\nprefix are deleted. You must set a `recursive` to true if you delete\nvariables by prefix."
- },
- "list": {
- "response": {
- "$ref": "ListVariablesResponse"
- },
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "parameters": {
- "parent": {
- "description": "The path to the RuntimeConfig resource for which you want to list variables.\nThe configuration must exist beforehand; the path must be in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/configs/[^/]+$",
- "location": "path"
- },
- "filter": {
- "description": "Filters variables by matching the specified filter. For example:\n\n`projects/example-project/config/[CONFIG_NAME]/variables/example-variable`.",
- "type": "string",
- "location": "query"
- },
- "returnValues": {
- "location": "query",
- "description": "The flag indicates whether the user wants to return values of variables.\nIf true, then only those variables that user has IAM GetVariable permission\nwill be returned along with their values.",
- "type": "boolean"
- },
- "pageToken": {
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken`\nreturned by a previous list request to get the next page of results.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.",
- "type": "integer"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables",
- "id": "runtimeconfig.projects.configs.variables.list",
- "path": "v1beta1/{+parent}/variables",
- "description": "Lists variables within given a configuration, matching any provided filters.\nThis only lists variable names, not the values, unless `return_values` is\ntrue, in which case only variables that user has IAM permission to GetVariable\nwill be returned."
- },
- "create": {
- "path": "v1beta1/{+parent}/variables",
- "id": "runtimeconfig.projects.configs.variables.create",
- "description": "Creates a variable within the given configuration. You cannot create\na variable with a name that is a prefix of an existing variable name, or a\nname that has an existing variable name as a prefix.\n\nTo learn more about creating a variable, read the\n[Setting and Getting Data](/deployment-manager/runtime-configurator/set-and-get-variables)\ndocumentation.",
- "request": {
- "$ref": "Variable"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "Variable"
- },
- "parameters": {
- "requestId": {
- "description": "An optional but recommended unique `request_id`. If the server\nreceives two `create()` requests with the same\n`request_id`, then the second request will be ignored and the\nfirst resource created and stored in the backend is returned.\nEmpty `request_id` fields are ignored.\n\nIt is responsibility of the client to ensure uniqueness of the\n`request_id` strings.\n\n`request_id` strings are limited to 64 characters.",
- "type": "string",
- "location": "query"
- },
- "parent": {
- "description": "The path to the RutimeConfig resource that this variable should belong to.\nThe configuration must exist beforehand; the path must be in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/configs/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables"
- },
- "get": {
- "response": {
- "$ref": "Variable"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
- "location": "path",
- "description": "The name of the variable to return, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIBLE_NAME]`",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}",
- "id": "runtimeconfig.projects.configs.variables.get",
- "path": "v1beta1/{+name}",
- "description": "Gets information about a single variable."
- },
- "watch": {
- "description": "Watches a specific variable and waits for a change in the variable's value.\nWhen there is a change, this method returns the new value or times out.\n\nIf a variable is deleted while being watched, the `variableState` state is\nset to `DELETED` and the method returns the last known variable `value`.\n\nIf you set the deadline for watching to a larger value than internal timeout\n(60 seconds), the current variable value is returned and the `variableState`\nwill be `VARIABLE_STATE_UNSPECIFIED`.\n\nTo learn more about creating a watcher, read the\n[Watching a Variable for Changes](/deployment-manager/runtime-configurator/watching-a-variable)\ndocumentation.",
- "request": {
- "$ref": "WatchVariableRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Variable"
- },
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
- "location": "path",
- "description": "The name of the variable to watch, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}:watch",
- "path": "v1beta1/{+name}:watch",
- "id": "runtimeconfig.projects.configs.variables.watch"
- },
- "update": {
- "path": "v1beta1/{+name}",
- "id": "runtimeconfig.projects.configs.variables.update",
- "description": "Updates an existing variable with a new value.",
- "request": {
- "$ref": "Variable"
- },
- "httpMethod": "PUT",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Variable"
- },
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
- "location": "path",
- "description": "The name of the variable to update, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]`",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}"
- },
- "testIamPermissions": {
- "id": "runtimeconfig.projects.configs.variables.testIamPermissions",
- "path": "v1beta1/{+resource}:testIamPermissions",
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}:testIamPermissions"
- }
- }
- },
- "waiters": {
- "methods": {
- "delete": {
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "parameters": {
- "name": {
- "description": "The Waiter resource to delete, in the format:\n\n `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/configs/[^/]+/waiters/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}",
- "id": "runtimeconfig.projects.configs.waiters.delete",
- "path": "v1beta1/{+name}",
- "description": "Deletes the waiter with the specified name."
- },
- "get": {
- "description": "Gets information about a single waiter.",
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "response": {
- "$ref": "Waiter"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/configs/[^/]+/waiters/[^/]+$",
- "location": "path",
- "description": "The fully-qualified name of the Waiter resource object to retrieve, in the\nformat:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]`",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}",
- "id": "runtimeconfig.projects.configs.waiters.get",
- "path": "v1beta1/{+name}"
- },
- "list": {
- "id": "runtimeconfig.projects.configs.waiters.list",
- "path": "v1beta1/{+parent}/waiters",
- "description": "List waiters within the given configuration.",
- "response": {
- "$ref": "ListWaitersResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "parameters": {
- "parent": {
- "description": "The path to the configuration for which you want to get a list of waiters.\nThe configuration must exist beforehand; the path must be in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/configs/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken`\nreturned by a previous list request to get the next page of results.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.",
- "type": "integer"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters"
- },
- "create": {
- "path": "v1beta1/{+parent}/waiters",
- "id": "runtimeconfig.projects.configs.waiters.create",
- "description": "Creates a Waiter resource. This operation returns a long-running Operation\nresource which can be polled for completion. However, a waiter with the\ngiven name will exist (and can be retrieved) prior to the operation\ncompleting. If the operation fails, the failed Waiter resource will\nstill exist and must be deleted prior to subsequent creation attempts.",
- "request": {
- "$ref": "Waiter"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "requestId": {
- "location": "query",
- "description": "An optional but recommended unique `request_id`. If the server\nreceives two `create()` requests with the same\n`request_id`, then the second request will be ignored and the\nfirst resource created and stored in the backend is returned.\nEmpty `request_id` fields are ignored.\n\nIt is responsibility of the client to ensure uniqueness of the\n`request_id` strings.\n\n`request_id` strings are limited to 64 characters.",
- "type": "string"
- },
- "parent": {
- "pattern": "^projects/[^/]+/configs/[^/]+$",
- "location": "path",
- "description": "The path to the configuration that will own the waiter.\nThe configuration must exist beforehand; the path must be in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters"
- },
- "testIamPermissions": {
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/configs/[^/]+/waiters/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}:testIamPermissions",
- "id": "runtimeconfig.projects.configs.waiters.testIamPermissions",
- "path": "v1beta1/{+resource}:testIamPermissions",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning."
- }
- }
- },
- "operations": {
- "methods": {
- "testIamPermissions": {
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/configs/[^/]+/operations/.+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/operations/{operationsId}:testIamPermissions",
- "id": "runtimeconfig.projects.configs.operations.testIamPermissions",
- "path": "v1beta1/{+resource}:testIamPermissions",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning."
- },
- "get": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "The name of the operation resource.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/configs/[^/]+/operations/.+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/operations/{operationsId}",
- "id": "runtimeconfig.projects.configs.operations.get",
- "path": "v1beta1/{+name}",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
- }
- }
- }
- },
- "methods": {
- "getIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "GET",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/configs/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:getIamPolicy",
- "id": "runtimeconfig.projects.configs.getIamPolicy",
- "path": "v1beta1/{+resource}:getIamPolicy",
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset."
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "RuntimeConfig"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/configs/[^/]+$",
- "location": "path",
- "description": "The name of the RuntimeConfig resource to retrieve, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}",
- "path": "v1beta1/{+name}",
- "id": "runtimeconfig.projects.configs.get",
- "description": "Gets information about a RuntimeConfig resource."
- },
- "update": {
- "response": {
- "$ref": "RuntimeConfig"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/configs/[^/]+$",
- "location": "path",
- "description": "The name of the RuntimeConfig resource to update, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}",
- "id": "runtimeconfig.projects.configs.update",
- "path": "v1beta1/{+name}",
- "description": "Updates a RuntimeConfig resource. The configuration must exist beforehand.",
- "request": {
- "$ref": "RuntimeConfig"
- }
- },
- "testIamPermissions": {
- "id": "runtimeconfig.projects.configs.testIamPermissions",
- "path": "v1beta1/{+resource}:testIamPermissions",
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/configs/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:testIamPermissions"
- },
- "delete": {
- "description": "Deletes a RuntimeConfig resource.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "description": "The RuntimeConfig resource to delete, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/configs/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}",
- "id": "runtimeconfig.projects.configs.delete",
- "path": "v1beta1/{+name}"
- },
- "list": {
- "path": "v1beta1/{+parent}/configs",
- "id": "runtimeconfig.projects.configs.list",
- "description": "Lists all the RuntimeConfig resources within project.",
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "ListConfigsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848)\nfor this request, in the format `projects/[PROJECT_ID]`.",
- "type": "string",
- "required": true
- },
- "pageToken": {
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken`\nreturned by a previous list request to get the next page of results.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.",
- "type": "integer"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/configs"
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "RuntimeConfig"
- },
- "parameters": {
- "requestId": {
- "location": "query",
- "description": "An optional but recommended unique `request_id`. If the server\nreceives two `create()` requests with the same\n`request_id`, then the second request will be ignored and the\nfirst resource created and stored in the backend is returned.\nEmpty `request_id` fields are ignored.\n\nIt is responsibility of the client to ensure uniqueness of the\n`request_id` strings.\n\n`request_id` strings are limited to 64 characters.",
- "type": "string"
- },
- "parent": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848)\nfor this request, in the format `projects/[PROJECT_ID]`.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs",
- "path": "v1beta1/{+parent}/configs",
- "id": "runtimeconfig.projects.configs.create",
- "description": "Creates a new RuntimeConfig resource. The configuration name must be\nunique within project.",
- "request": {
- "$ref": "RuntimeConfig"
- }
- },
- "setIamPolicy": {
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/configs/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:setIamPolicy",
- "id": "runtimeconfig.projects.configs.setIamPolicy",
- "path": "v1beta1/{+resource}:setIamPolicy"
- }
- }
- }
- }
- }
- },
- "parameters": {
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- }
- },
- "version": "v1beta1",
- "baseUrl": "https://runtimeconfig.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "The Runtime Configurator allows you to dynamically configure and expose variables through Google Cloud Platform. In addition, you can also set Watchers and Waiters that will watch for changes to your data and return based on certain conditions.",
- "servicePath": "",
- "basePath": "",
- "revision": "20171002",
- "documentationLink": "https://cloud.google.com/deployment-manager/runtime-configurator/",
- "id": "runtimeconfig:v1beta1",
- "discoveryVersion": "v1",
- "version_module": true,
"schemas": {
- "TestIamPermissionsResponse": {
- "properties": {
- "permissions": {
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "TestIamPermissionsResponse",
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object"
- },
- "ListVariablesResponse": {
- "properties": {
- "variables": {
- "description": "A list of variables and their values. The order of returned variable\nobjects is arbitrary.",
- "items": {
- "$ref": "Variable"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `pageSize`, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to continue\npaging through the results",
- "type": "string"
- }
- },
- "id": "ListVariablesResponse",
- "description": "Response for the `ListVariables()` method.",
- "type": "object"
- },
- "RuntimeConfig": {
- "description": "A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig\nservice. A RuntimeConfig resource consists of metadata and a hierarchy of\nvariables.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The resource name of a runtime config. The name must have the format:\n\n projects/[PROJECT_ID]/configs/[CONFIG_NAME]\n\nThe `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an\narbitrary name that matches RFC 1035 segment specification. The length of\n`[CONFIG_NAME]` must be less than 64 bytes.\n\nYou pick the RuntimeConfig resource name, but the server will validate that\nthe name adheres to this format. After you create the resource, you cannot\nchange the resource's name.",
- "type": "string"
- },
- "description": {
- "description": "An optional description of the RuntimeConfig object.",
- "type": "string"
- }
- },
- "id": "RuntimeConfig"
- },
- "WatchVariableRequest": {
- "description": "Request for the `WatchVariable()` method.",
- "type": "object",
- "properties": {
- "newerThan": {
- "format": "google-datetime",
- "description": "If specified, checks the current timestamp of the variable and if the\ncurrent timestamp is newer than `newerThan` timestamp, the method returns\nimmediately.\n\nIf not specified or the variable has an older timestamp, the watcher waits\nfor a the value to change before returning.",
- "type": "string"
- }
- },
- "id": "WatchVariableRequest"
- },
"ListWaitersResponse": {
+ "description": "Response for the `ListWaiters()` method.\nOrder of returned waiter objects is arbitrary.",
+ "type": "object",
"properties": {
"nextPageToken": {
"description": "This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `pageSize`, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to continue\npaging through the results",
@@ -865,9 +16,44 @@
"type": "array"
}
},
- "id": "ListWaitersResponse",
- "description": "Response for the `ListWaiters()` method.\nOrder of returned waiter objects is arbitrary.",
- "type": "object"
+ "id": "ListWaitersResponse"
+ },
+ "Waiter": {
+ "description": "A Waiter resource waits for some end condition within a RuntimeConfig resource\nto be met before it returns. For example, assume you have a distributed\nsystem where each node writes to a Variable resource indidicating the node's\nreadiness as part of the startup process.\n\nYou then configure a Waiter resource with the success condition set to wait\nuntil some number of nodes have checked in. Afterwards, your application\nruns some arbitrary code after the condition has been met and the waiter\nreturns successfully.\n\nOnce created, a Waiter resource is immutable.\n\nTo learn more about using waiters, read the\n[Creating a Waiter](/deployment-manager/runtime-configurator/creating-a-waiter)\ndocumentation.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the Waiter resource, in the format:\n\n projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]\n\nThe `[PROJECT_ID]` must be a valid Google Cloud project ID,\nthe `[CONFIG_NAME]` must be a valid RuntimeConfig resource, the\n`[WAITER_NAME]` must match RFC 1035 segment specification, and the length\nof `[WAITER_NAME]` must be less than 64 bytes.\n\nAfter you create a Waiter resource, you cannot change the resource name.",
+ "type": "string"
+ },
+ "error": {
+ "description": "[Output Only] If the waiter ended due to a failure or timeout, this value\nwill be set.",
+ "$ref": "Status"
+ },
+ "failure": {
+ "$ref": "EndCondition",
+ "description": "[Optional] The failure condition of this waiter. If this condition is met,\n`done` will be set to `true` and the `error` code will be set to `ABORTED`.\nThe failure condition takes precedence over the success condition. If both\nconditions are met, a failure will be indicated. This value is optional; if\nno failure condition is set, the only failure scenario will be a timeout."
+ },
+ "success": {
+ "description": "[Required] The success condition. If this condition is met, `done` will be\nset to `true` and the `error` value will remain unset. The failure condition\ntakes precedence over the success condition. If both conditions are met, a\nfailure will be indicated.",
+ "$ref": "EndCondition"
+ },
+ "createTime": {
+ "format": "google-datetime",
+ "description": "[Output Only] The instant at which this Waiter resource was created. Adding\nthe value of `timeout` to this instant yields the timeout deadline for the\nwaiter.",
+ "type": "string"
+ },
+ "done": {
+ "description": "[Output Only] If the value is `false`, it means the waiter is still waiting\nfor one of its conditions to be met.\n\nIf true, the waiter has finished. If the waiter finished due to a timeout\nor failure, `error` will be set.",
+ "type": "boolean"
+ },
+ "timeout": {
+ "format": "google-duration",
+ "description": "[Required] Specifies the timeout of the waiter in seconds, beginning from\nthe instant that `waiters().create` method is called. If this time elapses\nbefore the success or failure conditions are met, the waiter fails and sets\nthe `error` code to `DEADLINE_EXCEEDED`.",
+ "type": "string"
+ }
+ },
+ "id": "Waiter"
},
"TestIamPermissionsRequest": {
"properties": {
@@ -883,65 +69,21 @@
"description": "Request message for `TestIamPermissions` method.",
"type": "object"
},
- "Waiter": {
- "properties": {
- "failure": {
- "$ref": "EndCondition",
- "description": "[Optional] The failure condition of this waiter. If this condition is met,\n`done` will be set to `true` and the `error` code will be set to `ABORTED`.\nThe failure condition takes precedence over the success condition. If both\nconditions are met, a failure will be indicated. This value is optional; if\nno failure condition is set, the only failure scenario will be a timeout."
- },
- "success": {
- "description": "[Required] The success condition. If this condition is met, `done` will be\nset to `true` and the `error` value will remain unset. The failure condition\ntakes precedence over the success condition. If both conditions are met, a\nfailure will be indicated.",
- "$ref": "EndCondition"
- },
- "done": {
- "description": "[Output Only] If the value is `false`, it means the waiter is still waiting\nfor one of its conditions to be met.\n\nIf true, the waiter has finished. If the waiter finished due to a timeout\nor failure, `error` will be set.",
- "type": "boolean"
- },
- "createTime": {
- "format": "google-datetime",
- "description": "[Output Only] The instant at which this Waiter resource was created. Adding\nthe value of `timeout` to this instant yields the timeout deadline for the\nwaiter.",
- "type": "string"
- },
- "timeout": {
- "format": "google-duration",
- "description": "[Required] Specifies the timeout of the waiter in seconds, beginning from\nthe instant that `waiters().create` method is called. If this time elapses\nbefore the success or failure conditions are met, the waiter fails and sets\nthe `error` code to `DEADLINE_EXCEEDED`.",
- "type": "string"
- },
- "name": {
- "description": "The name of the Waiter resource, in the format:\n\n projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]\n\nThe `[PROJECT_ID]` must be a valid Google Cloud project ID,\nthe `[CONFIG_NAME]` must be a valid RuntimeConfig resource, the\n`[WAITER_NAME]` must match RFC 1035 segment specification, and the length\nof `[WAITER_NAME]` must be less than 64 bytes.\n\nAfter you create a Waiter resource, you cannot change the resource name.",
- "type": "string"
- },
- "error": {
- "$ref": "Status",
- "description": "[Output Only] If the waiter ended due to a failure or timeout, this value\nwill be set."
- }
- },
- "id": "Waiter",
- "description": "A Waiter resource waits for some end condition within a RuntimeConfig resource\nto be met before it returns. For example, assume you have a distributed\nsystem where each node writes to a Variable resource indidicating the node's\nreadiness as part of the startup process.\n\nYou then configure a Waiter resource with the success condition set to wait\nuntil some number of nodes have checked in. Afterwards, your application\nruns some arbitrary code after the condition has been met and the waiter\nreturns successfully.\n\nOnce created, a Waiter resource is immutable.\n\nTo learn more about using waiters, read the\n[Creating a Waiter](/deployment-manager/runtime-configurator/creating-a-waiter)\ndocumentation.",
- "type": "object"
- },
"Variable": {
- "description": "Describes a single variable within a RuntimeConfig resource.\nThe name denotes the hierarchical variable name. For example,\n`ports/serving_port` is a valid variable name. The variable value is an\nopaque string and only leaf variables can have values (that is, variables\nthat do not have any child variables).",
- "type": "object",
"properties": {
- "value": {
- "format": "byte",
- "description": "The binary value of the variable. The length of the value must be less\nthan 4096 bytes. Empty values are also accepted. The value must be\nbase64 encoded. Only one of `value` or `text` can be set.",
- "type": "string"
- },
"state": {
+ "enumDescriptions": [
+ "Default variable state.",
+ "The variable was updated, while `variables().watch` was executing.",
+ "The variable was deleted, while `variables().watch` was executing."
+ ],
"enum": [
"VARIABLE_STATE_UNSPECIFIED",
"UPDATED",
"DELETED"
],
"description": "[Ouput only] The current state of the variable. The variable state indicates\nthe outcome of the `variables().watch` call and is visible through the\n`get` and `list` calls.",
- "type": "string",
- "enumDescriptions": [
- "Default variable state.",
- "The variable was updated, while `variables().watch` was executing.",
- "The variable was deleted, while `variables().watch` was executing."
- ]
+ "type": "string"
},
"updateTime": {
"format": "google-datetime",
@@ -955,11 +97,20 @@
"text": {
"description": "The string value of the variable. The length of the value must be less\nthan 4096 bytes. Empty values are also accepted. For example,\n`text: \"my text value\"`. The string must be valid UTF-8.",
"type": "string"
+ },
+ "value": {
+ "format": "byte",
+ "description": "The binary value of the variable. The length of the value must be less\nthan 4096 bytes. Empty values are also accepted. The value must be\nbase64 encoded. Only one of `value` or `text` can be set.",
+ "type": "string"
}
},
- "id": "Variable"
+ "id": "Variable",
+ "description": "Describes a single variable within a RuntimeConfig resource.\nThe name denotes the hierarchical variable name. For example,\n`ports/serving_port` is a valid variable name. The variable value is an\nopaque string and only leaf variables can have values (that is, variables\nthat do not have any child variables).",
+ "type": "object"
},
"Policy": {
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
+ "type": "object",
"properties": {
"etag": {
"format": "byte",
@@ -979,9 +130,7 @@
"type": "array"
}
},
- "id": "Policy",
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
- "type": "object"
+ "id": "Policy"
},
"Operation": {
"properties": {
@@ -1023,8 +172,8 @@
"type": "object",
"properties": {
"policy": {
- "$ref": "Policy",
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.",
+ "$ref": "Policy"
}
},
"id": "SetIamPolicyRequest"
@@ -1033,10 +182,6 @@
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
@@ -1052,13 +197,15 @@
"format": "int32",
"description": "The status code, which should be an enum value of google.rpc.Code.",
"type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
}
},
"id": "Status"
},
"Binding": {
- "description": "Associates `members` with a `role`.",
- "type": "object",
"properties": {
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
@@ -1072,7 +219,15 @@
"type": "string"
}
},
- "id": "Binding"
+ "id": "Binding",
+ "description": "Associates `members` with a `role`.",
+ "type": "object"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
},
"Cardinality": {
"description": "A Cardinality condition for the Waiter resource. A cardinality condition is\nmet when the number of variables under a specified path prefix reaches a\npredefined number. For example, if you set a Cardinality condition where\nthe `path` is set to `/foo` and the number of paths is set to 2, the\nfollowing variables would meet the condition in a RuntimeConfig resource:\n\n+ `/foo/variable1 = \"value1\"`\n+ `/foo/variable2 = \"value2\"`\n+ `/bar/variable3 = \"value3\"`\n\nIt would not would not satisify the same condition with the `number` set to\n3, however, because there is only 2 paths that start with `/foo`.\nCardinality conditions are recursive; all subtrees under the specific\npath prefix are counted.",
@@ -1090,12 +245,6 @@
},
"id": "Cardinality"
},
- "Empty": {
- "properties": {},
- "id": "Empty",
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object"
- },
"ListConfigsResponse": {
"properties": {
"nextPageToken": {
@@ -1124,6 +273,65 @@
"id": "EndCondition",
"description": "The condition that a Waiter resource is waiting for.",
"type": "object"
+ },
+ "TestIamPermissionsResponse": {
+ "properties": {
+ "permissions": {
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "TestIamPermissionsResponse",
+ "description": "Response message for `TestIamPermissions` method.",
+ "type": "object"
+ },
+ "ListVariablesResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `pageSize`, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to continue\npaging through the results",
+ "type": "string"
+ },
+ "variables": {
+ "description": "A list of variables and their values. The order of returned variable\nobjects is arbitrary.",
+ "items": {
+ "$ref": "Variable"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListVariablesResponse",
+ "description": "Response for the `ListVariables()` method.",
+ "type": "object"
+ },
+ "RuntimeConfig": {
+ "description": "A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig\nservice. A RuntimeConfig resource consists of metadata and a hierarchy of\nvariables.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The resource name of a runtime config. The name must have the format:\n\n projects/[PROJECT_ID]/configs/[CONFIG_NAME]\n\nThe `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an\narbitrary name that matches RFC 1035 segment specification. The length of\n`[CONFIG_NAME]` must be less than 64 bytes.\n\nYou pick the RuntimeConfig resource name, but the server will validate that\nthe name adheres to this format. After you create the resource, you cannot\nchange the resource's name.",
+ "type": "string"
+ },
+ "description": {
+ "description": "An optional description of the RuntimeConfig object.",
+ "type": "string"
+ }
+ },
+ "id": "RuntimeConfig"
+ },
+ "WatchVariableRequest": {
+ "properties": {
+ "newerThan": {
+ "format": "google-datetime",
+ "description": "If specified, checks the current timestamp of the variable and if the\ncurrent timestamp is newer than `newerThan` timestamp, the method returns\nimmediately.\n\nIf not specified or the variable has an older timestamp, the watcher waits\nfor a the value to change before returning.",
+ "type": "string"
+ }
+ },
+ "id": "WatchVariableRequest",
+ "description": "Request for the `WatchVariable()` method.",
+ "type": "object"
}
},
"protocol": "rest",
@@ -1135,11 +343,11 @@
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/cloudruntimeconfig": {
- "description": "Manage your Google Cloud Platform services' runtime configuration"
- },
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/cloudruntimeconfig": {
+ "description": "Manage your Google Cloud Platform services' runtime configuration"
}
}
}
@@ -1149,5 +357,797 @@
"name": "runtimeconfig",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
- "title": "Google Cloud Runtime Configuration API"
+ "title": "Google Cloud Runtime Configuration API",
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "resources": {
+ "configs": {
+ "resources": {
+ "variables": {
+ "methods": {
+ "delete": {
+ "description": "Deletes a variable or multiple variables.\n\nIf you specify a variable name, then that variable is deleted. If you\nspecify a prefix and `recursive` is true, then all variables with that\nprefix are deleted. You must set a `recursive` to true if you delete\nvariables by prefix.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "recursive": {
+ "description": "Set to `true` to recursively delete multiple variables with the same\nprefix.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "name": {
+ "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
+ "location": "path",
+ "description": "The name of the variable to delete, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]`",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}",
+ "path": "v1beta1/{+name}",
+ "id": "runtimeconfig.projects.configs.variables.delete"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListVariablesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "returnValues": {
+ "description": "The flag indicates whether the user wants to return values of variables.\nIf true, then only those variables that user has IAM GetVariable permission\nwill be returned along with their values.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken`\nreturned by a previous list request to get the next page of results.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.",
+ "type": "integer"
+ },
+ "parent": {
+ "pattern": "^projects/[^/]+/configs/[^/]+$",
+ "location": "path",
+ "description": "The path to the RuntimeConfig resource for which you want to list variables.\nThe configuration must exist beforehand; the path must be in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
+ "type": "string",
+ "required": true
+ },
+ "filter": {
+ "location": "query",
+ "description": "Filters variables by matching the specified filter. For example:\n\n`projects/example-project/config/[CONFIG_NAME]/variables/example-variable`.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables",
+ "path": "v1beta1/{+parent}/variables",
+ "id": "runtimeconfig.projects.configs.variables.list",
+ "description": "Lists variables within given a configuration, matching any provided filters.\nThis only lists variable names, not the values, unless `return_values` is\ntrue, in which case only variables that user has IAM permission to GetVariable\nwill be returned."
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "Variable"
+ },
+ "parameters": {
+ "requestId": {
+ "description": "An optional but recommended unique `request_id`. If the server\nreceives two `create()` requests with the same\n`request_id`, then the second request will be ignored and the\nfirst resource created and stored in the backend is returned.\nEmpty `request_id` fields are ignored.\n\nIt is responsibility of the client to ensure uniqueness of the\n`request_id` strings.\n\n`request_id` strings are limited to 64 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "parent": {
+ "pattern": "^projects/[^/]+/configs/[^/]+$",
+ "location": "path",
+ "description": "The path to the RutimeConfig resource that this variable should belong to.\nThe configuration must exist beforehand; the path must be in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables",
+ "path": "v1beta1/{+parent}/variables",
+ "id": "runtimeconfig.projects.configs.variables.create",
+ "description": "Creates a variable within the given configuration. You cannot create\na variable with a name that is a prefix of an existing variable name, or a\nname that has an existing variable name as a prefix.\n\nTo learn more about creating a variable, read the\n[Setting and Getting Data](/deployment-manager/runtime-configurator/set-and-get-variables)\ndocumentation.",
+ "request": {
+ "$ref": "Variable"
+ }
+ },
+ "get": {
+ "response": {
+ "$ref": "Variable"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the variable to return, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIBLE_NAME]`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}",
+ "id": "runtimeconfig.projects.configs.variables.get",
+ "path": "v1beta1/{+name}",
+ "description": "Gets information about a single variable."
+ },
+ "watch": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Variable"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the variable to watch, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}:watch",
+ "path": "v1beta1/{+name}:watch",
+ "id": "runtimeconfig.projects.configs.variables.watch",
+ "request": {
+ "$ref": "WatchVariableRequest"
+ },
+ "description": "Watches a specific variable and waits for a change in the variable's value.\nWhen there is a change, this method returns the new value or times out.\n\nIf a variable is deleted while being watched, the `variableState` state is\nset to `DELETED` and the method returns the last known variable `value`.\n\nIf you set the deadline for watching to a larger value than internal timeout\n(60 seconds), the current variable value is returned and the `variableState`\nwill be `VARIABLE_STATE_UNSPECIFIED`.\n\nTo learn more about creating a watcher, read the\n[Watching a Variable for Changes](/deployment-manager/runtime-configurator/watching-a-variable)\ndocumentation."
+ },
+ "update": {
+ "response": {
+ "$ref": "Variable"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
+ "location": "path",
+ "description": "The name of the variable to update, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]`",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}",
+ "id": "runtimeconfig.projects.configs.variables.update",
+ "path": "v1beta1/{+name}",
+ "description": "Updates an existing variable with a new value.",
+ "request": {
+ "$ref": "Variable"
+ }
+ },
+ "testIamPermissions": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}:testIamPermissions",
+ "path": "v1beta1/{+resource}:testIamPermissions",
+ "id": "runtimeconfig.projects.configs.variables.testIamPermissions",
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ }
+ }
+ }
+ },
+ "waiters": {
+ "methods": {
+ "delete": {
+ "id": "runtimeconfig.projects.configs.waiters.delete",
+ "path": "v1beta1/{+name}",
+ "description": "Deletes the waiter with the specified name.",
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The Waiter resource to delete, in the format:\n\n `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/configs/[^/]+/waiters/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}"
+ },
+ "get": {
+ "response": {
+ "$ref": "Waiter"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/configs/[^/]+/waiters/[^/]+$",
+ "location": "path",
+ "description": "The fully-qualified name of the Waiter resource object to retrieve, in the\nformat:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]`",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}",
+ "id": "runtimeconfig.projects.configs.waiters.get",
+ "path": "v1beta1/{+name}",
+ "description": "Gets information about a single waiter."
+ },
+ "list": {
+ "description": "List waiters within the given configuration.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListWaitersResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+/configs/[^/]+$",
+ "location": "path",
+ "description": "The path to the configuration for which you want to get a list of waiters.\nThe configuration must exist beforehand; the path must be in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
+ "type": "string",
+ "required": true
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken`\nreturned by a previous list request to get the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.",
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters",
+ "path": "v1beta1/{+parent}/waiters",
+ "id": "runtimeconfig.projects.configs.waiters.list"
+ },
+ "create": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "requestId": {
+ "description": "An optional but recommended unique `request_id`. If the server\nreceives two `create()` requests with the same\n`request_id`, then the second request will be ignored and the\nfirst resource created and stored in the backend is returned.\nEmpty `request_id` fields are ignored.\n\nIt is responsibility of the client to ensure uniqueness of the\n`request_id` strings.\n\n`request_id` strings are limited to 64 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "parent": {
+ "pattern": "^projects/[^/]+/configs/[^/]+$",
+ "location": "path",
+ "description": "The path to the configuration that will own the waiter.\nThe configuration must exist beforehand; the path must be in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters",
+ "id": "runtimeconfig.projects.configs.waiters.create",
+ "path": "v1beta1/{+parent}/waiters",
+ "description": "Creates a Waiter resource. This operation returns a long-running Operation\nresource which can be polled for completion. However, a waiter with the\ngiven name will exist (and can be retrieved) prior to the operation\ncompleting. If the operation fails, the failed Waiter resource will\nstill exist and must be deleted prior to subsequent creation attempts.",
+ "request": {
+ "$ref": "Waiter"
+ }
+ },
+ "testIamPermissions": {
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/configs/[^/]+/waiters/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}:testIamPermissions",
+ "id": "runtimeconfig.projects.configs.waiters.testIamPermissions",
+ "path": "v1beta1/{+resource}:testIamPermissions"
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "testIamPermissions": {
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/configs/[^/]+/operations/.+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/operations/{operationsId}:testIamPermissions",
+ "id": "runtimeconfig.projects.configs.operations.testIamPermissions",
+ "path": "v1beta1/{+resource}:testIamPermissions"
+ },
+ "get": {
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/configs/[^/]+/operations/.+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/operations/{operationsId}",
+ "id": "runtimeconfig.projects.configs.operations.get",
+ "path": "v1beta1/{+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."
+ }
+ }
+ }
+ },
+ "methods": {
+ "setIamPolicy": {
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/configs/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:setIamPolicy",
+ "id": "runtimeconfig.projects.configs.setIamPolicy",
+ "path": "v1beta1/{+resource}:setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy."
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "RuntimeConfig"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "requestId": {
+ "description": "An optional but recommended unique `request_id`. If the server\nreceives two `create()` requests with the same\n`request_id`, then the second request will be ignored and the\nfirst resource created and stored in the backend is returned.\nEmpty `request_id` fields are ignored.\n\nIt is responsibility of the client to ensure uniqueness of the\n`request_id` strings.\n\n`request_id` strings are limited to 64 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "parent": {
+ "description": "The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848)\nfor this request, in the format `projects/[PROJECT_ID]`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs",
+ "path": "v1beta1/{+parent}/configs",
+ "id": "runtimeconfig.projects.configs.create",
+ "request": {
+ "$ref": "RuntimeConfig"
+ },
+ "description": "Creates a new RuntimeConfig resource. The configuration name must be\nunique within project."
+ },
+ "getIamPolicy": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/configs/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:getIamPolicy",
+ "path": "v1beta1/{+resource}:getIamPolicy",
+ "id": "runtimeconfig.projects.configs.getIamPolicy",
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset."
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "RuntimeConfig"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the RuntimeConfig resource to retrieve, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/configs/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}",
+ "path": "v1beta1/{+name}",
+ "id": "runtimeconfig.projects.configs.get",
+ "description": "Gets information about a RuntimeConfig resource."
+ },
+ "update": {
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "RuntimeConfig"
+ },
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/configs/[^/]+$",
+ "location": "path",
+ "description": "The name of the RuntimeConfig resource to update, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}",
+ "path": "v1beta1/{+name}",
+ "id": "runtimeconfig.projects.configs.update",
+ "description": "Updates a RuntimeConfig resource. The configuration must exist beforehand.",
+ "request": {
+ "$ref": "RuntimeConfig"
+ }
+ },
+ "testIamPermissions": {
+ "path": "v1beta1/{+resource}:testIamPermissions",
+ "id": "runtimeconfig.projects.configs.testIamPermissions",
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/configs/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:testIamPermissions"
+ },
+ "delete": {
+ "id": "runtimeconfig.projects.configs.delete",
+ "path": "v1beta1/{+name}",
+ "description": "Deletes a RuntimeConfig resource.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/configs/[^/]+$",
+ "location": "path",
+ "description": "The RuntimeConfig resource to delete, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}"
+ },
+ "list": {
+ "id": "runtimeconfig.projects.configs.list",
+ "path": "v1beta1/{+parent}/configs",
+ "description": "Lists all the RuntimeConfig resources within project.",
+ "response": {
+ "$ref": "ListConfigsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848)\nfor this request, in the format `projects/[PROJECT_ID]`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken`\nreturned by a previous list request to get the next page of results.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "version": "v1beta1",
+ "baseUrl": "https://runtimeconfig.googleapis.com/",
+ "servicePath": "",
+ "description": "The Runtime Configurator allows you to dynamically configure and expose variables through Google Cloud Platform. In addition, you can also set Watchers and Waiters that will watch for changes to your data and return based on certain conditions.",
+ "kind": "discovery#restDescription",
+ "basePath": "",
+ "documentationLink": "https://cloud.google.com/deployment-manager/runtime-configurator/",
+ "id": "runtimeconfig:v1beta1",
+ "revision": "20171002",
+ "discoveryVersion": "v1",
+ "version_module": true
}
diff --git a/safebrowsing/v4/safebrowsing-api.json b/safebrowsing/v4/safebrowsing-api.json
index d235ecb..30b118a 100644
--- a/safebrowsing/v4/safebrowsing-api.json
+++ b/safebrowsing/v4/safebrowsing-api.json
@@ -1,125 +1,35 @@
{
+ "kind": "discovery#restDescription",
"servicePath": "",
"description": "Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources.",
- "kind": "discovery#restDescription",
"rootUrl": "https://safebrowsing.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "safebrowsing",
"batchPath": "batch",
- "revision": "20171004",
- "documentationLink": "https://developers.google.com/safe-browsing/",
"id": "safebrowsing:v4",
+ "documentationLink": "https://developers.google.com/safe-browsing/",
+ "revision": "20171010",
"title": "Google Safe Browsing API",
"ownerName": "Google",
"discoveryVersion": "v1",
"resources": {
- "threatLists": {
- "methods": {
- "list": {
- "description": "Lists the Safe Browsing threat lists available for download.",
- "response": {
- "$ref": "ListThreatListsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {},
- "flatPath": "v4/threatLists",
- "id": "safebrowsing.threatLists.list",
- "path": "v4/threatLists"
- }
- }
- },
- "threatMatches": {
- "methods": {
- "find": {
- "parameters": {},
- "flatPath": "v4/threatMatches:find",
- "id": "safebrowsing.threatMatches.find",
- "path": "v4/threatMatches:find",
- "description": "Finds the threat entries that match the Safe Browsing lists.",
- "request": {
- "$ref": "FindThreatMatchesRequest"
- },
- "response": {
- "$ref": "FindThreatMatchesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST"
- }
- }
- },
- "fullHashes": {
- "methods": {
- "find": {
- "description": "Finds the full hashes that match the requested hash prefixes.",
- "request": {
- "$ref": "FindFullHashesRequest"
- },
- "response": {
- "$ref": "FindFullHashesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "flatPath": "v4/fullHashes:find",
- "id": "safebrowsing.fullHashes.find",
- "path": "v4/fullHashes:find"
- }
- }
- },
- "encodedUpdates": {
- "methods": {
- "get": {
- "id": "safebrowsing.encodedUpdates.get",
- "path": "v4/encodedUpdates/{encodedRequest}",
- "description": "",
- "response": {
- "$ref": "FetchThreatListUpdatesResponse"
- },
- "parameterOrder": [
- "encodedRequest"
- ],
- "httpMethod": "GET",
- "parameters": {
- "clientId": {
- "location": "query",
- "description": "A client ID that uniquely identifies the client implementation of the Safe\nBrowsing API.",
- "type": "string"
- },
- "clientVersion": {
- "location": "query",
- "description": "The version of the client implementation.",
- "type": "string"
- },
- "encodedRequest": {
- "type": "string",
- "required": true,
- "location": "path",
- "format": "byte",
- "description": "A serialized FetchThreatListUpdatesRequest proto."
- }
- },
- "flatPath": "v4/encodedUpdates/{encodedRequest}"
- }
- }
- },
"threatListUpdates": {
"methods": {
"fetch": {
- "flatPath": "v4/threatListUpdates:fetch",
"id": "safebrowsing.threatListUpdates.fetch",
"path": "v4/threatListUpdates:fetch",
- "description": "Fetches the most recent threat list updates. A client can request updates\nfor multiple lists at once.",
"request": {
"$ref": "FetchThreatListUpdatesRequest"
},
+ "description": "Fetches the most recent threat list updates. A client can request updates\nfor multiple lists at once.",
"response": {
"$ref": "FetchThreatListUpdatesResponse"
},
"parameterOrder": [],
"httpMethod": "POST",
- "parameters": {}
+ "parameters": {},
+ "flatPath": "v4/threatListUpdates:fetch"
}
}
},
@@ -128,22 +38,22 @@
"get": {
"description": "",
"httpMethod": "GET",
- "parameterOrder": [
- "encodedRequest"
- ],
"response": {
"$ref": "FindFullHashesResponse"
},
+ "parameterOrder": [
+ "encodedRequest"
+ ],
"parameters": {
"clientId": {
+ "location": "query",
"description": "A client ID that (hopefully) uniquely identifies the client implementation\nof the Safe Browsing API.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"clientVersion": {
+ "location": "query",
"description": "The version of the client implementation.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"encodedRequest": {
"location": "path",
@@ -158,50 +68,149 @@
"id": "safebrowsing.encodedFullHashes.get"
}
}
+ },
+ "threatLists": {
+ "methods": {
+ "list": {
+ "parameters": {},
+ "flatPath": "v4/threatLists",
+ "id": "safebrowsing.threatLists.list",
+ "path": "v4/threatLists",
+ "description": "Lists the Safe Browsing threat lists available for download.",
+ "response": {
+ "$ref": "ListThreatListsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET"
+ }
+ }
+ },
+ "threatMatches": {
+ "methods": {
+ "find": {
+ "description": "Finds the threat entries that match the Safe Browsing lists.",
+ "request": {
+ "$ref": "FindThreatMatchesRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "FindThreatMatchesResponse"
+ },
+ "parameters": {},
+ "flatPath": "v4/threatMatches:find",
+ "path": "v4/threatMatches:find",
+ "id": "safebrowsing.threatMatches.find"
+ }
+ }
+ },
+ "fullHashes": {
+ "methods": {
+ "find": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "FindFullHashesResponse"
+ },
+ "parameters": {},
+ "flatPath": "v4/fullHashes:find",
+ "path": "v4/fullHashes:find",
+ "id": "safebrowsing.fullHashes.find",
+ "description": "Finds the full hashes that match the requested hash prefixes.",
+ "request": {
+ "$ref": "FindFullHashesRequest"
+ }
+ }
+ }
+ },
+ "encodedUpdates": {
+ "methods": {
+ "get": {
+ "parameters": {
+ "encodedRequest": {
+ "location": "path",
+ "format": "byte",
+ "description": "A serialized FetchThreatListUpdatesRequest proto.",
+ "type": "string",
+ "required": true
+ },
+ "clientId": {
+ "description": "A client ID that uniquely identifies the client implementation of the Safe\nBrowsing API.",
+ "type": "string",
+ "location": "query"
+ },
+ "clientVersion": {
+ "description": "The version of the client implementation.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v4/encodedUpdates/{encodedRequest}",
+ "path": "v4/encodedUpdates/{encodedRequest}",
+ "id": "safebrowsing.encodedUpdates.get",
+ "description": "",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "encodedRequest"
+ ],
+ "response": {
+ "$ref": "FetchThreatListUpdatesResponse"
+ }
+ }
+ }
}
},
"parameters": {
- "upload_protocol": {
+ "bearer_token": {
"location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "description": "OAuth bearer token.",
"type": "string"
},
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
"prettyPrint": {
"location": "query",
"description": "Returns response with indentations and line breaks.",
"default": "true",
"type": "boolean"
},
- "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": {
+ "uploadType": {
"location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ]
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
},
"callback": {
"location": "query",
"description": "JSONP",
"type": "string"
},
- "alt": {
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
"location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "alt": {
"description": "Data format for response.",
"default": "json",
"enum": [
@@ -214,11 +223,7 @@
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
- ]
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
+ ],
"location": "query"
},
"key": {
@@ -226,112 +231,77 @@
"type": "string",
"location": "query"
},
- "quotaUser": {
- "type": "string",
+ "access_token": {
"location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
- },
- "pp": {
- "default": "true",
- "type": "boolean",
- "location": "query",
- "description": "Pretty-print response."
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
+ "description": "OAuth access token.",
"type": "string"
},
- "oauth_token": {
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
}
},
"schemas": {
"MetadataEntry": {
+ "id": "MetadataEntry",
"description": "A single metadata entry.",
"type": "object",
"properties": {
- "key": {
- "type": "string",
- "format": "byte",
- "description": "The metadata entry key. For JSON requests, the key is base64-encoded."
- },
"value": {
- "type": "string",
"format": "byte",
- "description": "The metadata entry value. For JSON requests, the value is base64-encoded."
+ "description": "The metadata entry value. For JSON requests, the value is base64-encoded.",
+ "type": "string"
+ },
+ "key": {
+ "format": "byte",
+ "description": "The metadata entry key. For JSON requests, the key is base64-encoded.",
+ "type": "string"
}
- },
- "id": "MetadataEntry"
+ }
},
"ClientInfo": {
+ "id": "ClientInfo",
"description": "The client metadata associated with Safe Browsing API requests.",
"type": "object",
"properties": {
"clientId": {
- "type": "string",
- "description": "A client ID that (hopefully) uniquely identifies the client implementation\nof the Safe Browsing API."
+ "description": "A client ID that (hopefully) uniquely identifies the client implementation\nof the Safe Browsing API.",
+ "type": "string"
},
"clientVersion": {
"description": "The version of the client implementation.",
"type": "string"
}
+ }
+ },
+ "FindThreatMatchesRequest": {
+ "description": "Request to check entries against lists.",
+ "type": "object",
+ "properties": {
+ "client": {
+ "$ref": "ClientInfo",
+ "description": "The client metadata."
+ },
+ "threatInfo": {
+ "description": "The lists and entries to be checked for matches.",
+ "$ref": "ThreatInfo"
+ }
},
- "id": "ClientInfo"
+ "id": "FindThreatMatchesRequest"
},
"ThreatInfo": {
+ "id": "ThreatInfo",
"description": "The information regarding one or more threats that a client submits when\nchecking for matches in threat lists.",
"type": "object",
"properties": {
- "threatEntryTypes": {
- "enumDescriptions": [
- "Unspecified.",
- "A URL.",
- "An executable program.",
- "An IP range.",
- "Chrome extension.",
- "Filename.",
- "CERT"
- ],
- "description": "The entry types to be checked.",
- "items": {
- "enum": [
- "THREAT_ENTRY_TYPE_UNSPECIFIED",
- "URL",
- "EXECUTABLE",
- "IP_RANGE",
- "CHROME_EXTENSION",
- "FILENAME",
- "CERT"
- ],
- "type": "string"
- },
- "type": "array"
- },
"threatTypes": {
- "description": "The threat types to be checked.",
- "items": {
- "type": "string",
- "enum": [
- "THREAT_TYPE_UNSPECIFIED",
- "MALWARE",
- "SOCIAL_ENGINEERING",
- "UNWANTED_SOFTWARE",
- "POTENTIALLY_HARMFUL_APPLICATION",
- "SOCIAL_ENGINEERING_INTERNAL",
- "API_ABUSE",
- "MALICIOUS_BINARY",
- "CSD_WHITELIST",
- "CSD_DOWNLOAD_WHITELIST",
- "CLIENT_INCIDENT",
- "CLIENT_INCIDENT_WHITELIST",
- "APK_MALWARE_OFFLINE",
- "SUBRESOURCE_FILTER"
- ]
- },
- "type": "array",
"enumDescriptions": [
"Unknown.",
"Malware threat type.",
@@ -347,25 +317,30 @@
"Whitelist used when detecting client incident threats.\nThis enum was never launched and should be re-used for the next list.",
"List used for offline APK checks in PAM.",
"Patterns to be used for activating the subresource filter. Interstitial\nwill not be shown for patterns from this list."
- ]
+ ],
+ "description": "The threat types to be checked.",
+ "items": {
+ "enum": [
+ "THREAT_TYPE_UNSPECIFIED",
+ "MALWARE",
+ "SOCIAL_ENGINEERING",
+ "UNWANTED_SOFTWARE",
+ "POTENTIALLY_HARMFUL_APPLICATION",
+ "SOCIAL_ENGINEERING_INTERNAL",
+ "API_ABUSE",
+ "MALICIOUS_BINARY",
+ "CSD_WHITELIST",
+ "CSD_DOWNLOAD_WHITELIST",
+ "CLIENT_INCIDENT",
+ "CLIENT_INCIDENT_WHITELIST",
+ "APK_MALWARE_OFFLINE",
+ "SUBRESOURCE_FILTER"
+ ],
+ "type": "string"
+ },
+ "type": "array"
},
"platformTypes": {
- "description": "The platform types to be checked.",
- "items": {
- "type": "string",
- "enum": [
- "PLATFORM_TYPE_UNSPECIFIED",
- "WINDOWS",
- "LINUX",
- "ANDROID",
- "OSX",
- "IOS",
- "ANY_PLATFORM",
- "ALL_PLATFORMS",
- "CHROME"
- ]
- },
- "type": "array",
"enumDescriptions": [
"Unknown platform.",
"Threat posed to Windows.",
@@ -376,7 +351,23 @@
"Threat posed to at least one of the defined platforms.",
"Threat posed to all defined platforms.",
"Threat posed to Chrome."
- ]
+ ],
+ "description": "The platform types to be checked.",
+ "items": {
+ "enum": [
+ "PLATFORM_TYPE_UNSPECIFIED",
+ "WINDOWS",
+ "LINUX",
+ "ANDROID",
+ "OSX",
+ "IOS",
+ "ANY_PLATFORM",
+ "ALL_PLATFORMS",
+ "CHROME"
+ ],
+ "type": "string"
+ },
+ "type": "array"
},
"threatEntries": {
"description": "The threat entries to be checked.",
@@ -384,26 +375,36 @@
"$ref": "ThreatEntry"
},
"type": "array"
- }
- },
- "id": "ThreatInfo"
- },
- "FindThreatMatchesRequest": {
- "properties": {
- "client": {
- "$ref": "ClientInfo",
- "description": "The client metadata."
},
- "threatInfo": {
- "description": "The lists and entries to be checked for matches.",
- "$ref": "ThreatInfo"
+ "threatEntryTypes": {
+ "enumDescriptions": [
+ "Unspecified.",
+ "A URL.",
+ "An executable program.",
+ "An IP range.",
+ "Chrome extension.",
+ "Filename.",
+ "CERT"
+ ],
+ "description": "The entry types to be checked.",
+ "items": {
+ "type": "string",
+ "enum": [
+ "THREAT_ENTRY_TYPE_UNSPECIFIED",
+ "URL",
+ "EXECUTABLE",
+ "IP_RANGE",
+ "CHROME_EXTENSION",
+ "FILENAME",
+ "CERT"
+ ]
+ },
+ "type": "array"
}
- },
- "id": "FindThreatMatchesRequest",
- "description": "Request to check entries against lists.",
- "type": "object"
+ }
},
"ThreatEntryMetadata": {
+ "id": "ThreatEntryMetadata",
"description": "The metadata associated with a specific threat entry. The client is expected\nto know the metadata key/value pairs associated with each threat type.",
"type": "object",
"properties": {
@@ -414,8 +415,7 @@
},
"type": "array"
}
- },
- "id": "ThreatEntryMetadata"
+ }
},
"RawIndices": {
"description": "A set of raw indices to remove from a local list.",
@@ -467,29 +467,6 @@
},
"id": "FetchThreatListUpdatesResponse"
},
- "FindFullHashesResponse": {
- "type": "object",
- "properties": {
- "matches": {
- "description": "The full hashes that matched the requested prefixes.",
- "items": {
- "$ref": "ThreatMatch"
- },
- "type": "array"
- },
- "negativeCacheDuration": {
- "format": "google-duration",
- "description": "For requested entities that did not match the threat list, how long to\ncache the response.",
- "type": "string"
- },
- "minimumWaitDuration": {
- "format": "google-duration",
- "description": "The minimum duration the client must wait before issuing any find hashes\nrequest. If this field is not set, clients can issue a request as soon as\nthey want.",
- "type": "string"
- }
- },
- "id": "FindFullHashesResponse"
- },
"Checksum": {
"description": "The expected state of a client's local database.",
"type": "object",
@@ -502,25 +479,42 @@
},
"id": "Checksum"
},
+ "FindFullHashesResponse": {
+ "type": "object",
+ "properties": {
+ "minimumWaitDuration": {
+ "format": "google-duration",
+ "description": "The minimum duration the client must wait before issuing any find hashes\nrequest. If this field is not set, clients can issue a request as soon as\nthey want.",
+ "type": "string"
+ },
+ "matches": {
+ "description": "The full hashes that matched the requested prefixes.",
+ "items": {
+ "$ref": "ThreatMatch"
+ },
+ "type": "array"
+ },
+ "negativeCacheDuration": {
+ "format": "google-duration",
+ "description": "For requested entities that did not match the threat list, how long to\ncache the response.",
+ "type": "string"
+ }
+ },
+ "id": "FindFullHashesResponse"
+ },
"ThreatEntrySet": {
"description": "A set of threats that should be added or removed from a client's local\ndatabase.",
"type": "object",
"properties": {
- "rawHashes": {
- "$ref": "RawHashes",
- "description": "The raw SHA256-formatted entries."
- },
"riceHashes": {
"$ref": "RiceDeltaEncoding",
"description": "The encoded 4-byte prefixes of SHA256-formatted entries, using a\nGolomb-Rice encoding. The hashes are converted to uint32, sorted in\nascending order, then delta encoded and stored as encoded_data."
},
"riceIndices": {
- "$ref": "RiceDeltaEncoding",
- "description": "The encoded local, lexicographically-sorted list indices, using a\nGolomb-Rice encoding. Used for sending compressed removal indices. The\nremoval indices (uint32) are sorted in ascending order, then delta encoded\nand stored as encoded_data."
+ "description": "The encoded local, lexicographically-sorted list indices, using a\nGolomb-Rice encoding. Used for sending compressed removal indices. The\nremoval indices (uint32) are sorted in ascending order, then delta encoded\nand stored as encoded_data.",
+ "$ref": "RiceDeltaEncoding"
},
"compressionType": {
- "description": "The compression type for the entries in this set.",
- "type": "string",
"enumDescriptions": [
"Unknown.",
"Raw, uncompressed data.",
@@ -530,11 +524,17 @@
"COMPRESSION_TYPE_UNSPECIFIED",
"RAW",
"RICE"
- ]
+ ],
+ "description": "The compression type for the entries in this set.",
+ "type": "string"
},
"rawIndices": {
- "$ref": "RawIndices",
- "description": "The raw removal indices for a local list."
+ "description": "The raw removal indices for a local list.",
+ "$ref": "RawIndices"
+ },
+ "rawHashes": {
+ "$ref": "RawHashes",
+ "description": "The raw SHA256-formatted entries."
}
},
"id": "ThreatEntrySet"
@@ -543,25 +543,25 @@
"description": "Request to return full hashes matched by the provided hash prefixes.",
"type": "object",
"properties": {
+ "apiClient": {
+ "description": "Client metadata associated with callers of higher-level APIs built on top\nof the client's implementation.",
+ "$ref": "ClientInfo"
+ },
"clientStates": {
+ "description": "The current client states for each of the client's local threat lists.",
"items": {
"format": "byte",
"type": "string"
},
- "type": "array",
- "description": "The current client states for each of the client's local threat lists."
+ "type": "array"
},
"client": {
- "description": "The client metadata.",
- "$ref": "ClientInfo"
+ "$ref": "ClientInfo",
+ "description": "The client metadata."
},
"threatInfo": {
- "$ref": "ThreatInfo",
- "description": "The lists and hashes to be checked."
- },
- "apiClient": {
- "description": "Client metadata associated with callers of higher-level APIs built on top\nof the client's implementation.",
- "$ref": "ClientInfo"
+ "description": "The lists and hashes to be checked.",
+ "$ref": "ThreatInfo"
}
},
"id": "FindFullHashesRequest"
@@ -570,11 +570,6 @@
"description": "A single list update request.",
"type": "object",
"properties": {
- "state": {
- "format": "byte",
- "description": "The current state of the client for the requested list (the encrypted\nclient state that was received from the last successful list update).",
- "type": "string"
- },
"platformType": {
"enumDescriptions": [
"Unknown platform.",
@@ -602,10 +597,12 @@
"type": "string"
},
"constraints": {
- "description": "The constraints associated with this request.",
- "$ref": "Constraints"
+ "$ref": "Constraints",
+ "description": "The constraints associated with this request."
},
"threatType": {
+ "description": "The type of threat posed by entries present in the list.",
+ "type": "string",
"enumDescriptions": [
"Unknown.",
"Malware threat type.",
@@ -637,20 +634,9 @@
"CLIENT_INCIDENT_WHITELIST",
"APK_MALWARE_OFFLINE",
"SUBRESOURCE_FILTER"
- ],
- "description": "The type of threat posed by entries present in the list.",
- "type": "string"
+ ]
},
"threatEntryType": {
- "enum": [
- "THREAT_ENTRY_TYPE_UNSPECIFIED",
- "URL",
- "EXECUTABLE",
- "IP_RANGE",
- "CHROME_EXTENSION",
- "FILENAME",
- "CERT"
- ],
"description": "The types of entries present in the list.",
"type": "string",
"enumDescriptions": [
@@ -661,12 +647,28 @@
"Chrome extension.",
"Filename.",
"CERT"
+ ],
+ "enum": [
+ "THREAT_ENTRY_TYPE_UNSPECIFIED",
+ "URL",
+ "EXECUTABLE",
+ "IP_RANGE",
+ "CHROME_EXTENSION",
+ "FILENAME",
+ "CERT"
]
+ },
+ "state": {
+ "format": "byte",
+ "description": "The current state of the client for the requested list (the encrypted\nclient state that was received from the last successful list update).",
+ "type": "string"
}
},
"id": "ListUpdateRequest"
},
"FetchThreatListUpdatesRequest": {
+ "id": "FetchThreatListUpdatesRequest",
+ "description": "Describes a Safe Browsing API update request. Clients can request updates for\nmultiple lists in a single request.\nNOTE: Field index 2 is unused.\nNEXT: 5",
"type": "object",
"properties": {
"listUpdateRequests": {
@@ -680,71 +682,16 @@
"description": "The client metadata.",
"$ref": "ClientInfo"
}
- },
- "id": "FetchThreatListUpdatesRequest",
- "description": "Describes a Safe Browsing API update request. Clients can request updates for\nmultiple lists in a single request.\nNOTE: Field index 2 is unused.\nNEXT: 5"
+ }
},
"ListUpdateResponse": {
+ "id": "ListUpdateResponse",
+ "description": "An update to an individual list.",
+ "type": "object",
"properties": {
- "additions": {
- "description": "A set of entries to add to a local threat type's list. Repeated to allow\nfor a combination of compressed and raw data to be sent in a single\nresponse.",
- "items": {
- "$ref": "ThreatEntrySet"
- },
- "type": "array"
- },
- "checksum": {
- "$ref": "Checksum",
- "description": "The expected SHA256 hash of the client state; that is, of the sorted list\nof all hashes present in the database after applying the provided update.\nIf the client state doesn't match the expected state, the client must\ndisregard this update and retry later."
- },
- "responseType": {
- "enumDescriptions": [
- "Unknown.",
- "Partial updates are applied to the client's existing local database.",
- "Full updates replace the client's entire local database. This means\nthat either the client was seriously out-of-date or the client is\nbelieved to be corrupt."
- ],
- "enum": [
- "RESPONSE_TYPE_UNSPECIFIED",
- "PARTIAL_UPDATE",
- "FULL_UPDATE"
- ],
- "description": "The type of response. This may indicate that an action is required by the\nclient when the response is received.",
- "type": "string"
- },
- "threatType": {
- "enumDescriptions": [
- "Unknown.",
- "Malware threat type.",
- "Social engineering threat type.",
- "Unwanted software threat type.",
- "Potentially harmful application threat type.",
- "Social engineering threat type for internal use.",
- "API abuse threat type.",
- "Malicious binary threat type.",
- "Client side detection whitelist threat type.",
- "Client side download detection whitelist threat type.",
- "Client incident threat type.",
- "Whitelist used when detecting client incident threats.\nThis enum was never launched and should be re-used for the next list.",
- "List used for offline APK checks in PAM.",
- "Patterns to be used for activating the subresource filter. Interstitial\nwill not be shown for patterns from this list."
- ],
- "enum": [
- "THREAT_TYPE_UNSPECIFIED",
- "MALWARE",
- "SOCIAL_ENGINEERING",
- "UNWANTED_SOFTWARE",
- "POTENTIALLY_HARMFUL_APPLICATION",
- "SOCIAL_ENGINEERING_INTERNAL",
- "API_ABUSE",
- "MALICIOUS_BINARY",
- "CSD_WHITELIST",
- "CSD_DOWNLOAD_WHITELIST",
- "CLIENT_INCIDENT",
- "CLIENT_INCIDENT_WHITELIST",
- "APK_MALWARE_OFFLINE",
- "SUBRESOURCE_FILTER"
- ],
- "description": "The threat type for which data is returned.",
+ "newClientState": {
+ "format": "byte",
+ "description": "The new client state, in encrypted format. Opaque to clients.",
"type": "string"
},
"removals": {
@@ -754,11 +701,6 @@
},
"type": "array"
},
- "newClientState": {
- "format": "byte",
- "description": "The new client state, in encrypted format. Opaque to clients.",
- "type": "string"
- },
"platformType": {
"enumDescriptions": [
"Unknown platform.",
@@ -786,6 +728,8 @@
"type": "string"
},
"threatEntryType": {
+ "description": "The format of the threats.",
+ "type": "string",
"enumDescriptions": [
"Unspecified.",
"A URL.",
@@ -803,81 +747,35 @@
"CHROME_EXTENSION",
"FILENAME",
"CERT"
- ],
- "description": "The format of the threats.",
- "type": "string"
- }
- },
- "id": "ListUpdateResponse",
- "description": "An update to an individual list.",
- "type": "object"
- },
- "Constraints": {
- "description": "The constraints for this update.",
- "type": "object",
- "properties": {
- "supportedCompressions": {
+ ]
+ },
+ "additions": {
+ "description": "A set of entries to add to a local threat type's list. Repeated to allow\nfor a combination of compressed and raw data to be sent in a single\nresponse.",
"items": {
- "enum": [
- "COMPRESSION_TYPE_UNSPECIFIED",
- "RAW",
- "RICE"
- ],
- "type": "string"
+ "$ref": "ThreatEntrySet"
},
- "type": "array",
+ "type": "array"
+ },
+ "checksum": {
+ "$ref": "Checksum",
+ "description": "The expected SHA256 hash of the client state; that is, of the sorted list\nof all hashes present in the database after applying the provided update.\nIf the client state doesn't match the expected state, the client must\ndisregard this update and retry later."
+ },
+ "responseType": {
"enumDescriptions": [
"Unknown.",
- "Raw, uncompressed data.",
- "Rice-Golomb encoded data."
+ "Partial updates are applied to the client's existing local database.",
+ "Full updates replace the client's entire local database. This means\nthat either the client was seriously out-of-date or the client is\nbelieved to be corrupt."
],
- "description": "The compression types supported by the client."
- },
- "maxUpdateEntries": {
- "type": "integer",
- "format": "int32",
- "description": "The maximum size in number of entries. The update will not contain more\nentries than this value. This should be a power of 2 between 2**10 and\n2**20. If zero, no update size limit is set."
- },
- "region": {
- "description": "Requests the list for a specific geographic location. If not set the\nserver may pick that value based on the user's IP address. Expects ISO\n3166-1 alpha-2 format.",
- "type": "string"
- },
- "maxDatabaseEntries": {
- "format": "int32",
- "description": "Sets the maximum number of entries that the client is willing to have\nin the local database. This should be a power of 2 between 2**10 and\n2**20. If zero, no database size limit is set.",
- "type": "integer"
- }
- },
- "id": "Constraints"
- },
- "ThreatMatch": {
- "id": "ThreatMatch",
- "description": "A match when checking a threat entry in the Safe Browsing threat lists.",
- "type": "object",
- "properties": {
- "cacheDuration": {
- "format": "google-duration",
- "description": "The cache lifetime for the returned match. Clients must not cache this\nresponse for more than this duration to avoid false positives.",
+ "enum": [
+ "RESPONSE_TYPE_UNSPECIFIED",
+ "PARTIAL_UPDATE",
+ "FULL_UPDATE"
+ ],
+ "description": "The type of response. This may indicate that an action is required by the\nclient when the response is received.",
"type": "string"
},
"threatType": {
- "enum": [
- "THREAT_TYPE_UNSPECIFIED",
- "MALWARE",
- "SOCIAL_ENGINEERING",
- "UNWANTED_SOFTWARE",
- "POTENTIALLY_HARMFUL_APPLICATION",
- "SOCIAL_ENGINEERING_INTERNAL",
- "API_ABUSE",
- "MALICIOUS_BINARY",
- "CSD_WHITELIST",
- "CSD_DOWNLOAD_WHITELIST",
- "CLIENT_INCIDENT",
- "CLIENT_INCIDENT_WHITELIST",
- "APK_MALWARE_OFFLINE",
- "SUBRESOURCE_FILTER"
- ],
- "description": "The threat type matching this threat.",
+ "description": "The threat type for which data is returned.",
"type": "string",
"enumDescriptions": [
"Unknown.",
@@ -894,19 +792,69 @@
"Whitelist used when detecting client incident threats.\nThis enum was never launched and should be re-used for the next list.",
"List used for offline APK checks in PAM.",
"Patterns to be used for activating the subresource filter. Interstitial\nwill not be shown for patterns from this list."
+ ],
+ "enum": [
+ "THREAT_TYPE_UNSPECIFIED",
+ "MALWARE",
+ "SOCIAL_ENGINEERING",
+ "UNWANTED_SOFTWARE",
+ "POTENTIALLY_HARMFUL_APPLICATION",
+ "SOCIAL_ENGINEERING_INTERNAL",
+ "API_ABUSE",
+ "MALICIOUS_BINARY",
+ "CSD_WHITELIST",
+ "CSD_DOWNLOAD_WHITELIST",
+ "CLIENT_INCIDENT",
+ "CLIENT_INCIDENT_WHITELIST",
+ "APK_MALWARE_OFFLINE",
+ "SUBRESOURCE_FILTER"
]
+ }
+ }
+ },
+ "Constraints": {
+ "id": "Constraints",
+ "description": "The constraints for this update.",
+ "type": "object",
+ "properties": {
+ "maxUpdateEntries": {
+ "format": "int32",
+ "description": "The maximum size in number of entries. The update will not contain more\nentries than this value. This should be a power of 2 between 2**10 and\n2**20. If zero, no update size limit is set.",
+ "type": "integer"
},
- "threatEntryMetadata": {
- "description": "Optional metadata associated with this threat.",
- "$ref": "ThreatEntryMetadata"
+ "region": {
+ "description": "Requests the list for a specific geographic location. If not set the\nserver may pick that value based on the user's IP address. Expects ISO\n3166-1 alpha-2 format.",
+ "type": "string"
},
- "threat": {
- "$ref": "ThreatEntry",
- "description": "The threat matching this threat."
+ "maxDatabaseEntries": {
+ "format": "int32",
+ "description": "Sets the maximum number of entries that the client is willing to have\nin the local database. This should be a power of 2 between 2**10 and\n2**20. If zero, no database size limit is set.",
+ "type": "integer"
},
+ "supportedCompressions": {
+ "description": "The compression types supported by the client.",
+ "items": {
+ "enum": [
+ "COMPRESSION_TYPE_UNSPECIFIED",
+ "RAW",
+ "RICE"
+ ],
+ "type": "string"
+ },
+ "type": "array",
+ "enumDescriptions": [
+ "Unknown.",
+ "Raw, uncompressed data.",
+ "Rice-Golomb encoded data."
+ ]
+ }
+ }
+ },
+ "ThreatMatch": {
+ "description": "A match when checking a threat entry in the Safe Browsing threat lists.",
+ "type": "object",
+ "properties": {
"platformType": {
- "description": "The platform type matching this threat.",
- "type": "string",
"enumDescriptions": [
"Unknown platform.",
"Threat posed to Windows.",
@@ -928,9 +876,13 @@
"ANY_PLATFORM",
"ALL_PLATFORMS",
"CHROME"
- ]
+ ],
+ "description": "The platform type matching this threat.",
+ "type": "string"
},
"threatEntryType": {
+ "description": "The threat entry type matching this threat.",
+ "type": "string",
"enumDescriptions": [
"Unspecified.",
"A URL.",
@@ -948,13 +900,62 @@
"CHROME_EXTENSION",
"FILENAME",
"CERT"
- ],
- "description": "The threat entry type matching this threat.",
+ ]
+ },
+ "cacheDuration": {
+ "format": "google-duration",
+ "description": "The cache lifetime for the returned match. Clients must not cache this\nresponse for more than this duration to avoid false positives.",
"type": "string"
+ },
+ "threatEntryMetadata": {
+ "description": "Optional metadata associated with this threat.",
+ "$ref": "ThreatEntryMetadata"
+ },
+ "threatType": {
+ "description": "The threat type matching this threat.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown.",
+ "Malware threat type.",
+ "Social engineering threat type.",
+ "Unwanted software threat type.",
+ "Potentially harmful application threat type.",
+ "Social engineering threat type for internal use.",
+ "API abuse threat type.",
+ "Malicious binary threat type.",
+ "Client side detection whitelist threat type.",
+ "Client side download detection whitelist threat type.",
+ "Client incident threat type.",
+ "Whitelist used when detecting client incident threats.\nThis enum was never launched and should be re-used for the next list.",
+ "List used for offline APK checks in PAM.",
+ "Patterns to be used for activating the subresource filter. Interstitial\nwill not be shown for patterns from this list."
+ ],
+ "enum": [
+ "THREAT_TYPE_UNSPECIFIED",
+ "MALWARE",
+ "SOCIAL_ENGINEERING",
+ "UNWANTED_SOFTWARE",
+ "POTENTIALLY_HARMFUL_APPLICATION",
+ "SOCIAL_ENGINEERING_INTERNAL",
+ "API_ABUSE",
+ "MALICIOUS_BINARY",
+ "CSD_WHITELIST",
+ "CSD_DOWNLOAD_WHITELIST",
+ "CLIENT_INCIDENT",
+ "CLIENT_INCIDENT_WHITELIST",
+ "APK_MALWARE_OFFLINE",
+ "SUBRESOURCE_FILTER"
+ ]
+ },
+ "threat": {
+ "$ref": "ThreatEntry",
+ "description": "The threat matching this threat."
}
- }
+ },
+ "id": "ThreatMatch"
},
"ListThreatListsResponse": {
+ "id": "ListThreatListsResponse",
"type": "object",
"properties": {
"threatLists": {
@@ -964,14 +965,18 @@
},
"type": "array"
}
- },
- "id": "ListThreatListsResponse"
+ }
},
"RiceDeltaEncoding": {
"id": "RiceDeltaEncoding",
"description": "The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or\ncompressed removal indices.",
"type": "object",
"properties": {
+ "riceParameter": {
+ "format": "int32",
+ "description": "The Golomb-Rice parameter, which is a number between 2 and 28. This field\nis missing (that is, zero) if `num_entries` is zero.",
+ "type": "integer"
+ },
"encodedData": {
"format": "byte",
"description": "The encoded deltas that are encoded using the Golomb-Rice coder.",
@@ -986,11 +991,6 @@
"format": "int32",
"description": "The number of entries that are delta encoded in the encoded data. If only a\nsingle integer was encoded, this will be zero and the single value will be\nstored in `first_value`.",
"type": "integer"
- },
- "riceParameter": {
- "format": "int32",
- "description": "The Golomb-Rice parameter, which is a number between 2 and 28. This field\nis missing (that is, zero) if `num_entries` is zero.",
- "type": "integer"
}
}
},
@@ -1011,6 +1011,10 @@
"description": "An individual threat; for example, a malicious URL or its hash\nrepresentation. Only one of these fields should be set.",
"type": "object",
"properties": {
+ "url": {
+ "description": "A URL.",
+ "type": "string"
+ },
"digest": {
"format": "byte",
"description": "The digest of an executable in SHA256 format. The API supports both\nbinary and hex digests. For JSON requests, digests are base64-encoded.",
@@ -1020,10 +1024,6 @@
"format": "byte",
"description": "A hash prefix, consisting of the most significant 4-32 bytes of a SHA256\nhash. This field is in binary format. For JSON requests, hashes are\nbase64-encoded.",
"type": "string"
- },
- "url": {
- "description": "A URL.",
- "type": "string"
}
},
"id": "ThreatEntry"
@@ -1032,9 +1032,30 @@
"description": "Describes an individual threat list. A list is defined by three parameters:\nthe type of threat posed, the type of platform targeted by the threat, and\nthe type of entries in the list.",
"type": "object",
"properties": {
- "platformType": {
+ "threatEntryType": {
+ "description": "The entry types contained in the list.",
"type": "string",
"enumDescriptions": [
+ "Unspecified.",
+ "A URL.",
+ "An executable program.",
+ "An IP range.",
+ "Chrome extension.",
+ "Filename.",
+ "CERT"
+ ],
+ "enum": [
+ "THREAT_ENTRY_TYPE_UNSPECIFIED",
+ "URL",
+ "EXECUTABLE",
+ "IP_RANGE",
+ "CHROME_EXTENSION",
+ "FILENAME",
+ "CERT"
+ ]
+ },
+ "platformType": {
+ "enumDescriptions": [
"Unknown platform.",
"Threat posed to Windows.",
"Threat posed to Linux.",
@@ -1056,9 +1077,26 @@
"ALL_PLATFORMS",
"CHROME"
],
- "description": "The platform type targeted by the list's entries."
+ "description": "The platform type targeted by the list's entries.",
+ "type": "string"
},
"threatType": {
+ "enumDescriptions": [
+ "Unknown.",
+ "Malware threat type.",
+ "Social engineering threat type.",
+ "Unwanted software threat type.",
+ "Potentially harmful application threat type.",
+ "Social engineering threat type for internal use.",
+ "API abuse threat type.",
+ "Malicious binary threat type.",
+ "Client side detection whitelist threat type.",
+ "Client side download detection whitelist threat type.",
+ "Client incident threat type.",
+ "Whitelist used when detecting client incident threats.\nThis enum was never launched and should be re-used for the next list.",
+ "List used for offline APK checks in PAM.",
+ "Patterns to be used for activating the subresource filter. Interstitial\nwill not be shown for patterns from this list."
+ ],
"enum": [
"THREAT_TYPE_UNSPECIFIED",
"MALWARE",
@@ -1076,55 +1114,17 @@
"SUBRESOURCE_FILTER"
],
"description": "The threat type posed by the list's entries.",
- "type": "string",
- "enumDescriptions": [
- "Unknown.",
- "Malware threat type.",
- "Social engineering threat type.",
- "Unwanted software threat type.",
- "Potentially harmful application threat type.",
- "Social engineering threat type for internal use.",
- "API abuse threat type.",
- "Malicious binary threat type.",
- "Client side detection whitelist threat type.",
- "Client side download detection whitelist threat type.",
- "Client incident threat type.",
- "Whitelist used when detecting client incident threats.\nThis enum was never launched and should be re-used for the next list.",
- "List used for offline APK checks in PAM.",
- "Patterns to be used for activating the subresource filter. Interstitial\nwill not be shown for patterns from this list."
- ]
- },
- "threatEntryType": {
- "enumDescriptions": [
- "Unspecified.",
- "A URL.",
- "An executable program.",
- "An IP range.",
- "Chrome extension.",
- "Filename.",
- "CERT"
- ],
- "enum": [
- "THREAT_ENTRY_TYPE_UNSPECIFIED",
- "URL",
- "EXECUTABLE",
- "IP_RANGE",
- "CHROME_EXTENSION",
- "FILENAME",
- "CERT"
- ],
- "description": "The entry types contained in the list.",
"type": "string"
}
},
"id": "ThreatListDescriptor"
}
},
+ "protocol": "rest",
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
- "protocol": "rest",
"version": "v4",
"baseUrl": "https://safebrowsing.googleapis.com/"
}
diff --git a/script/v1/script-api.json b/script/v1/script-api.json
index 6cb3045..c08877e 100644
--- a/script/v1/script-api.json
+++ b/script/v1/script-api.json
@@ -3,6 +3,10 @@
"scripts": {
"methods": {
"run": {
+ "request": {
+ "$ref": "ExecutionRequest"
+ },
+ "description": "Runs a function in an Apps Script project. The project must be deployed\nfor use with the Apps Script Execution API.\n\nThis method requires authorization with an OAuth 2.0 token that includes at\nleast one of the scopes listed in the [Authorization](#authorization)\nsection; script projects that do not require authorization cannot be\nexecuted through this API. To find the correct scopes to include in the\nauthentication token, open the project in the script editor, then select\n**File \u003e Project properties** and click the **Scopes** tab.",
"response": {
"$ref": "Operation"
},
@@ -10,6 +14,14 @@
"scriptId"
],
"httpMethod": "POST",
+ "parameters": {
+ "scriptId": {
+ "description": "The script ID of the script to be executed. To find the script ID, open\nthe project in the script editor and select **File \u003e Project properties**.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
"scopes": [
"https://mail.google.com/",
"https://www.google.com/calendar/feeds",
@@ -23,48 +35,48 @@
"https://www.googleapis.com/auth/spreadsheets",
"https://www.googleapis.com/auth/userinfo.email"
],
- "parameters": {
- "scriptId": {
- "description": "The script ID of the script to be executed. To find the script ID, open\nthe project in the script editor and select **File \u003e Project properties**.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
"flatPath": "v1/scripts/{scriptId}:run",
"path": "v1/scripts/{scriptId}:run",
- "id": "script.scripts.run",
- "description": "Runs a function in an Apps Script project. The project must be deployed\nfor use with the Apps Script Execution API.\n\nThis method requires authorization with an OAuth 2.0 token that includes at\nleast one of the scopes listed in the [Authorization](#authorization)\nsection; script projects that do not require authorization cannot be\nexecuted through this API. To find the correct scopes to include in the\nauthentication token, open the project in the script editor, then select\n**File \u003e Project properties** and click the **Scopes** tab.",
- "request": {
- "$ref": "ExecutionRequest"
- }
+ "id": "script.scripts.run"
}
}
}
},
"parameters": {
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
"upload_protocol": {
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string"
},
"prettyPrint": {
- "location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
+ "default": "true",
"location": "query"
},
"fields": {
- "location": "query",
"description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "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"
@@ -73,14 +85,12 @@
"enum": [
"1",
"2"
- ],
- "description": "V1 error format.",
- "type": "string"
+ ]
},
"callback": {
- "location": "query",
"description": "JSONP",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"alt": {
"enumDescriptions": [
@@ -98,92 +108,29 @@
],
"type": "string"
},
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string",
"location": "query"
},
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
"quotaUser": {
+ "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pp": {
"description": "Pretty-print response.",
"type": "boolean",
"default": "true",
"location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
}
},
"schemas": {
- "Status": {
- "properties": {
- "message": {
- "description": "A developer-facing error message, which is in English. Any user-facing error message is localized and sent in the [`google.rpc.Status.details`](google.rpc.Status.details) field, or localized by the client.",
- "type": "string"
- },
- "details": {
- "description": "An array that contains a single `ExecutionError` object that provides information about the nature of the error.",
- "type": "array",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- }
- },
- "code": {
- "description": "The status code. For this API, this value will always be 3, corresponding to an \u003ccode\u003eINVALID_ARGUMENT\u003c/code\u003e error.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "Status",
- "description": "If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, the response body's `error` field will contain this `Status` object.",
- "type": "object"
- },
- "ExecutionRequest": {
- "properties": {
- "function": {
- "description": "The name of the function to execute in the given script. The name does not\ninclude parentheses or parameters.",
- "type": "string"
- },
- "devMode": {
- "description": "If `true` and the user is an owner of the script, the script runs at the\nmost recently saved version rather than the version deployed for use with\nthe Execution API. Optional; default is `false`.",
- "type": "boolean"
- },
- "parameters": {
- "description": "The parameters to be passed to the function being executed. The object type\nfor each parameter should match the expected type in Apps Script.\nParameters cannot be Apps Script-specific object types (such as a\n`Document` or a `Calendar`); they can only be primitive types such as\n`string`, `number`, `array`, `object`, or `boolean`. Optional.",
- "type": "array",
- "items": {
- "type": "any"
- }
- },
- "sessionState": {
- "description": "For Android add-ons only. An ID that represents the user's current session\nin the Android app for Google Docs or Sheets, included as extra data in the\n[`Intent`](https://developer.android.com/guide/components/intents-filters.html)\nthat launches the add-on. When an Android add-on is run with a session\nstate, it gains the privileges of a\n[bound](https://developers.google.com/apps-script/guides/bound) script —\nthat is, it can access information like the user's current cursor position\n(in Docs) or selected cell (in Sheets). To retrieve the state, call\n`Intent.getStringExtra(\"com.google.android.apps.docs.addons.SessionState\")`.\nOptional.",
- "type": "string"
- }
- },
- "id": "ExecutionRequest",
- "description": "A request to run the function in a script. The script is identified by the\nspecified `script_id`. Executing a function on a script returns results\nbased on the implementation of the script.",
- "type": "object"
- },
"ExecutionResponse": {
"description": "An object that provides the return value of a function executed through the\nApps Script Execution API. If a\n`run` call succeeds and the\nscript function returns successfully, the response body's\n`response` field contains this\n`ExecutionResponse` object.",
"type": "object",
@@ -196,8 +143,6 @@
"id": "ExecutionResponse"
},
"Operation": {
- "description": "The response will not arrive until the function finishes executing. The maximum runtime is listed in the guide to [limitations in Apps Script](https://developers.google.com/apps-script/guides/services/quotas#current_limitations).\n\u003cp\u003eIf the script function returns successfully, the `response` field will contain an `ExecutionResponse` object with the function's return value in the object's `result` field.\u003c/p\u003e\n\u003cp\u003eIf the script function (or Apps Script itself) throws an exception, the `error` field will contain a `Status` object. The `Status` object's `details` field will contain an array with a single `ExecutionError` object that provides information about the nature of the error.\u003c/p\u003e\n\u003cp\u003eIf the `run` call itself fails (for example, because of a malformed request or an authorization error), the method will return an HTTP response code in the 4XX range with a different format for the response body. Client libraries will automatically convert a 4XX response into an exception class.\u003c/p\u003e",
- "type": "object",
"properties": {
"done": {
"description": "This field is only used with asynchronous executions and indicates whether or not the script execution has completed. A completed execution has a populated response field containing the `ExecutionResponse` from function that was executed.",
@@ -224,7 +169,9 @@
"type": "object"
}
},
- "id": "Operation"
+ "id": "Operation",
+ "description": "The response will not arrive until the function finishes executing. The maximum runtime is listed in the guide to [limitations in Apps Script](https://developers.google.com/apps-script/guides/services/quotas#current_limitations).\n\u003cp\u003eIf the script function returns successfully, the `response` field will contain an `ExecutionResponse` object with the function's return value in the object's `result` field.\u003c/p\u003e\n\u003cp\u003eIf the script function (or Apps Script itself) throws an exception, the `error` field will contain a `Status` object. The `Status` object's `details` field will contain an array with a single `ExecutionError` object that provides information about the nature of the error.\u003c/p\u003e\n\u003cp\u003eIf the `run` call itself fails (for example, because of a malformed request or an authorization error), the method will return an HTTP response code in the 4XX range with a different format for the response body. Client libraries will automatically convert a 4XX response into an exception class.\u003c/p\u003e",
+ "type": "object"
},
"ScriptStackTraceElement": {
"properties": {
@@ -263,24 +210,71 @@
}
},
"id": "ExecutionError"
+ },
+ "Status": {
+ "description": "If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, the response body's `error` field will contain this `Status` object.",
+ "type": "object",
+ "properties": {
+ "details": {
+ "description": "An array that contains a single `ExecutionError` object that provides information about the nature of the error.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ }
+ },
+ "code": {
+ "description": "The status code. For this API, this value will always be 3, corresponding to an \u003ccode\u003eINVALID_ARGUMENT\u003c/code\u003e error.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which is in English. Any user-facing error message is localized and sent in the [`google.rpc.Status.details`](google.rpc.Status.details) field, or localized by the client.",
+ "type": "string"
+ }
+ },
+ "id": "Status"
+ },
+ "ExecutionRequest": {
+ "properties": {
+ "function": {
+ "description": "The name of the function to execute in the given script. The name does not\ninclude parentheses or parameters.",
+ "type": "string"
+ },
+ "devMode": {
+ "description": "If `true` and the user is an owner of the script, the script runs at the\nmost recently saved version rather than the version deployed for use with\nthe Execution API. Optional; default is `false`.",
+ "type": "boolean"
+ },
+ "parameters": {
+ "description": "The parameters to be passed to the function being executed. The object type\nfor each parameter should match the expected type in Apps Script.\nParameters cannot be Apps Script-specific object types (such as a\n`Document` or a `Calendar`); they can only be primitive types such as\n`string`, `number`, `array`, `object`, or `boolean`. Optional.",
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ },
+ "sessionState": {
+ "description": "For Android add-ons only. An ID that represents the user's current session\nin the Android app for Google Docs or Sheets, included as extra data in the\n[`Intent`](https://developer.android.com/guide/components/intents-filters.html)\nthat launches the add-on. When an Android add-on is run with a session\nstate, it gains the privileges of a\n[bound](https://developers.google.com/apps-script/guides/bound) script —\nthat is, it can access information like the user's current cursor position\n(in Docs) or selected cell (in Sheets). To retrieve the state, call\n`Intent.getStringExtra(\"com.google.android.apps.docs.addons.SessionState\")`.\nOptional.",
+ "type": "string"
+ }
+ },
+ "id": "ExecutionRequest",
+ "description": "A request to run the function in a script. The script is identified by the\nspecified `script_id`. Executing a function on a script returns results\nbased on the implementation of the script.",
+ "type": "object"
}
},
+ "protocol": "rest",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
- "protocol": "rest",
"version": "v1",
"baseUrl": "https://script.googleapis.com/",
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/userinfo.email": {
- "description": "View your email address"
- },
- "https://www.google.com/calendar/feeds": {
- "description": "Manage your calendars"
- },
"https://www.googleapis.com/auth/groups": {
"description": "View and manage your Google Groups"
},
@@ -296,24 +290,30 @@
"https://www.googleapis.com/auth/admin.directory.group": {
"description": "View and manage the provisioning of groups on your domain"
},
- "https://mail.google.com/": {
- "description": "Read, send, delete, and manage your email"
- },
"https://www.googleapis.com/auth/spreadsheets": {
"description": "View and manage your spreadsheets in Google Drive"
},
+ "https://mail.google.com/": {
+ "description": "Read, send, delete, and manage your email"
+ },
"https://www.googleapis.com/auth/forms": {
"description": "View and manage your forms in Google Drive"
},
"https://www.google.com/m8/feeds": {
"description": "Manage your contacts"
+ },
+ "https://www.googleapis.com/auth/userinfo.email": {
+ "description": "View your email address"
+ },
+ "https://www.google.com/calendar/feeds": {
+ "description": "Manage your calendars"
}
}
}
},
- "servicePath": "",
- "description": "An API for managing and executing Google Apps Script projects.",
"kind": "discovery#restDescription",
+ "description": "An API for managing and executing Google Apps Script projects.",
+ "servicePath": "",
"rootUrl": "https://script.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
diff --git a/searchconsole/v1/searchconsole-api.json b/searchconsole/v1/searchconsole-api.json
index 27acb82..389b429 100644
--- a/searchconsole/v1/searchconsole-api.json
+++ b/searchconsole/v1/searchconsole-api.json
@@ -1,18 +1,7 @@
{
- "version": "v1",
- "baseUrl": "https://searchconsole.googleapis.com/",
- "canonicalName": "Search Console",
- "kind": "discovery#restDescription",
- "description": "Provides tools for running validation tests against single URLs",
- "servicePath": "",
- "rootUrl": "https://searchconsole.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "searchconsole",
- "batchPath": "batch",
- "id": "searchconsole:v1",
- "documentationLink": "https://developers.google.com/webmaster-tools/search-console-api/",
"revision": "20171007",
+ "documentationLink": "https://developers.google.com/webmaster-tools/search-console-api/",
+ "id": "searchconsole:v1",
"title": "Google Search Console URL Testing Tools API",
"discoveryVersion": "v1",
"ownerName": "Google",
@@ -44,9 +33,9 @@
},
"parameters": {
"upload_protocol": {
+ "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"prettyPrint": {
"description": "Returns response with indentations and line breaks.",
@@ -64,39 +53,39 @@
"description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
"callback": {
"location": "query",
"description": "JSONP",
"type": "string"
},
- "alt": {
+ "$.xgafv": {
"enum": [
- "json",
- "media",
- "proto"
+ "1",
+ "2"
],
+ "description": "V1 error format.",
"type": "string",
"enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query"
+ },
+ "alt": {
+ "enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"description": "Data format for response.",
- "default": "json"
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string"
},
"key": {
"location": "query",
@@ -104,9 +93,9 @@
"type": "string"
},
"access_token": {
+ "location": "query",
"description": "OAuth access token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"quotaUser": {
"location": "query",
@@ -114,23 +103,92 @@
"type": "string"
},
"pp": {
+ "location": "query",
"description": "Pretty-print response.",
"type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
+ "default": "true"
},
"bearer_token": {
"description": "OAuth bearer token.",
"type": "string",
"location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
}
},
"schemas": {
+ "BlockedResource": {
+ "properties": {
+ "url": {
+ "description": "URL of the blocked resource.",
+ "type": "string"
+ }
+ },
+ "id": "BlockedResource",
+ "description": "Blocked resource.",
+ "type": "object"
+ },
+ "TestStatus": {
+ "description": "Final state of the test, including error details if necessary.",
+ "type": "object",
+ "properties": {
+ "status": {
+ "enumDescriptions": [
+ "Internal error when running this test. Please try running the test again.",
+ "Inspection has completed without errors.",
+ "Inspection terminated in an error state. This indicates a problem in\nGoogle's infrastructure, not a user error. Please try again later.",
+ "Google can not access the URL because of a user error such as a robots.txt\nblockage, a 403 or 500 code etc. Please make sure that the URL provided is\naccessible by Googlebot and is not password protected."
+ ],
+ "enum": [
+ "TEST_STATUS_UNSPECIFIED",
+ "COMPLETE",
+ "INTERNAL_ERROR",
+ "PAGE_UNREACHABLE"
+ ],
+ "description": "Status of the test.",
+ "type": "string"
+ },
+ "details": {
+ "description": "Error details if applicable.",
+ "type": "string"
+ }
+ },
+ "id": "TestStatus"
+ },
+ "RunMobileFriendlyTestRequest": {
+ "properties": {
+ "url": {
+ "description": "URL for inspection.",
+ "type": "string"
+ },
+ "requestScreenshot": {
+ "description": "Whether or not screenshot is requested. Default is false.",
+ "type": "boolean"
+ }
+ },
+ "id": "RunMobileFriendlyTestRequest",
+ "description": "Mobile-friendly test request.",
+ "type": "object"
+ },
+ "Image": {
+ "description": "Describe image data.",
+ "type": "object",
+ "properties": {
+ "data": {
+ "description": "Image data in format determined by the mime type. Currently, the format\nwill always be \"image/png\", but this might change in the future.",
+ "format": "byte",
+ "type": "string"
+ },
+ "mimeType": {
+ "description": "The mime-type of the image data.",
+ "type": "string"
+ }
+ },
+ "id": "Image"
+ },
"MobileFriendlyIssue": {
"properties": {
"rule": {
@@ -161,11 +219,9 @@
"type": "object"
},
"RunMobileFriendlyTestResponse": {
+ "description": "Mobile-friendly test response, including mobile-friendly issues and resource\nissues.",
+ "type": "object",
"properties": {
- "screenshot": {
- "$ref": "Image",
- "description": "Screenshot of the requested URL."
- },
"testStatus": {
"description": "Final state of the test, can be either complete or an error.",
"$ref": "TestStatus"
@@ -197,96 +253,40 @@
"items": {
"$ref": "MobileFriendlyIssue"
}
+ },
+ "screenshot": {
+ "$ref": "Image",
+ "description": "Screenshot of the requested URL."
}
},
- "id": "RunMobileFriendlyTestResponse",
- "description": "Mobile-friendly test response, including mobile-friendly issues and resource\nissues.",
- "type": "object"
+ "id": "RunMobileFriendlyTestResponse"
},
"ResourceIssue": {
- "description": "Information about a resource with issue.",
- "type": "object",
"properties": {
"blockedResource": {
- "description": "Describes a blocked resource issue.",
- "$ref": "BlockedResource"
+ "$ref": "BlockedResource",
+ "description": "Describes a blocked resource issue."
}
},
- "id": "ResourceIssue"
- },
- "BlockedResource": {
- "description": "Blocked resource.",
- "type": "object",
- "properties": {
- "url": {
- "description": "URL of the blocked resource.",
- "type": "string"
- }
- },
- "id": "BlockedResource"
- },
- "TestStatus": {
- "description": "Final state of the test, including error details if necessary.",
- "type": "object",
- "properties": {
- "status": {
- "enum": [
- "TEST_STATUS_UNSPECIFIED",
- "COMPLETE",
- "INTERNAL_ERROR",
- "PAGE_UNREACHABLE"
- ],
- "description": "Status of the test.",
- "type": "string",
- "enumDescriptions": [
- "Internal error when running this test. Please try running the test again.",
- "Inspection has completed without errors.",
- "Inspection terminated in an error state. This indicates a problem in\nGoogle's infrastructure, not a user error. Please try again later.",
- "Google can not access the URL because of a user error such as a robots.txt\nblockage, a 403 or 500 code etc. Please make sure that the URL provided is\naccessible by Googlebot and is not password protected."
- ]
- },
- "details": {
- "description": "Error details if applicable.",
- "type": "string"
- }
- },
- "id": "TestStatus"
- },
- "RunMobileFriendlyTestRequest": {
- "properties": {
- "url": {
- "description": "URL for inspection.",
- "type": "string"
- },
- "requestScreenshot": {
- "description": "Whether or not screenshot is requested. Default is false.",
- "type": "boolean"
- }
- },
- "id": "RunMobileFriendlyTestRequest",
- "description": "Mobile-friendly test request.",
+ "id": "ResourceIssue",
+ "description": "Information about a resource with issue.",
"type": "object"
- },
- "Image": {
- "description": "Describe image data.",
- "type": "object",
- "properties": {
- "mimeType": {
- "description": "The mime-type of the image data.",
- "type": "string"
- },
- "data": {
- "description": "Image data in format determined by the mime type. Currently, the format\nwill always be \"image/png\", but this might change in the future.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "Image"
}
},
- "protocol": "rest",
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- }
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ },
+ "protocol": "rest",
+ "version": "v1",
+ "baseUrl": "https://searchconsole.googleapis.com/",
+ "canonicalName": "Search Console",
+ "kind": "discovery#restDescription",
+ "description": "Provides tools for running validation tests against single URLs",
+ "servicePath": "",
+ "rootUrl": "https://searchconsole.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "searchconsole",
+ "batchPath": "batch"
}
diff --git a/servicecontrol/v1/servicecontrol-api.json b/servicecontrol/v1/servicecontrol-api.json
index d45f42b..f1119d9 100644
--- a/servicecontrol/v1/servicecontrol-api.json
+++ b/servicecontrol/v1/servicecontrol-api.json
@@ -1,669 +1,321 @@
{
- "id": "servicecontrol:v1",
- "documentationLink": "https://cloud.google.com/service-control/",
+ "ownerName": "Google",
+ "resources": {
+ "services": {
+ "methods": {
+ "startReconciliation": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "response": {
+ "$ref": "StartReconciliationResponse"
+ },
+ "parameters": {
+ "serviceName": {
+ "description": "Name of the service as specified in the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/servicecontrol"
+ ],
+ "flatPath": "v1/services/{serviceName}:startReconciliation",
+ "path": "v1/services/{serviceName}:startReconciliation",
+ "id": "servicecontrol.services.startReconciliation",
+ "description": "Unlike rate quota, allocation quota does not get refilled periodically.\nSo, it is possible that the quota usage as seen by the service differs from\nwhat the One Platform considers the usage is. This is expected to happen\nonly rarely, but over time this can accumulate. Services can invoke\nStartReconciliation and EndReconciliation to correct this usage drift, as\ndescribed below:\n1. Service sends StartReconciliation with a timestamp in future for each\n metric that needs to be reconciled. The timestamp being in future allows\n to account for in-flight AllocateQuota and ReleaseQuota requests for the\n same metric.\n2. One Platform records this timestamp and starts tracking subsequent\n AllocateQuota and ReleaseQuota requests until EndReconciliation is\n called.\n3. At or after the time specified in the StartReconciliation, service\n sends EndReconciliation with the usage that needs to be reconciled to.\n4. One Platform adjusts its own record of usage for that metric to the\n value specified in EndReconciliation by taking in to account any\n allocation or release between StartReconciliation and EndReconciliation.\n\nSignals the quota controller that the service wants to perform a usage\nreconciliation as specified in the request.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).",
+ "request": {
+ "$ref": "StartReconciliationRequest"
+ }
+ },
+ "check": {
+ "id": "servicecontrol.services.check",
+ "path": "v1/services/{serviceName}:check",
+ "description": "Checks an operation with Google Service Control to decide whether\nthe given operation should proceed. It should be called before the\noperation is executed.\n\nIf feasible, the client should cache the check results and reuse them for\n60 seconds. In case of server errors, the client can rely on the cached\nresults for longer time.\n\nNOTE: the CheckRequest has the size limit of 64KB.\n\nThis method requires the `servicemanagement.services.check` permission\non the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).",
+ "request": {
+ "$ref": "CheckRequest"
+ },
+ "response": {
+ "$ref": "CheckResponse"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "serviceName": {
+ "description": "The service name as specified in its service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee\n[google.api.Service](https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service)\nfor the definition of a service name.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/servicecontrol"
+ ],
+ "flatPath": "v1/services/{serviceName}:check"
+ },
+ "releaseQuota": {
+ "response": {
+ "$ref": "ReleaseQuotaResponse"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "serviceName": {
+ "description": "Name of the service as specified in the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/servicecontrol"
+ ],
+ "flatPath": "v1/services/{serviceName}:releaseQuota",
+ "id": "servicecontrol.services.releaseQuota",
+ "path": "v1/services/{serviceName}:releaseQuota",
+ "description": "Releases previously allocated quota done through AllocateQuota method.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Cloud IAM](https://cloud.google.com/iam).\n\n\n**NOTE:** The client **must** fail-open on server errors `INTERNAL`,\n`UNKNOWN`, `DEADLINE_EXCEEDED`, and `UNAVAILABLE`. To ensure system\nreliability, the server may inject these errors to prohibit any hard\ndependency on the quota functionality.",
+ "request": {
+ "$ref": "ReleaseQuotaRequest"
+ }
+ },
+ "endReconciliation": {
+ "response": {
+ "$ref": "EndReconciliationResponse"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "serviceName": {
+ "description": "Name of the service as specified in the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/servicecontrol"
+ ],
+ "flatPath": "v1/services/{serviceName}:endReconciliation",
+ "id": "servicecontrol.services.endReconciliation",
+ "path": "v1/services/{serviceName}:endReconciliation",
+ "description": "Signals the quota controller that service ends the ongoing usage\nreconciliation.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).",
+ "request": {
+ "$ref": "EndReconciliationRequest"
+ }
+ },
+ "report": {
+ "description": "Reports operation results to Google Service Control, such as logs and\nmetrics. It should be called after an operation is completed.\n\nIf feasible, the client should aggregate reporting data for up to 5\nseconds to reduce API traffic. Limiting aggregation to 5 seconds is to\nreduce data loss during client crashes. Clients should carefully choose\nthe aggregation time window to avoid data loss risk more than 0.01%\nfor business and compliance reasons.\n\nNOTE: the ReportRequest has the size limit of 1MB.\n\nThis method requires the `servicemanagement.services.report` permission\non the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).",
+ "request": {
+ "$ref": "ReportRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "response": {
+ "$ref": "ReportResponse"
+ },
+ "parameters": {
+ "serviceName": {
+ "location": "path",
+ "description": "The service name as specified in its service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee\n[google.api.Service](https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service)\nfor the definition of a service name.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/servicecontrol"
+ ],
+ "flatPath": "v1/services/{serviceName}:report",
+ "path": "v1/services/{serviceName}:report",
+ "id": "servicecontrol.services.report"
+ },
+ "allocateQuota": {
+ "flatPath": "v1/services/{serviceName}:allocateQuota",
+ "path": "v1/services/{serviceName}:allocateQuota",
+ "id": "servicecontrol.services.allocateQuota",
+ "description": "Attempts to allocate quota for the specified consumer. It should be called\nbefore the operation is executed.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Cloud IAM](https://cloud.google.com/iam).\n\n**NOTE:** The client **must** fail-open on server errors `INTERNAL`,\n`UNKNOWN`, `DEADLINE_EXCEEDED`, and `UNAVAILABLE`. To ensure system\nreliability, the server may inject these errors to prohibit any hard\ndependency on the quota functionality.",
+ "request": {
+ "$ref": "AllocateQuotaRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "response": {
+ "$ref": "AllocateQuotaResponse"
+ },
+ "parameters": {
+ "serviceName": {
+ "location": "path",
+ "description": "Name of the service as specified in the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/servicecontrol"
+ ]
+ }
+ }
+ }
+ },
+ "parameters": {
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ]
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth access token."
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "oauth_token": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user."
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://servicecontrol.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Google Service Control provides control plane functionality to managed services, such as logging, monitoring, and status checks.",
+ "servicePath": "",
+ "basePath": "",
"revision": "20170930",
+ "documentationLink": "https://cloud.google.com/service-control/",
+ "id": "servicecontrol:v1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "CheckRequest": {
- "id": "CheckRequest",
- "description": "Request message for the Check method.",
- "type": "object",
- "properties": {
- "skipActivationCheck": {
- "description": "Indicates if service activation check should be skipped for this request.\nDefault behavior is to perform the check and apply relevant quota.",
- "type": "boolean"
- },
- "requestProjectSettings": {
- "description": "Requests the project settings to be returned as part of the check response.",
- "type": "boolean"
- },
- "operation": {
- "description": "The operation to be checked.",
- "$ref": "Operation"
- },
- "serviceConfigId": {
- "description": "Specifies which version of service configuration should be used to process\nthe request.\n\nIf unspecified or no matching version can be found, the\nlatest one will be used.",
- "type": "string"
- }
- }
- },
- "QuotaOperation": {
- "id": "QuotaOperation",
- "description": "Represents information regarding a quota operation.",
- "type": "object",
- "properties": {
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Labels describing the operation.",
- "type": "object"
- },
- "consumerId": {
- "description": "Identity of the consumer for whom this quota operation is being performed.\n\nThis can be in one of the following formats:\n project:\u003cproject_id\u003e,\n project_number:\u003cproject_number\u003e,\n api_key:\u003capi_key\u003e.",
- "type": "string"
- },
- "operationId": {
- "description": "Identity of the operation. This is expected to be unique within the scope\nof the service that generated the operation, and guarantees idempotency in\ncase of retries.\n\nUUID version 4 is recommended, though not required. In scenarios where an\noperation is computed from existing information and an idempotent id is\ndesirable for deduplication purpose, UUID version 5 is recommended. See\nRFC 4122 for details.",
- "type": "string"
- },
- "quotaMode": {
- "description": "Quota mode for this operation.",
- "type": "string",
- "enumDescriptions": [
- "Guard against implicit default. Must not be used.",
- "For AllocateQuota request, allocates quota for the amount specified in\nthe service configuration or specified using the quota metrics. If the\namount is higher than the available quota, allocation error will be\nreturned and no quota will be allocated.",
- "The operation allocates quota for the amount specified in the service\nconfiguration or specified using the quota metrics. If the amount is\nhigher than the available quota, request does not fail but all available\nquota will be allocated.",
- "For AllocateQuota request, only checks if there is enough quota\navailable and does not change the available quota. No lock is placed on\nthe available quota either."
- ],
- "enum": [
- "UNSPECIFIED",
- "NORMAL",
- "BEST_EFFORT",
- "CHECK_ONLY"
- ]
- },
- "methodName": {
- "description": "Fully qualified name of the API method for which this quota operation is\nrequested. This name is used for matching quota rules or metric rules and\nbilling status rules defined in service configuration. This field is not\nrequired if the quota operation is performed on non-API resources.\n\nExample of an RPC method name:\n google.example.library.v1.LibraryService.CreateShelf",
- "type": "string"
- },
- "quotaMetrics": {
- "description": "Represents information about this operation. Each MetricValueSet\ncorresponds to a metric defined in the service configuration.\nThe data type used in the MetricValueSet must agree with\nthe data type specified in the metric definition.\n\nWithin a single operation, it is not allowed to have more than one\nMetricValue instances that have the same metric names and identical\nlabel value combinations. If a request has such duplicated MetricValue\ninstances, the entire request is rejected with\nan invalid argument error.",
- "items": {
- "$ref": "MetricValueSet"
- },
- "type": "array"
- }
- }
- },
- "EndReconciliationRequest": {
- "id": "EndReconciliationRequest",
- "description": "Request message for QuotaController.EndReconciliation.",
- "type": "object",
- "properties": {
- "reconciliationOperation": {
- "description": "Operation that describes the quota reconciliation.",
- "$ref": "QuotaOperation"
- },
- "serviceConfigId": {
- "description": "Specifies which version of service configuration should be used to process\nthe request. If unspecified or no matching version can be found, the latest\none will be used.",
- "type": "string"
- }
- }
- },
- "ReportInfo": {
- "id": "ReportInfo",
- "description": "Contains additional info about the report operation.",
- "type": "object",
- "properties": {
- "operationId": {
- "description": "The Operation.operation_id value from the request.",
- "type": "string"
- },
- "quotaInfo": {
- "description": "Quota usage info when processing the `Operation`.",
- "$ref": "QuotaInfo"
- }
- }
- },
- "Operation": {
- "description": "Represents information regarding an operation.",
- "type": "object",
- "properties": {
- "quotaProperties": {
- "$ref": "QuotaProperties",
- "description": "Represents the properties needed for quota check. Applicable only if this\noperation is for a quota check request. If this is not specified, no quota\ncheck will be performed."
- },
- "consumerId": {
- "description": "Identity of the consumer who is using the service.\nThis field should be filled in for the operations initiated by a\nconsumer, but not for service-initiated operations that are\nnot related to a specific consumer.\n\nThis can be in one of the following formats:\n project:\u003cproject_id\u003e,\n project_number:\u003cproject_number\u003e,\n api_key:\u003capi_key\u003e.",
- "type": "string"
- },
- "operationId": {
- "type": "string",
- "description": "Identity of the operation. This must be unique within the scope of the\nservice that generated the operation. If the service calls\nCheck() and Report() on the same operation, the two calls should carry\nthe same id.\n\nUUID version 4 is recommended, though not required.\nIn scenarios where an operation is computed from existing information\nand an idempotent id is desirable for deduplication purpose, UUID version 5\nis recommended. See RFC 4122 for details."
- },
- "endTime": {
- "format": "google-datetime",
- "description": "End time of the operation.\nRequired when the operation is used in ServiceController.Report,\nbut optional when the operation is used in ServiceController.Check.",
- "type": "string"
- },
- "operationName": {
- "description": "Fully qualified name of the operation. Reserved for future use.",
- "type": "string"
- },
- "startTime": {
- "format": "google-datetime",
- "description": "Required. Start time of the operation.",
- "type": "string"
- },
- "importance": {
- "enum": [
- "LOW",
- "HIGH",
- "DEBUG"
- ],
- "description": "DO NOT USE. This is an experimental field.",
- "type": "string",
- "enumDescriptions": [
- "The API implementation may cache and aggregate the data.\nThe data may be lost when rare and unexpected system failures occur.",
- "The API implementation doesn't cache and aggregate the data.\nIf the method returns successfully, it's guaranteed that the data has\nbeen persisted in durable storage.",
- "In addition to the behavior described in HIGH, DEBUG enables\nadditional validation logic that is only useful during the onboarding\nprocess. This is only available to Google internal services and\nthe service must be whitelisted by chemist-dev@google.com in order\nto use this level."
- ]
- },
- "resourceContainer": {
- "description": "DO NOT USE. This field is deprecated, use \"resources\" field instead.\nThe resource name of the parent of a resource in the resource hierarchy.\n\nThis can be in one of the following formats:\n - “projects/\u003cproject-id or project-number\u003e”\n - “folders/\u003cfolder-id\u003e”\n - “organizations/\u003corganization-id\u003e”",
- "type": "string"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Labels describing the operation. Only the following labels are allowed:\n\n- Labels describing monitored resources as defined in\n the service configuration.\n- Default labels of metric values. When specified, labels defined in the\n metric value override these default.\n- The following labels defined by Google Cloud Platform:\n - `cloud.googleapis.com/location` describing the location where the\n operation happened,\n - `servicecontrol.googleapis.com/user_agent` describing the user agent\n of the API request,\n - `servicecontrol.googleapis.com/service_agent` describing the service\n used to handle the API request (e.g. ESP),\n - `servicecontrol.googleapis.com/platform` describing the platform\n where the API is served (e.g. GAE, GCE, GKE).",
- "type": "object"
- },
- "resources": {
- "items": {
- "$ref": "ResourceInfo"
- },
- "type": "array",
- "description": "The resources that are involved in the operation."
- },
- "logEntries": {
- "description": "Represents information to be logged.",
- "items": {
- "$ref": "LogEntry"
- },
- "type": "array"
- },
- "userLabels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "User defined labels for the resource that this operation is associated\nwith. Only a combination of 1000 user labels per consumer project are\nallowed.",
- "type": "object"
- },
- "metricValueSets": {
- "description": "Represents information about this operation. Each MetricValueSet\ncorresponds to a metric defined in the service configuration.\nThe data type used in the MetricValueSet must agree with\nthe data type specified in the metric definition.\n\nWithin a single operation, it is not allowed to have more than one\nMetricValue instances that have the same metric names and identical\nlabel value combinations. If a request has such duplicated MetricValue\ninstances, the entire request is rejected with\nan invalid argument error.",
- "items": {
- "$ref": "MetricValueSet"
- },
- "type": "array"
- }
- },
- "id": "Operation"
- },
- "ReportResponse": {
- "description": "Response message for the Report method.",
- "type": "object",
- "properties": {
- "reportInfos": {
- "items": {
- "$ref": "ReportInfo"
- },
- "type": "array",
- "description": "Quota usage for each quota release `Operation` request.\n\nFully or partially failed quota release request may or may not be present\nin `report_quota_info`. For example, a failed quota release request will\nhave the current quota usage info when precise quota library returns the\ninfo. A deadline exceeded quota request will not have quota usage info.\n\nIf there is no quota release request, report_quota_info will be empty.\n"
- },
- "serviceConfigId": {
- "description": "The actual config id used to process the request.",
- "type": "string"
- },
- "reportErrors": {
- "items": {
- "$ref": "ReportError"
- },
- "type": "array",
- "description": "Partial failures, one for each `Operation` in the request that failed\nprocessing. There are three possible combinations of the RPC status:\n\n1. The combination of a successful RPC status and an empty `report_errors`\n list indicates a complete success where all `Operations` in the\n request are processed successfully.\n2. The combination of a successful RPC status and a non-empty\n `report_errors` list indicates a partial success where some\n `Operations` in the request succeeded. Each\n `Operation` that failed processing has a corresponding item\n in this list.\n3. A failed RPC status indicates a general non-deterministic failure.\n When this happens, it's impossible to know which of the\n 'Operations' in the request succeeded or failed."
- }
- },
- "id": "ReportResponse"
- },
- "CheckResponse": {
- "type": "object",
- "properties": {
- "checkInfo": {
- "description": "Feedback data returned from the server during processing a Check request.",
- "$ref": "CheckInfo"
- },
- "checkErrors": {
- "description": "Indicate the decision of the check.\n\nIf no check errors are present, the service should process the operation.\nOtherwise the service should use the list of errors to determine the\nappropriate action.",
- "items": {
- "$ref": "CheckError"
- },
- "type": "array"
- },
- "operationId": {
- "description": "The same operation_id value used in the CheckRequest.\nUsed for logging and diagnostics purposes.",
- "type": "string"
- },
- "serviceConfigId": {
- "description": "The actual config id used to process the request.",
- "type": "string"
- },
- "quotaInfo": {
- "$ref": "QuotaInfo",
- "description": "Quota information for the check request associated with this response.\n"
- }
- },
- "id": "CheckResponse",
- "description": "Response message for the Check method."
- },
- "Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "type": "array"
- },
- "code": {
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer"
- },
- "message": {
- "type": "string",
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client."
- }
- },
- "id": "Status"
- },
- "AllocateInfo": {
- "type": "object",
- "properties": {
- "unusedArguments": {
- "description": "A list of label keys that were unused by the server in processing the\nrequest. Thus, for similar requests repeated in a certain future time\nwindow, the caller can choose to ignore these labels in the requests\nto achieve better client-side cache hits and quota aggregation.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "AllocateInfo"
- },
- "ReportRequest": {
- "description": "Request message for the Report method.",
- "type": "object",
- "properties": {
- "serviceConfigId": {
- "description": "Specifies which version of service config should be used to process the\nrequest.\n\nIf unspecified or no matching version can be found, the\nlatest one will be used.",
- "type": "string"
- },
- "operations": {
- "description": "Operations to be reported.\n\nTypically the service should report one operation per request.\nPutting multiple operations into a single request is allowed, but should\nbe used only when multiple operations are natually available at the time\nof the report.\n\nIf multiple operations are in a single request, the total request size\nshould be no larger than 1MB. See ReportResponse.report_errors for\npartial failure behavior.",
- "items": {
- "$ref": "Operation"
- },
- "type": "array"
- }
- },
- "id": "ReportRequest"
- },
- "AuditLog": {
- "description": "Common audit log format for Google Cloud Platform API operations.\n\n",
- "type": "object",
- "properties": {
- "resourceName": {
- "description": "The resource or collection that is the target of the operation.\nThe name is a scheme-less URI, not including the API service name.\nFor example:\n\n \"shelves/SHELF_ID/books\"\n \"shelves/SHELF_ID/books/BOOK_ID\"",
- "type": "string"
- },
- "serviceData": {
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
- },
- "description": "Deprecated, use `metadata` field instead.\nOther service-specific data about the request, response, and other\nactivities.",
- "type": "object"
- },
- "numResponseItems": {
- "format": "int64",
- "description": "The number of items returned from a List or Query API method,\nif applicable.",
- "type": "string"
- },
- "authorizationInfo": {
- "items": {
- "$ref": "AuthorizationInfo"
- },
- "type": "array",
- "description": "Authorization information. If there are multiple\nresources or permissions involved, then there is\none AuthorizationInfo element for each {resource, permission} tuple."
- },
- "request": {
- "description": "The operation request. This may not include all request parameters,\nsuch as those that are too large, privacy-sensitive, or duplicated\nelsewhere in the log record.\nIt should never include user-generated data, such as file contents.\nWhen the JSON object represented here has a proto equivalent, the proto\nname will be indicated in the `@type` property.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- }
- },
- "requestMetadata": {
- "description": "Metadata about the operation.",
- "$ref": "RequestMetadata"
- },
- "authenticationInfo": {
- "description": "Authentication information.",
- "$ref": "AuthenticationInfo"
- },
- "status": {
- "description": "The status of the overall operation.",
- "$ref": "Status"
- },
- "serviceName": {
- "description": "The name of the API service performing the operation. For example,\n`\"datastore.googleapis.com\"`.",
- "type": "string"
- },
- "response": {
- "description": "The operation response. This may not include all response elements,\nsuch as those that are too large, privacy-sensitive, or duplicated\nelsewhere in the log record.\nIt should never include user-generated data, such as file contents.\nWhen the JSON object represented here has a proto equivalent, the proto\nname will be indicated in the `@type` property.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- }
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "Other service-specific data about the request, response, and other\ninformation associated with the current audited event.",
- "type": "object"
- },
- "methodName": {
- "description": "The name of the service method or operation.\nFor API calls, this should be the name of the API method.\nFor example,\n\n \"google.datastore.v1.Datastore.RunQuery\"\n \"google.logging.v1.LoggingService.DeleteLog\"",
- "type": "string"
- }
- },
- "id": "AuditLog"
- },
- "LogEntry": {
- "type": "object",
- "properties": {
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "A set of user-defined (key, value) data that provides additional\ninformation about the log entry.",
- "type": "object"
- },
- "severity": {
- "description": "The severity of the log entry. The default value is\n`LogSeverity.DEFAULT`.",
- "type": "string",
- "enumDescriptions": [
- "(0) The log entry has no assigned severity level.",
- "(100) Debug or trace information.",
- "(200) Routine information, such as ongoing status or performance.",
- "(300) Normal but significant events, such as start up, shut down, or\na configuration change.",
- "(400) Warning events might cause problems.",
- "(500) Error events are likely to cause problems.",
- "(600) Critical events cause more severe problems or outages.",
- "(700) A person must take an action immediately.",
- "(800) One or more systems are unusable."
- ],
- "enum": [
- "DEFAULT",
- "DEBUG",
- "INFO",
- "NOTICE",
- "WARNING",
- "ERROR",
- "CRITICAL",
- "ALERT",
- "EMERGENCY"
- ]
- },
- "insertId": {
- "description": "A unique ID for the log entry used for deduplication. If omitted,\nthe implementation will generate one based on operation_id.",
- "type": "string"
- },
- "name": {
- "description": "Required. The log to which this log entry belongs. Examples: `\"syslog\"`,\n`\"book_log\"`.",
- "type": "string"
- },
- "structPayload": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "The log entry payload, represented as a structure that\nis expressed as a JSON object.",
- "type": "object"
- },
- "textPayload": {
- "description": "The log entry payload, represented as a Unicode string (UTF-8).",
- "type": "string"
- },
- "protoPayload": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "The log entry payload, represented as a protocol buffer that is\nexpressed as a JSON object. The only accepted type currently is\nAuditLog.",
- "type": "object"
- },
- "timestamp": {
- "format": "google-datetime",
- "description": "The time the event described by the log entry occurred. If\nomitted, defaults to operation start time.",
- "type": "string"
- }
- },
- "id": "LogEntry",
- "description": "An individual log entry."
- },
- "MetricValue": {
- "description": "Represents a single metric value.",
- "type": "object",
- "properties": {
- "int64Value": {
- "format": "int64",
- "description": "A signed 64-bit integer value.",
- "type": "string"
- },
- "distributionValue": {
- "$ref": "Distribution",
- "description": "A distribution value."
- },
- "boolValue": {
- "description": "A boolean value.",
- "type": "boolean"
- },
- "endTime": {
- "type": "string",
- "format": "google-datetime",
- "description": "The end of the time period over which this metric value's measurement\napplies."
- },
- "startTime": {
- "format": "google-datetime",
- "description": "The start of the time period over which this metric value's measurement\napplies. The time period has different semantics for different metric\ntypes (cumulative, delta, and gauge). See the metric definition\ndocumentation in the service configuration for details.",
- "type": "string"
- },
- "moneyValue": {
- "$ref": "Money",
- "description": "A money value."
- },
- "stringValue": {
- "type": "string",
- "description": "A text string value."
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "The labels describing the metric value.\nSee comments on google.api.servicecontrol.v1.Operation.labels for\nthe overriding relationship.",
- "type": "object"
- },
- "doubleValue": {
- "format": "double",
- "description": "A double precision floating point value.",
- "type": "number"
- }
- },
- "id": "MetricValue"
- },
- "EndReconciliationResponse": {
- "description": "Response message for QuotaController.EndReconciliation.",
- "type": "object",
- "properties": {
- "reconciliationErrors": {
- "items": {
- "$ref": "QuotaError"
- },
- "type": "array",
- "description": "Indicates the decision of the reconciliation end."
- },
- "operationId": {
- "type": "string",
- "description": "The same operation_id value used in the EndReconciliationRequest. Used for\nlogging and diagnostics purposes."
- },
- "serviceConfigId": {
- "description": "ID of the actual config used to process the request.",
- "type": "string"
- },
- "quotaMetrics": {
- "description": "Metric values as tracked by One Platform before the adjustment was made.\nThe following metrics will be included:\n\n1. Per quota metric total usage will be specified using the following gauge\nmetric:\n \"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n2. Value for each quota limit associated with the metrics will be specified\nusing the following gauge metric:\n \"serviceruntime.googleapis.com/quota/limit\"\n\n3. Delta value of the usage after the reconciliation for limits associated\nwith the metrics will be specified using the following metric:\n \"serviceruntime.googleapis.com/allocation/reconciliation_delta\"\nThe delta value is defined as:\n new_usage_from_client - existing_value_in_spanner.\nThis metric is not defined in serviceruntime.yaml or in Cloud Monarch.\nThis metric is meant for callers' use only. Since this metric is not\ndefined in the monitoring backend, reporting on this metric will result in\nan error.",
- "items": {
- "$ref": "MetricValueSet"
- },
- "type": "array"
- }
- },
- "id": "EndReconciliationResponse"
- },
- "Money": {
- "type": "object",
- "properties": {
- "nanos": {
- "format": "int32",
- "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
- "type": "integer"
- },
- "units": {
- "format": "int64",
- "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
- "type": "string"
- },
- "currencyCode": {
- "description": "The 3-letter currency code defined in ISO 4217.",
- "type": "string"
- }
- },
- "id": "Money",
- "description": "Represents an amount of money with its currency type."
- },
- "ExplicitBuckets": {
- "description": "Describing buckets with arbitrary user-provided width.",
- "type": "object",
- "properties": {
- "bounds": {
- "description": "'bound' is a list of strictly increasing boundaries between\nbuckets. Note that a list of length N-1 defines N buckets because\nof fenceposting. See comments on `bucket_options` for details.\n\nThe i'th finite bucket covers the interval\n [bound[i-1], bound[i])\nwhere i ranges from 1 to bound_size() - 1. Note that there are no\nfinite buckets at all if 'bound' only contains a single element; in\nthat special case the single bound defines the boundary between the\nunderflow and overflow buckets.\n\nbucket number lower bound upper bound\n i == 0 (underflow) -inf bound[i]\n 0 \u003c i \u003c bound_size() bound[i-1] bound[i]\n i == bound_size() (overflow) bound[i-1] +inf",
- "items": {
- "format": "double",
- "type": "number"
- },
- "type": "array"
- }
- },
- "id": "ExplicitBuckets"
- },
- "Distribution": {
- "description": "Distribution represents a frequency distribution of double-valued sample\npoints. It contains the size of the population of sample points plus\nadditional optional information:\n\n - the arithmetic mean of the samples\n - the minimum and maximum of the samples\n - the sum-squared-deviation of the samples, used to compute variance\n - a histogram of the values of the sample points",
- "type": "object",
- "properties": {
- "explicitBuckets": {
- "$ref": "ExplicitBuckets",
- "description": "Buckets with arbitrary user-provided width."
- },
- "maximum": {
- "format": "double",
- "description": "The maximum of the population of values. Ignored if `count` is zero.",
- "type": "number"
- },
- "sumOfSquaredDeviation": {
- "format": "double",
- "description": "The sum of squared deviations from the mean:\n Sum[i=1..count]((x_i - mean)^2)\nwhere each x_i is a sample values. If `count` is zero then this field\nmust be zero, otherwise validation of the request fails.",
- "type": "number"
- },
- "exponentialBuckets": {
- "description": "Buckets with exponentially growing width.",
- "$ref": "ExponentialBuckets"
- },
- "linearBuckets": {
- "$ref": "LinearBuckets",
- "description": "Buckets with constant width."
- },
- "minimum": {
- "format": "double",
- "description": "The minimum of the population of values. Ignored if `count` is zero.",
- "type": "number"
- },
- "count": {
- "format": "int64",
- "description": "The total number of samples in the distribution. Must be \u003e= 0.",
- "type": "string"
- },
- "mean": {
- "format": "double",
- "description": "The arithmetic mean of the samples in the distribution. If `count` is\nzero then this field must be zero.",
- "type": "number"
- },
- "bucketCounts": {
- "description": "The number of samples in each histogram bucket. `bucket_counts` are\noptional. If present, they must sum to the `count` value.\n\nThe buckets are defined below in `bucket_option`. There are N buckets.\n`bucket_counts[0]` is the number of samples in the underflow bucket.\n`bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples\nin each of the finite buckets. And `bucket_counts[N] is the number\nof samples in the overflow bucket. See the comments of `bucket_option`\nbelow for more details.\n\nAny suffix of trailing zeros may be omitted.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "Distribution"
- },
"ExponentialBuckets": {
- "description": "Describing buckets with exponentially growing width.",
- "type": "object",
"properties": {
+ "numFiniteBuckets": {
+ "format": "int32",
+ "description": "The number of finite buckets. With the underflow and overflow buckets,\nthe total number of buckets is `num_finite_buckets` + 2.\nSee comments on `bucket_options` for details.",
+ "type": "integer"
+ },
"growthFactor": {
+ "type": "number",
"format": "double",
- "description": "The i'th exponential bucket covers the interval\n [scale * growth_factor^(i-1), scale * growth_factor^i)\nwhere i ranges from 1 to num_finite_buckets inclusive.\nMust be larger than 1.0.",
- "type": "number"
+ "description": "The i'th exponential bucket covers the interval\n [scale * growth_factor^(i-1), scale * growth_factor^i)\nwhere i ranges from 1 to num_finite_buckets inclusive.\nMust be larger than 1.0."
},
"scale": {
"format": "double",
"description": "The i'th exponential bucket covers the interval\n [scale * growth_factor^(i-1), scale * growth_factor^i)\nwhere i ranges from 1 to num_finite_buckets inclusive.\nMust be \u003e 0.",
"type": "number"
- },
- "numFiniteBuckets": {
- "format": "int32",
- "description": "The number of finite buckets. With the underflow and overflow buckets,\nthe total number of buckets is `num_finite_buckets` + 2.\nSee comments on `bucket_options` for details.",
- "type": "integer"
}
},
- "id": "ExponentialBuckets"
+ "id": "ExponentialBuckets",
+ "description": "Describing buckets with exponentially growing width.",
+ "type": "object"
},
"AuthorizationInfo": {
- "description": "Authorization information for the operation.",
"type": "object",
"properties": {
"resource": {
- "description": "The resource being accessed, as a REST-style string. For example:\n\n bigquery.googleapis.com/projects/PROJECTID/datasets/DATASETID",
- "type": "string"
+ "type": "string",
+ "description": "The resource being accessed, as a REST-style string. For example:\n\n bigquery.googleapis.com/projects/PROJECTID/datasets/DATASETID"
},
"granted": {
- "description": "Whether or not authorization for `resource` and `permission`\nwas granted.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "Whether or not authorization for `resource` and `permission`\nwas granted."
},
"permission": {
"description": "The required IAM permission.",
"type": "string"
}
},
- "id": "AuthorizationInfo"
+ "id": "AuthorizationInfo",
+ "description": "Authorization information for the operation."
},
"ResourceInfo": {
- "type": "object",
"properties": {
"resourceContainer": {
"description": "The identifier of the parent of this resource instance.\nMust be in one of the following formats:\n - “projects/\u003cproject-id or project-number\u003e”\n - “folders/\u003cfolder-id\u003e”\n - “organizations/\u003corganization-id\u003e”",
@@ -675,9 +327,11 @@
}
},
"id": "ResourceInfo",
- "description": "Describes a resource associated with this operation."
+ "description": "Describes a resource associated with this operation.",
+ "type": "object"
},
"StartReconciliationResponse": {
+ "description": "Response message for QuotaController.StartReconciliation.",
"type": "object",
"properties": {
"reconciliationErrors": {
@@ -692,8 +346,8 @@
"type": "string"
},
"serviceConfigId": {
- "type": "string",
- "description": "ID of the actual config used to process the request."
+ "description": "ID of the actual config used to process the request.",
+ "type": "string"
},
"quotaMetrics": {
"description": "Metric values as tracked by One Platform before the start of\nreconciliation. The following metrics will be included:\n\n1. Per quota metric total usage will be specified using the following gauge\nmetric:\n \"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n2. Value for each quota limit associated with the metrics will be specified\nusing the following gauge metric:\n \"serviceruntime.googleapis.com/quota/limit\"",
@@ -703,10 +357,10 @@
"type": "array"
}
},
- "id": "StartReconciliationResponse",
- "description": "Response message for QuotaController.StartReconciliation."
+ "id": "StartReconciliationResponse"
},
"QuotaProperties": {
+ "description": "Represents the properties needed for quota operations.",
"type": "object",
"properties": {
"quotaMode": {
@@ -726,55 +380,55 @@
"type": "string"
}
},
- "id": "QuotaProperties",
- "description": "Represents the properties needed for quota operations."
+ "id": "QuotaProperties"
},
"LinearBuckets": {
- "id": "LinearBuckets",
"description": "Describing buckets with constant width.",
"type": "object",
"properties": {
+ "offset": {
+ "format": "double",
+ "description": "The i'th linear bucket covers the interval\n [offset + (i-1) * width, offset + i * width)\nwhere i ranges from 1 to num_finite_buckets, inclusive.",
+ "type": "number"
+ },
"numFiniteBuckets": {
"format": "int32",
"description": "The number of finite buckets. With the underflow and overflow buckets,\nthe total number of buckets is `num_finite_buckets` + 2.\nSee comments on `bucket_options` for details.",
"type": "integer"
},
"width": {
+ "type": "number",
"format": "double",
- "description": "The i'th linear bucket covers the interval\n [offset + (i-1) * width, offset + i * width)\nwhere i ranges from 1 to num_finite_buckets, inclusive.\nMust be strictly positive.",
- "type": "number"
- },
- "offset": {
- "format": "double",
- "description": "The i'th linear bucket covers the interval\n [offset + (i-1) * width, offset + i * width)\nwhere i ranges from 1 to num_finite_buckets, inclusive.",
- "type": "number"
+ "description": "The i'th linear bucket covers the interval\n [offset + (i-1) * width, offset + i * width)\nwhere i ranges from 1 to num_finite_buckets, inclusive.\nMust be strictly positive."
}
- }
+ },
+ "id": "LinearBuckets"
},
"AuthenticationInfo": {
+ "type": "object",
"properties": {
- "authoritySelector": {
- "description": "The authority selector specified by the requestor, if any.\nIt is not guaranteed that the principal was allowed to use this authority.",
- "type": "string"
- },
"thirdPartyPrincipal": {
- "description": "The third party identification (if any) of the authenticated user making\nthe request.\nWhen the JSON object represented here has a proto equivalent, the proto\nname will be indicated in the `@type` property.",
- "type": "object",
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
- }
+ },
+ "description": "The third party identification (if any) of the authenticated user making\nthe request.\nWhen the JSON object represented here has a proto equivalent, the proto\nname will be indicated in the `@type` property.",
+ "type": "object"
},
"principalEmail": {
"description": "The email address of the authenticated user (or service account on behalf\nof third party principal) making the request. For privacy reasons, the\nprincipal email address is redacted for all read-only operations that fail\nwith a \"permission denied\" error.",
"type": "string"
+ },
+ "authoritySelector": {
+ "type": "string",
+ "description": "The authority selector specified by the requestor, if any.\nIt is not guaranteed that the principal was allowed to use this authority."
}
},
"id": "AuthenticationInfo",
- "description": "Authentication information for the operation.",
- "type": "object"
+ "description": "Authentication information for the operation."
},
"AllocateQuotaResponse": {
+ "description": "Response message for the AllocateQuota method.",
"type": "object",
"properties": {
"quotaMetrics": {
@@ -785,27 +439,26 @@
"type": "array"
},
"operationId": {
- "description": "The same operation_id value used in the AllocateQuotaRequest. Used for\nlogging and diagnostics purposes.",
- "type": "string"
+ "type": "string",
+ "description": "The same operation_id value used in the AllocateQuotaRequest. Used for\nlogging and diagnostics purposes."
},
"allocateInfo": {
- "$ref": "AllocateInfo",
- "description": "WARNING: DO NOT use this field until this warning message is removed."
+ "description": "WARNING: DO NOT use this field until this warning message is removed.",
+ "$ref": "AllocateInfo"
},
"serviceConfigId": {
- "description": "ID of the actual config used to process the request.",
- "type": "string"
+ "type": "string",
+ "description": "ID of the actual config used to process the request."
},
"allocateErrors": {
- "description": "Indicates the decision of the allocate.",
"items": {
"$ref": "QuotaError"
},
- "type": "array"
+ "type": "array",
+ "description": "Indicates the decision of the allocate."
}
},
- "id": "AllocateQuotaResponse",
- "description": "Response message for the AllocateQuota method."
+ "id": "AllocateQuotaResponse"
},
"ReleaseQuotaRequest": {
"description": "Request message for the ReleaseQuota method.",
@@ -877,10 +530,6 @@
"description": "Metadata about the request.",
"type": "object",
"properties": {
- "callerIp": {
- "description": "The IP address of the caller.\nFor caller from internet, this will be public IPv4 or IPv6 address.\nFor caller from a Compute Engine VM with external IP address, this\nwill be the VM's external IP address. For caller from a Compute\nEngine VM without external IP address, if the VM is in the same\norganization (or project) as the accessed resource, `caller_ip` will\nbe the VM's internal IPv4 address, otherwise the `caller_ip` will be\nredacted to \"gce-internal-ip\".\nSee https://cloud.google.com/compute/docs/vpc/ for more information.",
- "type": "string"
- },
"callerSuppliedUserAgent": {
"description": "The user agent of the caller.\nThis information is not authenticated and should be treated accordingly.\nFor example:\n\n+ `google-api-python-client/1.4.0`:\n The request was made by the Google API client for Python.\n+ `Cloud SDK Command Line Tool apitools-client/1.0 gcloud/0.9.62`:\n The request was made by the Google Cloud SDK CLI (gcloud).\n+ `AppEngine-Google; (+http://code.google.com/appengine; appid: s~my-project`:\n The request was made from the `my-project` App Engine app.\nNOLINT",
"type": "string"
@@ -888,58 +537,34 @@
"callerNetwork": {
"description": "The network of the caller.\nSet only if the network host project is part of the same GCP organization\n(or project) as the accessed resource.\nSee https://cloud.google.com/compute/docs/vpc/ for more information.\nThis is a scheme-less URI full resource name. For example:\n\n \"//compute.googleapis.com/projects/PROJECT_ID/global/networks/NETWORK_ID\"",
"type": "string"
+ },
+ "callerIp": {
+ "description": "The IP address of the caller.\nFor caller from internet, this will be public IPv4 or IPv6 address.\nFor caller from a Compute Engine VM with external IP address, this\nwill be the VM's external IP address. For caller from a Compute\nEngine VM without external IP address, if the VM is in the same\norganization (or project) as the accessed resource, `caller_ip` will\nbe the VM's internal IPv4 address, otherwise the `caller_ip` will be\nredacted to \"gce-internal-ip\".\nSee https://cloud.google.com/compute/docs/vpc/ for more information.",
+ "type": "string"
}
},
"id": "RequestMetadata"
},
"CheckInfo": {
+ "description": "Contains additional information about the check operation.",
+ "type": "object",
"properties": {
"unusedArguments": {
- "description": "A list of fields and label keys that are ignored by the server.\nThe client doesn't need to send them for following requests to improve\nperformance and allow better aggregation.",
"items": {
"type": "string"
},
- "type": "array"
+ "type": "array",
+ "description": "A list of fields and label keys that are ignored by the server.\nThe client doesn't need to send them for following requests to improve\nperformance and allow better aggregation."
},
"consumerInfo": {
"$ref": "ConsumerInfo",
"description": "Consumer info of this check."
}
},
- "id": "CheckInfo",
- "description": "Contains additional information about the check operation.",
- "type": "object"
- },
- "ReleaseQuotaResponse": {
- "description": "Response message for the ReleaseQuota method.",
- "type": "object",
- "properties": {
- "serviceConfigId": {
- "description": "ID of the actual config used to process the request.",
- "type": "string"
- },
- "releaseErrors": {
- "description": "Indicates the decision of the release.",
- "items": {
- "$ref": "QuotaError"
- },
- "type": "array"
- },
- "quotaMetrics": {
- "description": "Quota metrics to indicate the result of release. Depending on the\nrequest, one or more of the following metrics will be included:\n\n1. For rate quota, per quota group or per quota metric released amount\nwill be specified using the following delta metric:\n \"serviceruntime.googleapis.com/api/consumer/quota_refund_count\"\n\n2. For allocation quota, per quota metric total usage will be specified\nusing the following gauge metric:\n \"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n3. For allocation quota, value for each quota limit associated with\nthe metrics will be specified using the following gauge metric:\n \"serviceruntime.googleapis.com/quota/limit\"",
- "items": {
- "$ref": "MetricValueSet"
- },
- "type": "array"
- },
- "operationId": {
- "description": "The same operation_id value used in the ReleaseQuotaRequest. Used for\nlogging and diagnostics purposes.",
- "type": "string"
- }
- },
- "id": "ReleaseQuotaResponse"
+ "id": "CheckInfo"
},
"AllocateQuotaRequest": {
+ "description": "Request message for the AllocateQuota method.",
"type": "object",
"properties": {
"serviceConfigId": {
@@ -947,14 +572,43 @@
"type": "string"
},
"allocateOperation": {
- "description": "Operation that describes the quota allocation.",
- "$ref": "QuotaOperation"
+ "$ref": "QuotaOperation",
+ "description": "Operation that describes the quota allocation."
}
},
- "id": "AllocateQuotaRequest",
- "description": "Request message for the AllocateQuota method."
+ "id": "AllocateQuotaRequest"
+ },
+ "ReleaseQuotaResponse": {
+ "description": "Response message for the ReleaseQuota method.",
+ "type": "object",
+ "properties": {
+ "operationId": {
+ "type": "string",
+ "description": "The same operation_id value used in the ReleaseQuotaRequest. Used for\nlogging and diagnostics purposes."
+ },
+ "serviceConfigId": {
+ "description": "ID of the actual config used to process the request.",
+ "type": "string"
+ },
+ "releaseErrors": {
+ "items": {
+ "$ref": "QuotaError"
+ },
+ "type": "array",
+ "description": "Indicates the decision of the release."
+ },
+ "quotaMetrics": {
+ "description": "Quota metrics to indicate the result of release. Depending on the\nrequest, one or more of the following metrics will be included:\n\n1. For rate quota, per quota group or per quota metric released amount\nwill be specified using the following delta metric:\n \"serviceruntime.googleapis.com/api/consumer/quota_refund_count\"\n\n2. For allocation quota, per quota metric total usage will be specified\nusing the following gauge metric:\n \"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n3. For allocation quota, value for each quota limit associated with\nthe metrics will be specified using the following gauge metric:\n \"serviceruntime.googleapis.com/quota/limit\"",
+ "items": {
+ "$ref": "MetricValueSet"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ReleaseQuotaResponse"
},
"MetricValueSet": {
+ "type": "object",
"properties": {
"metricName": {
"description": "The metric name defined in the service configuration.",
@@ -969,20 +623,19 @@
}
},
"id": "MetricValueSet",
- "description": "Represents a set of metric values in the same metric.\nEach metric value in the set should have a unique combination of start time,\nend time, and label values.",
- "type": "object"
+ "description": "Represents a set of metric values in the same metric.\nEach metric value in the set should have a unique combination of start time,\nend time, and label values."
},
"ReportError": {
"description": "Represents the processing error of one Operation in the request.",
"type": "object",
"properties": {
- "operationId": {
- "description": "The Operation.operation_id value from the request.",
- "type": "string"
- },
"status": {
"$ref": "Status",
"description": "Details of the error when processing the Operation."
+ },
+ "operationId": {
+ "description": "The Operation.operation_id value from the request.",
+ "type": "string"
}
},
"id": "ReportError"
@@ -991,13 +644,13 @@
"description": "Request message for QuotaController.StartReconciliation.",
"type": "object",
"properties": {
- "serviceConfigId": {
- "description": "Specifies which version of service configuration should be used to process\nthe request. If unspecified or no matching version can be found, the latest\none will be used.",
- "type": "string"
- },
"reconciliationOperation": {
"description": "Operation that describes the quota reconciliation.",
"$ref": "QuotaOperation"
+ },
+ "serviceConfigId": {
+ "description": "Specifies which version of service configuration should be used to process\nthe request. If unspecified or no matching version can be found, the latest\none will be used.",
+ "type": "string"
}
},
"id": "StartReconciliationRequest"
@@ -1011,6 +664,40 @@
"type": "string"
},
"code": {
+ "enum": [
+ "ERROR_CODE_UNSPECIFIED",
+ "NOT_FOUND",
+ "PERMISSION_DENIED",
+ "RESOURCE_EXHAUSTED",
+ "BUDGET_EXCEEDED",
+ "DENIAL_OF_SERVICE_DETECTED",
+ "LOAD_SHEDDING",
+ "ABUSER_DETECTED",
+ "SERVICE_NOT_ACTIVATED",
+ "VISIBILITY_DENIED",
+ "BILLING_DISABLED",
+ "PROJECT_DELETED",
+ "PROJECT_INVALID",
+ "IP_ADDRESS_BLOCKED",
+ "REFERER_BLOCKED",
+ "CLIENT_APP_BLOCKED",
+ "API_TARGET_BLOCKED",
+ "API_KEY_INVALID",
+ "API_KEY_EXPIRED",
+ "API_KEY_NOT_FOUND",
+ "SPATULA_HEADER_INVALID",
+ "LOAS_ROLE_INVALID",
+ "NO_LOAS_PROJECT",
+ "LOAS_PROJECT_DISABLED",
+ "SECURITY_POLICY_VIOLATED",
+ "NAMESPACE_LOOKUP_UNAVAILABLE",
+ "SERVICE_STATUS_UNAVAILABLE",
+ "BILLING_STATUS_UNAVAILABLE",
+ "QUOTA_CHECK_UNAVAILABLE",
+ "LOAS_PROJECT_LOOKUP_UNAVAILABLE",
+ "CLOUD_RESOURCE_MANAGER_BACKEND_UNAVAILABLE",
+ "SECURITY_POLICY_BACKEND_UNAVAILABLE"
+ ],
"description": "The error code.",
"type": "string",
"enumDescriptions": [
@@ -1046,50 +733,23 @@
"The Spanner for looking up LOAS project is unavailable.",
"Cloud Resource Manager backend server is unavailable.",
"Backend server for evaluating security policy is unavailable."
- ],
- "enum": [
- "ERROR_CODE_UNSPECIFIED",
- "NOT_FOUND",
- "PERMISSION_DENIED",
- "RESOURCE_EXHAUSTED",
- "BUDGET_EXCEEDED",
- "DENIAL_OF_SERVICE_DETECTED",
- "LOAD_SHEDDING",
- "ABUSER_DETECTED",
- "SERVICE_NOT_ACTIVATED",
- "VISIBILITY_DENIED",
- "BILLING_DISABLED",
- "PROJECT_DELETED",
- "PROJECT_INVALID",
- "IP_ADDRESS_BLOCKED",
- "REFERER_BLOCKED",
- "CLIENT_APP_BLOCKED",
- "API_TARGET_BLOCKED",
- "API_KEY_INVALID",
- "API_KEY_EXPIRED",
- "API_KEY_NOT_FOUND",
- "SPATULA_HEADER_INVALID",
- "LOAS_ROLE_INVALID",
- "NO_LOAS_PROJECT",
- "LOAS_PROJECT_DISABLED",
- "SECURITY_POLICY_VIOLATED",
- "NAMESPACE_LOOKUP_UNAVAILABLE",
- "SERVICE_STATUS_UNAVAILABLE",
- "BILLING_STATUS_UNAVAILABLE",
- "QUOTA_CHECK_UNAVAILABLE",
- "LOAS_PROJECT_LOOKUP_UNAVAILABLE",
- "CLOUD_RESOURCE_MANAGER_BACKEND_UNAVAILABLE",
- "SECURITY_POLICY_BACKEND_UNAVAILABLE"
]
}
},
"id": "CheckError"
},
"QuotaInfo": {
- "id": "QuotaInfo",
"description": "Contains the quota information for a quota check response.",
"type": "object",
"properties": {
+ "quotaConsumed": {
+ "description": "Map of quota group name to the actual number of tokens consumed. If the\nquota check was not successful, then this will not be populated due to no\nquota consumption.\n\nWe are not merging this field with 'quota_metrics' field because of the\ncomplexity of scaling in Chemist client code base. For simplicity, we will\nkeep this field for Castor (that scales quota usage) and 'quota_metrics'\nfor SuperQuota (that doesn't scale quota usage).\n",
+ "type": "object",
+ "additionalProperties": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
"quotaMetrics": {
"description": "Quota metrics to indicate the usage. Depending on the check request, one or\nmore of the following metrics will be included:\n\n1. For rate quota, per quota group or per quota metric incremental usage\nwill be specified using the following delta metric:\n \"serviceruntime.googleapis.com/api/consumer/quota_used_count\"\n\n2. For allocation quota, per quota metric total usage will be specified\nusing the following gauge metric:\n \"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n3. For both rate quota and allocation quota, the quota limit reached\ncondition will be specified using the following boolean metric:\n \"serviceruntime.googleapis.com/quota/exceeded\"",
"items": {
@@ -1103,18 +763,12 @@
"type": "string"
},
"type": "array"
- },
- "quotaConsumed": {
- "additionalProperties": {
- "format": "int32",
- "type": "integer"
- },
- "description": "Map of quota group name to the actual number of tokens consumed. If the\nquota check was not successful, then this will not be populated due to no\nquota consumption.\n\nWe are not merging this field with 'quota_metrics' field because of the\ncomplexity of scaling in Chemist client code base. For simplicity, we will\nkeep this field for Castor (that scales quota usage) and 'quota_metrics'\nfor SuperQuota (that doesn't scale quota usage).\n",
- "type": "object"
}
- }
+ },
+ "id": "QuotaInfo"
},
"ConsumerInfo": {
+ "description": "`ConsumerInfo` provides information about the consumer project.",
"type": "object",
"properties": {
"projectNumber": {
@@ -1123,24 +777,639 @@
"type": "string"
}
},
- "id": "ConsumerInfo",
- "description": "`ConsumerInfo` provides information about the consumer project."
+ "id": "ConsumerInfo"
+ },
+ "CheckRequest": {
+ "id": "CheckRequest",
+ "description": "Request message for the Check method.",
+ "type": "object",
+ "properties": {
+ "skipActivationCheck": {
+ "description": "Indicates if service activation check should be skipped for this request.\nDefault behavior is to perform the check and apply relevant quota.",
+ "type": "boolean"
+ },
+ "requestProjectSettings": {
+ "description": "Requests the project settings to be returned as part of the check response.",
+ "type": "boolean"
+ },
+ "operation": {
+ "description": "The operation to be checked.",
+ "$ref": "Operation"
+ },
+ "serviceConfigId": {
+ "description": "Specifies which version of service configuration should be used to process\nthe request.\n\nIf unspecified or no matching version can be found, the\nlatest one will be used.",
+ "type": "string"
+ }
+ }
+ },
+ "QuotaOperation": {
+ "description": "Represents information regarding a quota operation.",
+ "type": "object",
+ "properties": {
+ "quotaMetrics": {
+ "description": "Represents information about this operation. Each MetricValueSet\ncorresponds to a metric defined in the service configuration.\nThe data type used in the MetricValueSet must agree with\nthe data type specified in the metric definition.\n\nWithin a single operation, it is not allowed to have more than one\nMetricValue instances that have the same metric names and identical\nlabel value combinations. If a request has such duplicated MetricValue\ninstances, the entire request is rejected with\nan invalid argument error.",
+ "items": {
+ "$ref": "MetricValueSet"
+ },
+ "type": "array"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Labels describing the operation.",
+ "type": "object"
+ },
+ "consumerId": {
+ "description": "Identity of the consumer for whom this quota operation is being performed.\n\nThis can be in one of the following formats:\n project:\u003cproject_id\u003e,\n project_number:\u003cproject_number\u003e,\n api_key:\u003capi_key\u003e.",
+ "type": "string"
+ },
+ "operationId": {
+ "description": "Identity of the operation. This is expected to be unique within the scope\nof the service that generated the operation, and guarantees idempotency in\ncase of retries.\n\nUUID version 4 is recommended, though not required. In scenarios where an\noperation is computed from existing information and an idempotent id is\ndesirable for deduplication purpose, UUID version 5 is recommended. See\nRFC 4122 for details.",
+ "type": "string"
+ },
+ "quotaMode": {
+ "enum": [
+ "UNSPECIFIED",
+ "NORMAL",
+ "BEST_EFFORT",
+ "CHECK_ONLY"
+ ],
+ "description": "Quota mode for this operation.",
+ "type": "string",
+ "enumDescriptions": [
+ "Guard against implicit default. Must not be used.",
+ "For AllocateQuota request, allocates quota for the amount specified in\nthe service configuration or specified using the quota metrics. If the\namount is higher than the available quota, allocation error will be\nreturned and no quota will be allocated.",
+ "The operation allocates quota for the amount specified in the service\nconfiguration or specified using the quota metrics. If the amount is\nhigher than the available quota, request does not fail but all available\nquota will be allocated.",
+ "For AllocateQuota request, only checks if there is enough quota\navailable and does not change the available quota. No lock is placed on\nthe available quota either."
+ ]
+ },
+ "methodName": {
+ "description": "Fully qualified name of the API method for which this quota operation is\nrequested. This name is used for matching quota rules or metric rules and\nbilling status rules defined in service configuration. This field is not\nrequired if the quota operation is performed on non-API resources.\n\nExample of an RPC method name:\n google.example.library.v1.LibraryService.CreateShelf",
+ "type": "string"
+ }
+ },
+ "id": "QuotaOperation"
+ },
+ "EndReconciliationRequest": {
+ "type": "object",
+ "properties": {
+ "serviceConfigId": {
+ "description": "Specifies which version of service configuration should be used to process\nthe request. If unspecified or no matching version can be found, the latest\none will be used.",
+ "type": "string"
+ },
+ "reconciliationOperation": {
+ "$ref": "QuotaOperation",
+ "description": "Operation that describes the quota reconciliation."
+ }
+ },
+ "id": "EndReconciliationRequest",
+ "description": "Request message for QuotaController.EndReconciliation."
+ },
+ "ReportInfo": {
+ "description": "Contains additional info about the report operation.",
+ "type": "object",
+ "properties": {
+ "operationId": {
+ "description": "The Operation.operation_id value from the request.",
+ "type": "string"
+ },
+ "quotaInfo": {
+ "$ref": "QuotaInfo",
+ "description": "Quota usage info when processing the `Operation`."
+ }
+ },
+ "id": "ReportInfo"
+ },
+ "Operation": {
+ "description": "Represents information regarding an operation.",
+ "type": "object",
+ "properties": {
+ "quotaProperties": {
+ "$ref": "QuotaProperties",
+ "description": "Represents the properties needed for quota check. Applicable only if this\noperation is for a quota check request. If this is not specified, no quota\ncheck will be performed."
+ },
+ "consumerId": {
+ "description": "Identity of the consumer who is using the service.\nThis field should be filled in for the operations initiated by a\nconsumer, but not for service-initiated operations that are\nnot related to a specific consumer.\n\nThis can be in one of the following formats:\n project:\u003cproject_id\u003e,\n project_number:\u003cproject_number\u003e,\n api_key:\u003capi_key\u003e.",
+ "type": "string"
+ },
+ "operationId": {
+ "description": "Identity of the operation. This must be unique within the scope of the\nservice that generated the operation. If the service calls\nCheck() and Report() on the same operation, the two calls should carry\nthe same id.\n\nUUID version 4 is recommended, though not required.\nIn scenarios where an operation is computed from existing information\nand an idempotent id is desirable for deduplication purpose, UUID version 5\nis recommended. See RFC 4122 for details.",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "End time of the operation.\nRequired when the operation is used in ServiceController.Report,\nbut optional when the operation is used in ServiceController.Check.",
+ "type": "string"
+ },
+ "operationName": {
+ "description": "Fully qualified name of the operation. Reserved for future use.",
+ "type": "string"
+ },
+ "startTime": {
+ "format": "google-datetime",
+ "description": "Required. Start time of the operation.",
+ "type": "string"
+ },
+ "importance": {
+ "description": "DO NOT USE. This is an experimental field.",
+ "type": "string",
+ "enumDescriptions": [
+ "The API implementation may cache and aggregate the data.\nThe data may be lost when rare and unexpected system failures occur.",
+ "The API implementation doesn't cache and aggregate the data.\nIf the method returns successfully, it's guaranteed that the data has\nbeen persisted in durable storage.",
+ "In addition to the behavior described in HIGH, DEBUG enables\nadditional validation logic that is only useful during the onboarding\nprocess. This is only available to Google internal services and\nthe service must be whitelisted by chemist-dev@google.com in order\nto use this level."
+ ],
+ "enum": [
+ "LOW",
+ "HIGH",
+ "DEBUG"
+ ]
+ },
+ "resourceContainer": {
+ "description": "DO NOT USE. This field is deprecated, use \"resources\" field instead.\nThe resource name of the parent of a resource in the resource hierarchy.\n\nThis can be in one of the following formats:\n - “projects/\u003cproject-id or project-number\u003e”\n - “folders/\u003cfolder-id\u003e”\n - “organizations/\u003corganization-id\u003e”",
+ "type": "string"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Labels describing the operation. Only the following labels are allowed:\n\n- Labels describing monitored resources as defined in\n the service configuration.\n- Default labels of metric values. When specified, labels defined in the\n metric value override these default.\n- The following labels defined by Google Cloud Platform:\n - `cloud.googleapis.com/location` describing the location where the\n operation happened,\n - `servicecontrol.googleapis.com/user_agent` describing the user agent\n of the API request,\n - `servicecontrol.googleapis.com/service_agent` describing the service\n used to handle the API request (e.g. ESP),\n - `servicecontrol.googleapis.com/platform` describing the platform\n where the API is served (e.g. GAE, GCE, GKE).",
+ "type": "object"
+ },
+ "resources": {
+ "description": "The resources that are involved in the operation.",
+ "items": {
+ "$ref": "ResourceInfo"
+ },
+ "type": "array"
+ },
+ "logEntries": {
+ "description": "Represents information to be logged.",
+ "items": {
+ "$ref": "LogEntry"
+ },
+ "type": "array"
+ },
+ "userLabels": {
+ "description": "User defined labels for the resource that this operation is associated\nwith. Only a combination of 1000 user labels per consumer project are\nallowed.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "metricValueSets": {
+ "items": {
+ "$ref": "MetricValueSet"
+ },
+ "type": "array",
+ "description": "Represents information about this operation. Each MetricValueSet\ncorresponds to a metric defined in the service configuration.\nThe data type used in the MetricValueSet must agree with\nthe data type specified in the metric definition.\n\nWithin a single operation, it is not allowed to have more than one\nMetricValue instances that have the same metric names and identical\nlabel value combinations. If a request has such duplicated MetricValue\ninstances, the entire request is rejected with\nan invalid argument error."
+ }
+ },
+ "id": "Operation"
+ },
+ "ReportResponse": {
+ "description": "Response message for the Report method.",
+ "type": "object",
+ "properties": {
+ "reportErrors": {
+ "items": {
+ "$ref": "ReportError"
+ },
+ "type": "array",
+ "description": "Partial failures, one for each `Operation` in the request that failed\nprocessing. There are three possible combinations of the RPC status:\n\n1. The combination of a successful RPC status and an empty `report_errors`\n list indicates a complete success where all `Operations` in the\n request are processed successfully.\n2. The combination of a successful RPC status and a non-empty\n `report_errors` list indicates a partial success where some\n `Operations` in the request succeeded. Each\n `Operation` that failed processing has a corresponding item\n in this list.\n3. A failed RPC status indicates a general non-deterministic failure.\n When this happens, it's impossible to know which of the\n 'Operations' in the request succeeded or failed."
+ },
+ "reportInfos": {
+ "description": "Quota usage for each quota release `Operation` request.\n\nFully or partially failed quota release request may or may not be present\nin `report_quota_info`. For example, a failed quota release request will\nhave the current quota usage info when precise quota library returns the\ninfo. A deadline exceeded quota request will not have quota usage info.\n\nIf there is no quota release request, report_quota_info will be empty.\n",
+ "items": {
+ "$ref": "ReportInfo"
+ },
+ "type": "array"
+ },
+ "serviceConfigId": {
+ "description": "The actual config id used to process the request.",
+ "type": "string"
+ }
+ },
+ "id": "ReportResponse"
+ },
+ "CheckResponse": {
+ "description": "Response message for the Check method.",
+ "type": "object",
+ "properties": {
+ "checkInfo": {
+ "description": "Feedback data returned from the server during processing a Check request.",
+ "$ref": "CheckInfo"
+ },
+ "checkErrors": {
+ "description": "Indicate the decision of the check.\n\nIf no check errors are present, the service should process the operation.\nOtherwise the service should use the list of errors to determine the\nappropriate action.",
+ "items": {
+ "$ref": "CheckError"
+ },
+ "type": "array"
+ },
+ "operationId": {
+ "description": "The same operation_id value used in the CheckRequest.\nUsed for logging and diagnostics purposes.",
+ "type": "string"
+ },
+ "serviceConfigId": {
+ "description": "The actual config id used to process the request.",
+ "type": "string"
+ },
+ "quotaInfo": {
+ "description": "Quota information for the check request associated with this response.\n",
+ "$ref": "QuotaInfo"
+ }
+ },
+ "id": "CheckResponse"
+ },
+ "Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
+ "properties": {
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "code": {
+ "format": "int32",
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "type": "integer"
+ }
+ },
+ "id": "Status"
+ },
+ "ReportRequest": {
+ "description": "Request message for the Report method.",
+ "type": "object",
+ "properties": {
+ "serviceConfigId": {
+ "description": "Specifies which version of service config should be used to process the\nrequest.\n\nIf unspecified or no matching version can be found, the\nlatest one will be used.",
+ "type": "string"
+ },
+ "operations": {
+ "description": "Operations to be reported.\n\nTypically the service should report one operation per request.\nPutting multiple operations into a single request is allowed, but should\nbe used only when multiple operations are natually available at the time\nof the report.\n\nIf multiple operations are in a single request, the total request size\nshould be no larger than 1MB. See ReportResponse.report_errors for\npartial failure behavior.",
+ "items": {
+ "$ref": "Operation"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ReportRequest"
+ },
+ "AllocateInfo": {
+ "type": "object",
+ "properties": {
+ "unusedArguments": {
+ "description": "A list of label keys that were unused by the server in processing the\nrequest. Thus, for similar requests repeated in a certain future time\nwindow, the caller can choose to ignore these labels in the requests\nto achieve better client-side cache hits and quota aggregation.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "AllocateInfo"
+ },
+ "LogEntry": {
+ "properties": {
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "A set of user-defined (key, value) data that provides additional\ninformation about the log entry.",
+ "type": "object"
+ },
+ "severity": {
+ "description": "The severity of the log entry. The default value is\n`LogSeverity.DEFAULT`.",
+ "type": "string",
+ "enumDescriptions": [
+ "(0) The log entry has no assigned severity level.",
+ "(100) Debug or trace information.",
+ "(200) Routine information, such as ongoing status or performance.",
+ "(300) Normal but significant events, such as start up, shut down, or\na configuration change.",
+ "(400) Warning events might cause problems.",
+ "(500) Error events are likely to cause problems.",
+ "(600) Critical events cause more severe problems or outages.",
+ "(700) A person must take an action immediately.",
+ "(800) One or more systems are unusable."
+ ],
+ "enum": [
+ "DEFAULT",
+ "DEBUG",
+ "INFO",
+ "NOTICE",
+ "WARNING",
+ "ERROR",
+ "CRITICAL",
+ "ALERT",
+ "EMERGENCY"
+ ]
+ },
+ "insertId": {
+ "description": "A unique ID for the log entry used for deduplication. If omitted,\nthe implementation will generate one based on operation_id.",
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "description": "Required. The log to which this log entry belongs. Examples: `\"syslog\"`,\n`\"book_log\"`."
+ },
+ "structPayload": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "The log entry payload, represented as a structure that\nis expressed as a JSON object.",
+ "type": "object"
+ },
+ "textPayload": {
+ "description": "The log entry payload, represented as a Unicode string (UTF-8).",
+ "type": "string"
+ },
+ "protoPayload": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The log entry payload, represented as a protocol buffer that is\nexpressed as a JSON object. The only accepted type currently is\nAuditLog.",
+ "type": "object"
+ },
+ "timestamp": {
+ "type": "string",
+ "format": "google-datetime",
+ "description": "The time the event described by the log entry occurred. If\nomitted, defaults to operation start time."
+ }
+ },
+ "id": "LogEntry",
+ "description": "An individual log entry.",
+ "type": "object"
+ },
+ "AuditLog": {
+ "id": "AuditLog",
+ "description": "Common audit log format for Google Cloud Platform API operations.\n\n",
+ "type": "object",
+ "properties": {
+ "authorizationInfo": {
+ "description": "Authorization information. If there are multiple\nresources or permissions involved, then there is\none AuthorizationInfo element for each {resource, permission} tuple.",
+ "items": {
+ "$ref": "AuthorizationInfo"
+ },
+ "type": "array"
+ },
+ "request": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "The operation request. This may not include all request parameters,\nsuch as those that are too large, privacy-sensitive, or duplicated\nelsewhere in the log record.\nIt should never include user-generated data, such as file contents.\nWhen the JSON object represented here has a proto equivalent, the proto\nname will be indicated in the `@type` property.",
+ "type": "object"
+ },
+ "requestMetadata": {
+ "description": "Metadata about the operation.",
+ "$ref": "RequestMetadata"
+ },
+ "authenticationInfo": {
+ "description": "Authentication information.",
+ "$ref": "AuthenticationInfo"
+ },
+ "status": {
+ "$ref": "Status",
+ "description": "The status of the overall operation."
+ },
+ "serviceName": {
+ "type": "string",
+ "description": "The name of the API service performing the operation. For example,\n`\"datastore.googleapis.com\"`."
+ },
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "The operation response. This may not include all response elements,\nsuch as those that are too large, privacy-sensitive, or duplicated\nelsewhere in the log record.\nIt should never include user-generated data, such as file contents.\nWhen the JSON object represented here has a proto equivalent, the proto\nname will be indicated in the `@type` property.",
+ "type": "object"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object."
+ },
+ "description": "Other service-specific data about the request, response, and other\ninformation associated with the current audited event.",
+ "type": "object"
+ },
+ "methodName": {
+ "description": "The name of the service method or operation.\nFor API calls, this should be the name of the API method.\nFor example,\n\n \"google.datastore.v1.Datastore.RunQuery\"\n \"google.logging.v1.LoggingService.DeleteLog\"",
+ "type": "string"
+ },
+ "resourceName": {
+ "type": "string",
+ "description": "The resource or collection that is the target of the operation.\nThe name is a scheme-less URI, not including the API service name.\nFor example:\n\n \"shelves/SHELF_ID/books\"\n \"shelves/SHELF_ID/books/BOOK_ID\""
+ },
+ "serviceData": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Deprecated, use `metadata` field instead.\nOther service-specific data about the request, response, and other\nactivities.",
+ "type": "object"
+ },
+ "numResponseItems": {
+ "format": "int64",
+ "description": "The number of items returned from a List or Query API method,\nif applicable.",
+ "type": "string"
+ }
+ }
+ },
+ "MetricValue": {
+ "type": "object",
+ "properties": {
+ "moneyValue": {
+ "$ref": "Money",
+ "description": "A money value."
+ },
+ "stringValue": {
+ "description": "A text string value.",
+ "type": "string"
+ },
+ "labels": {
+ "description": "The labels describing the metric value.\nSee comments on google.api.servicecontrol.v1.Operation.labels for\nthe overriding relationship.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "doubleValue": {
+ "format": "double",
+ "description": "A double precision floating point value.",
+ "type": "number"
+ },
+ "int64Value": {
+ "format": "int64",
+ "description": "A signed 64-bit integer value.",
+ "type": "string"
+ },
+ "distributionValue": {
+ "$ref": "Distribution",
+ "description": "A distribution value."
+ },
+ "boolValue": {
+ "description": "A boolean value.",
+ "type": "boolean"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "The end of the time period over which this metric value's measurement\napplies.",
+ "type": "string"
+ },
+ "startTime": {
+ "format": "google-datetime",
+ "description": "The start of the time period over which this metric value's measurement\napplies. The time period has different semantics for different metric\ntypes (cumulative, delta, and gauge). See the metric definition\ndocumentation in the service configuration for details.",
+ "type": "string"
+ }
+ },
+ "id": "MetricValue",
+ "description": "Represents a single metric value."
+ },
+ "EndReconciliationResponse": {
+ "id": "EndReconciliationResponse",
+ "description": "Response message for QuotaController.EndReconciliation.",
+ "type": "object",
+ "properties": {
+ "quotaMetrics": {
+ "description": "Metric values as tracked by One Platform before the adjustment was made.\nThe following metrics will be included:\n\n1. Per quota metric total usage will be specified using the following gauge\nmetric:\n \"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n2. Value for each quota limit associated with the metrics will be specified\nusing the following gauge metric:\n \"serviceruntime.googleapis.com/quota/limit\"\n\n3. Delta value of the usage after the reconciliation for limits associated\nwith the metrics will be specified using the following metric:\n \"serviceruntime.googleapis.com/allocation/reconciliation_delta\"\nThe delta value is defined as:\n new_usage_from_client - existing_value_in_spanner.\nThis metric is not defined in serviceruntime.yaml or in Cloud Monarch.\nThis metric is meant for callers' use only. Since this metric is not\ndefined in the monitoring backend, reporting on this metric will result in\nan error.",
+ "items": {
+ "$ref": "MetricValueSet"
+ },
+ "type": "array"
+ },
+ "reconciliationErrors": {
+ "description": "Indicates the decision of the reconciliation end.",
+ "items": {
+ "$ref": "QuotaError"
+ },
+ "type": "array"
+ },
+ "operationId": {
+ "type": "string",
+ "description": "The same operation_id value used in the EndReconciliationRequest. Used for\nlogging and diagnostics purposes."
+ },
+ "serviceConfigId": {
+ "description": "ID of the actual config used to process the request.",
+ "type": "string"
+ }
+ }
+ },
+ "Money": {
+ "description": "Represents an amount of money with its currency type.",
+ "type": "object",
+ "properties": {
+ "nanos": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000."
+ },
+ "units": {
+ "format": "int64",
+ "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
+ "type": "string"
+ },
+ "currencyCode": {
+ "description": "The 3-letter currency code defined in ISO 4217.",
+ "type": "string"
+ }
+ },
+ "id": "Money"
+ },
+ "Distribution": {
+ "type": "object",
+ "properties": {
+ "linearBuckets": {
+ "$ref": "LinearBuckets",
+ "description": "Buckets with constant width."
+ },
+ "minimum": {
+ "format": "double",
+ "description": "The minimum of the population of values. Ignored if `count` is zero.",
+ "type": "number"
+ },
+ "count": {
+ "format": "int64",
+ "description": "The total number of samples in the distribution. Must be \u003e= 0.",
+ "type": "string"
+ },
+ "mean": {
+ "format": "double",
+ "description": "The arithmetic mean of the samples in the distribution. If `count` is\nzero then this field must be zero.",
+ "type": "number"
+ },
+ "bucketCounts": {
+ "description": "The number of samples in each histogram bucket. `bucket_counts` are\noptional. If present, they must sum to the `count` value.\n\nThe buckets are defined below in `bucket_option`. There are N buckets.\n`bucket_counts[0]` is the number of samples in the underflow bucket.\n`bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples\nin each of the finite buckets. And `bucket_counts[N] is the number\nof samples in the overflow bucket. See the comments of `bucket_option`\nbelow for more details.\n\nAny suffix of trailing zeros may be omitted.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "explicitBuckets": {
+ "$ref": "ExplicitBuckets",
+ "description": "Buckets with arbitrary user-provided width."
+ },
+ "maximum": {
+ "format": "double",
+ "description": "The maximum of the population of values. Ignored if `count` is zero.",
+ "type": "number"
+ },
+ "sumOfSquaredDeviation": {
+ "format": "double",
+ "description": "The sum of squared deviations from the mean:\n Sum[i=1..count]((x_i - mean)^2)\nwhere each x_i is a sample values. If `count` is zero then this field\nmust be zero, otherwise validation of the request fails.",
+ "type": "number"
+ },
+ "exponentialBuckets": {
+ "description": "Buckets with exponentially growing width.",
+ "$ref": "ExponentialBuckets"
+ }
+ },
+ "id": "Distribution",
+ "description": "Distribution represents a frequency distribution of double-valued sample\npoints. It contains the size of the population of sample points plus\nadditional optional information:\n\n - the arithmetic mean of the samples\n - the minimum and maximum of the samples\n - the sum-squared-deviation of the samples, used to compute variance\n - a histogram of the values of the sample points"
+ },
+ "ExplicitBuckets": {
+ "properties": {
+ "bounds": {
+ "items": {
+ "format": "double",
+ "type": "number"
+ },
+ "type": "array",
+ "description": "'bound' is a list of strictly increasing boundaries between\nbuckets. Note that a list of length N-1 defines N buckets because\nof fenceposting. See comments on `bucket_options` for details.\n\nThe i'th finite bucket covers the interval\n [bound[i-1], bound[i])\nwhere i ranges from 1 to bound_size() - 1. Note that there are no\nfinite buckets at all if 'bound' only contains a single element; in\nthat special case the single bound defines the boundary between the\nunderflow and overflow buckets.\n\nbucket number lower bound upper bound\n i == 0 (underflow) -inf bound[i]\n 0 \u003c i \u003c bound_size() bound[i-1] bound[i]\n i == bound_size() (overflow) bound[i-1] +inf"
+ }
+ },
+ "id": "ExplicitBuckets",
+ "description": "Describing buckets with arbitrary user-provided width.",
+ "type": "object"
}
},
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"protocol": "rest",
"canonicalName": "Service Control",
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
"https://www.googleapis.com/auth/servicecontrol": {
"description": "Manage your Google Service Control data"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
}
}
}
@@ -1150,274 +1419,5 @@
"name": "servicecontrol",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
- "title": "Google Service Control API",
- "ownerName": "Google",
- "resources": {
- "services": {
- "methods": {
- "endReconciliation": {
- "httpMethod": "POST",
- "parameterOrder": [
- "serviceName"
- ],
- "response": {
- "$ref": "EndReconciliationResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/servicecontrol"
- ],
- "parameters": {
- "serviceName": {
- "description": "Name of the service as specified in the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/services/{serviceName}:endReconciliation",
- "path": "v1/services/{serviceName}:endReconciliation",
- "id": "servicecontrol.services.endReconciliation",
- "request": {
- "$ref": "EndReconciliationRequest"
- },
- "description": "Signals the quota controller that service ends the ongoing usage\nreconciliation.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam)."
- },
- "report": {
- "httpMethod": "POST",
- "parameterOrder": [
- "serviceName"
- ],
- "response": {
- "$ref": "ReportResponse"
- },
- "parameters": {
- "serviceName": {
- "location": "path",
- "description": "The service name as specified in its service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee\n[google.api.Service](https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service)\nfor the definition of a service name.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/servicecontrol"
- ],
- "flatPath": "v1/services/{serviceName}:report",
- "path": "v1/services/{serviceName}:report",
- "id": "servicecontrol.services.report",
- "description": "Reports operation results to Google Service Control, such as logs and\nmetrics. It should be called after an operation is completed.\n\nIf feasible, the client should aggregate reporting data for up to 5\nseconds to reduce API traffic. Limiting aggregation to 5 seconds is to\nreduce data loss during client crashes. Clients should carefully choose\nthe aggregation time window to avoid data loss risk more than 0.01%\nfor business and compliance reasons.\n\nNOTE: the ReportRequest has the size limit of 1MB.\n\nThis method requires the `servicemanagement.services.report` permission\non the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).",
- "request": {
- "$ref": "ReportRequest"
- }
- },
- "allocateQuota": {
- "parameters": {
- "serviceName": {
- "description": "Name of the service as specified in the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/servicecontrol"
- ],
- "flatPath": "v1/services/{serviceName}:allocateQuota",
- "id": "servicecontrol.services.allocateQuota",
- "path": "v1/services/{serviceName}:allocateQuota",
- "description": "Attempts to allocate quota for the specified consumer. It should be called\nbefore the operation is executed.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Cloud IAM](https://cloud.google.com/iam).\n\n**NOTE:** The client **must** fail-open on server errors `INTERNAL`,\n`UNKNOWN`, `DEADLINE_EXCEEDED`, and `UNAVAILABLE`. To ensure system\nreliability, the server may inject these errors to prohibit any hard\ndependency on the quota functionality.",
- "request": {
- "$ref": "AllocateQuotaRequest"
- },
- "response": {
- "$ref": "AllocateQuotaResponse"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "POST"
- },
- "startReconciliation": {
- "flatPath": "v1/services/{serviceName}:startReconciliation",
- "id": "servicecontrol.services.startReconciliation",
- "path": "v1/services/{serviceName}:startReconciliation",
- "request": {
- "$ref": "StartReconciliationRequest"
- },
- "description": "Unlike rate quota, allocation quota does not get refilled periodically.\nSo, it is possible that the quota usage as seen by the service differs from\nwhat the One Platform considers the usage is. This is expected to happen\nonly rarely, but over time this can accumulate. Services can invoke\nStartReconciliation and EndReconciliation to correct this usage drift, as\ndescribed below:\n1. Service sends StartReconciliation with a timestamp in future for each\n metric that needs to be reconciled. The timestamp being in future allows\n to account for in-flight AllocateQuota and ReleaseQuota requests for the\n same metric.\n2. One Platform records this timestamp and starts tracking subsequent\n AllocateQuota and ReleaseQuota requests until EndReconciliation is\n called.\n3. At or after the time specified in the StartReconciliation, service\n sends EndReconciliation with the usage that needs to be reconciled to.\n4. One Platform adjusts its own record of usage for that metric to the\n value specified in EndReconciliation by taking in to account any\n allocation or release between StartReconciliation and EndReconciliation.\n\nSignals the quota controller that the service wants to perform a usage\nreconciliation as specified in the request.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).",
- "response": {
- "$ref": "StartReconciliationResponse"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/servicecontrol"
- ],
- "parameters": {
- "serviceName": {
- "location": "path",
- "description": "Name of the service as specified in the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.",
- "type": "string",
- "required": true
- }
- }
- },
- "check": {
- "response": {
- "$ref": "CheckResponse"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/servicecontrol"
- ],
- "parameters": {
- "serviceName": {
- "description": "The service name as specified in its service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee\n[google.api.Service](https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service)\nfor the definition of a service name.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/services/{serviceName}:check",
- "id": "servicecontrol.services.check",
- "path": "v1/services/{serviceName}:check",
- "request": {
- "$ref": "CheckRequest"
- },
- "description": "Checks an operation with Google Service Control to decide whether\nthe given operation should proceed. It should be called before the\noperation is executed.\n\nIf feasible, the client should cache the check results and reuse them for\n60 seconds. In case of server errors, the client can rely on the cached\nresults for longer time.\n\nNOTE: the CheckRequest has the size limit of 64KB.\n\nThis method requires the `servicemanagement.services.check` permission\non the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam)."
- },
- "releaseQuota": {
- "request": {
- "$ref": "ReleaseQuotaRequest"
- },
- "description": "Releases previously allocated quota done through AllocateQuota method.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Cloud IAM](https://cloud.google.com/iam).\n\n\n**NOTE:** The client **must** fail-open on server errors `INTERNAL`,\n`UNKNOWN`, `DEADLINE_EXCEEDED`, and `UNAVAILABLE`. To ensure system\nreliability, the server may inject these errors to prohibit any hard\ndependency on the quota functionality.",
- "response": {
- "$ref": "ReleaseQuotaResponse"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/servicecontrol"
- ],
- "parameters": {
- "serviceName": {
- "location": "path",
- "description": "Name of the service as specified in the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/services/{serviceName}:releaseQuota",
- "id": "servicecontrol.services.releaseQuota",
- "path": "v1/services/{serviceName}:releaseQuota"
- }
- }
- }
- },
- "parameters": {
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "type": "string",
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "fields": {
- "type": "string",
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response."
- },
- "$.xgafv": {
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ]
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- }
- },
- "version": "v1",
- "baseUrl": "https://servicecontrol.googleapis.com/",
- "servicePath": "",
- "description": "Google Service Control provides control plane functionality to managed services, such as logging, monitoring, and status checks.",
- "kind": "discovery#restDescription",
- "basePath": ""
+ "title": "Google Service Control API"
}
diff --git a/servicecontrol/v1/servicecontrol-gen.go b/servicecontrol/v1/servicecontrol-gen.go
index 235f7ab..1e1b2e3 100644
--- a/servicecontrol/v1/servicecontrol-gen.go
+++ b/servicecontrol/v1/servicecontrol-gen.go
@@ -1614,10 +1614,12 @@
// quota operation is
// requested. This name is used for matching quota rules or metric rules
// and
- // billing status rules defined in service configuration. This field is
- // not
- // required if the quota operation is performed on non-API
- // resources.
+ // billing status rules defined in service configuration.
+ //
+ // This field should not be set if any of the following is true:
+ // (1) the quota operation is performed on non-API resources.
+ // (2) quota_metrics is set because the caller is doing quota
+ // override.
//
// Example of an RPC method name:
// google.example.library.v1.LibraryService.CreateShelf
@@ -1652,6 +1654,8 @@
// MetricValue
// instances, the entire request is rejected with
// an invalid argument error.
+ //
+ // This field is mutually exclusive with method_name.
QuotaMetrics []*MetricValueSet `json:"quotaMetrics,omitempty"`
// QuotaMode: Quota mode for this operation.
diff --git a/servicemanagement/v1/servicemanagement-api.json b/servicemanagement/v1/servicemanagement-api.json
index 5257a96..0f683fc 100644
--- a/servicemanagement/v1/servicemanagement-api.json
+++ b/servicemanagement/v1/servicemanagement-api.json
@@ -1,323 +1,905 @@
{
+ "canonicalName": "Service Management",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/service.management": {
+ "description": "Manage your Google API service configuration"
+ },
+ "https://www.googleapis.com/auth/service.management.readonly": {
+ "description": "View your Google API service configuration"
+ },
+ "https://www.googleapis.com/auth/cloud-platform.read-only": {
+ "description": "View your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://servicemanagement.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "servicemanagement",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Google Service Management API",
+ "ownerName": "Google",
+ "resources": {
+ "operations": {
+ "methods": {
+ "get": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource.",
+ "type": "string",
+ "required": true,
+ "pattern": "^operations/.+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "flatPath": "v1/operations/{operationsId}",
+ "id": "servicemanagement.operations.get",
+ "path": "v1/{+name}",
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
+ },
+ "list": {
+ "description": "Lists service operations that match the specified filter in the request.",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "filter": {
+ "location": "query",
+ "description": "A string for filtering Operations.\n The following filter fields are supported:\n\n * serviceName: Required. Only `=` operator is allowed.\n * startTime: The time this job was started, in ISO 8601 format.\n Allowed operators are `\u003e=`, `\u003e`, `\u003c=`, and `\u003c`.\n * status: Can be `done`, `in_progress`, or `failed`. Allowed\n operators are `=`, and `!=`.\n\n Filter expression supports conjunction (AND) and disjunction (OR)\n logical operators. However, the serviceName restriction must be at the\n top-level and can only be combined with other restrictions via the AND\n logical operator.\n\n Examples:\n\n * `serviceName={some-service}.googleapis.com`\n * `serviceName={some-service}.googleapis.com AND startTime\u003e=\"2017-02-01\"`\n * `serviceName={some-service}.googleapis.com AND status=done`\n * `serviceName={some-service}.googleapis.com AND (status=done OR startTime\u003e=\"2017-02-01\")`",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Not used.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The maximum number of operations to return. If unspecified, defaults to\n50. The maximum value is 100.",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "flatPath": "v1/operations",
+ "id": "servicemanagement.operations.list",
+ "path": "v1/operations"
+ }
+ }
+ },
+ "services": {
+ "methods": {
+ "generateConfigReport": {
+ "request": {
+ "$ref": "GenerateConfigReportRequest"
+ },
+ "description": "Generates and returns a report (errors, warnings and changes from\nexisting configurations) associated with\nGenerateConfigReportRequest.new_value\n\nIf GenerateConfigReportRequest.old_value is specified,\nGenerateConfigReportRequest will contain a single ChangeReport based on the\ncomparison between GenerateConfigReportRequest.new_value and\nGenerateConfigReportRequest.old_value.\nIf GenerateConfigReportRequest.old_value is not specified, this method\nwill compare GenerateConfigReportRequest.new_value with the last pushed\nservice configuration.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "GenerateConfigReportResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "parameters": {},
+ "flatPath": "v1/services:generateConfigReport",
+ "path": "v1/services:generateConfigReport",
+ "id": "servicemanagement.services.generateConfigReport"
+ },
+ "get": {
+ "description": "Gets a managed service. Authentication is required unless the service is\npublic.",
+ "response": {
+ "$ref": "ManagedService"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "serviceName": {
+ "location": "path",
+ "description": "The name of the service. See the `ServiceManager` overview for naming\nrequirements. For example: `example.googleapis.com`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/service.management",
+ "https://www.googleapis.com/auth/service.management.readonly"
+ ],
+ "flatPath": "v1/services/{serviceName}",
+ "id": "servicemanagement.services.get",
+ "path": "v1/services/{serviceName}"
+ },
+ "testIamPermissions": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/service.management",
+ "https://www.googleapis.com/auth/service.management.readonly"
+ ],
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^services/[^/]+$"
+ }
+ },
+ "flatPath": "v1/services/{servicesId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "servicemanagement.services.testIamPermissions",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning."
+ },
+ "getConfig": {
+ "flatPath": "v1/services/{serviceName}/config",
+ "id": "servicemanagement.services.getConfig",
+ "path": "v1/services/{serviceName}/config",
+ "description": "Gets a service configuration (version) for a managed service.",
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "response": {
+ "$ref": "Service"
+ },
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/service.management",
+ "https://www.googleapis.com/auth/service.management.readonly"
+ ],
+ "parameters": {
+ "view": {
+ "description": "Specifies which parts of the Service Config should be returned in the\nresponse.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ]
+ },
+ "serviceName": {
+ "location": "path",
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
+ "type": "string",
+ "required": true
+ },
+ "configId": {
+ "description": "The id of the service configuration resource.",
+ "type": "string",
+ "location": "query"
+ }
+ }
+ },
+ "enable": {
+ "description": "Enables a service for a project, so it can be used\nfor the project. See\n[Cloud Auth Guide](https://cloud.google.com/docs/authentication) for\nmore information.\n\nOperation\u003cresponse: EnableServiceResponse\u003e",
+ "request": {
+ "$ref": "EnableServiceRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "serviceName": {
+ "location": "path",
+ "description": "Name of the service to enable. Specifying an unknown service name will\ncause the request to fail.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "flatPath": "v1/services/{serviceName}:enable",
+ "id": "servicemanagement.services.enable",
+ "path": "v1/services/{serviceName}:enable"
+ },
+ "delete": {
+ "description": "Deletes a managed service. This method will change the service to the\n`Soft-Delete` state for 30 days. Within this period, service producers may\ncall UndeleteService to restore the service.\nAfter 30 days, the service will be permanently deleted.\n\nOperation\u003cresponse: google.protobuf.Empty\u003e",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "parameters": {
+ "serviceName": {
+ "location": "path",
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/services/{serviceName}",
+ "id": "servicemanagement.services.delete",
+ "path": "v1/services/{serviceName}"
+ },
+ "setIamPolicy": {
+ "flatPath": "v1/services/{servicesId}:setIamPolicy",
+ "id": "servicemanagement.services.setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^services/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ]
+ },
+ "disable": {
+ "request": {
+ "$ref": "DisableServiceRequest"
+ },
+ "description": "Disables a service for a project, so it can no longer be\nbe used for the project. It prevents accidental usage that may cause\nunexpected billing charges or security leaks.\n\nOperation\u003cresponse: DisableServiceResponse\u003e",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "parameters": {
+ "serviceName": {
+ "description": "Name of the service to disable. Specifying an unknown service name\nwill cause the request to fail.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/services/{serviceName}:disable",
+ "path": "v1/services/{serviceName}:disable",
+ "id": "servicemanagement.services.disable"
+ },
+ "getIamPolicy": {
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^services/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/service.management",
+ "https://www.googleapis.com/auth/service.management.readonly"
+ ],
+ "flatPath": "v1/services/{servicesId}:getIamPolicy",
+ "id": "servicemanagement.services.getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ }
+ },
+ "undelete": {
+ "flatPath": "v1/services/{serviceName}:undelete",
+ "id": "servicemanagement.services.undelete",
+ "path": "v1/services/{serviceName}:undelete",
+ "description": "Revives a previously deleted managed service. The method restores the\nservice using the configuration at the time the service was deleted.\nThe target service must exist and must have been deleted within the\nlast 30 days.\n\nOperation\u003cresponse: UndeleteServiceResponse\u003e",
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "parameters": {
+ "serviceName": {
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ }
+ },
+ "list": {
+ "description": "Lists managed services.\n\nReturns all public services. For authenticated users, also returns all\nservices the calling user has \"servicemanagement.services.get\" permission\nfor.\n\n**BETA:** If the caller specifies the `consumer_id`, it returns only the\nservices enabled on the consumer. The `consumer_id` must have the format\nof \"project:{PROJECT-ID}\".",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListServicesResponse"
+ },
+ "parameterOrder": [],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/service.management",
+ "https://www.googleapis.com/auth/service.management.readonly"
+ ],
+ "parameters": {
+ "consumerId": {
+ "location": "query",
+ "description": "Include services consumed by the specified consumer.\n\nThe Google Service Management implementation accepts the following\nforms:\n- project:\u003cproject_id\u003e",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Token identifying which result to start with; returned by a previous list\ncall.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Requested size of the next page of data.",
+ "type": "integer"
+ },
+ "producerProjectId": {
+ "description": "Include services produced by the specified project.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/services",
+ "path": "v1/services",
+ "id": "servicemanagement.services.list"
+ },
+ "create": {
+ "flatPath": "v1/services",
+ "id": "servicemanagement.services.create",
+ "path": "v1/services",
+ "description": "Creates a new managed service.\nPlease note one producer project can own no more than 20 services.\n\nOperation\u003cresponse: ManagedService\u003e",
+ "request": {
+ "$ref": "ManagedService"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ]
+ }
+ },
+ "resources": {
+ "rollouts": {
+ "methods": {
+ "get": {
+ "description": "Gets a service configuration rollout.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "serviceName",
+ "rolloutId"
+ ],
+ "response": {
+ "$ref": "Rollout"
+ },
+ "parameters": {
+ "serviceName": {
+ "location": "path",
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
+ "type": "string",
+ "required": true
+ },
+ "rolloutId": {
+ "location": "path",
+ "description": "The id of the rollout resource.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/service.management",
+ "https://www.googleapis.com/auth/service.management.readonly"
+ ],
+ "flatPath": "v1/services/{serviceName}/rollouts/{rolloutId}",
+ "path": "v1/services/{serviceName}/rollouts/{rolloutId}",
+ "id": "servicemanagement.services.rollouts.get"
+ },
+ "list": {
+ "description": "Lists the history of the service configuration rollouts for a managed\nservice, from the newest to the oldest.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "response": {
+ "$ref": "ListServiceRolloutsResponse"
+ },
+ "parameters": {
+ "filter": {
+ "description": "Use `filter` to return subset of rollouts.\nThe following filters are supported:\n -- To limit the results to only those in\n [status](google.api.servicemanagement.v1.RolloutStatus) 'SUCCESS',\n use filter='status=SUCCESS'\n -- To limit the results to those in\n [status](google.api.servicemanagement.v1.RolloutStatus) 'CANCELLED'\n or 'FAILED', use filter='status=CANCELLED OR status=FAILED'",
+ "type": "string",
+ "location": "query"
+ },
+ "serviceName": {
+ "location": "path",
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
+ "type": "string",
+ "required": true
+ },
+ "pageToken": {
+ "description": "The token of the page to retrieve.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The max number of items to include in the response list.",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/service.management",
+ "https://www.googleapis.com/auth/service.management.readonly"
+ ],
+ "flatPath": "v1/services/{serviceName}/rollouts",
+ "path": "v1/services/{serviceName}/rollouts",
+ "id": "servicemanagement.services.rollouts.list"
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "serviceName": {
+ "location": "path",
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "flatPath": "v1/services/{serviceName}/rollouts",
+ "path": "v1/services/{serviceName}/rollouts",
+ "id": "servicemanagement.services.rollouts.create",
+ "description": "Creates a new service configuration rollout. Based on rollout, the\nGoogle Service Management will roll out the service configurations to\ndifferent backend services. For example, the logging configuration will be\npushed to Google Cloud Logging.\n\nPlease note that any previous pending and running Rollouts and associated\nOperations will be automatically cancelled so that the latest Rollout will\nnot be blocked by previous Rollouts.\n\nOperation\u003cresponse: Rollout\u003e",
+ "request": {
+ "$ref": "Rollout"
+ }
+ }
+ }
+ },
+ "configs": {
+ "methods": {
+ "submit": {
+ "request": {
+ "$ref": "SubmitConfigSourceRequest"
+ },
+ "description": "Creates a new service configuration (version) for a managed service based\non\nuser-supplied configuration source files (for example: OpenAPI\nSpecification). This method stores the source configurations as well as the\ngenerated service configuration. To rollout the service configuration to\nother services,\nplease call CreateServiceRollout.\n\nOperation\u003cresponse: SubmitConfigSourceResponse\u003e",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "parameters": {
+ "serviceName": {
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/services/{serviceName}/configs:submit",
+ "path": "v1/services/{serviceName}/configs:submit",
+ "id": "servicemanagement.services.configs.submit"
+ },
+ "get": {
+ "parameterOrder": [
+ "serviceName",
+ "configId"
+ ],
+ "response": {
+ "$ref": "Service"
+ },
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/service.management",
+ "https://www.googleapis.com/auth/service.management.readonly"
+ ],
+ "parameters": {
+ "view": {
+ "location": "query",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "description": "Specifies which parts of the Service Config should be returned in the\nresponse.",
+ "type": "string"
+ },
+ "serviceName": {
+ "location": "path",
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
+ "type": "string",
+ "required": true
+ },
+ "configId": {
+ "location": "path",
+ "description": "The id of the service configuration resource.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/services/{serviceName}/configs/{configId}",
+ "id": "servicemanagement.services.configs.get",
+ "path": "v1/services/{serviceName}/configs/{configId}",
+ "description": "Gets a service configuration (version) for a managed service."
+ },
+ "list": {
+ "description": "Lists the history of the service configuration for a managed service,\nfrom the newest to the oldest.",
+ "response": {
+ "$ref": "ListServiceConfigsResponse"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "The max number of items to include in the response list.",
+ "type": "integer"
+ },
+ "serviceName": {
+ "location": "path",
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
+ "type": "string",
+ "required": true
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The token of the page to retrieve.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/service.management",
+ "https://www.googleapis.com/auth/service.management.readonly"
+ ],
+ "flatPath": "v1/services/{serviceName}/configs",
+ "id": "servicemanagement.services.configs.list",
+ "path": "v1/services/{serviceName}/configs"
+ },
+ "create": {
+ "description": "Creates a new service configuration (version) for a managed service.\nThis method only stores the service configuration. To roll out the service\nconfiguration to backend systems please call\nCreateServiceRollout.",
+ "request": {
+ "$ref": "Service"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "response": {
+ "$ref": "Service"
+ },
+ "parameters": {
+ "serviceName": {
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "flatPath": "v1/services/{serviceName}/configs",
+ "path": "v1/services/{serviceName}/configs",
+ "id": "servicemanagement.services.configs.create"
+ }
+ }
+ },
+ "consumers": {
+ "methods": {
+ "setIamPolicy": {
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^services/[^/]+/consumers/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "flatPath": "v1/services/{servicesId}/consumers/{consumersId}:setIamPolicy",
+ "id": "servicemanagement.services.consumers.setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ }
+ },
+ "testIamPermissions": {
+ "flatPath": "v1/services/{servicesId}/consumers/{consumersId}:testIamPermissions",
+ "id": "servicemanagement.services.consumers.testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^services/[^/]+/consumers/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/service.management",
+ "https://www.googleapis.com/auth/service.management.readonly"
+ ]
+ },
+ "getIamPolicy": {
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ },
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/service.management",
+ "https://www.googleapis.com/auth/service.management.readonly"
+ ],
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^services/[^/]+/consumers/[^/]+$"
+ }
+ },
+ "flatPath": "v1/services/{servicesId}/consumers/{consumersId}:getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "id": "servicemanagement.services.consumers.getIamPolicy"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ }
+ },
"version": "v1",
"baseUrl": "https://servicemanagement.googleapis.com/",
- "description": "Google Service Management allows service producers to publish their services on Google Cloud Platform so that they can be discovered and used by service consumers.",
"kind": "discovery#restDescription",
+ "description": "Google Service Management allows service producers to publish their services on Google Cloud Platform so that they can be discovered and used by service consumers.",
"servicePath": "",
"basePath": "",
- "revision": "20170926",
"documentationLink": "https://cloud.google.com/service-management/",
+ "revision": "20171007",
"id": "servicemanagement:v1",
"discoveryVersion": "v1",
"schemas": {
- "AuthorizationConfig": {
- "properties": {
- "provider": {
- "description": "The name of the authorization provider, such as\nfirebaserules.googleapis.com.",
- "type": "string"
- }
- },
- "id": "AuthorizationConfig",
- "description": "Configuration of authorization.\n\nThis section determines the authorization provider, if unspecified, then no\nauthorization check will be done.\n\nExample:\n\n experimental:\n authorization:\n provider: firebaserules.googleapis.com",
- "type": "object"
- },
- "DocumentationRule": {
- "description": "A documentation rule provides information about individual API elements.",
- "type": "object",
- "properties": {
- "deprecationDescription": {
- "description": "Deprecation description of the selected element(s). It can be provided if an\nelement is marked as `deprecated`.",
- "type": "string"
- },
- "selector": {
- "description": "The selector is a comma-separated list of patterns. Each pattern is a\nqualified name of the element which may end in \"*\", indicating a wildcard.\nWildcards are only allowed at the end and for a whole component of the\nqualified name, i.e. \"foo.*\" is ok, but not \"foo.b*\" or \"foo.*.bar\". To\nspecify a default for all applicable elements, the whole pattern \"*\"\nis used.",
- "type": "string"
- },
- "description": {
- "description": "Description of the selected API(s).",
- "type": "string"
- }
- },
- "id": "DocumentationRule"
- },
- "ContextRule": {
- "description": "A context rule provides information about the context for an individual API\nelement.",
- "type": "object",
- "properties": {
- "provided": {
- "description": "A list of full type names of provided contexts.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "requested": {
- "description": "A list of full type names of requested contexts.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "selector": {
- "type": "string",
- "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details."
- }
- },
- "id": "ContextRule"
- },
- "Billing": {
- "properties": {
- "consumerDestinations": {
- "description": "Billing configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations per service, each one must have\na different monitored resource type. A metric can be used in at most\none consumer destination.",
- "items": {
- "$ref": "BillingDestination"
- },
- "type": "array"
- }
- },
- "id": "Billing",
- "description": "Billing related configuration of the service.\n\nThe following example shows how to configure monitored resources and metrics\nfor billing:\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/borrowed_count\n metric_kind: DELTA\n value_type: INT64\n billing:\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/borrowed_count",
- "type": "object"
- },
- "MetricDescriptor": {
- "description": "Defines a metric type and its schema. Once a metric descriptor is created,\ndeleting or altering it stops data collection and makes the metric type's\nexisting data unusable.",
- "type": "object",
- "properties": {
- "displayName": {
- "description": "A concise name for the metric, which can be displayed in user interfaces.\nUse sentence case without an ending period, for example \"Request count\".",
- "type": "string"
- },
- "description": {
- "type": "string",
- "description": "A detailed description of the metric, which can be used in documentation."
- },
- "unit": {
- "type": "string",
- "description": "The unit in which the metric value is reported. It is only applicable\nif the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The\nsupported units are a subset of [The Unified Code for Units of\nMeasure](http://unitsofmeasure.org/ucum.html) standard:\n\n**Basic units (UNIT)**\n\n* `bit` bit\n* `By` byte\n* `s` second\n* `min` minute\n* `h` hour\n* `d` day\n\n**Prefixes (PREFIX)**\n\n* `k` kilo (10**3)\n* `M` mega (10**6)\n* `G` giga (10**9)\n* `T` tera (10**12)\n* `P` peta (10**15)\n* `E` exa (10**18)\n* `Z` zetta (10**21)\n* `Y` yotta (10**24)\n* `m` milli (10**-3)\n* `u` micro (10**-6)\n* `n` nano (10**-9)\n* `p` pico (10**-12)\n* `f` femto (10**-15)\n* `a` atto (10**-18)\n* `z` zepto (10**-21)\n* `y` yocto (10**-24)\n* `Ki` kibi (2**10)\n* `Mi` mebi (2**20)\n* `Gi` gibi (2**30)\n* `Ti` tebi (2**40)\n\n**Grammar**\n\nThe grammar includes the dimensionless unit `1`, such as `1/s`.\n\nThe grammar also includes these connectors:\n\n* `/` division (as an infix operator, e.g. `1/s`).\n* `.` multiplication (as an infix operator, e.g. `GBy.d`)\n\nThe grammar for a unit is as follows:\n\n Expression = Component { \".\" Component } { \"/\" Component } ;\n\n Component = [ PREFIX ] UNIT [ Annotation ]\n | Annotation\n | \"1\"\n ;\n\n Annotation = \"{\" NAME \"}\" ;\n\nNotes:\n\n* `Annotation` is just a comment if it follows a `UNIT` and is\n equivalent to `1` if it is used alone. For examples,\n `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.\n* `NAME` is a sequence of non-blank printable ASCII characters not\n containing '{' or '}'."
- },
- "labels": {
- "description": "The set of labels that can be used to describe a specific\ninstance of this metric type. For example, the\n`appengine.googleapis.com/http/server/response_latencies` metric\ntype has a label for the HTTP response code, `response_code`, so\nyou can look at latencies for successful responses or just\nfor responses that failed.",
- "items": {
- "$ref": "LabelDescriptor"
- },
- "type": "array"
- },
- "name": {
- "description": "The resource name of the metric descriptor. Depending on the\nimplementation, the name typically includes: (1) the parent resource name\nthat defines the scope of the metric type or of its data; and (2) the\nmetric's URL-encoded type, which also appears in the `type` field of this\ndescriptor. For example, following is the resource name of a custom\nmetric within the GCP project `my-project-id`:\n\n \"projects/my-project-id/metricDescriptors/custom.googleapis.com%2Finvoice%2Fpaid%2Famount\"",
- "type": "string"
- },
- "type": {
- "description": "The metric type, including its DNS name prefix. The type is not\nURL-encoded. All user-defined custom metric types have the DNS name\n`custom.googleapis.com`. Metric types should use a natural hierarchical\ngrouping. For example:\n\n \"custom.googleapis.com/invoice/paid/amount\"\n \"appengine.googleapis.com/http/server/response_latencies\"",
- "type": "string"
- },
- "valueType": {
- "enum": [
- "VALUE_TYPE_UNSPECIFIED",
- "BOOL",
- "INT64",
- "DOUBLE",
- "STRING",
- "DISTRIBUTION",
- "MONEY"
- ],
- "description": "Whether the measurement is an integer, a floating-point number, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported.",
- "type": "string",
- "enumDescriptions": [
- "Do not use this default value.",
- "The value is a boolean.\nThis value type can be used only if the metric kind is `GAUGE`.",
- "The value is a signed 64-bit integer.",
- "The value is a double precision floating point number.",
- "The value is a text string.\nThis value type can be used only if the metric kind is `GAUGE`.",
- "The value is a `Distribution`.",
- "The value is money."
- ]
- },
- "metricKind": {
- "enumDescriptions": [
- "Do not use this default value.",
- "An instantaneous measurement of a value.",
- "The change in a value during a time interval.",
- "A value accumulated over a time interval. Cumulative\nmeasurements in a time series should have the same start time\nand increasing end times, until an event resets the cumulative\nvalue to zero and sets a new start time for the following\npoints."
- ],
- "enum": [
- "METRIC_KIND_UNSPECIFIED",
- "GAUGE",
- "DELTA",
- "CUMULATIVE"
- ],
- "description": "Whether the metric records instantaneous values, changes to a value, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported.",
- "type": "string"
- }
- },
- "id": "MetricDescriptor"
- },
- "SourceContext": {
- "description": "`SourceContext` represents information about the source of a\nprotobuf element, like the file in which it is defined.",
- "type": "object",
- "properties": {
- "fileName": {
- "description": "The path-qualified name of the .proto file that contained the associated\nprotobuf element. For example: `\"google/protobuf/source_context.proto\"`.",
- "type": "string"
- }
- },
- "id": "SourceContext"
- },
- "Expr": {
- "description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"",
- "type": "object",
- "properties": {
- "description": {
- "description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
- "type": "string"
- },
- "expression": {
- "description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
- "type": "string"
- },
- "location": {
- "type": "string",
- "description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file."
- },
- "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"
- }
- },
- "id": "Expr"
- },
- "ListServicesResponse": {
- "properties": {
- "nextPageToken": {
- "description": "Token that can be passed to `ListServices` to resume a paginated query.",
- "type": "string"
- },
- "services": {
- "description": "The returned services will only have the name field set.",
- "items": {
- "$ref": "ManagedService"
- },
- "type": "array"
- }
- },
- "id": "ListServicesResponse",
- "description": "Response message for `ListServices` method.",
- "type": "object"
- },
- "Endpoint": {
- "description": "`Endpoint` describes a network endpoint that serves a set of APIs.\nA service may expose any number of endpoints, and all endpoints share the\nsame service configuration, such as quota configuration and monitoring\nconfiguration.\n\nExample service configuration:\n\n name: library-example.googleapis.com\n endpoints:\n # Below entry makes 'google.example.library.v1.Library'\n # API be served from endpoint address library-example.googleapis.com.\n # It also allows HTTP OPTIONS calls to be passed to the backend, for\n # it to decide whether the subsequent cross-origin request is\n # allowed to proceed.\n - name: library-example.googleapis.com\n allow_cors: true",
- "type": "object",
- "properties": {
- "features": {
- "description": "The list of features enabled on this endpoint.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "apis": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "The list of APIs served by this endpoint.\n\nIf no APIs are specified this translates to \"all APIs\" exported by the\nservice, as defined in the top-level service configuration."
- },
- "allowCors": {
- "description": "Allowing\n[CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka\ncross-domain traffic, would allow the backends served from this endpoint to\nreceive and respond to HTTP OPTIONS requests. The response will be used by\nthe browser to determine whether the subsequent cross-origin request is\nallowed to proceed.",
- "type": "boolean"
- },
- "aliases": {
- "description": "DEPRECATED: This field is no longer supported. Instead of using aliases,\nplease specify multiple google.api.Endpoint for each of the intented\nalias.\n\nAdditional names that this endpoint will be hosted on.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "name": {
- "description": "The canonical name of this endpoint.",
- "type": "string"
- },
- "target": {
- "description": "The specification of an Internet routable address of API frontend that will\nhandle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary).\nIt should be either a valid IPv4 address or a fully-qualified domain name.\nFor example, \"8.8.8.8\" or \"myservice.appspot.com\".",
- "type": "string"
- }
- },
- "id": "Endpoint"
- },
- "OAuthRequirements": {
- "description": "OAuth scopes are a way to define data and permissions on data. For example,\nthere are scopes defined for \"Read-only access to Google Calendar\" and\n\"Access to Cloud Platform\". Users can consent to a scope for an application,\ngiving it permission to access that data on their behalf.\n\nOAuth scope specifications should be fairly coarse grained; a user will need\nto see and understand the text description of what your scope means.\n\nIn most cases: use one or at most two OAuth scopes for an entire family of\nproducts. If your product has multiple APIs, you should probably be sharing\nthe OAuth scope across all of those APIs.\n\nWhen you need finer grained OAuth consent screens: talk with your product\nmanagement about how developers will use them in practice.\n\nPlease note that even though each of the canonical scopes is enough for a\nrequest to be accepted and passed to the backend, a request can still fail\ndue to the backend requiring additional scopes or permissions.",
- "type": "object",
- "properties": {
- "canonicalScopes": {
- "description": "The list of publicly documented OAuth scopes that are allowed access. An\nOAuth token containing any of these scopes will be accepted.\n\nExample:\n\n canonical_scopes: https://www.googleapis.com/auth/calendar,\n https://www.googleapis.com/auth/calendar.read",
- "type": "string"
- }
- },
- "id": "OAuthRequirements"
- },
- "TestIamPermissionsResponse": {
- "properties": {
- "permissions": {
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "TestIamPermissionsResponse",
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object"
- },
- "GetIamPolicyRequest": {
- "properties": {},
- "id": "GetIamPolicyRequest",
- "description": "Request message for `GetIamPolicy` method.",
- "type": "object"
- },
- "Usage": {
- "description": "Configuration controlling usage of a service.",
- "type": "object",
- "properties": {
- "producerNotificationChannel": {
- "description": "The full resource name of a channel used for sending notifications to the\nservice producer.\n\nGoogle Service Management currently only supports\n[Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification\nchannel. To use Google Cloud Pub/Sub as the channel, this must be the name\nof a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format\ndocumented in https://cloud.google.com/pubsub/docs/overview.",
- "type": "string"
- },
- "rules": {
- "description": "A list of usage rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
- "items": {
- "$ref": "UsageRule"
- },
- "type": "array"
- },
- "requirements": {
- "description": "Requirements that must be satisfied before a consumer project can use the\nservice. Each requirement is of the form \u003cservice.name\u003e/\u003crequirement-id\u003e;\nfor example 'serviceusage.googleapis.com/billing-enabled'.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "Usage"
- },
- "Context": {
- "description": "`Context` defines which contexts an API requests.\n\nExample:\n\n context:\n rules:\n - selector: \"*\"\n requested:\n - google.rpc.context.ProjectContext\n - google.rpc.context.OriginContext\n\nThe above specifies that all methods in the API request\n`google.rpc.context.ProjectContext` and\n`google.rpc.context.OriginContext`.\n\nAvailable context types are defined in package\n`google.rpc.context`.",
- "type": "object",
- "properties": {
- "rules": {
- "description": "A list of RPC context rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
- "items": {
- "$ref": "ContextRule"
- },
- "type": "array"
- }
- },
- "id": "Context"
- },
"LogDescriptor": {
- "id": "LogDescriptor",
"description": "A description of a log type. Example in YAML format:\n\n - name: library.googleapis.com/activity_history\n description: The history of borrowing and returning library items.\n display_name: Activity\n labels:\n - key: /customer_id\n description: Identifier of a library customer",
"type": "object",
"properties": {
+ "displayName": {
+ "description": "The human-readable name for this log. This information appears on\nthe user interface and should be concise.",
+ "type": "string"
+ },
+ "description": {
+ "description": "A human-readable description of this log. This information appears in\nthe documentation and can contain details.",
+ "type": "string"
+ },
"labels": {
"description": "The set of labels that are available to describe a specific log entry.\nRuntime requests that contain labels not specified here are\nconsidered invalid.",
"items": {
@@ -328,24 +910,15 @@
"name": {
"description": "The name of the log. It must be less than 512 characters long and can\ninclude the following characters: upper- and lower-case alphanumeric\ncharacters [A-Za-z0-9], and punctuation characters including\nslash, underscore, hyphen, period [/_-.].",
"type": "string"
- },
- "displayName": {
- "description": "The human-readable name for this log. This information appears on\nthe user interface and should be concise.",
- "type": "string"
- },
- "description": {
- "description": "A human-readable description of this log. This information appears in\nthe documentation and can contain details.",
- "type": "string"
}
- }
+ },
+ "id": "LogDescriptor"
},
"ConfigFile": {
"description": "Generic specification of a source configuration file",
"type": "object",
"properties": {
"fileType": {
- "description": "The type of configuration file this represents.",
- "type": "string",
"enumDescriptions": [
"Unknown file type.",
"YAML-specification of service.",
@@ -361,7 +934,9 @@
"OPEN_API_YAML",
"FILE_DESCRIPTOR_SET_PROTO",
"PROTO_FILE"
- ]
+ ],
+ "description": "The type of configuration file this represents.",
+ "type": "string"
},
"fileContents": {
"format": "byte",
@@ -406,7 +981,6 @@
"id": "MonitoredResourceDescriptor"
},
"CustomErrorRule": {
- "id": "CustomErrorRule",
"description": "A custom error rule.",
"type": "object",
"properties": {
@@ -418,23 +992,17 @@
"description": "Selects messages to which this rule applies.\n\nRefer to selector for syntax details.",
"type": "string"
}
- }
- },
- "CustomAuthRequirements": {
- "description": "Configuration for a custom authentication provider.",
- "type": "object",
- "properties": {
- "provider": {
- "description": "A configuration string containing connection information for the\nauthentication provider, typically formatted as a SmartService string\n(go/smartservice).",
- "type": "string"
- }
},
- "id": "CustomAuthRequirements"
+ "id": "CustomErrorRule"
},
"MediaDownload": {
"description": "Defines the Media configuration for a service in case of a download.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.",
"type": "object",
"properties": {
+ "useDirectDownload": {
+ "description": "A boolean that determines if direct download from ESF should be used for\ndownload of this media.",
+ "type": "boolean"
+ },
"enabled": {
"description": "Whether download is enabled.",
"type": "boolean"
@@ -447,32 +1015,39 @@
"description": "A boolean that determines whether a notification for the completion of a\ndownload should be sent to the backend.",
"type": "boolean"
},
- "dropzone": {
- "description": "Name of the Scotty dropzone to use for the current API.",
- "type": "string"
- },
"maxDirectDownloadSize": {
"format": "int64",
"description": "Optional maximum acceptable size for direct download.\nThe size is specified in bytes.",
"type": "string"
},
- "useDirectDownload": {
- "description": "A boolean that determines if direct download from ESF should be used for\ndownload of this media.",
- "type": "boolean"
+ "dropzone": {
+ "description": "Name of the Scotty dropzone to use for the current API.",
+ "type": "string"
}
},
"id": "MediaDownload"
},
+ "CustomAuthRequirements": {
+ "description": "Configuration for a custom authentication provider.",
+ "type": "object",
+ "properties": {
+ "provider": {
+ "description": "A configuration string containing connection information for the\nauthentication provider, typically formatted as a SmartService string\n(go/smartservice).",
+ "type": "string"
+ }
+ },
+ "id": "CustomAuthRequirements"
+ },
"ChangeReport": {
"description": "Change report associated with a particular service configuration.\n\nIt contains a list of ConfigChanges based on the comparison between\ntwo service configurations.",
"type": "object",
"properties": {
"configChanges": {
+ "description": "List of changes between two service configurations.\nThe changes will be alphabetically sorted based on the identifier\nof each change.\nA ConfigChange identifier is a dot separated path to the configuration.\nExample: visibility.rules[selector='LibraryService.CreateBook'].restriction",
"items": {
"$ref": "ConfigChange"
},
- "type": "array",
- "description": "List of changes between two service configurations.\nThe changes will be alphabetically sorted based on the identifier\nof each change.\nA ConfigChange identifier is a dot separated path to the configuration.\nExample: visibility.rules[selector='LibraryService.CreateBook'].restriction"
+ "type": "array"
}
},
"id": "ChangeReport"
@@ -482,8 +1057,8 @@
"type": "object",
"properties": {
"consumerId": {
- "type": "string",
- "description": "The identity of consumer resource which service disablement will be\napplied to.\n\nThe Google Service Management implementation accepts the following\nforms:\n- \"project:\u003cproject_id\u003e\"\n\nNote: this is made compatible with\ngoogle.api.servicecontrol.v1.Operation.consumer_id."
+ "description": "The identity of consumer resource which service disablement will be\napplied to.\n\nThe Google Service Management implementation accepts the following\nforms:\n- \"project:\u003cproject_id\u003e\"\n\nNote: this is made compatible with\ngoogle.api.servicecontrol.v1.Operation.consumer_id.",
+ "type": "string"
}
},
"id": "DisableServiceRequest"
@@ -503,16 +1078,16 @@
"description": "Defines the Media configuration for a service in case of an upload.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.",
"type": "object",
"properties": {
- "enabled": {
- "description": "Whether upload is enabled.",
+ "completeNotification": {
+ "description": "A boolean that determines whether a notification for the completion of an\nupload should be sent to the backend. These notifications will not be seen\nby the client and will not consume quota.",
"type": "boolean"
},
"progressNotification": {
"description": "Whether to receive a notification for progress changes of media upload.",
"type": "boolean"
},
- "completeNotification": {
- "description": "A boolean that determines whether a notification for the completion of an\nupload should be sent to the backend. These notifications will not be seen\nby the client and will not consume quota.",
+ "enabled": {
+ "description": "Whether upload is enabled.",
"type": "boolean"
},
"dropzone": {
@@ -527,23 +1102,22 @@
"description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the upload service if one is used for upload.",
"type": "string"
},
- "maxSize": {
- "format": "int64",
- "description": "Optional maximum acceptable size for an upload.\nThe size is specified in bytes.",
- "type": "string"
- },
"mimeTypes": {
"description": "An array of mimetype patterns. Esf will only accept uploads that match one\nof the given patterns.",
"items": {
"type": "string"
},
"type": "array"
+ },
+ "maxSize": {
+ "format": "int64",
+ "description": "Optional maximum acceptable size for an upload.\nThe size is specified in bytes.",
+ "type": "string"
}
},
"id": "MediaUpload"
},
"BillingDestination": {
- "id": "BillingDestination",
"description": "Configuration of a specific billing destination (Currently only support\nbill against consumer project).",
"type": "object",
"properties": {
@@ -558,18 +1132,19 @@
},
"type": "array"
}
- }
+ },
+ "id": "BillingDestination"
},
"Advice": {
+ "description": "Generated advice about this change, used for providing more\ninformation about how a change will affect the existing service.",
+ "type": "object",
"properties": {
"description": {
"description": "Useful description for why this advice was applied and what actions should\nbe taken to mitigate any implied risks.",
"type": "string"
}
},
- "id": "Advice",
- "description": "Generated advice about this change, used for providing more\ninformation about how a change will affect the existing service.",
- "type": "object"
+ "id": "Advice"
},
"ManagedService": {
"description": "The full representation of a Service that is managed by\nGoogle Service Management.",
@@ -587,10 +1162,13 @@
"id": "ManagedService"
},
"UsageRule": {
- "id": "UsageRule",
"description": "Usage configuration rules for the service.\n\nNOTE: Under development.\n\n\nUse this rule to configure unregistered calls for the service. Unregistered\ncalls are calls that do not contain consumer project identity.\n(Example: calls that do not contain an API key).\nBy default, API methods do not allow unregistered calls, and each method call\nmust be identified by a consumer project identity. Use this rule to\nallow/disallow unregistered calls.\n\nExample of an API that wants to allow unregistered calls for entire service.\n\n usage:\n rules:\n - selector: \"*\"\n allow_unregistered_calls: true\n\nExample of a method that wants to allow unregistered calls.\n\n usage:\n rules:\n - selector: \"google.example.library.v1.LibraryService.CreateBook\"\n allow_unregistered_calls: true",
"type": "object",
"properties": {
+ "skipServiceControl": {
+ "description": "True, if the method should skip service control. If so, no control plane\nfeature (like quota and billing) will be enabled.\nThis flag is used by ESP to allow some Endpoints customers to bypass\nGoogle internal checks.",
+ "type": "boolean"
+ },
"allowUnregisteredCalls": {
"description": "True, if the method allows unregistered calls; false otherwise.",
"type": "boolean"
@@ -598,27 +1176,24 @@
"selector": {
"description": "Selects the methods to which this rule applies. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for syntax details.",
"type": "string"
- },
- "skipServiceControl": {
- "description": "True, if the method should skip service control. If so, no control plane\nfeature (like quota and billing) will be enabled.",
- "type": "boolean"
}
- }
+ },
+ "id": "UsageRule"
},
"TrafficPercentStrategy": {
+ "description": "Strategy that specifies how clients of Google Service Controller want to\nsend traffic to use different config versions. This is generally\nused by API proxy to split traffic based on your configured precentage for\neach config version.\n\nOne example of how to gradually rollout a new service configuration using\nthis\nstrategy:\nDay 1\n\n Rollout {\n id: \"example.googleapis.com/rollout_20160206\"\n traffic_percent_strategy {\n percentages: {\n \"example.googleapis.com/20160201\": 70.00\n \"example.googleapis.com/20160206\": 30.00\n }\n }\n }\n\nDay 2\n\n Rollout {\n id: \"example.googleapis.com/rollout_20160207\"\n traffic_percent_strategy: {\n percentages: {\n \"example.googleapis.com/20160206\": 100.00\n }\n }\n }",
"type": "object",
"properties": {
"percentages": {
+ "description": "Maps service configuration IDs to their corresponding traffic percentage.\nKey is the service configuration ID, Value is the traffic percentage\nwhich must be greater than 0.0 and the sum must equal to 100.0.",
+ "type": "object",
"additionalProperties": {
"format": "double",
"type": "number"
- },
- "description": "Maps service configuration IDs to their corresponding traffic percentage.\nKey is the service configuration ID, Value is the traffic percentage\nwhich must be greater than 0.0 and the sum must equal to 100.0.",
- "type": "object"
+ }
}
},
- "id": "TrafficPercentStrategy",
- "description": "Strategy that specifies how clients of Google Service Controller want to\nsend traffic to use different config versions. This is generally\nused by API proxy to split traffic based on your configured precentage for\neach config version.\n\nOne example of how to gradually rollout a new service configuration using\nthis\nstrategy:\nDay 1\n\n Rollout {\n id: \"example.googleapis.com/rollout_20160206\"\n traffic_percent_strategy {\n percentages: {\n \"example.googleapis.com/20160201\": 70.00\n \"example.googleapis.com/20160206\": 30.00\n }\n }\n }\n\nDay 2\n\n Rollout {\n id: \"example.googleapis.com/rollout_20160207\"\n traffic_percent_strategy: {\n percentages: {\n \"example.googleapis.com/20160206\": 100.00\n }\n }\n }"
+ "id": "TrafficPercentStrategy"
},
"AuthRequirement": {
"description": "User-defined authentication requirements, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).",
@@ -639,6 +1214,13 @@
"description": "`Documentation` provides the information for describing a service.\n\nExample:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: \u003e\n The Google Calendar API gives access\n to most calendar features.\n pages:\n - name: Overview\n content: (== include google/foo/overview.md ==)\n - name: Tutorial\n content: (== include google/foo/tutorial.md ==)\n subpages;\n - name: Java\n content: (== include google/foo/tutorial_java.md ==)\n rules:\n - selector: google.calendar.Calendar.Get\n description: \u003e\n ...\n - selector: google.calendar.Calendar.Put\n description: \u003e\n ...\n\u003c/code\u003e\u003c/pre\u003e\nDocumentation is provided in markdown syntax. In addition to\nstandard markdown features, definition lists, tables and fenced\ncode blocks are supported. Section headers can be provided and are\ninterpreted relative to the section nesting of the context where\na documentation fragment is embedded.\n\nDocumentation from the IDL is merged with documentation defined\nvia the config at normalization time, where documentation provided\nby config rules overrides IDL provided.\n\nA number of constructs specific to the API platform are supported\nin documentation text.\n\nIn order to reference a proto element, the following\nnotation can be used:\n\u003cpre\u003e\u003ccode\u003e[fully.qualified.proto.name][]\u003c/code\u003e\u003c/pre\u003e\nTo override the display text used for the link, this can be used:\n\u003cpre\u003e\u003ccode\u003e[display text][fully.qualified.proto.name]\u003c/code\u003e\u003c/pre\u003e\nText can be excluded from doc using the following notation:\n\u003cpre\u003e\u003ccode\u003e(-- internal comment --)\u003c/code\u003e\u003c/pre\u003e\nComments can be made conditional using a visibility label. The below\ntext will be only rendered if the `BETA` label is available:\n\u003cpre\u003e\u003ccode\u003e(--BETA: comment for BETA users --)\u003c/code\u003e\u003c/pre\u003e\nA few directives are available in documentation. Note that\ndirectives must appear on a single line to be properly\nidentified. The `include` directive includes a markdown file from\nan external source:\n\u003cpre\u003e\u003ccode\u003e(== include path/to/file ==)\u003c/code\u003e\u003c/pre\u003e\nThe `resource_for` directive marks a message to be the resource of\na collection in REST view. If it is not specified, tools attempt\nto infer the resource from the operations in a collection:\n\u003cpre\u003e\u003ccode\u003e(== resource_for v1.shelves.books ==)\u003c/code\u003e\u003c/pre\u003e\nThe directive `suppress_warning` does not directly affect documentation\nand is documented together with service config validation.",
"type": "object",
"properties": {
+ "pages": {
+ "description": "The top level pages for the documentation set.",
+ "items": {
+ "$ref": "Page"
+ },
+ "type": "array"
+ },
"summary": {
"description": "A short summary of what the service does. Can only be provided by\nplain text.",
"type": "string"
@@ -657,18 +1239,12 @@
"$ref": "DocumentationRule"
},
"type": "array"
- },
- "pages": {
- "description": "The top level pages for the documentation set.",
- "items": {
- "$ref": "Page"
- },
- "type": "array"
}
},
"id": "Documentation"
},
"AuditLogConfig": {
+ "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
"type": "object",
"properties": {
"exemptedMembers": {
@@ -679,6 +1255,12 @@
"type": "array"
},
"logType": {
+ "enumDescriptions": [
+ "Default case. Should never be this.",
+ "Admin reads. Example: CloudIAM getIamPolicy",
+ "Data writes. Example: CloudSQL Users create",
+ "Data reads. Example: CloudSQL Users list"
+ ],
"enum": [
"LOG_TYPE_UNSPECIFIED",
"ADMIN_READ",
@@ -686,19 +1268,14 @@
"DATA_READ"
],
"description": "The log type that this config enables.",
- "type": "string",
- "enumDescriptions": [
- "Default case. Should never be this.",
- "Admin reads. Example: CloudIAM getIamPolicy",
- "Data writes. Example: CloudSQL Users create",
- "Data reads. Example: CloudSQL Users list"
- ]
+ "type": "string"
}
},
- "id": "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"
},
"ConfigSource": {
+ "description": "Represents a source file which is used to generate the service configuration\ndefined by `google.api.Service`.",
+ "type": "object",
"properties": {
"files": {
"description": "Set of source configuration files that are used to generate a service\nconfiguration (`google.api.Service`).",
@@ -712,13 +1289,47 @@
"type": "string"
}
},
- "id": "ConfigSource",
- "description": "Represents a source file which is used to generate the service configuration\ndefined by `google.api.Service`.",
- "type": "object"
+ "id": "ConfigSource"
},
- "BackendRule": {
+ "AuthenticationRule": {
+ "description": "Authentication rules for the service.\n\nBy default, if a method has any authentication requirements, every request\nmust include a valid credential matching one of the requirements.\nIt's an error to include more than one kind of credential in a single\nrequest.\n\nIf a method doesn't have any auth requirements, request credentials will be\nignored.",
"type": "object",
"properties": {
+ "customAuth": {
+ "$ref": "CustomAuthRequirements",
+ "description": "Configuration for custom authentication."
+ },
+ "oauth": {
+ "$ref": "OAuthRequirements",
+ "description": "The requirements for OAuth credentials."
+ },
+ "requirements": {
+ "description": "Requirements for additional authentication providers.",
+ "items": {
+ "$ref": "AuthRequirement"
+ },
+ "type": "array"
+ },
+ "allowWithoutCredential": {
+ "description": "Whether to allow requests without a credential. The credential can be\nan OAuth token, Google cookies (first-party auth) or EndUserCreds.\n\nFor requests without credentials, if the service control environment is\nspecified, each incoming request **must** be associated with a service\nconsumer. This can be done by passing an API key that belongs to a consumer\nproject.",
+ "type": "boolean"
+ },
+ "selector": {
+ "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ }
+ },
+ "id": "AuthenticationRule"
+ },
+ "BackendRule": {
+ "description": "A backend rule provides configuration for an individual API element.",
+ "type": "object",
+ "properties": {
+ "minDeadline": {
+ "format": "double",
+ "description": "Minimum deadline in seconds needed for this method. Calls having deadline\nvalue lower than this will be rejected.",
+ "type": "number"
+ },
"address": {
"description": "The address of the API backend.",
"type": "string"
@@ -731,45 +1342,9 @@
"format": "double",
"description": "The number of seconds to wait for a response from a request. The default\ndeadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds.",
"type": "number"
- },
- "minDeadline": {
- "format": "double",
- "description": "Minimum deadline in seconds needed for this method. Calls having deadline\nvalue lower than this will be rejected.",
- "type": "number"
}
},
- "id": "BackendRule",
- "description": "A backend rule provides configuration for an individual API element."
- },
- "AuthenticationRule": {
- "id": "AuthenticationRule",
- "description": "Authentication rules for the service.\n\nBy default, if a method has any authentication requirements, every request\nmust include a valid credential matching one of the requirements.\nIt's an error to include more than one kind of credential in a single\nrequest.\n\nIf a method doesn't have any auth requirements, request credentials will be\nignored.",
- "type": "object",
- "properties": {
- "requirements": {
- "items": {
- "$ref": "AuthRequirement"
- },
- "type": "array",
- "description": "Requirements for additional authentication providers."
- },
- "allowWithoutCredential": {
- "description": "Whether to allow requests without a credential. The credential can be\nan OAuth token, Google cookies (first-party auth) or EndUserCreds.\n\nFor requests without credentials, if the service control environment is\nspecified, each incoming request **must** be associated with a service\nconsumer. This can be done by passing an API key that belongs to a consumer\nproject.",
- "type": "boolean"
- },
- "selector": {
- "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
- "type": "string"
- },
- "customAuth": {
- "$ref": "CustomAuthRequirements",
- "description": "Configuration for custom authentication."
- },
- "oauth": {
- "description": "The requirements for OAuth credentials.",
- "$ref": "OAuthRequirements"
- }
- }
+ "id": "BackendRule"
},
"Policy": {
"description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
@@ -781,23 +1356,23 @@
"type": "string"
},
"version": {
- "type": "integer",
"format": "int32",
- "description": "Version of the `Policy`. The default version is 0."
+ "description": "Version of the `Policy`. The default version is 0.",
+ "type": "integer"
},
"auditConfigs": {
+ "description": "Specifies cloud audit logging configuration for this policy.",
"items": {
"$ref": "AuditConfig"
},
- "type": "array",
- "description": "Specifies cloud audit logging configuration for this policy."
+ "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",
- "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error."
+ "type": "array"
},
"iamOwned": {
"type": "boolean"
@@ -817,38 +1392,9 @@
"id": "UndeleteServiceResponse"
},
"Api": {
+ "description": "Api is a light-weight descriptor for an API Interface.\n\nInterfaces are also described as \"protocol buffer services\" in some contexts,\nsuch as by the \"service\" keyword in a .proto file, but they are different\nfrom API Services, which represent a concrete implementation of an interface\nas opposed to simply a description of methods and bindings. They are also\nsometimes simply referred to as \"APIs\" in other contexts, such as the name of\nthis message itself. See https://cloud.google.com/apis/design/glossary for\ndetailed terminology.",
+ "type": "object",
"properties": {
- "methods": {
- "description": "The methods of this interface, in unspecified order.",
- "items": {
- "$ref": "Method"
- },
- "type": "array"
- },
- "name": {
- "description": "The fully qualified name of this interface, including package name\nfollowed by the interface's simple name.",
- "type": "string"
- },
- "syntax": {
- "enum": [
- "SYNTAX_PROTO2",
- "SYNTAX_PROTO3"
- ],
- "description": "The source syntax of the service.",
- "type": "string",
- "enumDescriptions": [
- "Syntax `proto2`.",
- "Syntax `proto3`."
- ]
- },
- "sourceContext": {
- "description": "Source context for the protocol buffer service represented by this\nmessage.",
- "$ref": "SourceContext"
- },
- "version": {
- "description": "A version string for this interface. If specified, must have the form\n`major-version.minor-version`, as in `1.10`. If the minor version is\nomitted, it defaults to zero. If the entire version field is empty, the\nmajor version is derived from the package name, as outlined below. If the\nfield is not empty, the version in the package name will be verified to be\nconsistent with what is provided here.\n\nThe versioning schema uses [semantic\nversioning](http://semver.org) where the major version number\nindicates a breaking change and the minor version an additive,\nnon-breaking change. Both version numbers are signals to users\nwhat to expect from different versions, and should be carefully\nchosen based on the product plan.\n\nThe major version is also reflected in the package name of the\ninterface, which must end in `v\u003cmajor-version\u003e`, as in\n`google.feature.v1`. For major versions 0 and 1, the suffix can\nbe omitted. Zero major versions must only be used for\nexperimental, non-GA interfaces.\n",
- "type": "string"
- },
"mixins": {
"description": "Included interfaces. See Mixin.",
"items": {
@@ -862,11 +1408,40 @@
"$ref": "Option"
},
"type": "array"
+ },
+ "methods": {
+ "description": "The methods of this interface, in unspecified order.",
+ "items": {
+ "$ref": "Method"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "The fully qualified name of this interface, including package name\nfollowed by the interface's simple name.",
+ "type": "string"
+ },
+ "syntax": {
+ "enumDescriptions": [
+ "Syntax `proto2`.",
+ "Syntax `proto3`."
+ ],
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ],
+ "description": "The source syntax of the service.",
+ "type": "string"
+ },
+ "sourceContext": {
+ "$ref": "SourceContext",
+ "description": "Source context for the protocol buffer service represented by this\nmessage."
+ },
+ "version": {
+ "description": "A version string for this interface. If specified, must have the form\n`major-version.minor-version`, as in `1.10`. If the minor version is\nomitted, it defaults to zero. If the entire version field is empty, the\nmajor version is derived from the package name, as outlined below. If the\nfield is not empty, the version in the package name will be verified to be\nconsistent with what is provided here.\n\nThe versioning schema uses [semantic\nversioning](http://semver.org) where the major version number\nindicates a breaking change and the minor version an additive,\nnon-breaking change. Both version numbers are signals to users\nwhat to expect from different versions, and should be carefully\nchosen based on the product plan.\n\nThe major version is also reflected in the package name of the\ninterface, which must end in `v\u003cmajor-version\u003e`, as in\n`google.feature.v1`. For major versions 0 and 1, the suffix can\nbe omitted. Zero major versions must only be used for\nexperimental, non-GA interfaces.\n",
+ "type": "string"
}
},
- "id": "Api",
- "description": "Api is a light-weight descriptor for an API Interface.\n\nInterfaces are also described as \"protocol buffer services\" in some contexts,\nsuch as by the \"service\" keyword in a .proto file, but they are different\nfrom API Services, which represent a concrete implementation of an interface\nas opposed to simply a description of methods and bindings. They are also\nsometimes simply referred to as \"APIs\" in other contexts, such as the name of\nthis message itself. See https://cloud.google.com/apis/design/glossary for\ndetailed terminology.",
- "type": "object"
+ "id": "Api"
},
"MetricRule": {
"description": "Bind API methods to metrics. Binding a method to a metric causes that\nmetric's configured quota behaviors to apply to the method call.",
@@ -888,25 +1463,25 @@
"id": "MetricRule"
},
"Authentication": {
- "id": "Authentication",
"description": "`Authentication` defines the authentication configuration for an API.\n\nExample for an API targeted for external use:\n\n name: calendar.googleapis.com\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth",
"type": "object",
"properties": {
- "rules": {
- "description": "A list of authentication rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
- "items": {
- "$ref": "AuthenticationRule"
- },
- "type": "array"
- },
"providers": {
"description": "Defines a set of authentication providers that a service supports.",
"items": {
"$ref": "AuthProvider"
},
"type": "array"
+ },
+ "rules": {
+ "description": "A list of authentication rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
+ "items": {
+ "$ref": "AuthenticationRule"
+ },
+ "type": "array"
}
- }
+ },
+ "id": "Authentication"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
@@ -917,12 +1492,12 @@
"type": "boolean"
},
"response": {
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- },
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
- "type": "object"
+ }
},
"name": {
"description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
@@ -933,17 +1508,18 @@
"description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
- "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- }
+ },
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object"
}
},
"id": "Operation"
},
"Page": {
+ "description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.",
"type": "object",
"properties": {
"subpages": {
@@ -962,22 +1538,12 @@
"type": "string"
}
},
- "id": "Page",
- "description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure."
+ "id": "Page"
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
- "code": {
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
@@ -988,6 +1554,15 @@
"type": "object"
},
"type": "array"
+ },
+ "code": {
+ "format": "int32",
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "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"
@@ -996,10 +1571,6 @@
"description": "Associates `members` with a `role`.",
"type": "object",
"properties": {
- "condition": {
- "$ref": "Expr",
- "description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently.\nThis field is GOOGLE_INTERNAL."
- },
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
"items": {
@@ -1010,6 +1581,10 @@
"role": {
"description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
"type": "string"
+ },
+ "condition": {
+ "$ref": "Expr",
+ "description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently.\nThis field is GOOGLE_INTERNAL."
}
},
"id": "Binding"
@@ -1041,60 +1616,36 @@
},
"id": "AuthProvider"
},
- "Service": {
+ "EnumValue": {
+ "description": "Enum value definition.",
"type": "object",
"properties": {
- "apis": {
- "description": "A list of API interfaces exported by this service. Only the `name` field\nof the google.protobuf.Api needs to be provided by the configuration\nauthor, as the remaining fields will be derived from the IDL during the\nnormalization process. It is an error to specify an API interface here\nwhich cannot be resolved against the associated IDL files.",
+ "options": {
+ "description": "Protocol buffer options.",
"items": {
- "$ref": "Api"
+ "$ref": "Option"
},
"type": "array"
},
- "logs": {
- "description": "Defines the logs used by this service.",
- "items": {
- "$ref": "LogDescriptor"
- },
- "type": "array"
+ "number": {
+ "format": "int32",
+ "description": "Enum value number.",
+ "type": "integer"
},
- "types": {
- "description": "A list of all proto message types included in this API service.\nTypes referenced directly or indirectly by the `apis` are\nautomatically included. Messages which are not referenced but\nshall be included, such as types used by the `google.protobuf.Any` type,\nshould be listed here by name. Example:\n\n types:\n - name: google.protobuf.Int32",
- "items": {
- "$ref": "Type"
- },
- "type": "array"
- },
- "sourceInfo": {
- "description": "Output only. The source information for this configuration if available.",
- "$ref": "SourceInfo"
- },
- "http": {
- "$ref": "Http",
- "description": "HTTP configuration."
- },
- "backend": {
- "description": "API backend configuration.",
- "$ref": "Backend"
- },
- "systemParameters": {
- "$ref": "SystemParameters",
- "description": "System parameter configuration."
- },
- "documentation": {
- "description": "Additional API documentation.",
- "$ref": "Documentation"
- },
- "logging": {
- "$ref": "Logging",
- "description": "Logging configuration."
- },
- "monitoredResources": {
- "description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging configurations.",
- "items": {
- "$ref": "MonitoredResourceDescriptor"
- },
- "type": "array"
+ "name": {
+ "description": "Enum value name.",
+ "type": "string"
+ }
+ },
+ "id": "EnumValue"
+ },
+ "Service": {
+ "description": "`Service` is the root object of Google service configuration schema. It\ndescribes basic information about a service, such as the name and the\ntitle, and delegates other aspects to sub-sections. Each sub-section is\neither a proto message or a repeated proto message that configures a\nspecific aspect, such as auth. See each proto message definition for details.\n\nExample:\n\n type: google.api.Service\n config_version: 3\n name: calendar.googleapis.com\n title: Google Calendar API\n apis:\n - name: google.calendar.v3.Calendar\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth",
+ "type": "object",
+ "properties": {
+ "context": {
+ "$ref": "Context",
+ "description": "Context configuration."
},
"enums": {
"description": "A list of all enum types included in this API service. Enums\nreferenced directly or indirectly by the `apis` are automatically\nincluded. Enums which are not referenced but shall be included\nshould be listed here by name. Example:\n\n enums:\n - name: google.someapi.v1.SomeEnum",
@@ -1103,10 +1654,6 @@
},
"type": "array"
},
- "context": {
- "description": "Context configuration.",
- "$ref": "Context"
- },
"id": {
"description": "A unique ID for a specific instance of this message, typically assigned\nby the client for tracking purpose. If empty, the server may choose to\ngenerate one instead.",
"type": "string"
@@ -1127,8 +1674,8 @@
"$ref": "Authentication"
},
"experimental": {
- "$ref": "Experimental",
- "description": "Experimental configuration."
+ "description": "Experimental configuration.",
+ "$ref": "Experimental"
},
"control": {
"$ref": "Control",
@@ -1143,10 +1690,6 @@
"description": "Monitoring configuration.",
"$ref": "Monitoring"
},
- "producerProjectId": {
- "description": "The Google project that owns this service.",
- "type": "string"
- },
"systemTypes": {
"description": "A list of all proto message types included in this API service.\nIt serves similar purpose as [google.api.Service.types], except that\nthese types are not needed by user-defined APIs. Therefore, they will not\nshow up in the generated discovery doc. This field should only be used\nto define system APIs in ESF.",
"items": {
@@ -1154,9 +1697,13 @@
},
"type": "array"
},
+ "producerProjectId": {
+ "description": "The Google project that owns this service.",
+ "type": "string"
+ },
"visibility": {
- "description": "API visibility configuration.",
- "$ref": "Visibility"
+ "$ref": "Visibility",
+ "description": "API visibility configuration."
},
"quota": {
"description": "Quota configuration.",
@@ -1184,44 +1731,72 @@
"$ref": "Endpoint"
},
"type": "array"
- }
- },
- "id": "Service",
- "description": "`Service` is the root object of Google service configuration schema. It\ndescribes basic information about a service, such as the name and the\ntitle, and delegates other aspects to sub-sections. Each sub-section is\neither a proto message or a repeated proto message that configures a\nspecific aspect, such as auth. See each proto message definition for details.\n\nExample:\n\n type: google.api.Service\n config_version: 3\n name: calendar.googleapis.com\n title: Google Calendar API\n apis:\n - name: google.calendar.v3.Calendar\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth"
- },
- "EnumValue": {
- "description": "Enum value definition.",
- "type": "object",
- "properties": {
- "options": {
- "description": "Protocol buffer options.",
+ },
+ "logs": {
+ "description": "Defines the logs used by this service.",
"items": {
- "$ref": "Option"
+ "$ref": "LogDescriptor"
},
"type": "array"
},
- "number": {
- "format": "int32",
- "description": "Enum value number.",
- "type": "integer"
+ "apis": {
+ "description": "A list of API interfaces exported by this service. Only the `name` field\nof the google.protobuf.Api needs to be provided by the configuration\nauthor, as the remaining fields will be derived from the IDL during the\nnormalization process. It is an error to specify an API interface here\nwhich cannot be resolved against the associated IDL files.",
+ "items": {
+ "$ref": "Api"
+ },
+ "type": "array"
},
- "name": {
- "type": "string",
- "description": "Enum value name."
+ "types": {
+ "description": "A list of all proto message types included in this API service.\nTypes referenced directly or indirectly by the `apis` are\nautomatically included. Messages which are not referenced but\nshall be included, such as types used by the `google.protobuf.Any` type,\nshould be listed here by name. Example:\n\n types:\n - name: google.protobuf.Int32",
+ "items": {
+ "$ref": "Type"
+ },
+ "type": "array"
+ },
+ "sourceInfo": {
+ "description": "Output only. The source information for this configuration if available.",
+ "$ref": "SourceInfo"
+ },
+ "http": {
+ "$ref": "Http",
+ "description": "HTTP configuration."
+ },
+ "backend": {
+ "$ref": "Backend",
+ "description": "API backend configuration."
+ },
+ "systemParameters": {
+ "$ref": "SystemParameters",
+ "description": "System parameter configuration."
+ },
+ "documentation": {
+ "$ref": "Documentation",
+ "description": "Additional API documentation."
+ },
+ "logging": {
+ "$ref": "Logging",
+ "description": "Logging configuration."
+ },
+ "monitoredResources": {
+ "description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging configurations.",
+ "items": {
+ "$ref": "MonitoredResourceDescriptor"
+ },
+ "type": "array"
}
},
- "id": "EnumValue"
+ "id": "Service"
},
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
"type": "object",
"properties": {
"operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "Operation"
},
- "type": "array",
- "description": "A list of operations that matches the specified filter in the request."
+ "type": "array"
},
"nextPageToken": {
"description": "The standard List next-page token.",
@@ -1240,11 +1815,11 @@
"type": "string"
},
"steps": {
+ "description": "Detailed status information for each step. The order is undetermined.",
"items": {
"$ref": "Step"
},
- "type": "array",
- "description": "Detailed status information for each step. The order is undetermined."
+ "type": "array"
},
"resourceNames": {
"description": "The full name of the resources that this operation is directly\nassociated with.",
@@ -1262,6 +1837,7 @@
"id": "OperationMetadata"
},
"CustomHttpPattern": {
+ "description": "A custom pattern is used for defining custom HTTP verb.",
"type": "object",
"properties": {
"kind": {
@@ -1273,8 +1849,7 @@
"type": "string"
}
},
- "id": "CustomHttpPattern",
- "description": "A custom pattern is used for defining custom HTTP verb."
+ "id": "CustomHttpPattern"
},
"SystemParameterRule": {
"description": "Define a system parameter rule mapping system parameter definitions to\nmethods.",
@@ -1294,41 +1869,22 @@
},
"id": "SystemParameterRule"
},
- "VisibilityRule": {
- "description": "A visibility rule provides visibility configuration for an individual API\nelement.",
- "type": "object",
- "properties": {
- "restriction": {
- "description": "A comma-separated list of visibility labels that apply to the `selector`.\nAny of the listed labels can be used to grant the visibility.\n\nIf a rule has multiple labels, removing one of the labels but not all of\nthem can break clients.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: GOOGLE_INTERNAL, TRUSTED_TESTER\n\nRemoving GOOGLE_INTERNAL from this restriction will break clients that\nrely on this method and only had access to it through GOOGLE_INTERNAL.",
- "type": "string"
- },
- "selector": {
- "description": "Selects methods, messages, fields, enums, etc. to which this rule applies.\n\nRefer to selector for syntax details.",
- "type": "string"
- }
- },
- "id": "VisibilityRule"
- },
"HttpRule": {
"description": "`HttpRule` defines the mapping of an RPC method to one or more HTTP\nREST API methods. The mapping specifies how different portions of the RPC\nrequest message are mapped to URL path, URL query parameters, and\nHTTP request body. The mapping is typically specified as an\n`google.api.http` annotation on the RPC method,\nsee \"google/api/annotations.proto\" for details.\n\nThe mapping consists of a field specifying the path template and\nmethod kind. The path template can refer to fields in the request\nmessage, as in the example below which describes a REST GET\noperation on a resource collection of messages:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}/{sub.subfield}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n SubMessage sub = 2; // `sub.subfield` is url-mapped\n }\n message Message {\n string text = 1; // content of the resource\n }\n\nThe same http annotation can alternatively be expressed inside the\n`GRPC API Configuration` YAML file.\n\n http:\n rules:\n - selector: \u003cproto_package_name\u003e.Messaging.GetMessage\n get: /v1/messages/{message_id}/{sub.subfield}\n\nThis definition enables an automatic, bidrectional mapping of HTTP\nJSON to RPC. Example:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456/foo` | `GetMessage(message_id: \"123456\" sub: SubMessage(subfield: \"foo\"))`\n\nIn general, not only fields but also field paths can be referenced\nfrom a path pattern. Fields mapped to the path pattern cannot be\nrepeated and must have a primitive (non-message) type.\n\nAny fields in the request message which are not bound by the path\npattern automatically become (optional) HTTP query\nparameters. Assume the following definition of the request message:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n int64 revision = 2; // becomes a parameter\n SubMessage sub = 3; // `sub.subfield` becomes a parameter\n }\n\n\nThis enables a HTTP JSON to RPC mapping as below:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))`\n\nNote that fields which are mapped to HTTP parameters must have a\nprimitive type or a repeated primitive type. Message types are not\nallowed. In the case of a repeated type, the parameter can be\nrepeated in the URL, as in `...?param=A¶m=B`.\n\nFor HTTP method kinds which allow a request body, the `body` field\nspecifies the mapping. Consider a REST update method on the\nmessage resource collection:\n\n\n service Messaging {\n rpc UpdateMessage(UpdateMessageRequest) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"message\"\n };\n }\n }\n message UpdateMessageRequest {\n string message_id = 1; // mapped to the URL\n Message message = 2; // mapped to the body\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled, where the\nrepresentation of the JSON in the request body is determined by\nprotos JSON encoding:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })`\n\nThe special name `*` can be used in the body mapping to define that\nevery field not bound by the path template should be mapped to the\nrequest body. This enables the following alternative definition of\nthe update method:\n\n service Messaging {\n rpc UpdateMessage(Message) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"*\"\n };\n }\n }\n message Message {\n string message_id = 1;\n string text = 2;\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" text: \"Hi!\")`\n\nNote that when using `*` in the body mapping, it is not possible to\nhave HTTP parameters, as all fields not bound by the path end in\nthe body. This makes this option more rarely used in practice of\ndefining REST APIs. The common usage of `*` is in custom methods\nwhich don't use the URL at all for transferring data.\n\nIt is possible to define multiple HTTP methods for one RPC by using\nthe `additional_bindings` option. Example:\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http) = {\n get: \"/v1/messages/{message_id}\"\n additional_bindings {\n get: \"/v1/users/{user_id}/messages/{message_id}\"\n }\n };\n }\n }\n message GetMessageRequest {\n string message_id = 1;\n string user_id = 2;\n }\n\n\nThis enables the following two alternative HTTP JSON to RPC\nmappings:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456` | `GetMessage(message_id: \"123456\")`\n`GET /v1/users/me/messages/123456` | `GetMessage(user_id: \"me\" message_id: \"123456\")`\n\n# Rules for HTTP mapping\n\nThe rules for mapping HTTP path, query parameters, and body fields\nto the request message are as follows:\n\n1. The `body` field specifies either `*` or a field path, or is\n omitted. If omitted, it indicates there is no HTTP request body.\n2. Leaf fields (recursive expansion of nested messages in the\n request) can be classified into three types:\n (a) Matched in the URL template.\n (b) Covered by body (if body is `*`, everything except (a) fields;\n else everything under the body field)\n (c) All other fields.\n3. URL query parameters found in the HTTP request are mapped to (c) fields.\n4. Any body sent with an HTTP request can contain only (b) fields.\n\nThe syntax of the path template is as follows:\n\n Template = \"/\" Segments [ Verb ] ;\n Segments = Segment { \"/\" Segment } ;\n Segment = \"*\" | \"**\" | LITERAL | Variable ;\n Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ;\n FieldPath = IDENT { \".\" IDENT } ;\n Verb = \":\" LITERAL ;\n\nThe syntax `*` matches a single path segment. The syntax `**` matches zero\nor more path segments, which must be the last part of the path except the\n`Verb`. The syntax `LITERAL` matches literal text in the path.\n\nThe syntax `Variable` matches part of the URL path as specified by its\ntemplate. A variable template must not contain other variables. If a variable\nmatches a single path segment, its template may be omitted, e.g. `{var}`\nis equivalent to `{var=*}`.\n\nIf a variable contains exactly one path segment, such as `\"{var}\"` or\n`\"{var=*}\"`, when such a variable is expanded into a URL path, all characters\nexcept `[-_.~0-9a-zA-Z]` are percent-encoded. Such variables show up in the\nDiscovery Document as `{var}`.\n\nIf a variable contains one or more path segments, such as `\"{var=foo/*}\"`\nor `\"{var=**}\"`, when such a variable is expanded into a URL path, all\ncharacters except `[-_.~/0-9a-zA-Z]` are percent-encoded. Such variables\nshow up in the Discovery Document as `{+var}`.\n\nNOTE: While the single segment variable matches the semantics of\n[RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2\nSimple String Expansion, the multi segment variable **does not** match\nRFC 6570 Reserved Expansion. The reason is that the Reserved Expansion\ndoes not expand special characters like `?` and `#`, which would lead\nto invalid URLs.\n\nNOTE: the field paths in variables and in the `body` must not refer to\nrepeated fields or map fields.",
"type": "object",
"properties": {
- "delete": {
- "description": "Used for deleting a resource.",
- "type": "string"
- },
"body": {
"description": "The name of the request field whose value is mapped to the HTTP body, or\n`*` for mapping all fields not captured by the path pattern to the HTTP\nbody. NOTE: the referred field must not be a repeated field and must be\npresent at the top-level of request message type.",
"type": "string"
},
- "mediaDownload": {
- "$ref": "MediaDownload",
- "description": "Use this only for Scotty Requests. Do not use this for bytestream methods.\nFor media support, add instead [][google.bytestream.RestByteStream] as an\nAPI to your configuration."
- },
"post": {
"description": "Used for creating a resource.",
"type": "string"
},
+ "mediaDownload": {
+ "description": "Use this only for Scotty Requests. Do not use this for bytestream methods.\nFor media support, add instead [][google.bytestream.RestByteStream] as an\nAPI to your configuration.",
+ "$ref": "MediaDownload"
+ },
"additionalBindings": {
"description": "Additional HTTP bindings for the selector. Nested bindings must\nnot contain an `additional_bindings` field themselves (that is,\nthe nesting may only be one level deep).",
"items": {
@@ -1349,38 +1905,57 @@
"type": "string"
},
"custom": {
- "$ref": "CustomHttpPattern",
- "description": "The custom pattern is used for specifying an HTTP method that is not\nincluded in the `pattern` field, such as HEAD, or \"*\" to leave the\nHTTP method unspecified for this rule. The wild-card rule is useful\nfor services that provide content to Web (HTML) clients."
+ "description": "The custom pattern is used for specifying an HTTP method that is not\nincluded in the `pattern` field, such as HEAD, or \"*\" to leave the\nHTTP method unspecified for this rule. The wild-card rule is useful\nfor services that provide content to Web (HTML) clients.",
+ "$ref": "CustomHttpPattern"
},
"patch": {
"description": "Used for updating a resource.",
"type": "string"
},
"get": {
- "type": "string",
- "description": "Used for listing and getting information about resources."
+ "description": "Used for listing and getting information about resources.",
+ "type": "string"
},
"put": {
"description": "Used for updating a resource.",
"type": "string"
+ },
+ "delete": {
+ "description": "Used for deleting a resource.",
+ "type": "string"
}
},
"id": "HttpRule"
},
+ "VisibilityRule": {
+ "description": "A visibility rule provides visibility configuration for an individual API\nelement.",
+ "type": "object",
+ "properties": {
+ "restriction": {
+ "description": "A comma-separated list of visibility labels that apply to the `selector`.\nAny of the listed labels can be used to grant the visibility.\n\nIf a rule has multiple labels, removing one of the labels but not all of\nthem can break clients.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: GOOGLE_INTERNAL, TRUSTED_TESTER\n\nRemoving GOOGLE_INTERNAL from this restriction will break clients that\nrely on this method and only had access to it through GOOGLE_INTERNAL.",
+ "type": "string"
+ },
+ "selector": {
+ "description": "Selects methods, messages, fields, enums, etc. to which this rule applies.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ }
+ },
+ "id": "VisibilityRule"
+ },
"MonitoringDestination": {
"description": "Configuration of a specific monitoring destination (the producer project\nor the consumer project).",
"type": "object",
"properties": {
- "monitoredResource": {
- "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section.",
- "type": "string"
- },
"metrics": {
"description": "Names of the metrics to report to this monitoring destination.\nEach name must be defined in Service.metrics section.",
"items": {
"type": "string"
},
"type": "array"
+ },
+ "monitoredResource": {
+ "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section.",
+ "type": "string"
}
},
"id": "MonitoringDestination"
@@ -1414,12 +1989,9 @@
"id": "SystemParameters"
},
"ConfigChange": {
+ "description": "Output generated from semantically comparing two versions of a service\nconfiguration.\n\nIncludes detailed information about a field that have changed with\napplicable advice about potential consequences for the change, such as\nbackwards-incompatibility.",
"type": "object",
"properties": {
- "newValue": {
- "description": "Value of the changed object in the new Service configuration,\nin JSON format. This field will not be populated if ChangeType == REMOVED.",
- "type": "string"
- },
"changeType": {
"description": "The type for this change, either ADDED, REMOVED, or MODIFIED.",
"type": "string",
@@ -1450,12 +2022,17 @@
"oldValue": {
"description": "Value of the changed object in the old Service configuration,\nin JSON format. This field will not be populated if ChangeType == ADDED.",
"type": "string"
+ },
+ "newValue": {
+ "description": "Value of the changed object in the new Service configuration,\nin JSON format. This field will not be populated if ChangeType == REMOVED.",
+ "type": "string"
}
},
- "id": "ConfigChange",
- "description": "Output generated from semantically comparing two versions of a service\nconfiguration.\n\nIncludes detailed information about a field that have changed with\napplicable advice about potential consequences for the change, such as\nbackwards-incompatibility."
+ "id": "ConfigChange"
},
"Quota": {
+ "description": "Quota configuration helps to achieve fairness and budgeting in service\nusage.\n\nThe quota configuration works this way:\n- The service configuration defines a set of metrics.\n- For API calls, the quota.metric_rules maps methods to metrics with\n corresponding costs.\n- The quota.limits defines limits on the metrics, which will be used for\n quota checks at runtime.\n\nAn example quota configuration in yaml format:\n\n quota:\n\n - name: apiWriteQpsPerProject\n metric: library.googleapis.com/write_calls\n unit: \"1/min/{project}\" # rate limit for consumer projects\n values:\n STANDARD: 10000\n\n\n # The metric rules bind all methods to the read_calls metric,\n # except for the UpdateBook and DeleteBook methods. These two methods\n # are mapped to the write_calls metric, with the UpdateBook method\n # consuming at twice rate as the DeleteBook method.\n metric_rules:\n - selector: \"*\"\n metric_costs:\n library.googleapis.com/read_calls: 1\n - selector: google.example.library.v1.LibraryService.UpdateBook\n metric_costs:\n library.googleapis.com/write_calls: 2\n - selector: google.example.library.v1.LibraryService.DeleteBook\n metric_costs:\n library.googleapis.com/write_calls: 1\n\n Corresponding Metric definition:\n\n metrics:\n - name: library.googleapis.com/read_calls\n display_name: Read requests\n metric_kind: DELTA\n value_type: INT64\n\n - name: library.googleapis.com/write_calls\n display_name: Write requests\n metric_kind: DELTA\n value_type: INT64",
+ "type": "object",
"properties": {
"limits": {
"description": "List of `QuotaLimit` definitions for the service.",
@@ -1472,21 +2049,27 @@
"type": "array"
}
},
- "id": "Quota",
- "description": "Quota configuration helps to achieve fairness and budgeting in service\nusage.\n\nThe quota configuration works this way:\n- The service configuration defines a set of metrics.\n- For API calls, the quota.metric_rules maps methods to metrics with\n corresponding costs.\n- The quota.limits defines limits on the metrics, which will be used for\n quota checks at runtime.\n\nAn example quota configuration in yaml format:\n\n quota:\n\n - name: apiWriteQpsPerProject\n metric: library.googleapis.com/write_calls\n unit: \"1/min/{project}\" # rate limit for consumer projects\n values:\n STANDARD: 10000\n\n\n # The metric rules bind all methods to the read_calls metric,\n # except for the UpdateBook and DeleteBook methods. These two methods\n # are mapped to the write_calls metric, with the UpdateBook method\n # consuming at twice rate as the DeleteBook method.\n metric_rules:\n - selector: \"*\"\n metric_costs:\n library.googleapis.com/read_calls: 1\n - selector: google.example.library.v1.LibraryService.UpdateBook\n metric_costs:\n library.googleapis.com/write_calls: 2\n - selector: google.example.library.v1.LibraryService.DeleteBook\n metric_costs:\n library.googleapis.com/write_calls: 1\n\n Corresponding Metric definition:\n\n metrics:\n - name: library.googleapis.com/read_calls\n display_name: Read requests\n metric_kind: DELTA\n value_type: INT64\n\n - name: library.googleapis.com/write_calls\n display_name: Write requests\n metric_kind: DELTA\n value_type: INT64",
- "type": "object"
+ "id": "Quota"
},
"Rollout": {
"description": "A rollout resource that defines how service configuration versions are pushed\nto control plane systems. Typically, you create a new version of the\nservice config, and then create a Rollout to push the service config.",
"type": "object",
"properties": {
+ "createdBy": {
+ "description": "The user who created the Rollout. Readonly.",
+ "type": "string"
+ },
+ "trafficPercentStrategy": {
+ "$ref": "TrafficPercentStrategy",
+ "description": "Google Service Control selects service configurations based on\ntraffic percentage."
+ },
"rolloutId": {
"description": "Optional unique identifier of this Rollout. Only lower case letters, digits\n and '-' are allowed.\n\nIf not specified by client, the server will generate one. The generated id\nwill have the form of \u003cdate\u003e\u003crevision number\u003e, where \"date\" is the create\ndate in ISO 8601 format. \"revision number\" is a monotonically increasing\npositive number that is reset every day for each service.\nAn example of the generated rollout_id is '2016-02-16r1'",
"type": "string"
},
"deleteServiceStrategy": {
- "description": "The strategy associated with a rollout to delete a `ManagedService`.\nReadonly.",
- "$ref": "DeleteServiceStrategy"
+ "$ref": "DeleteServiceStrategy",
+ "description": "The strategy associated with a rollout to delete a `ManagedService`.\nReadonly."
},
"createTime": {
"format": "google-datetime",
@@ -1494,8 +2077,6 @@
"type": "string"
},
"status": {
- "description": "The status of this rollout. Readonly. In case of a failed rollout,\nthe system will automatically rollback to the current Rollout\nversion. Readonly.",
- "type": "string",
"enumDescriptions": [
"No status specified.",
"The Rollout is in progress.",
@@ -1513,19 +2094,13 @@
"FAILED",
"PENDING",
"FAILED_ROLLED_BACK"
- ]
+ ],
+ "description": "The status of this rollout. Readonly. In case of a failed rollout,\nthe system will automatically rollback to the current Rollout\nversion. Readonly.",
+ "type": "string"
},
"serviceName": {
"description": "The name of the service associated with this Rollout.",
"type": "string"
- },
- "trafficPercentStrategy": {
- "description": "Google Service Control selects service configurations based on\ntraffic percentage.",
- "$ref": "TrafficPercentStrategy"
- },
- "createdBy": {
- "description": "The user who created the Rollout. Readonly.",
- "type": "string"
}
},
"id": "Rollout"
@@ -1534,16 +2109,16 @@
"description": "Request message for GenerateConfigReport method.",
"type": "object",
"properties": {
- "newConfig": {
+ "oldConfig": {
+ "description": "Service configuration against which the comparison will be done.\nFor this version of API, the supported types are\ngoogle.api.servicemanagement.v1.ConfigRef,\ngoogle.api.servicemanagement.v1.ConfigSource,\nand google.api.Service",
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- },
- "description": "Service configuration for which we want to generate the report.\nFor this version of API, the supported types are\ngoogle.api.servicemanagement.v1.ConfigRef,\ngoogle.api.servicemanagement.v1.ConfigSource,\nand google.api.Service",
- "type": "object"
+ }
},
- "oldConfig": {
- "description": "Service configuration against which the comparison will be done.\nFor this version of API, the supported types are\ngoogle.api.servicemanagement.v1.ConfigRef,\ngoogle.api.servicemanagement.v1.ConfigSource,\nand google.api.Service",
+ "newConfig": {
+ "description": "Service configuration for which we want to generate the report.\nFor this version of API, the supported types are\ngoogle.api.servicemanagement.v1.ConfigRef,\ngoogle.api.servicemanagement.v1.ConfigSource,\nand google.api.Service",
"type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
@@ -1563,8 +2138,8 @@
"type": "string"
},
"policy": {
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.",
- "$ref": "Policy"
+ "$ref": "Policy",
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
}
},
"id": "SetIamPolicyRequest"
@@ -1573,11 +2148,9 @@
"description": "Represents the status of one operation step.",
"type": "object",
"properties": {
- "description": {
- "description": "The short description of the step.",
- "type": "string"
- },
"status": {
+ "description": "The status code.",
+ "type": "string",
"enumDescriptions": [
"Unspecifed code.",
"The operation or step has completed without errors.",
@@ -1593,8 +2166,10 @@
"IN_PROGRESS",
"FAILED",
"CANCELLED"
- ],
- "description": "The status code.",
+ ]
+ },
+ "description": {
+ "description": "The short description of the step.",
"type": "string"
}
},
@@ -1629,12 +2204,12 @@
"type": "object",
"properties": {
"value": {
+ "description": "The option's value packed in an Any message. If the value is a primitive,\nthe corresponding wrapper type defined in google/protobuf/wrappers.proto\nshould be used. If the value is an enum, it should be stored as an int32\nvalue using the google.protobuf.Int32Value type.",
"type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- },
- "description": "The option's value packed in an Any message. If the value is a primitive,\nthe corresponding wrapper type defined in google/protobuf/wrappers.proto\nshould be used. If the value is an enum, it should be stored as an int32\nvalue using the google.protobuf.Int32Value type."
+ }
},
"name": {
"description": "The option's name. For protobuf built-in options (options defined in\ndescriptor.proto), this is the short name. For example, `\"map_entry\"`.\nFor custom options, it should be the fully-qualified name. For example,\n`\"google.api.http\"`.",
@@ -1664,63 +2239,25 @@
},
"id": "Logging"
},
- "QuotaLimit": {
- "id": "QuotaLimit",
- "description": "`QuotaLimit` defines a specific limit that applies over a specified duration\nfor a limit type. There can be at most one limit for a duration and limit\ntype combination defined within a `QuotaGroup`.",
- "type": "object",
- "properties": {
- "defaultLimit": {
- "format": "int64",
- "description": "Default number of tokens that can be consumed during the specified\nduration. This is the number of tokens assigned when a client\napplication developer activates the service for his/her project.\n\nSpecifying a value of 0 will block all requests. This can be used if you\nare provisioning quota to selected consumers and blocking others.\nSimilarly, a value of -1 will indicate an unlimited quota. No other\nnegative values are allowed.\n\nUsed by group-based quotas only.",
- "type": "string"
- },
- "description": {
- "description": "Optional. User-visible, extended description for this quota limit.\nShould be used only when more context is needed to understand this limit\nthan provided by the limit's display name (see: `display_name`).",
- "type": "string"
- },
- "metric": {
- "description": "The name of the metric this quota limit applies to. The quota limits with\nthe same metric will be checked together during runtime. The metric must be\ndefined within the service config.\n\nUsed by metric-based quotas only.",
- "type": "string"
- },
- "displayName": {
- "description": "User-visible display name for this limit.\nOptional. If not set, the UI will provide a default display name based on\nthe quota configuration. This field can be used to override the default\ndisplay name generated from the configuration.",
- "type": "string"
- },
- "values": {
- "additionalProperties": {
- "format": "int64",
- "type": "string"
- },
- "description": "Tiered limit values, currently only STANDARD is supported.",
- "type": "object"
- },
- "unit": {
- "description": "Specify the unit of the quota limit. It uses the same syntax as\nMetric.unit. The supported unit kinds are determined by the quota\nbackend system.\n\nThe [Google Service Control](https://cloud.google.com/service-control)\nsupports the following unit components:\n* One of the time intevals:\n * \"/min\" for quota every minute.\n * \"/d\" for quota every 24 hours, starting 00:00 US Pacific Time.\n * Otherwise the quota won't be reset by time, such as storage limit.\n* One and only one of the granted containers:\n * \"/{project}\" quota for a project\n\nHere are some examples:\n* \"1/min/{project}\" for quota per minute per project.\n\nNote: the order of unit components is insignificant.\nThe \"1\" at the beginning is required to follow the metric unit syntax.\n\nUsed by metric-based quotas only.",
- "type": "string"
- },
- "maxLimit": {
- "format": "int64",
- "description": "Maximum number of tokens that can be consumed during the specified\nduration. Client application developers can override the default limit up\nto this maximum. If specified, this value cannot be set to a value less\nthan the default limit. If not specified, it is set to the default limit.\n\nTo allow clients to apply overrides with no upper bound, set this to -1,\nindicating unlimited maximum quota.\n\nUsed by group-based quotas only.",
- "type": "string"
- },
- "name": {
- "type": "string",
- "description": "Name of the quota limit. The name is used to refer to the limit when\noverriding the default limit on per-consumer basis.\n\nFor metric-based quota limits, the name must be provided, and it must be\nunique within the service. The name can only include alphanumeric\ncharacters as well as '-'.\n\nThe maximum length of the limit name is 64 characters.\n\nThe name of a limit is used as a unique identifier for this limit.\nTherefore, once a limit has been put into use, its name should be\nimmutable. You can use the display_name field to provide a user-friendly\nname for the limit. The display name can be evolved over time without\naffecting the identity of the limit."
- },
- "freeTier": {
- "format": "int64",
- "description": "Free tier value displayed in the Developers Console for this limit.\nThe free tier is the number of tokens that will be subtracted from the\nbilled amount when billing is enabled.\nThis field can only be set on a limit with duration \"1d\", in a billable\ngroup; it is invalid on any other limit. If this field is not set, it\ndefaults to 0, indicating that there is no free tier for this service.\n\nUsed by group-based quotas only.",
- "type": "string"
- },
- "duration": {
- "description": "Duration of this limit in textual notation. Example: \"100s\", \"24h\", \"1d\".\nFor duration longer than a day, only multiple of days is supported. We\nsupport only \"100s\" and \"1d\" for now. Additional support will be added in\nthe future. \"0\" indicates indefinite duration.\n\nUsed by group-based quotas only.",
- "type": "string"
- }
- }
- },
"Method": {
+ "description": "Method represents a method of an API interface.",
"type": "object",
"properties": {
+ "responseTypeUrl": {
+ "description": "The URL of the output message type.",
+ "type": "string"
+ },
+ "options": {
+ "description": "Any metadata attached to the method.",
+ "items": {
+ "$ref": "Option"
+ },
+ "type": "array"
+ },
+ "responseStreaming": {
+ "description": "If true, the response is streamed.",
+ "type": "boolean"
+ },
"name": {
"description": "The simple name of this method.",
"type": "string"
@@ -1744,51 +2281,89 @@
],
"description": "The source syntax of this method.",
"type": "string"
- },
- "responseTypeUrl": {
- "description": "The URL of the output message type.",
- "type": "string"
- },
- "options": {
- "description": "Any metadata attached to the method.",
- "items": {
- "$ref": "Option"
- },
- "type": "array"
- },
- "responseStreaming": {
- "description": "If true, the response is streamed.",
- "type": "boolean"
}
},
- "id": "Method",
- "description": "Method represents a method of an API interface."
+ "id": "Method"
+ },
+ "QuotaLimit": {
+ "description": "`QuotaLimit` defines a specific limit that applies over a specified duration\nfor a limit type. There can be at most one limit for a duration and limit\ntype combination defined within a `QuotaGroup`.",
+ "type": "object",
+ "properties": {
+ "duration": {
+ "description": "Duration of this limit in textual notation. Example: \"100s\", \"24h\", \"1d\".\nFor duration longer than a day, only multiple of days is supported. We\nsupport only \"100s\" and \"1d\" for now. Additional support will be added in\nthe future. \"0\" indicates indefinite duration.\n\nUsed by group-based quotas only.",
+ "type": "string"
+ },
+ "freeTier": {
+ "format": "int64",
+ "description": "Free tier value displayed in the Developers Console for this limit.\nThe free tier is the number of tokens that will be subtracted from the\nbilled amount when billing is enabled.\nThis field can only be set on a limit with duration \"1d\", in a billable\ngroup; it is invalid on any other limit. If this field is not set, it\ndefaults to 0, indicating that there is no free tier for this service.\n\nUsed by group-based quotas only.",
+ "type": "string"
+ },
+ "defaultLimit": {
+ "format": "int64",
+ "description": "Default number of tokens that can be consumed during the specified\nduration. This is the number of tokens assigned when a client\napplication developer activates the service for his/her project.\n\nSpecifying a value of 0 will block all requests. This can be used if you\nare provisioning quota to selected consumers and blocking others.\nSimilarly, a value of -1 will indicate an unlimited quota. No other\nnegative values are allowed.\n\nUsed by group-based quotas only.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "User-visible display name for this limit.\nOptional. If not set, the UI will provide a default display name based on\nthe quota configuration. This field can be used to override the default\ndisplay name generated from the configuration.",
+ "type": "string"
+ },
+ "metric": {
+ "description": "The name of the metric this quota limit applies to. The quota limits with\nthe same metric will be checked together during runtime. The metric must be\ndefined within the service config.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Optional. User-visible, extended description for this quota limit.\nShould be used only when more context is needed to understand this limit\nthan provided by the limit's display name (see: `display_name`).",
+ "type": "string"
+ },
+ "values": {
+ "description": "Tiered limit values. You must specify this as a key:value pair, with an\ninteger value that is the maximum number of requests allowed for the\nspecified unit. Currently only STANDARD is supported.",
+ "type": "object",
+ "additionalProperties": {
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "unit": {
+ "description": "Specify the unit of the quota limit. It uses the same syntax as\nMetric.unit. The supported unit kinds are determined by the quota\nbackend system.\n\nHere are some examples:\n* \"1/min/{project}\" for quota per minute per project.\n\nNote: the order of unit components is insignificant.\nThe \"1\" at the beginning is required to follow the metric unit syntax.",
+ "type": "string"
+ },
+ "maxLimit": {
+ "format": "int64",
+ "description": "Maximum number of tokens that can be consumed during the specified\nduration. Client application developers can override the default limit up\nto this maximum. If specified, this value cannot be set to a value less\nthan the default limit. If not specified, it is set to the default limit.\n\nTo allow clients to apply overrides with no upper bound, set this to -1,\nindicating unlimited maximum quota.\n\nUsed by group-based quotas only.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the quota limit.\n\nThe name must be provided, and it must be unique within the service. The\nname can only include alphanumeric characters as well as '-'.\n\nThe maximum length of the limit name is 64 characters.",
+ "type": "string"
+ }
+ },
+ "id": "QuotaLimit"
},
"ListServiceRolloutsResponse": {
- "id": "ListServiceRolloutsResponse",
"description": "Response message for ListServiceRollouts method.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "The token of the next page of results.",
- "type": "string"
- },
"rollouts": {
"description": "The list of rollout resources.",
"items": {
"$ref": "Rollout"
},
"type": "array"
+ },
+ "nextPageToken": {
+ "description": "The token of the next page of results.",
+ "type": "string"
}
- }
+ },
+ "id": "ListServiceRolloutsResponse"
},
"ConfigRef": {
"description": "Represents a service configuration with its name and id.",
"type": "object",
"properties": {
"name": {
- "type": "string",
- "description": "Resource name of a service config. It must have the following\nformat: \"services/{service name}/configs/{config id}\"."
+ "description": "Resource name of a service config. It must have the following\nformat: \"services/{service name}/configs/{config id}\".",
+ "type": "string"
}
},
"id": "ConfigRef"
@@ -1802,28 +2377,17 @@
"type": "string"
},
"root": {
- "type": "string",
- "description": "If non-empty specifies a path under which inherited HTTP paths\nare rooted."
+ "description": "If non-empty specifies a path under which inherited HTTP paths\nare rooted.",
+ "type": "string"
}
},
"id": "Mixin"
},
"FlowOperationMetadata": {
+ "description": "The metadata associated with a long running operation resource.",
"type": "object",
"properties": {
- "flowName": {
- "description": "The name of the top-level flow corresponding to this operation.\nMust be equal to the \"name\" field for a FlowName enum.",
- "type": "string"
- },
- "resourceNames": {
- "description": "The full name of the resources that this flow is directly associated with.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
"cancelState": {
- "type": "string",
"enumDescriptions": [
"Default state, cancellable but not cancelled.",
"The operation has proceeded past the point of no return and cannot\nbe cancelled.",
@@ -1834,7 +2398,8 @@
"UNCANCELLABLE",
"CANCELLED"
],
- "description": "The state of the operation with respect to cancellation."
+ "description": "The state of the operation with respect to cancellation.",
+ "type": "string"
},
"deadline": {
"format": "google-datetime",
@@ -1847,39 +2412,49 @@
"type": "integer"
},
"startTime": {
- "type": "string",
"format": "google-datetime",
- "description": "The start time of the operation."
+ "description": "The start time of the operation.",
+ "type": "string"
},
"surface": {
- "enum": [
- "UNSPECIFIED_OP_SERVICE",
- "SERVICE_MANAGEMENT",
- "SERVICE_USAGE",
- "SERVICE_CONSUMER_MANAGEMENT"
- ],
"type": "string",
"enumDescriptions": [
"",
"",
"",
"TenancyUnit, ServiceNetworking fall under this"
+ ],
+ "enum": [
+ "UNSPECIFIED_OP_SERVICE",
+ "SERVICE_MANAGEMENT",
+ "SERVICE_USAGE",
+ "SERVICE_CONSUMER_MANAGEMENT"
]
+ },
+ "flowName": {
+ "description": "The name of the top-level flow corresponding to this operation.\nMust be equal to the \"name\" field for a FlowName enum.",
+ "type": "string"
+ },
+ "resourceNames": {
+ "description": "The full name of the resources that this flow is directly associated with.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
},
- "id": "FlowOperationMetadata",
- "description": "The metadata associated with a long running operation resource."
+ "id": "FlowOperationMetadata"
},
"CustomError": {
"description": "Customize service error responses. For example, list any service\nspecific protobuf types that can appear in error detail lists of\nerror responses.\n\nExample:\n\n custom_error:\n types:\n - google.foo.v1.CustomError\n - google.foo.v1.AnotherError",
"type": "object",
"properties": {
"types": {
+ "description": "The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.",
"items": {
"type": "string"
},
- "type": "array",
- "description": "The list of custom error detail types, e.g. 'google.foo.v1.CustomError'."
+ "type": "array"
},
"rules": {
"description": "The list of custom error rules that apply to individual API messages.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
@@ -1895,22 +2470,21 @@
"description": "Defines the HTTP configuration for an API service. It contains a list of\nHttpRule, each specifying the mapping of an RPC method\nto one or more HTTP REST API methods.",
"type": "object",
"properties": {
+ "fullyDecodeReservedExpansion": {
+ "description": "When set to true, URL path parmeters will be fully URI-decoded except in\ncases of single segment matches in reserved expansion, where \"%2F\" will be\nleft encoded.\n\nThe default behavior is to not decode RFC 6570 reserved characters in multi\nsegment matches.",
+ "type": "boolean"
+ },
"rules": {
"description": "A list of HTTP configuration rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
"items": {
"$ref": "HttpRule"
},
"type": "array"
- },
- "fullyDecodeReservedExpansion": {
- "description": "When set to true, URL path parmeters will be fully URI-decoded except in\ncases of single segment matches in reserved expansion, where \"%2F\" will be\nleft encoded.\n\nThe default behavior is to not decode RFC 6570 reserved characters in multi\nsegment matches.",
- "type": "boolean"
}
},
"id": "Http"
},
"SourceInfo": {
- "id": "SourceInfo",
"description": "Source information used to create a Service Config",
"type": "object",
"properties": {
@@ -1925,7 +2499,8 @@
},
"type": "array"
}
- }
+ },
+ "id": "SourceInfo"
},
"Control": {
"description": "Selects and configures the service controller used by the service. The\nservice controller handles features like abuse, quota, billing, logging,\nmonitoring, etc.",
@@ -1942,35 +2517,51 @@
"description": "Define a parameter's name and location. The parameter may be passed as either\nan HTTP header or a URL query parameter, and if both are passed the behavior\nis implementation-dependent.",
"type": "object",
"properties": {
+ "urlQueryParameter": {
+ "description": "Define the URL query parameter name to use for the parameter. It is case\nsensitive.",
+ "type": "string"
+ },
"httpHeader": {
"description": "Define the HTTP header name to use for the parameter. It is case\ninsensitive.",
"type": "string"
},
"name": {
- "type": "string",
- "description": "Define the name of the parameter, such as \"api_key\" . It is case sensitive."
- },
- "urlQueryParameter": {
- "description": "Define the URL query parameter name to use for the parameter. It is case\nsensitive.",
+ "description": "Define the name of the parameter, such as \"api_key\" . It is case sensitive.",
"type": "string"
}
},
"id": "SystemParameter"
},
- "Field": {
+ "Monitoring": {
+ "description": "Monitoring configuration of the service.\n\nThe example below shows how to configure monitored resources and metrics\nfor monitoring. In the example, a monitored resource and two metrics are\ndefined. The `library.googleapis.com/book/returned_count` metric is sent\nto both producer and consumer projects, whereas the\n`library.googleapis.com/book/overdue_count` metric is only sent to the\nconsumer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/returned_count\n metric_kind: DELTA\n value_type: INT64\n labels:\n - key: /customer_id\n - name: library.googleapis.com/book/overdue_count\n metric_kind: GAUGE\n value_type: INT64\n labels:\n - key: /customer_id\n monitoring:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n - library.googleapis.com/book/overdue_count",
+ "type": "object",
"properties": {
- "number": {
- "format": "int32",
- "description": "The field number.",
- "type": "integer"
+ "consumerDestinations": {
+ "description": "Monitoring configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none consumer destination.",
+ "items": {
+ "$ref": "MonitoringDestination"
+ },
+ "type": "array"
},
+ "producerDestinations": {
+ "description": "Monitoring configurations for sending metrics to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none producer destination.",
+ "items": {
+ "$ref": "MonitoringDestination"
+ },
+ "type": "array"
+ }
+ },
+ "id": "Monitoring"
+ },
+ "Field": {
+ "description": "A single field of a message type.",
+ "type": "object",
+ "properties": {
"jsonName": {
- "type": "string",
- "description": "The field JSON name."
+ "description": "The field JSON name.",
+ "type": "string"
},
"kind": {
- "description": "The field type.",
- "type": "string",
"enumDescriptions": [
"Field type unknown.",
"Field type double.",
@@ -2012,7 +2603,9 @@
"TYPE_SFIXED64",
"TYPE_SINT32",
"TYPE_SINT64"
- ]
+ ],
+ "description": "The field type.",
+ "type": "string"
},
"options": {
"description": "The protocol buffer options.",
@@ -2027,8 +2620,8 @@
"type": "integer"
},
"packed": {
- "type": "boolean",
- "description": "Whether to use alternative packed wire representation."
+ "description": "Whether to use alternative packed wire representation.",
+ "type": "boolean"
},
"cardinality": {
"enumDescriptions": [
@@ -2047,53 +2640,35 @@
"type": "string"
},
"defaultValue": {
- "type": "string",
- "description": "The string value of the default value of this field. Proto2 syntax only."
+ "description": "The string value of the default value of this field. Proto2 syntax only.",
+ "type": "string"
},
"name": {
- "type": "string",
- "description": "The field name."
+ "description": "The field name.",
+ "type": "string"
},
"typeUrl": {
"description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.Timestamp\"`.",
"type": "string"
- }
- },
- "id": "Field",
- "description": "A single field of a message type.",
- "type": "object"
- },
- "Monitoring": {
- "description": "Monitoring configuration of the service.\n\nThe example below shows how to configure monitored resources and metrics\nfor monitoring. In the example, a monitored resource and two metrics are\ndefined. The `library.googleapis.com/book/returned_count` metric is sent\nto both producer and consumer projects, whereas the\n`library.googleapis.com/book/overdue_count` metric is only sent to the\nconsumer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/returned_count\n metric_kind: DELTA\n value_type: INT64\n labels:\n - key: /customer_id\n - name: library.googleapis.com/book/overdue_count\n metric_kind: GAUGE\n value_type: INT64\n labels:\n - key: /customer_id\n monitoring:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n - library.googleapis.com/book/overdue_count",
- "type": "object",
- "properties": {
- "consumerDestinations": {
- "description": "Monitoring configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none consumer destination.",
- "items": {
- "$ref": "MonitoringDestination"
- },
- "type": "array"
},
- "producerDestinations": {
- "description": "Monitoring configurations for sending metrics to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none producer destination.",
- "items": {
- "$ref": "MonitoringDestination"
- },
- "type": "array"
+ "number": {
+ "format": "int32",
+ "description": "The field number.",
+ "type": "integer"
}
},
- "id": "Monitoring"
+ "id": "Field"
},
"TestIamPermissionsRequest": {
"description": "Request message for `TestIamPermissions` method.",
"type": "object",
"properties": {
"permissions": {
+ "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
"items": {
"type": "string"
},
- "type": "array",
- "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions)."
+ "type": "array"
}
},
"id": "TestIamPermissionsRequest"
@@ -2102,29 +2677,6 @@
"description": "Enum type definition.",
"type": "object",
"properties": {
- "options": {
- "description": "Protocol buffer options.",
- "items": {
- "$ref": "Option"
- },
- "type": "array"
- },
- "syntax": {
- "enumDescriptions": [
- "Syntax `proto2`.",
- "Syntax `proto3`."
- ],
- "enum": [
- "SYNTAX_PROTO2",
- "SYNTAX_PROTO3"
- ],
- "description": "The source syntax.",
- "type": "string"
- },
- "sourceContext": {
- "$ref": "SourceContext",
- "description": "The source context."
- },
"enumvalue": {
"description": "Enum value definitions.",
"items": {
@@ -2135,6 +2687,29 @@
"name": {
"description": "Enum type name.",
"type": "string"
+ },
+ "options": {
+ "description": "Protocol buffer options.",
+ "items": {
+ "$ref": "Option"
+ },
+ "type": "array"
+ },
+ "syntax": {
+ "description": "The source syntax.",
+ "type": "string",
+ "enumDescriptions": [
+ "Syntax `proto2`.",
+ "Syntax `proto3`."
+ ],
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ]
+ },
+ "sourceContext": {
+ "$ref": "SourceContext",
+ "description": "The source context."
}
},
"id": "Enum"
@@ -2143,10 +2718,6 @@
"description": "A description of a label.",
"type": "object",
"properties": {
- "key": {
- "description": "The label key.",
- "type": "string"
- },
"description": {
"description": "A human-readable description for the label.",
"type": "string"
@@ -2164,11 +2735,16 @@
],
"description": "The type of data that can be assigned to the label.",
"type": "string"
+ },
+ "key": {
+ "description": "The label key.",
+ "type": "string"
}
},
"id": "LabelDescriptor"
},
"Diagnostic": {
+ "description": "Represents a diagnostic message (error or warning)",
"type": "object",
"properties": {
"location": {
@@ -2176,7 +2752,6 @@
"type": "string"
},
"kind": {
- "type": "string",
"enumDescriptions": [
"Warnings and errors",
"Only errors"
@@ -2185,26 +2760,26 @@
"WARNING",
"ERROR"
],
- "description": "The kind of diagnostic information provided."
+ "description": "The kind of diagnostic information provided.",
+ "type": "string"
},
"message": {
"description": "Message describing the error or warning.",
"type": "string"
}
},
- "id": "Diagnostic",
- "description": "Represents a diagnostic message (error or warning)"
+ "id": "Diagnostic"
},
"EnableServiceRequest": {
+ "description": "Request message for EnableService method.",
+ "type": "object",
"properties": {
"consumerId": {
"description": "The identity of consumer resource which service enablement will be\napplied to.\n\nThe Google Service Management implementation accepts the following\nforms:\n- \"project:\u003cproject_id\u003e\"\n\nNote: this is made compatible with\ngoogle.api.servicecontrol.v1.Operation.consumer_id.",
"type": "string"
}
},
- "id": "EnableServiceRequest",
- "description": "Request message for EnableService method.",
- "type": "object"
+ "id": "EnableServiceRequest"
},
"Type": {
"description": "A protocol buffer message type.",
@@ -2235,31 +2810,29 @@
},
"type": "array"
},
+ "sourceContext": {
+ "$ref": "SourceContext",
+ "description": "The source context."
+ },
"syntax": {
+ "enumDescriptions": [
+ "Syntax `proto2`.",
+ "Syntax `proto3`."
+ ],
"enum": [
"SYNTAX_PROTO2",
"SYNTAX_PROTO3"
],
"description": "The source syntax.",
- "type": "string",
- "enumDescriptions": [
- "Syntax `proto2`.",
- "Syntax `proto3`."
- ]
- },
- "sourceContext": {
- "description": "The source context.",
- "$ref": "SourceContext"
+ "type": "string"
}
},
"id": "Type"
},
"GenerateConfigReportResponse": {
+ "description": "Response message for GenerateConfigReport method.",
+ "type": "object",
"properties": {
- "id": {
- "description": "ID of the service configuration this report belongs to.",
- "type": "string"
- },
"diagnostics": {
"description": "Errors / Linter warnings associated with the service definition this\nreport\nbelongs to.",
"items": {
@@ -2268,20 +2841,22 @@
"type": "array"
},
"serviceName": {
- "type": "string",
- "description": "Name of the service this report belongs to."
+ "description": "Name of the service this report belongs to.",
+ "type": "string"
},
"changeReports": {
+ "description": "list of ChangeReport, each corresponding to comparison between two\nservice configurations.",
"items": {
"$ref": "ChangeReport"
},
- "type": "array",
- "description": "list of ChangeReport, each corresponding to comparison between two\nservice configurations."
+ "type": "array"
+ },
+ "id": {
+ "description": "ID of the service configuration this report belongs to.",
+ "type": "string"
}
},
- "id": "GenerateConfigReportResponse",
- "description": "Response message for GenerateConfigReport method.",
- "type": "object"
+ "id": "GenerateConfigReportResponse"
},
"ListServiceConfigsResponse": {
"description": "Response message for ListServiceConfigs method.",
@@ -2306,13 +2881,14 @@
"type": "object",
"properties": {
"authorization": {
- "$ref": "AuthorizationConfig",
- "description": "Authorization configuration."
+ "description": "Authorization configuration.",
+ "$ref": "AuthorizationConfig"
}
},
"id": "Experimental"
},
"Backend": {
+ "description": "`Backend` defines the backend configuration for a service.",
"type": "object",
"properties": {
"rules": {
@@ -2323,13 +2899,16 @@
"type": "array"
}
},
- "id": "Backend",
- "description": "`Backend` defines the backend configuration for a service."
+ "id": "Backend"
},
"AuditConfig": {
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
"type": "object",
"properties": {
+ "service": {
+ "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
+ "type": "string"
+ },
"auditLogConfigs": {
"description": "The configuration for logging of each type of permission.\nNext ID: 4",
"items": {
@@ -2342,10 +2921,6 @@
"type": "string"
},
"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"
}
},
"id": "AuditConfig"
@@ -2354,899 +2929,324 @@
"description": "Request message for SubmitConfigSource method.",
"type": "object",
"properties": {
- "validateOnly": {
- "description": "Optional. If set, this will result in the generation of a\n`google.api.Service` configuration based on the `ConfigSource` provided,\nbut the generated config and the sources will NOT be persisted.",
- "type": "boolean"
- },
"configSource": {
"description": "The source configuration for the service.",
"$ref": "ConfigSource"
+ },
+ "validateOnly": {
+ "description": "Optional. If set, this will result in the generation of a\n`google.api.Service` configuration based on the `ConfigSource` provided,\nbut the generated config and the sources will NOT be persisted.",
+ "type": "boolean"
}
},
"id": "SubmitConfigSourceRequest"
+ },
+ "DocumentationRule": {
+ "description": "A documentation rule provides information about individual API elements.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "Description of the selected API(s).",
+ "type": "string"
+ },
+ "deprecationDescription": {
+ "description": "Deprecation description of the selected element(s). It can be provided if an\nelement is marked as `deprecated`.",
+ "type": "string"
+ },
+ "selector": {
+ "description": "The selector is a comma-separated list of patterns. Each pattern is a\nqualified name of the element which may end in \"*\", indicating a wildcard.\nWildcards are only allowed at the end and for a whole component of the\nqualified name, i.e. \"foo.*\" is ok, but not \"foo.b*\" or \"foo.*.bar\". To\nspecify a default for all applicable elements, the whole pattern \"*\"\nis used.",
+ "type": "string"
+ }
+ },
+ "id": "DocumentationRule"
+ },
+ "AuthorizationConfig": {
+ "description": "Configuration of authorization.\n\nThis section determines the authorization provider, if unspecified, then no\nauthorization check will be done.\n\nExample:\n\n experimental:\n authorization:\n provider: firebaserules.googleapis.com",
+ "type": "object",
+ "properties": {
+ "provider": {
+ "description": "The name of the authorization provider, such as\nfirebaserules.googleapis.com.",
+ "type": "string"
+ }
+ },
+ "id": "AuthorizationConfig"
+ },
+ "ContextRule": {
+ "description": "A context rule provides information about the context for an individual API\nelement.",
+ "type": "object",
+ "properties": {
+ "provided": {
+ "description": "A list of full type names of provided contexts.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "requested": {
+ "description": "A list of full type names of requested contexts.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "selector": {
+ "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ }
+ },
+ "id": "ContextRule"
+ },
+ "SourceContext": {
+ "description": "`SourceContext` represents information about the source of a\nprotobuf element, like the file in which it is defined.",
+ "type": "object",
+ "properties": {
+ "fileName": {
+ "description": "The path-qualified name of the .proto file that contained the associated\nprotobuf element. For example: `\"google/protobuf/source_context.proto\"`.",
+ "type": "string"
+ }
+ },
+ "id": "SourceContext"
+ },
+ "MetricDescriptor": {
+ "description": "Defines a metric type and its schema. Once a metric descriptor is created,\ndeleting or altering it stops data collection and makes the metric type's\nexisting data unusable.",
+ "type": "object",
+ "properties": {
+ "displayName": {
+ "description": "A concise name for the metric, which can be displayed in user interfaces.\nUse sentence case without an ending period, for example \"Request count\".\nThis field is optional but it is recommended to be set for any metrics\nassociated with user-visible concepts, such as Quota.",
+ "type": "string"
+ },
+ "description": {
+ "description": "A detailed description of the metric, which can be used in documentation.",
+ "type": "string"
+ },
+ "unit": {
+ "description": "The unit in which the metric value is reported. It is only applicable\nif the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The\nsupported units are a subset of [The Unified Code for Units of\nMeasure](http://unitsofmeasure.org/ucum.html) standard:\n\n**Basic units (UNIT)**\n\n* `bit` bit\n* `By` byte\n* `s` second\n* `min` minute\n* `h` hour\n* `d` day\n\n**Prefixes (PREFIX)**\n\n* `k` kilo (10**3)\n* `M` mega (10**6)\n* `G` giga (10**9)\n* `T` tera (10**12)\n* `P` peta (10**15)\n* `E` exa (10**18)\n* `Z` zetta (10**21)\n* `Y` yotta (10**24)\n* `m` milli (10**-3)\n* `u` micro (10**-6)\n* `n` nano (10**-9)\n* `p` pico (10**-12)\n* `f` femto (10**-15)\n* `a` atto (10**-18)\n* `z` zepto (10**-21)\n* `y` yocto (10**-24)\n* `Ki` kibi (2**10)\n* `Mi` mebi (2**20)\n* `Gi` gibi (2**30)\n* `Ti` tebi (2**40)\n\n**Grammar**\n\nThe grammar includes the dimensionless unit `1`, such as `1/s`.\n\nThe grammar also includes these connectors:\n\n* `/` division (as an infix operator, e.g. `1/s`).\n* `.` multiplication (as an infix operator, e.g. `GBy.d`)\n\nThe grammar for a unit is as follows:\n\n Expression = Component { \".\" Component } { \"/\" Component } ;\n\n Component = [ PREFIX ] UNIT [ Annotation ]\n | Annotation\n | \"1\"\n ;\n\n Annotation = \"{\" NAME \"}\" ;\n\nNotes:\n\n* `Annotation` is just a comment if it follows a `UNIT` and is\n equivalent to `1` if it is used alone. For examples,\n `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.\n* `NAME` is a sequence of non-blank printable ASCII characters not\n containing '{' or '}'.",
+ "type": "string"
+ },
+ "labels": {
+ "description": "The set of labels that can be used to describe a specific\ninstance of this metric type. For example, the\n`appengine.googleapis.com/http/server/response_latencies` metric\ntype has a label for the HTTP response code, `response_code`, so\nyou can look at latencies for successful responses or just\nfor responses that failed.",
+ "items": {
+ "$ref": "LabelDescriptor"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "The resource name of the metric descriptor.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The metric type, including its DNS name prefix. The type is not\nURL-encoded. All user-defined custom metric types have the DNS name\n`custom.googleapis.com`. Metric types should use a natural hierarchical\ngrouping. For example:\n\n \"custom.googleapis.com/invoice/paid/amount\"\n \"appengine.googleapis.com/http/server/response_latencies\"",
+ "type": "string"
+ },
+ "valueType": {
+ "description": "Whether the measurement is an integer, a floating-point number, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported.",
+ "type": "string",
+ "enumDescriptions": [
+ "Do not use this default value.",
+ "The value is a boolean.\nThis value type can be used only if the metric kind is `GAUGE`.",
+ "The value is a signed 64-bit integer.",
+ "The value is a double precision floating point number.",
+ "The value is a text string.\nThis value type can be used only if the metric kind is `GAUGE`.",
+ "The value is a `Distribution`.",
+ "The value is money."
+ ],
+ "enum": [
+ "VALUE_TYPE_UNSPECIFIED",
+ "BOOL",
+ "INT64",
+ "DOUBLE",
+ "STRING",
+ "DISTRIBUTION",
+ "MONEY"
+ ]
+ },
+ "metricKind": {
+ "enumDescriptions": [
+ "Do not use this default value.",
+ "An instantaneous measurement of a value.",
+ "The change in a value during a time interval.",
+ "A value accumulated over a time interval. Cumulative\nmeasurements in a time series should have the same start time\nand increasing end times, until an event resets the cumulative\nvalue to zero and sets a new start time for the following\npoints."
+ ],
+ "enum": [
+ "METRIC_KIND_UNSPECIFIED",
+ "GAUGE",
+ "DELTA",
+ "CUMULATIVE"
+ ],
+ "description": "Whether the metric records instantaneous values, changes to a value, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported.",
+ "type": "string"
+ }
+ },
+ "id": "MetricDescriptor"
+ },
+ "Billing": {
+ "description": "Billing related configuration of the service.\n\nThe following example shows how to configure monitored resources and metrics\nfor billing:\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/borrowed_count\n metric_kind: DELTA\n value_type: INT64\n billing:\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/borrowed_count",
+ "type": "object",
+ "properties": {
+ "consumerDestinations": {
+ "description": "Billing configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations per service, each one must have\na different monitored resource type. A metric can be used in at most\none consumer destination.",
+ "items": {
+ "$ref": "BillingDestination"
+ },
+ "type": "array"
+ }
+ },
+ "id": "Billing"
+ },
+ "Expr": {
+ "description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "description": {
+ "description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
+ "type": "string"
+ },
+ "expression": {
+ "description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
+ "type": "string"
+ }
+ },
+ "id": "Expr"
+ },
+ "ListServicesResponse": {
+ "description": "Response message for `ListServices` method.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Token that can be passed to `ListServices` to resume a paginated query.",
+ "type": "string"
+ },
+ "services": {
+ "description": "The returned services will only have the name field set.",
+ "items": {
+ "$ref": "ManagedService"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListServicesResponse"
+ },
+ "Endpoint": {
+ "description": "`Endpoint` describes a network endpoint that serves a set of APIs.\nA service may expose any number of endpoints, and all endpoints share the\nsame service configuration, such as quota configuration and monitoring\nconfiguration.\n\nExample service configuration:\n\n name: library-example.googleapis.com\n endpoints:\n # Below entry makes 'google.example.library.v1.Library'\n # API be served from endpoint address library-example.googleapis.com.\n # It also allows HTTP OPTIONS calls to be passed to the backend, for\n # it to decide whether the subsequent cross-origin request is\n # allowed to proceed.\n - name: library-example.googleapis.com\n allow_cors: true",
+ "type": "object",
+ "properties": {
+ "features": {
+ "description": "The list of features enabled on this endpoint.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "apis": {
+ "description": "The list of APIs served by this endpoint.\n\nIf no APIs are specified this translates to \"all APIs\" exported by the\nservice, as defined in the top-level service configuration.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "allowCors": {
+ "description": "Allowing\n[CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka\ncross-domain traffic, would allow the backends served from this endpoint to\nreceive and respond to HTTP OPTIONS requests. The response will be used by\nthe browser to determine whether the subsequent cross-origin request is\nallowed to proceed.",
+ "type": "boolean"
+ },
+ "aliases": {
+ "description": "DEPRECATED: This field is no longer supported. Instead of using aliases,\nplease specify multiple google.api.Endpoint for each of the intented\nalias.\n\nAdditional names that this endpoint will be hosted on.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "The canonical name of this endpoint.",
+ "type": "string"
+ },
+ "target": {
+ "description": "The specification of an Internet routable address of API frontend that will\nhandle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary).\nIt should be either a valid IPv4 address or a fully-qualified domain name.\nFor example, \"8.8.8.8\" or \"myservice.appspot.com\".",
+ "type": "string"
+ }
+ },
+ "id": "Endpoint"
+ },
+ "OAuthRequirements": {
+ "description": "OAuth scopes are a way to define data and permissions on data. For example,\nthere are scopes defined for \"Read-only access to Google Calendar\" and\n\"Access to Cloud Platform\". Users can consent to a scope for an application,\ngiving it permission to access that data on their behalf.\n\nOAuth scope specifications should be fairly coarse grained; a user will need\nto see and understand the text description of what your scope means.\n\nIn most cases: use one or at most two OAuth scopes for an entire family of\nproducts. If your product has multiple APIs, you should probably be sharing\nthe OAuth scope across all of those APIs.\n\nWhen you need finer grained OAuth consent screens: talk with your product\nmanagement about how developers will use them in practice.\n\nPlease note that even though each of the canonical scopes is enough for a\nrequest to be accepted and passed to the backend, a request can still fail\ndue to the backend requiring additional scopes or permissions.",
+ "type": "object",
+ "properties": {
+ "canonicalScopes": {
+ "description": "The list of publicly documented OAuth scopes that are allowed access. An\nOAuth token containing any of these scopes will be accepted.\n\nExample:\n\n canonical_scopes: https://www.googleapis.com/auth/calendar,\n https://www.googleapis.com/auth/calendar.read",
+ "type": "string"
+ }
+ },
+ "id": "OAuthRequirements"
+ },
+ "Usage": {
+ "description": "Configuration controlling usage of a service.",
+ "type": "object",
+ "properties": {
+ "producerNotificationChannel": {
+ "description": "The full resource name of a channel used for sending notifications to the\nservice producer.\n\nGoogle Service Management currently only supports\n[Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification\nchannel. To use Google Cloud Pub/Sub as the channel, this must be the name\nof a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format\ndocumented in https://cloud.google.com/pubsub/docs/overview.",
+ "type": "string"
+ },
+ "rules": {
+ "description": "A list of usage rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
+ "items": {
+ "$ref": "UsageRule"
+ },
+ "type": "array"
+ },
+ "requirements": {
+ "description": "Requirements that must be satisfied before a consumer project can use the\nservice. Each requirement is of the form \u003cservice.name\u003e/\u003crequirement-id\u003e;\nfor example 'serviceusage.googleapis.com/billing-enabled'.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "Usage"
+ },
+ "GetIamPolicyRequest": {
+ "description": "Request message for `GetIamPolicy` method.",
+ "type": "object",
+ "properties": {},
+ "id": "GetIamPolicyRequest"
+ },
+ "TestIamPermissionsResponse": {
+ "description": "Response message for `TestIamPermissions` method.",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "TestIamPermissionsResponse"
+ },
+ "Context": {
+ "description": "`Context` defines which contexts an API requests.\n\nExample:\n\n context:\n rules:\n - selector: \"*\"\n requested:\n - google.rpc.context.ProjectContext\n - google.rpc.context.OriginContext\n\nThe above specifies that all methods in the API request\n`google.rpc.context.ProjectContext` and\n`google.rpc.context.OriginContext`.\n\nAvailable context types are defined in package\n`google.rpc.context`.",
+ "type": "object",
+ "properties": {
+ "rules": {
+ "description": "A list of RPC context rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
+ "items": {
+ "$ref": "ContextRule"
+ },
+ "type": "array"
+ }
+ },
+ "id": "Context"
}
},
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
- "protocol": "rest",
- "canonicalName": "Service Management",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/service.management.readonly": {
- "description": "View your Google API service configuration"
- },
- "https://www.googleapis.com/auth/cloud-platform.read-only": {
- "description": "View your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/service.management": {
- "description": "Manage your Google API service configuration"
- }
- }
- }
- },
- "rootUrl": "https://servicemanagement.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "servicemanagement",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Google Service Management API",
- "ownerName": "Google",
- "resources": {
- "services": {
- "methods": {
- "get": {
- "description": "Gets a managed service. Authentication is required unless the service is\npublic.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ManagedService"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/service.management",
- "https://www.googleapis.com/auth/service.management.readonly"
- ],
- "parameters": {
- "serviceName": {
- "description": "The name of the service. See the `ServiceManager` overview for naming\nrequirements. For example: `example.googleapis.com`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/services/{serviceName}",
- "path": "v1/services/{serviceName}",
- "id": "servicemanagement.services.get"
- },
- "testIamPermissions": {
- "id": "servicemanagement.services.testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^services/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/service.management",
- "https://www.googleapis.com/auth/service.management.readonly"
- ],
- "flatPath": "v1/services/{servicesId}:testIamPermissions"
- },
- "getConfig": {
- "parameters": {
- "configId": {
- "location": "query",
- "description": "The id of the service configuration resource.",
- "type": "string"
- },
- "view": {
- "type": "string",
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "description": "Specifies which parts of the Service Config should be returned in the\nresponse."
- },
- "serviceName": {
- "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/service.management",
- "https://www.googleapis.com/auth/service.management.readonly"
- ],
- "flatPath": "v1/services/{serviceName}/config",
- "path": "v1/services/{serviceName}/config",
- "id": "servicemanagement.services.getConfig",
- "description": "Gets a service configuration (version) for a managed service.",
- "httpMethod": "GET",
- "parameterOrder": [
- "serviceName"
- ],
- "response": {
- "$ref": "Service"
- }
- },
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "serviceName"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "parameters": {
- "serviceName": {
- "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/services/{serviceName}",
- "path": "v1/services/{serviceName}",
- "id": "servicemanagement.services.delete",
- "description": "Deletes a managed service. This method will change the service to the\n`Soft-Delete` state for 30 days. Within this period, service producers may\ncall UndeleteService to restore the service.\nAfter 30 days, the service will be permanently deleted.\n\nOperation\u003cresponse: google.protobuf.Empty\u003e"
- },
- "enable": {
- "request": {
- "$ref": "EnableServiceRequest"
- },
- "description": "Enables a service for a project, so it can be used\nfor the project. See\n[Cloud Auth Guide](https://cloud.google.com/docs/authentication) for\nmore information.\n\nOperation\u003cresponse: EnableServiceResponse\u003e",
- "httpMethod": "POST",
- "parameterOrder": [
- "serviceName"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "parameters": {
- "serviceName": {
- "description": "Name of the service to enable. Specifying an unknown service name will\ncause the request to fail.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/services/{serviceName}:enable",
- "path": "v1/services/{serviceName}:enable",
- "id": "servicemanagement.services.enable"
- },
- "setIamPolicy": {
- "id": "servicemanagement.services.setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^services/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/services/{servicesId}:setIamPolicy"
- },
- "disable": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "POST",
- "parameters": {
- "serviceName": {
- "description": "Name of the service to disable. Specifying an unknown service name\nwill cause the request to fail.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "flatPath": "v1/services/{serviceName}:disable",
- "id": "servicemanagement.services.disable",
- "path": "v1/services/{serviceName}:disable",
- "description": "Disables a service for a project, so it can no longer be\nbe used for the project. It prevents accidental usage that may cause\nunexpected billing charges or security leaks.\n\nOperation\u003cresponse: DisableServiceResponse\u003e",
- "request": {
- "$ref": "DisableServiceRequest"
- }
- },
- "getIamPolicy": {
- "request": {
- "$ref": "GetIamPolicyRequest"
- },
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/service.management",
- "https://www.googleapis.com/auth/service.management.readonly"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^services/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/services/{servicesId}:getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "id": "servicemanagement.services.getIamPolicy"
- },
- "undelete": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "POST",
- "parameters": {
- "serviceName": {
- "location": "path",
- "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "flatPath": "v1/services/{serviceName}:undelete",
- "id": "servicemanagement.services.undelete",
- "path": "v1/services/{serviceName}:undelete",
- "description": "Revives a previously deleted managed service. The method restores the\nservice using the configuration at the time the service was deleted.\nThe target service must exist and must have been deleted within the\nlast 30 days.\n\nOperation\u003cresponse: UndeleteServiceResponse\u003e"
- },
- "list": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/service.management",
- "https://www.googleapis.com/auth/service.management.readonly"
- ],
- "parameters": {
- "consumerId": {
- "location": "query",
- "description": "Include services consumed by the specified consumer.\n\nThe Google Service Management implementation accepts the following\nforms:\n- project:\u003cproject_id\u003e",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "Token identifying which result to start with; returned by a previous list\ncall.",
- "type": "string"
- },
- "pageSize": {
- "format": "int32",
- "description": "Requested size of the next page of data.",
- "type": "integer",
- "location": "query"
- },
- "producerProjectId": {
- "description": "Include services produced by the specified project.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1/services",
- "path": "v1/services",
- "id": "servicemanagement.services.list",
- "description": "Lists managed services.\n\nReturns all public services. For authenticated users, also returns all\nservices the calling user has \"servicemanagement.services.get\" permission\nfor.\n\n**BETA:** If the caller specifies the `consumer_id`, it returns only the\nservices enabled on the consumer. The `consumer_id` must have the format\nof \"project:{PROJECT-ID}\".",
- "httpMethod": "GET",
- "parameterOrder": [],
- "response": {
- "$ref": "ListServicesResponse"
- }
- },
- "create": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "flatPath": "v1/services",
- "id": "servicemanagement.services.create",
- "path": "v1/services",
- "description": "Creates a new managed service.\nPlease note one producer project can own no more than 20 services.\n\nOperation\u003cresponse: ManagedService\u003e",
- "request": {
- "$ref": "ManagedService"
- }
- },
- "generateConfigReport": {
- "path": "v1/services:generateConfigReport",
- "id": "servicemanagement.services.generateConfigReport",
- "request": {
- "$ref": "GenerateConfigReportRequest"
- },
- "description": "Generates and returns a report (errors, warnings and changes from\nexisting configurations) associated with\nGenerateConfigReportRequest.new_value\n\nIf GenerateConfigReportRequest.old_value is specified,\nGenerateConfigReportRequest will contain a single ChangeReport based on the\ncomparison between GenerateConfigReportRequest.new_value and\nGenerateConfigReportRequest.old_value.\nIf GenerateConfigReportRequest.old_value is not specified, this method\nwill compare GenerateConfigReportRequest.new_value with the last pushed\nservice configuration.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "GenerateConfigReportResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "parameters": {},
- "flatPath": "v1/services:generateConfigReport"
- }
- },
- "resources": {
- "configs": {
- "methods": {
- "submit": {
- "request": {
- "$ref": "SubmitConfigSourceRequest"
- },
- "description": "Creates a new service configuration (version) for a managed service based\non\nuser-supplied configuration source files (for example: OpenAPI\nSpecification). This method stores the source configurations as well as the\ngenerated service configuration. To rollout the service configuration to\nother services,\nplease call CreateServiceRollout.\n\nOperation\u003cresponse: SubmitConfigSourceResponse\u003e",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "parameters": {
- "serviceName": {
- "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/services/{serviceName}/configs:submit",
- "id": "servicemanagement.services.configs.submit",
- "path": "v1/services/{serviceName}/configs:submit"
- },
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "serviceName",
- "configId"
- ],
- "response": {
- "$ref": "Service"
- },
- "parameters": {
- "serviceName": {
- "location": "path",
- "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
- "type": "string",
- "required": true
- },
- "configId": {
- "location": "path",
- "description": "The id of the service configuration resource.",
- "type": "string",
- "required": true
- },
- "view": {
- "description": "Specifies which parts of the Service Config should be returned in the\nresponse.",
- "type": "string",
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ]
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/service.management",
- "https://www.googleapis.com/auth/service.management.readonly"
- ],
- "flatPath": "v1/services/{serviceName}/configs/{configId}",
- "path": "v1/services/{serviceName}/configs/{configId}",
- "id": "servicemanagement.services.configs.get",
- "description": "Gets a service configuration (version) for a managed service."
- },
- "list": {
- "parameters": {
- "serviceName": {
- "location": "path",
- "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
- "type": "string",
- "required": true
- },
- "pageToken": {
- "location": "query",
- "description": "The token of the page to retrieve.",
- "type": "string"
- },
- "pageSize": {
- "format": "int32",
- "description": "The max number of items to include in the response list.",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/service.management",
- "https://www.googleapis.com/auth/service.management.readonly"
- ],
- "flatPath": "v1/services/{serviceName}/configs",
- "path": "v1/services/{serviceName}/configs",
- "id": "servicemanagement.services.configs.list",
- "description": "Lists the history of the service configuration for a managed service,\nfrom the newest to the oldest.",
- "httpMethod": "GET",
- "parameterOrder": [
- "serviceName"
- ],
- "response": {
- "$ref": "ListServiceConfigsResponse"
- }
- },
- "create": {
- "path": "v1/services/{serviceName}/configs",
- "id": "servicemanagement.services.configs.create",
- "description": "Creates a new service configuration (version) for a managed service.\nThis method only stores the service configuration. To roll out the service\nconfiguration to backend systems please call\nCreateServiceRollout.",
- "request": {
- "$ref": "Service"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "serviceName"
- ],
- "response": {
- "$ref": "Service"
- },
- "parameters": {
- "serviceName": {
- "location": "path",
- "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "flatPath": "v1/services/{serviceName}/configs"
- }
- }
- },
- "consumers": {
- "methods": {
- "setIamPolicy": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "parameters": {
- "resource": {
- "pattern": "^services/[^/]+/consumers/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "flatPath": "v1/services/{servicesId}/consumers/{consumersId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "id": "servicemanagement.services.consumers.setIamPolicy",
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "request": {
- "$ref": "SetIamPolicyRequest"
- }
- },
- "testIamPermissions": {
- "flatPath": "v1/services/{servicesId}/consumers/{consumersId}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "id": "servicemanagement.services.consumers.testIamPermissions",
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^services/[^/]+/consumers/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/service.management",
- "https://www.googleapis.com/auth/service.management.readonly"
- ]
- },
- "getIamPolicy": {
- "request": {
- "$ref": "GetIamPolicyRequest"
- },
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/service.management",
- "https://www.googleapis.com/auth/service.management.readonly"
- ],
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^services/[^/]+/consumers/[^/]+$"
- }
- },
- "flatPath": "v1/services/{servicesId}/consumers/{consumersId}:getIamPolicy",
- "id": "servicemanagement.services.consumers.getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy"
- }
- }
- },
- "rollouts": {
- "methods": {
- "get": {
- "flatPath": "v1/services/{serviceName}/rollouts/{rolloutId}",
- "id": "servicemanagement.services.rollouts.get",
- "path": "v1/services/{serviceName}/rollouts/{rolloutId}",
- "description": "Gets a service configuration rollout.",
- "response": {
- "$ref": "Rollout"
- },
- "parameterOrder": [
- "serviceName",
- "rolloutId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/service.management",
- "https://www.googleapis.com/auth/service.management.readonly"
- ],
- "parameters": {
- "serviceName": {
- "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "rolloutId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The id of the rollout resource."
- }
- }
- },
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListServiceRolloutsResponse"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/service.management",
- "https://www.googleapis.com/auth/service.management.readonly"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "The token of the page to retrieve.",
- "type": "string"
- },
- "pageSize": {
- "format": "int32",
- "description": "The max number of items to include in the response list.",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "description": "Use `filter` to return subset of rollouts.\nThe following filters are supported:\n -- To limit the results to only those in\n [status](google.api.servicemanagement.v1.RolloutStatus) 'SUCCESS',\n use filter='status=SUCCESS'\n -- To limit the results to those in\n [status](google.api.servicemanagement.v1.RolloutStatus) 'CANCELLED'\n or 'FAILED', use filter='status=CANCELLED OR status=FAILED'",
- "type": "string",
- "location": "query"
- },
- "serviceName": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`."
- }
- },
- "flatPath": "v1/services/{serviceName}/rollouts",
- "path": "v1/services/{serviceName}/rollouts",
- "id": "servicemanagement.services.rollouts.list",
- "description": "Lists the history of the service configuration rollouts for a managed\nservice, from the newest to the oldest."
- },
- "create": {
- "request": {
- "$ref": "Rollout"
- },
- "description": "Creates a new service configuration rollout. Based on rollout, the\nGoogle Service Management will roll out the service configurations to\ndifferent backend services. For example, the logging configuration will be\npushed to Google Cloud Logging.\n\nPlease note that any previous pending and running Rollouts and associated\nOperations will be automatically cancelled so that the latest Rollout will\nnot be blocked by previous Rollouts.\n\nOperation\u003cresponse: Rollout\u003e",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "parameters": {
- "serviceName": {
- "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/services/{serviceName}/rollouts",
- "id": "servicemanagement.services.rollouts.create",
- "path": "v1/services/{serviceName}/rollouts"
- }
- }
- }
- }
- },
- "operations": {
- "methods": {
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "parameters": {
- "name": {
- "description": "The name of the operation resource.",
- "type": "string",
- "required": true,
- "pattern": "^operations/.+$",
- "location": "path"
- }
- },
- "flatPath": "v1/operations/{operationsId}",
- "path": "v1/{+name}",
- "id": "servicemanagement.operations.get",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
- },
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [],
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameters": {
- "filter": {
- "location": "query",
- "description": "A string for filtering Operations.\n The following filter fields are supported:\n\n * serviceName: Required. Only `=` operator is allowed.\n * startTime: The time this job was started, in ISO 8601 format.\n Allowed operators are `\u003e=`, `\u003e`, `\u003c=`, and `\u003c`.\n * status: Can be `done`, `in_progress`, or `failed`. Allowed\n operators are `=`, and `!=`.\n\n Filter expression supports conjunction (AND) and disjunction (OR)\n logical operators. However, the serviceName restriction must be at the\n top-level and can only be combined with other restrictions via the AND\n logical operator.\n\n Examples:\n\n * `serviceName={some-service}.googleapis.com`\n * `serviceName={some-service}.googleapis.com AND startTime\u003e=\"2017-02-01\"`\n * `serviceName={some-service}.googleapis.com AND status=done`\n * `serviceName={some-service}.googleapis.com AND (status=done OR startTime\u003e=\"2017-02-01\")`",
- "type": "string"
- },
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "location": "query",
- "description": "Not used.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The maximum number of operations to return. If unspecified, defaults to\n50. The maximum value is 100.",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "flatPath": "v1/operations",
- "path": "v1/operations",
- "id": "servicemanagement.operations.list",
- "description": "Lists service operations that match the specified filter in the request."
- }
- }
- }
- },
- "parameters": {
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "$.xgafv": {
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format."
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "alt": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- }
- }
+ "protocol": "rest"
}
diff --git a/servicemanagement/v1/servicemanagement-gen.go b/servicemanagement/v1/servicemanagement-gen.go
index 3b78d94..fd9d350 100644
--- a/servicemanagement/v1/servicemanagement-gen.go
+++ b/servicemanagement/v1/servicemanagement-gen.go
@@ -835,6 +835,7 @@
// The following example shows how to configure monitored resources and
// metrics
// for billing:
+//
// monitored_resources:
// - type: library.googleapis.com/branch
// labels:
@@ -3344,6 +3345,9 @@
// user interfaces.
// Use sentence case without an ending period, for example "Request
// count".
+ // This field is optional but it is recommended to be set for any
+ // metrics
+ // associated with user-visible concepts, such as Quota.
DisplayName string `json:"displayName,omitempty"`
// Labels: The set of labels that can be used to describe a
@@ -3373,21 +3377,7 @@
// points.
MetricKind string `json:"metricKind,omitempty"`
- // Name: The resource name of the metric descriptor. Depending on
- // the
- // implementation, the name typically includes: (1) the parent resource
- // name
- // that defines the scope of the metric type or of its data; and (2)
- // the
- // metric's URL-encoded type, which also appears in the `type` field of
- // this
- // descriptor. For example, following is the resource name of a
- // custom
- // metric within the GCP project `my-project-id`:
- //
- //
- // "projects/my-project-id/metricDescriptors/custom.googleapis.com%2Finvo
- // ice%2Fpaid%2Famount"
+ // Name: The resource name of the metric descriptor.
Name string `json:"name,omitempty"`
// Type: The metric type, including its DNS name prefix. The type is
@@ -4426,31 +4416,15 @@
// the same metric will be checked together during runtime. The metric
// must be
// defined within the service config.
- //
- // Used by metric-based quotas only.
Metric string `json:"metric,omitempty"`
- // Name: Name of the quota limit. The name is used to refer to the limit
- // when
- // overriding the default limit on per-consumer basis.
+ // Name: Name of the quota limit.
//
- // For metric-based quota limits, the name must be provided, and it must
- // be
- // unique within the service. The name can only include
- // alphanumeric
- // characters as well as '-'.
+ // The name must be provided, and it must be unique within the service.
+ // The
+ // name can only include alphanumeric characters as well as '-'.
//
// The maximum length of the limit name is 64 characters.
- //
- // The name of a limit is used as a unique identifier for this
- // limit.
- // Therefore, once a limit has been put into use, its name should
- // be
- // immutable. You can use the display_name field to provide a
- // user-friendly
- // name for the limit. The display name can be evolved over time
- // without
- // affecting the identity of the limit.
Name string `json:"name,omitempty"`
// Unit: Specify the unit of the quota limit. It uses the same syntax
@@ -4459,28 +4433,19 @@
// quota
// backend system.
//
- // The [Google Service
- // Control](https://cloud.google.com/service-control)
- // supports the following unit components:
- // * One of the time intevals:
- // * "/min" for quota every minute.
- // * "/d" for quota every 24 hours, starting 00:00 US Pacific Time.
- // * Otherwise the quota won't be reset by time, such as storage
- // limit.
- // * One and only one of the granted containers:
- // * "/{project}" quota for a project
- //
// Here are some examples:
// * "1/min/{project}" for quota per minute per project.
//
// Note: the order of unit components is insignificant.
// The "1" at the beginning is required to follow the metric unit
// syntax.
- //
- // Used by metric-based quotas only.
Unit string `json:"unit,omitempty"`
- // Values: Tiered limit values, currently only STANDARD is supported.
+ // Values: Tiered limit values. You must specify this as a key:value
+ // pair, with an
+ // integer value that is the maximum number of requests allowed for
+ // the
+ // specified unit. Currently only STANDARD is supported.
Values map[string]string `json:"values,omitempty"`
// ForceSendFields is a list of field names (e.g. "DefaultLimit") to
@@ -5585,6 +5550,9 @@
// SkipServiceControl: True, if the method should skip service control.
// If so, no control plane
// feature (like quota and billing) will be enabled.
+ // This flag is used by ESP to allow some Endpoints customers to
+ // bypass
+ // Google internal checks.
SkipServiceControl bool `json:"skipServiceControl,omitempty"`
// ForceSendFields is a list of field names (e.g.
diff --git a/serviceuser/v1/serviceuser-api.json b/serviceuser/v1/serviceuser-api.json
index a7b24d6..a9fd0a2 100644
--- a/serviceuser/v1/serviceuser-api.json
+++ b/serviceuser/v1/serviceuser-api.json
@@ -1,995 +1,10 @@
{
- "resources": {
- "projects": {
- "resources": {
- "services": {
- "methods": {
- "disable": {
- "id": "serviceuser.projects.services.disable",
- "path": "v1/{+name}:disable",
- "request": {
- "$ref": "DisableServiceRequest"
- },
- "description": "Disable a service so it can no longer be used with a\nproject. This prevents unintended usage that may cause unexpected billing\ncharges or security leaks.\n\nOperation\u003cresponse: google.protobuf.Empty\u003e",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/services/[^/]+$",
- "location": "path",
- "description": "Name of the consumer and the service to disable for that consumer.\n\nThe Service User implementation accepts the following forms for consumer:\n- \"project:\u003cproject_id\u003e\"\n\nA valid path would be:\n- /v1/projects/my-project/services/servicemanagement.googleapis.com:disable",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/projects/{projectsId}/services/{servicesId}:disable"
- },
- "enable": {
- "path": "v1/{+name}:enable",
- "id": "serviceuser.projects.services.enable",
- "description": "Enable a service so it can be used with a project.\nSee [Cloud Auth Guide](https://cloud.google.com/docs/authentication) for\nmore information.\n\nOperation\u003cresponse: google.protobuf.Empty\u003e",
- "request": {
- "$ref": "EnableServiceRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "name": {
- "description": "Name of the consumer and the service to enable for that consumer.\n\nA valid path would be:\n- /v1/projects/my-project/services/servicemanagement.googleapis.com:enable",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/services/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "flatPath": "v1/projects/{projectsId}/services/{servicesId}:enable"
- },
- "list": {
- "description": "List enabled services for the specified consumer.",
- "response": {
- "$ref": "ListEnabledServicesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "pageToken": {
- "description": "Token identifying which result to start with; returned by a previous list\ncall.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "format": "int32",
- "description": "Requested size of the next page of data."
- },
- "parent": {
- "description": "List enabled services for the specified parent.\n\nAn example valid parent would be:\n- projects/my-project",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/services",
- "id": "serviceuser.projects.services.list",
- "path": "v1/{+parent}/services"
- }
- }
- }
- }
- },
- "services": {
- "methods": {
- "search": {
- "flatPath": "v1/services:search",
- "id": "serviceuser.services.search",
- "path": "v1/services:search",
- "description": "Search available services.\n\nWhen no filter is specified, returns all accessible services. For\nauthenticated users, also returns all services the calling user has\n\"servicemanagement.services.bind\" permission for.",
- "response": {
- "$ref": "SearchServicesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Token identifying which result to start with; returned by a previous list\ncall.",
- "type": "string"
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "format": "int32",
- "description": "Requested size of the next page of data."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- }
- }
- }
- },
- "parameters": {
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "alt": {
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- }
- },
- "version": "v1",
- "baseUrl": "https://serviceuser.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use.",
- "servicePath": "",
- "basePath": "",
- "id": "serviceuser:v1",
+ "revision": "20171006",
"documentationLink": "https://cloud.google.com/service-management/",
- "revision": "20170926",
+ "id": "serviceuser:v1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "SystemParameter": {
- "properties": {
- "name": {
- "type": "string",
- "description": "Define the name of the parameter, such as \"api_key\" . It is case sensitive."
- },
- "urlQueryParameter": {
- "description": "Define the URL query parameter name to use for the parameter. It is case\nsensitive.",
- "type": "string"
- },
- "httpHeader": {
- "description": "Define the HTTP header name to use for the parameter. It is case\ninsensitive.",
- "type": "string"
- }
- },
- "id": "SystemParameter",
- "description": "Define a parameter's name and location. The parameter may be passed as either\nan HTTP header or a URL query parameter, and if both are passed the behavior\nis implementation-dependent.",
- "type": "object"
- },
- "Field": {
- "description": "A single field of a message type.",
- "type": "object",
- "properties": {
- "options": {
- "description": "The protocol buffer options.",
- "items": {
- "$ref": "Option"
- },
- "type": "array"
- },
- "oneofIndex": {
- "format": "int32",
- "description": "The index of the field type in `Type.oneofs`, for message or enumeration\ntypes. The first type has index 1; zero means the type is not in the list.",
- "type": "integer"
- },
- "packed": {
- "type": "boolean",
- "description": "Whether to use alternative packed wire representation."
- },
- "cardinality": {
- "description": "The field cardinality.",
- "type": "string",
- "enumDescriptions": [
- "For fields with unknown cardinality.",
- "For optional fields.",
- "For required fields. Proto2 syntax only.",
- "For repeated fields."
- ],
- "enum": [
- "CARDINALITY_UNKNOWN",
- "CARDINALITY_OPTIONAL",
- "CARDINALITY_REQUIRED",
- "CARDINALITY_REPEATED"
- ]
- },
- "defaultValue": {
- "description": "The string value of the default value of this field. Proto2 syntax only.",
- "type": "string"
- },
- "name": {
- "description": "The field name.",
- "type": "string"
- },
- "typeUrl": {
- "description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.Timestamp\"`.",
- "type": "string"
- },
- "number": {
- "format": "int32",
- "description": "The field number.",
- "type": "integer"
- },
- "jsonName": {
- "description": "The field JSON name.",
- "type": "string"
- },
- "kind": {
- "description": "The field type.",
- "type": "string",
- "enumDescriptions": [
- "Field type unknown.",
- "Field type double.",
- "Field type float.",
- "Field type int64.",
- "Field type uint64.",
- "Field type int32.",
- "Field type fixed64.",
- "Field type fixed32.",
- "Field type bool.",
- "Field type string.",
- "Field type group. Proto2 syntax only, and deprecated.",
- "Field type message.",
- "Field type bytes.",
- "Field type uint32.",
- "Field type enum.",
- "Field type sfixed32.",
- "Field type sfixed64.",
- "Field type sint32.",
- "Field type sint64."
- ],
- "enum": [
- "TYPE_UNKNOWN",
- "TYPE_DOUBLE",
- "TYPE_FLOAT",
- "TYPE_INT64",
- "TYPE_UINT64",
- "TYPE_INT32",
- "TYPE_FIXED64",
- "TYPE_FIXED32",
- "TYPE_BOOL",
- "TYPE_STRING",
- "TYPE_GROUP",
- "TYPE_MESSAGE",
- "TYPE_BYTES",
- "TYPE_UINT32",
- "TYPE_ENUM",
- "TYPE_SFIXED32",
- "TYPE_SFIXED64",
- "TYPE_SINT32",
- "TYPE_SINT64"
- ]
- }
- },
- "id": "Field"
- },
- "Monitoring": {
- "description": "Monitoring configuration of the service.\n\nThe example below shows how to configure monitored resources and metrics\nfor monitoring. In the example, a monitored resource and two metrics are\ndefined. The `library.googleapis.com/book/returned_count` metric is sent\nto both producer and consumer projects, whereas the\n`library.googleapis.com/book/overdue_count` metric is only sent to the\nconsumer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/returned_count\n metric_kind: DELTA\n value_type: INT64\n labels:\n - key: /customer_id\n - name: library.googleapis.com/book/overdue_count\n metric_kind: GAUGE\n value_type: INT64\n labels:\n - key: /customer_id\n monitoring:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n - library.googleapis.com/book/overdue_count",
- "type": "object",
- "properties": {
- "consumerDestinations": {
- "description": "Monitoring configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none consumer destination.",
- "items": {
- "$ref": "MonitoringDestination"
- },
- "type": "array"
- },
- "producerDestinations": {
- "description": "Monitoring configurations for sending metrics to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none producer destination.",
- "items": {
- "$ref": "MonitoringDestination"
- },
- "type": "array"
- }
- },
- "id": "Monitoring"
- },
- "Enum": {
- "description": "Enum type definition.",
- "type": "object",
- "properties": {
- "enumvalue": {
- "description": "Enum value definitions.",
- "items": {
- "$ref": "EnumValue"
- },
- "type": "array"
- },
- "name": {
- "description": "Enum type name.",
- "type": "string"
- },
- "options": {
- "description": "Protocol buffer options.",
- "items": {
- "$ref": "Option"
- },
- "type": "array"
- },
- "syntax": {
- "enum": [
- "SYNTAX_PROTO2",
- "SYNTAX_PROTO3"
- ],
- "description": "The source syntax.",
- "type": "string",
- "enumDescriptions": [
- "Syntax `proto2`.",
- "Syntax `proto3`."
- ]
- },
- "sourceContext": {
- "description": "The source context.",
- "$ref": "SourceContext"
- }
- },
- "id": "Enum"
- },
- "LabelDescriptor": {
- "properties": {
- "valueType": {
- "enumDescriptions": [
- "A variable-length string. This is the default.",
- "Boolean; true or false.",
- "A 64-bit signed integer."
- ],
- "enum": [
- "STRING",
- "BOOL",
- "INT64"
- ],
- "description": "The type of data that can be assigned to the label.",
- "type": "string"
- },
- "key": {
- "description": "The label key.",
- "type": "string"
- },
- "description": {
- "description": "A human-readable description for the label.",
- "type": "string"
- }
- },
- "id": "LabelDescriptor",
- "description": "A description of a label.",
- "type": "object"
- },
- "EnableServiceRequest": {
- "id": "EnableServiceRequest",
- "description": "Request message for EnableService method.",
- "type": "object",
- "properties": {}
- },
- "Type": {
- "description": "A protocol buffer message type.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The fully qualified message name.",
- "type": "string"
- },
- "oneofs": {
- "description": "The list of types appearing in `oneof` definitions in this type.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "syntax": {
- "description": "The source syntax.",
- "type": "string",
- "enumDescriptions": [
- "Syntax `proto2`.",
- "Syntax `proto3`."
- ],
- "enum": [
- "SYNTAX_PROTO2",
- "SYNTAX_PROTO3"
- ]
- },
- "sourceContext": {
- "description": "The source context.",
- "$ref": "SourceContext"
- },
- "options": {
- "description": "The protocol buffer options.",
- "items": {
- "$ref": "Option"
- },
- "type": "array"
- },
- "fields": {
- "description": "The list of fields.",
- "items": {
- "$ref": "Field"
- },
- "type": "array"
- }
- },
- "id": "Type"
- },
- "Experimental": {
- "description": "Experimental service configuration. These configuration options can\nonly be used by whitelisted users.",
- "type": "object",
- "properties": {
- "authorization": {
- "description": "Authorization configuration.",
- "$ref": "AuthorizationConfig"
- }
- },
- "id": "Experimental"
- },
- "Backend": {
- "description": "`Backend` defines the backend configuration for a service.",
- "type": "object",
- "properties": {
- "rules": {
- "description": "A list of API backend rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
- "items": {
- "$ref": "BackendRule"
- },
- "type": "array"
- }
- },
- "id": "Backend"
- },
- "DocumentationRule": {
- "description": "A documentation rule provides information about individual API elements.",
- "type": "object",
- "properties": {
- "deprecationDescription": {
- "description": "Deprecation description of the selected element(s). It can be provided if an\nelement is marked as `deprecated`.",
- "type": "string"
- },
- "selector": {
- "description": "The selector is a comma-separated list of patterns. Each pattern is a\nqualified name of the element which may end in \"*\", indicating a wildcard.\nWildcards are only allowed at the end and for a whole component of the\nqualified name, i.e. \"foo.*\" is ok, but not \"foo.b*\" or \"foo.*.bar\". To\nspecify a default for all applicable elements, the whole pattern \"*\"\nis used.",
- "type": "string"
- },
- "description": {
- "description": "Description of the selected API(s).",
- "type": "string"
- }
- },
- "id": "DocumentationRule"
- },
- "AuthorizationConfig": {
- "id": "AuthorizationConfig",
- "description": "Configuration of authorization.\n\nThis section determines the authorization provider, if unspecified, then no\nauthorization check will be done.\n\nExample:\n\n experimental:\n authorization:\n provider: firebaserules.googleapis.com",
- "type": "object",
- "properties": {
- "provider": {
- "description": "The name of the authorization provider, such as\nfirebaserules.googleapis.com.",
- "type": "string"
- }
- }
- },
- "ContextRule": {
- "id": "ContextRule",
- "description": "A context rule provides information about the context for an individual API\nelement.",
- "type": "object",
- "properties": {
- "selector": {
- "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
- "type": "string"
- },
- "provided": {
- "description": "A list of full type names of provided contexts.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "requested": {
- "description": "A list of full type names of requested contexts.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- }
- },
- "SourceContext": {
- "properties": {
- "fileName": {
- "description": "The path-qualified name of the .proto file that contained the associated\nprotobuf element. For example: `\"google/protobuf/source_context.proto\"`.",
- "type": "string"
- }
- },
- "id": "SourceContext",
- "description": "`SourceContext` represents information about the source of a\nprotobuf element, like the file in which it is defined.",
- "type": "object"
- },
- "MetricDescriptor": {
- "description": "Defines a metric type and its schema. Once a metric descriptor is created,\ndeleting or altering it stops data collection and makes the metric type's\nexisting data unusable.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The resource name of the metric descriptor. Depending on the\nimplementation, the name typically includes: (1) the parent resource name\nthat defines the scope of the metric type or of its data; and (2) the\nmetric's URL-encoded type, which also appears in the `type` field of this\ndescriptor. For example, following is the resource name of a custom\nmetric within the GCP project `my-project-id`:\n\n \"projects/my-project-id/metricDescriptors/custom.googleapis.com%2Finvoice%2Fpaid%2Famount\"",
- "type": "string"
- },
- "type": {
- "type": "string",
- "description": "The metric type, including its DNS name prefix. The type is not\nURL-encoded. All user-defined custom metric types have the DNS name\n`custom.googleapis.com`. Metric types should use a natural hierarchical\ngrouping. For example:\n\n \"custom.googleapis.com/invoice/paid/amount\"\n \"appengine.googleapis.com/http/server/response_latencies\""
- },
- "valueType": {
- "type": "string",
- "enumDescriptions": [
- "Do not use this default value.",
- "The value is a boolean.\nThis value type can be used only if the metric kind is `GAUGE`.",
- "The value is a signed 64-bit integer.",
- "The value is a double precision floating point number.",
- "The value is a text string.\nThis value type can be used only if the metric kind is `GAUGE`.",
- "The value is a `Distribution`.",
- "The value is money."
- ],
- "enum": [
- "VALUE_TYPE_UNSPECIFIED",
- "BOOL",
- "INT64",
- "DOUBLE",
- "STRING",
- "DISTRIBUTION",
- "MONEY"
- ],
- "description": "Whether the measurement is an integer, a floating-point number, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported."
- },
- "metricKind": {
- "enumDescriptions": [
- "Do not use this default value.",
- "An instantaneous measurement of a value.",
- "The change in a value during a time interval.",
- "A value accumulated over a time interval. Cumulative\nmeasurements in a time series should have the same start time\nand increasing end times, until an event resets the cumulative\nvalue to zero and sets a new start time for the following\npoints."
- ],
- "enum": [
- "METRIC_KIND_UNSPECIFIED",
- "GAUGE",
- "DELTA",
- "CUMULATIVE"
- ],
- "description": "Whether the metric records instantaneous values, changes to a value, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported.",
- "type": "string"
- },
- "displayName": {
- "description": "A concise name for the metric, which can be displayed in user interfaces.\nUse sentence case without an ending period, for example \"Request count\".",
- "type": "string"
- },
- "description": {
- "description": "A detailed description of the metric, which can be used in documentation.",
- "type": "string"
- },
- "unit": {
- "description": "The unit in which the metric value is reported. It is only applicable\nif the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The\nsupported units are a subset of [The Unified Code for Units of\nMeasure](http://unitsofmeasure.org/ucum.html) standard:\n\n**Basic units (UNIT)**\n\n* `bit` bit\n* `By` byte\n* `s` second\n* `min` minute\n* `h` hour\n* `d` day\n\n**Prefixes (PREFIX)**\n\n* `k` kilo (10**3)\n* `M` mega (10**6)\n* `G` giga (10**9)\n* `T` tera (10**12)\n* `P` peta (10**15)\n* `E` exa (10**18)\n* `Z` zetta (10**21)\n* `Y` yotta (10**24)\n* `m` milli (10**-3)\n* `u` micro (10**-6)\n* `n` nano (10**-9)\n* `p` pico (10**-12)\n* `f` femto (10**-15)\n* `a` atto (10**-18)\n* `z` zepto (10**-21)\n* `y` yocto (10**-24)\n* `Ki` kibi (2**10)\n* `Mi` mebi (2**20)\n* `Gi` gibi (2**30)\n* `Ti` tebi (2**40)\n\n**Grammar**\n\nThe grammar includes the dimensionless unit `1`, such as `1/s`.\n\nThe grammar also includes these connectors:\n\n* `/` division (as an infix operator, e.g. `1/s`).\n* `.` multiplication (as an infix operator, e.g. `GBy.d`)\n\nThe grammar for a unit is as follows:\n\n Expression = Component { \".\" Component } { \"/\" Component } ;\n\n Component = [ PREFIX ] UNIT [ Annotation ]\n | Annotation\n | \"1\"\n ;\n\n Annotation = \"{\" NAME \"}\" ;\n\nNotes:\n\n* `Annotation` is just a comment if it follows a `UNIT` and is\n equivalent to `1` if it is used alone. For examples,\n `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.\n* `NAME` is a sequence of non-blank printable ASCII characters not\n containing '{' or '}'.",
- "type": "string"
- },
- "labels": {
- "description": "The set of labels that can be used to describe a specific\ninstance of this metric type. For example, the\n`appengine.googleapis.com/http/server/response_latencies` metric\ntype has a label for the HTTP response code, `response_code`, so\nyou can look at latencies for successful responses or just\nfor responses that failed.",
- "items": {
- "$ref": "LabelDescriptor"
- },
- "type": "array"
- }
- },
- "id": "MetricDescriptor"
- },
- "Billing": {
- "id": "Billing",
- "description": "Billing related configuration of the service.\n\nThe following example shows how to configure monitored resources and metrics\nfor billing:\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/borrowed_count\n metric_kind: DELTA\n value_type: INT64\n billing:\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/borrowed_count",
- "type": "object",
- "properties": {
- "consumerDestinations": {
- "description": "Billing configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations per service, each one must have\na different monitored resource type. A metric can be used in at most\none consumer destination.",
- "items": {
- "$ref": "BillingDestination"
- },
- "type": "array"
- }
- }
- },
- "Endpoint": {
- "type": "object",
- "properties": {
- "name": {
- "description": "The canonical name of this endpoint.",
- "type": "string"
- },
- "target": {
- "description": "The specification of an Internet routable address of API frontend that will\nhandle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary).\nIt should be either a valid IPv4 address or a fully-qualified domain name.\nFor example, \"8.8.8.8\" or \"myservice.appspot.com\".",
- "type": "string"
- },
- "features": {
- "description": "The list of features enabled on this endpoint.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "apis": {
- "description": "The list of APIs served by this endpoint.\n\nIf no APIs are specified this translates to \"all APIs\" exported by the\nservice, as defined in the top-level service configuration.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "allowCors": {
- "description": "Allowing\n[CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka\ncross-domain traffic, would allow the backends served from this endpoint to\nreceive and respond to HTTP OPTIONS requests. The response will be used by\nthe browser to determine whether the subsequent cross-origin request is\nallowed to proceed.",
- "type": "boolean"
- },
- "aliases": {
- "description": "DEPRECATED: This field is no longer supported. Instead of using aliases,\nplease specify multiple google.api.Endpoint for each of the intented\nalias.\n\nAdditional names that this endpoint will be hosted on.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "Endpoint",
- "description": "`Endpoint` describes a network endpoint that serves a set of APIs.\nA service may expose any number of endpoints, and all endpoints share the\nsame service configuration, such as quota configuration and monitoring\nconfiguration.\n\nExample service configuration:\n\n name: library-example.googleapis.com\n endpoints:\n # Below entry makes 'google.example.library.v1.Library'\n # API be served from endpoint address library-example.googleapis.com.\n # It also allows HTTP OPTIONS calls to be passed to the backend, for\n # it to decide whether the subsequent cross-origin request is\n # allowed to proceed.\n - name: library-example.googleapis.com\n allow_cors: true"
- },
- "ListEnabledServicesResponse": {
- "description": "Response message for `ListEnabledServices` method.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Token that can be passed to `ListEnabledServices` to resume a paginated\nquery.",
- "type": "string"
- },
- "services": {
- "description": "Services enabled for the specified parent.",
- "items": {
- "$ref": "PublishedService"
- },
- "type": "array"
- }
- },
- "id": "ListEnabledServicesResponse"
- },
- "OAuthRequirements": {
- "description": "OAuth scopes are a way to define data and permissions on data. For example,\nthere are scopes defined for \"Read-only access to Google Calendar\" and\n\"Access to Cloud Platform\". Users can consent to a scope for an application,\ngiving it permission to access that data on their behalf.\n\nOAuth scope specifications should be fairly coarse grained; a user will need\nto see and understand the text description of what your scope means.\n\nIn most cases: use one or at most two OAuth scopes for an entire family of\nproducts. If your product has multiple APIs, you should probably be sharing\nthe OAuth scope across all of those APIs.\n\nWhen you need finer grained OAuth consent screens: talk with your product\nmanagement about how developers will use them in practice.\n\nPlease note that even though each of the canonical scopes is enough for a\nrequest to be accepted and passed to the backend, a request can still fail\ndue to the backend requiring additional scopes or permissions.",
- "type": "object",
- "properties": {
- "canonicalScopes": {
- "description": "The list of publicly documented OAuth scopes that are allowed access. An\nOAuth token containing any of these scopes will be accepted.\n\nExample:\n\n canonical_scopes: https://www.googleapis.com/auth/calendar,\n https://www.googleapis.com/auth/calendar.read",
- "type": "string"
- }
- },
- "id": "OAuthRequirements"
- },
- "Usage": {
- "type": "object",
- "properties": {
- "producerNotificationChannel": {
- "description": "The full resource name of a channel used for sending notifications to the\nservice producer.\n\nGoogle Service Management currently only supports\n[Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification\nchannel. To use Google Cloud Pub/Sub as the channel, this must be the name\nof a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format\ndocumented in https://cloud.google.com/pubsub/docs/overview.",
- "type": "string"
- },
- "rules": {
- "description": "A list of usage rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
- "items": {
- "$ref": "UsageRule"
- },
- "type": "array"
- },
- "requirements": {
- "description": "Requirements that must be satisfied before a consumer project can use the\nservice. Each requirement is of the form \u003cservice.name\u003e/\u003crequirement-id\u003e;\nfor example 'serviceusage.googleapis.com/billing-enabled'.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "Usage",
- "description": "Configuration controlling usage of a service."
- },
- "Context": {
- "description": "`Context` defines which contexts an API requests.\n\nExample:\n\n context:\n rules:\n - selector: \"*\"\n requested:\n - google.rpc.context.ProjectContext\n - google.rpc.context.OriginContext\n\nThe above specifies that all methods in the API request\n`google.rpc.context.ProjectContext` and\n`google.rpc.context.OriginContext`.\n\nAvailable context types are defined in package\n`google.rpc.context`.",
- "type": "object",
- "properties": {
- "rules": {
- "description": "A list of RPC context rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
- "items": {
- "$ref": "ContextRule"
- },
- "type": "array"
- }
- },
- "id": "Context"
- },
- "LogDescriptor": {
- "description": "A description of a log type. Example in YAML format:\n\n - name: library.googleapis.com/activity_history\n description: The history of borrowing and returning library items.\n display_name: Activity\n labels:\n - key: /customer_id\n description: Identifier of a library customer",
- "type": "object",
- "properties": {
- "name": {
- "description": "The name of the log. It must be less than 512 characters long and can\ninclude the following characters: upper- and lower-case alphanumeric\ncharacters [A-Za-z0-9], and punctuation characters including\nslash, underscore, hyphen, period [/_-.].",
- "type": "string"
- },
- "displayName": {
- "description": "The human-readable name for this log. This information appears on\nthe user interface and should be concise.",
- "type": "string"
- },
- "description": {
- "type": "string",
- "description": "A human-readable description of this log. This information appears in\nthe documentation and can contain details."
- },
- "labels": {
- "description": "The set of labels that are available to describe a specific log entry.\nRuntime requests that contain labels not specified here are\nconsidered invalid.",
- "items": {
- "$ref": "LabelDescriptor"
- },
- "type": "array"
- }
- },
- "id": "LogDescriptor"
- },
- "CustomErrorRule": {
- "description": "A custom error rule.",
- "type": "object",
- "properties": {
- "isErrorType": {
- "description": "Mark this message as possible payload in error response. Otherwise,\nobjects of this type will be filtered when they appear in error payload.",
- "type": "boolean"
- },
- "selector": {
- "description": "Selects messages to which this rule applies.\n\nRefer to selector for syntax details.",
- "type": "string"
- }
- },
- "id": "CustomErrorRule"
- },
- "MonitoredResourceDescriptor": {
- "description": "An object that describes the schema of a MonitoredResource object using a\ntype name and a set of labels. For example, the monitored resource\ndescriptor for Google Compute Engine VM instances has a type of\n`\"gce_instance\"` and specifies the use of the labels `\"instance_id\"` and\n`\"zone\"` to identify particular VM instances.\n\nDifferent APIs can support different monitored resource types. APIs generally\nprovide a `list` method that returns the monitored resource descriptors used\nby the API.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Optional. The resource name of the monitored resource descriptor:\n`\"projects/{project_id}/monitoredResourceDescriptors/{type}\"` where\n{type} is the value of the `type` field in this object and\n{project_id} is a project ID that provides API-specific context for\naccessing the type. APIs that do not use project information can use the\nresource name format `\"monitoredResourceDescriptors/{type}\"`.",
- "type": "string"
- },
- "description": {
- "description": "Optional. A detailed description of the monitored resource type that might\nbe used in documentation.",
- "type": "string"
- },
- "displayName": {
- "description": "Optional. A concise name for the monitored resource type that might be\ndisplayed in user interfaces. It should be a Title Cased Noun Phrase,\nwithout any article or other determiners. For example,\n`\"Google Cloud SQL Database\"`.",
- "type": "string"
- },
- "type": {
- "description": "Required. The monitored resource type. For example, the type\n`\"cloudsql_database\"` represents databases in Google Cloud SQL.\nThe maximum length of this value is 256 characters.",
- "type": "string"
- },
- "labels": {
- "description": "Required. A set of labels used to describe instances of this monitored\nresource type. For example, an individual Google Cloud SQL database is\nidentified by values for the labels `\"database_id\"` and `\"zone\"`.",
- "items": {
- "$ref": "LabelDescriptor"
- },
- "type": "array"
- }
- },
- "id": "MonitoredResourceDescriptor"
- },
- "MediaDownload": {
- "id": "MediaDownload",
- "description": "Defines the Media configuration for a service in case of a download.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.",
- "type": "object",
- "properties": {
- "enabled": {
- "description": "Whether download is enabled.",
- "type": "boolean"
- },
- "downloadService": {
- "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the download service if one is used for download.",
- "type": "string"
- },
- "completeNotification": {
- "type": "boolean",
- "description": "A boolean that determines whether a notification for the completion of a\ndownload should be sent to the backend."
- },
- "dropzone": {
- "description": "Name of the Scotty dropzone to use for the current API.",
- "type": "string"
- },
- "maxDirectDownloadSize": {
- "format": "int64",
- "description": "Optional maximum acceptable size for direct download.\nThe size is specified in bytes.",
- "type": "string"
- },
- "useDirectDownload": {
- "description": "A boolean that determines if direct download from ESF should be used for\ndownload of this media.",
- "type": "boolean"
- }
- }
- },
- "CustomAuthRequirements": {
- "type": "object",
- "properties": {
- "provider": {
- "description": "A configuration string containing connection information for the\nauthentication provider, typically formatted as a SmartService string\n(go/smartservice).",
- "type": "string"
- }
- },
- "id": "CustomAuthRequirements",
- "description": "Configuration for a custom authentication provider."
- },
- "DisableServiceRequest": {
- "description": "Request message for DisableService method.",
- "type": "object",
- "properties": {},
- "id": "DisableServiceRequest"
- },
- "SearchServicesResponse": {
- "description": "Response message for SearchServices method.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Token that can be passed to `ListAvailableServices` to resume a paginated\nquery.",
- "type": "string"
- },
- "services": {
- "description": "Services available publicly or available to the authenticated caller.",
- "items": {
- "$ref": "PublishedService"
- },
- "type": "array"
- }
- },
- "id": "SearchServicesResponse"
- },
- "MediaUpload": {
- "description": "Defines the Media configuration for a service in case of an upload.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.",
- "type": "object",
- "properties": {
- "startNotification": {
- "description": "Whether to receive a notification on the start of media upload.",
- "type": "boolean"
- },
- "uploadService": {
- "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the upload service if one is used for upload.",
- "type": "string"
- },
- "maxSize": {
- "format": "int64",
- "description": "Optional maximum acceptable size for an upload.\nThe size is specified in bytes.",
- "type": "string"
- },
- "mimeTypes": {
- "description": "An array of mimetype patterns. Esf will only accept uploads that match one\nof the given patterns.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "completeNotification": {
- "description": "A boolean that determines whether a notification for the completion of an\nupload should be sent to the backend. These notifications will not be seen\nby the client and will not consume quota.",
- "type": "boolean"
- },
- "progressNotification": {
- "description": "Whether to receive a notification for progress changes of media upload.",
- "type": "boolean"
- },
- "enabled": {
- "type": "boolean",
- "description": "Whether upload is enabled."
- },
- "dropzone": {
- "description": "Name of the Scotty dropzone to use for the current API.",
- "type": "string"
- }
- },
- "id": "MediaUpload"
- },
- "BillingDestination": {
- "type": "object",
- "properties": {
- "monitoredResource": {
- "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section.",
- "type": "string"
- },
- "metrics": {
- "description": "Names of the metrics to report to this billing destination.\nEach name must be defined in Service.metrics section.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "BillingDestination",
- "description": "Configuration of a specific billing destination (Currently only support\nbill against consumer project)."
- },
"UsageRule": {
"description": "Usage configuration rules for the service.\n\nNOTE: Under development.\n\n\nUse this rule to configure unregistered calls for the service. Unregistered\ncalls are calls that do not contain consumer project identity.\n(Example: calls that do not contain an API key).\nBy default, API methods do not allow unregistered calls, and each method call\nmust be identified by a consumer project identity. Use this rule to\nallow/disallow unregistered calls.\n\nExample of an API that wants to allow unregistered calls for entire service.\n\n usage:\n rules:\n - selector: \"*\"\n allow_unregistered_calls: true\n\nExample of a method that wants to allow unregistered calls.\n\n usage:\n rules:\n - selector: \"google.example.library.v1.LibraryService.CreateBook\"\n allow_unregistered_calls: true",
"type": "object",
@@ -999,7 +14,7 @@
"type": "string"
},
"skipServiceControl": {
- "description": "True, if the method should skip service control. If so, no control plane\nfeature (like quota and billing) will be enabled.",
+ "description": "True, if the method should skip service control. If so, no control plane\nfeature (like quota and billing) will be enabled.\nThis flag is used by ESP to allow some Endpoints customers to bypass\nGoogle internal checks.",
"type": "boolean"
},
"allowUnregisteredCalls": {
@@ -1010,22 +25,21 @@
"id": "UsageRule"
},
"AuthRequirement": {
- "description": "User-defined authentication requirements, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).",
"type": "object",
"properties": {
+ "audiences": {
+ "type": "string",
+ "description": "NOTE: This will be deprecated soon, once AuthProvider.audiences is\nimplemented and accepted in all the runtime components.\n\nThe list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com"
+ },
"providerId": {
"description": "id from authentication provider.\n\nExample:\n\n provider_id: bookstore_auth",
"type": "string"
- },
- "audiences": {
- "description": "NOTE: This will be deprecated soon, once AuthProvider.audiences is\nimplemented and accepted in all the runtime components.\n\nThe list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com",
- "type": "string"
}
},
- "id": "AuthRequirement"
+ "id": "AuthRequirement",
+ "description": "User-defined authentication requirements, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32)."
},
"Documentation": {
- "description": "`Documentation` provides the information for describing a service.\n\nExample:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: \u003e\n The Google Calendar API gives access\n to most calendar features.\n pages:\n - name: Overview\n content: (== include google/foo/overview.md ==)\n - name: Tutorial\n content: (== include google/foo/tutorial.md ==)\n subpages;\n - name: Java\n content: (== include google/foo/tutorial_java.md ==)\n rules:\n - selector: google.calendar.Calendar.Get\n description: \u003e\n ...\n - selector: google.calendar.Calendar.Put\n description: \u003e\n ...\n\u003c/code\u003e\u003c/pre\u003e\nDocumentation is provided in markdown syntax. In addition to\nstandard markdown features, definition lists, tables and fenced\ncode blocks are supported. Section headers can be provided and are\ninterpreted relative to the section nesting of the context where\na documentation fragment is embedded.\n\nDocumentation from the IDL is merged with documentation defined\nvia the config at normalization time, where documentation provided\nby config rules overrides IDL provided.\n\nA number of constructs specific to the API platform are supported\nin documentation text.\n\nIn order to reference a proto element, the following\nnotation can be used:\n\u003cpre\u003e\u003ccode\u003e[fully.qualified.proto.name][]\u003c/code\u003e\u003c/pre\u003e\nTo override the display text used for the link, this can be used:\n\u003cpre\u003e\u003ccode\u003e[display text][fully.qualified.proto.name]\u003c/code\u003e\u003c/pre\u003e\nText can be excluded from doc using the following notation:\n\u003cpre\u003e\u003ccode\u003e(-- internal comment --)\u003c/code\u003e\u003c/pre\u003e\nComments can be made conditional using a visibility label. The below\ntext will be only rendered if the `BETA` label is available:\n\u003cpre\u003e\u003ccode\u003e(--BETA: comment for BETA users --)\u003c/code\u003e\u003c/pre\u003e\nA few directives are available in documentation. Note that\ndirectives must appear on a single line to be properly\nidentified. The `include` directive includes a markdown file from\nan external source:\n\u003cpre\u003e\u003ccode\u003e(== include path/to/file ==)\u003c/code\u003e\u003c/pre\u003e\nThe `resource_for` directive marks a message to be the resource of\na collection in REST view. If it is not specified, tools attempt\nto infer the resource from the operations in a collection:\n\u003cpre\u003e\u003ccode\u003e(== resource_for v1.shelves.books ==)\u003c/code\u003e\u003c/pre\u003e\nThe directive `suppress_warning` does not directly affect documentation\nand is documented together with service config validation.",
"type": "object",
"properties": {
"summary": {
@@ -1033,12 +47,12 @@
"type": "string"
},
"documentationRootUrl": {
- "description": "The URL to the root of documentation.",
- "type": "string"
+ "type": "string",
+ "description": "The URL to the root of documentation."
},
"overview": {
- "type": "string",
- "description": "Declares a single overview page. For example:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n overview: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nThis is a shortcut for the following declaration (using pages style):\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n pages:\n - name: Overview\n content: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nNote: you cannot specify both `overview` field and `pages` field."
+ "description": "Declares a single overview page. For example:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n overview: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nThis is a shortcut for the following declaration (using pages style):\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n pages:\n - name: Overview\n content: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nNote: you cannot specify both `overview` field and `pages` field.",
+ "type": "string"
},
"rules": {
"description": "A list of documentation rules that apply to individual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
@@ -1055,54 +69,25 @@
"type": "array"
}
},
- "id": "Documentation"
- },
- "AuthenticationRule": {
- "description": "Authentication rules for the service.\n\nBy default, if a method has any authentication requirements, every request\nmust include a valid credential matching one of the requirements.\nIt's an error to include more than one kind of credential in a single\nrequest.\n\nIf a method doesn't have any auth requirements, request credentials will be\nignored.",
- "type": "object",
- "properties": {
- "allowWithoutCredential": {
- "description": "Whether to allow requests without a credential. The credential can be\nan OAuth token, Google cookies (first-party auth) or EndUserCreds.\n\nFor requests without credentials, if the service control environment is\nspecified, each incoming request **must** be associated with a service\nconsumer. This can be done by passing an API key that belongs to a consumer\nproject.",
- "type": "boolean"
- },
- "selector": {
- "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
- "type": "string"
- },
- "customAuth": {
- "$ref": "CustomAuthRequirements",
- "description": "Configuration for custom authentication."
- },
- "oauth": {
- "description": "The requirements for OAuth credentials.",
- "$ref": "OAuthRequirements"
- },
- "requirements": {
- "description": "Requirements for additional authentication providers.",
- "items": {
- "$ref": "AuthRequirement"
- },
- "type": "array"
- }
- },
- "id": "AuthenticationRule"
+ "id": "Documentation",
+ "description": "`Documentation` provides the information for describing a service.\n\nExample:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: \u003e\n The Google Calendar API gives access\n to most calendar features.\n pages:\n - name: Overview\n content: (== include google/foo/overview.md ==)\n - name: Tutorial\n content: (== include google/foo/tutorial.md ==)\n subpages;\n - name: Java\n content: (== include google/foo/tutorial_java.md ==)\n rules:\n - selector: google.calendar.Calendar.Get\n description: \u003e\n ...\n - selector: google.calendar.Calendar.Put\n description: \u003e\n ...\n\u003c/code\u003e\u003c/pre\u003e\nDocumentation is provided in markdown syntax. In addition to\nstandard markdown features, definition lists, tables and fenced\ncode blocks are supported. Section headers can be provided and are\ninterpreted relative to the section nesting of the context where\na documentation fragment is embedded.\n\nDocumentation from the IDL is merged with documentation defined\nvia the config at normalization time, where documentation provided\nby config rules overrides IDL provided.\n\nA number of constructs specific to the API platform are supported\nin documentation text.\n\nIn order to reference a proto element, the following\nnotation can be used:\n\u003cpre\u003e\u003ccode\u003e[fully.qualified.proto.name][]\u003c/code\u003e\u003c/pre\u003e\nTo override the display text used for the link, this can be used:\n\u003cpre\u003e\u003ccode\u003e[display text][fully.qualified.proto.name]\u003c/code\u003e\u003c/pre\u003e\nText can be excluded from doc using the following notation:\n\u003cpre\u003e\u003ccode\u003e(-- internal comment --)\u003c/code\u003e\u003c/pre\u003e\nComments can be made conditional using a visibility label. The below\ntext will be only rendered if the `BETA` label is available:\n\u003cpre\u003e\u003ccode\u003e(--BETA: comment for BETA users --)\u003c/code\u003e\u003c/pre\u003e\nA few directives are available in documentation. Note that\ndirectives must appear on a single line to be properly\nidentified. The `include` directive includes a markdown file from\nan external source:\n\u003cpre\u003e\u003ccode\u003e(== include path/to/file ==)\u003c/code\u003e\u003c/pre\u003e\nThe `resource_for` directive marks a message to be the resource of\na collection in REST view. If it is not specified, tools attempt\nto infer the resource from the operations in a collection:\n\u003cpre\u003e\u003ccode\u003e(== resource_for v1.shelves.books ==)\u003c/code\u003e\u003c/pre\u003e\nThe directive `suppress_warning` does not directly affect documentation\nand is documented together with service config validation."
},
"BackendRule": {
"description": "A backend rule provides configuration for an individual API element.",
"type": "object",
"properties": {
"address": {
- "type": "string",
- "description": "The address of the API backend."
+ "description": "The address of the API backend.",
+ "type": "string"
},
"selector": {
- "type": "string",
- "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details."
+ "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
+ "type": "string"
},
"deadline": {
+ "type": "number",
"format": "double",
- "description": "The number of seconds to wait for a response from a request. The default\ndeadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds.",
- "type": "number"
+ "description": "The number of seconds to wait for a response from a request. The default\ndeadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds."
},
"minDeadline": {
"format": "double",
@@ -1112,41 +97,40 @@
},
"id": "BackendRule"
},
+ "AuthenticationRule": {
+ "description": "Authentication rules for the service.\n\nBy default, if a method has any authentication requirements, every request\nmust include a valid credential matching one of the requirements.\nIt's an error to include more than one kind of credential in a single\nrequest.\n\nIf a method doesn't have any auth requirements, request credentials will be\nignored.",
+ "type": "object",
+ "properties": {
+ "customAuth": {
+ "description": "Configuration for custom authentication.",
+ "$ref": "CustomAuthRequirements"
+ },
+ "oauth": {
+ "$ref": "OAuthRequirements",
+ "description": "The requirements for OAuth credentials."
+ },
+ "requirements": {
+ "description": "Requirements for additional authentication providers.",
+ "items": {
+ "$ref": "AuthRequirement"
+ },
+ "type": "array"
+ },
+ "allowWithoutCredential": {
+ "description": "Whether to allow requests without a credential. The credential can be\nan OAuth token, Google cookies (first-party auth) or EndUserCreds.\n\nFor requests without credentials, if the service control environment is\nspecified, each incoming request **must** be associated with a service\nconsumer. This can be done by passing an API key that belongs to a consumer\nproject.",
+ "type": "boolean"
+ },
+ "selector": {
+ "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ }
+ },
+ "id": "AuthenticationRule"
+ },
"Api": {
"description": "Api is a light-weight descriptor for an API Interface.\n\nInterfaces are also described as \"protocol buffer services\" in some contexts,\nsuch as by the \"service\" keyword in a .proto file, but they are different\nfrom API Services, which represent a concrete implementation of an interface\nas opposed to simply a description of methods and bindings. They are also\nsometimes simply referred to as \"APIs\" in other contexts, such as the name of\nthis message itself. See https://cloud.google.com/apis/design/glossary for\ndetailed terminology.",
"type": "object",
"properties": {
- "methods": {
- "description": "The methods of this interface, in unspecified order.",
- "items": {
- "$ref": "Method"
- },
- "type": "array"
- },
- "name": {
- "description": "The fully qualified name of this interface, including package name\nfollowed by the interface's simple name.",
- "type": "string"
- },
- "syntax": {
- "type": "string",
- "enumDescriptions": [
- "Syntax `proto2`.",
- "Syntax `proto3`."
- ],
- "enum": [
- "SYNTAX_PROTO2",
- "SYNTAX_PROTO3"
- ],
- "description": "The source syntax of the service."
- },
- "sourceContext": {
- "$ref": "SourceContext",
- "description": "Source context for the protocol buffer service represented by this\nmessage."
- },
- "version": {
- "description": "A version string for this interface. If specified, must have the form\n`major-version.minor-version`, as in `1.10`. If the minor version is\nomitted, it defaults to zero. If the entire version field is empty, the\nmajor version is derived from the package name, as outlined below. If the\nfield is not empty, the version in the package name will be verified to be\nconsistent with what is provided here.\n\nThe versioning schema uses [semantic\nversioning](http://semver.org) where the major version number\nindicates a breaking change and the minor version an additive,\nnon-breaking change. Both version numbers are signals to users\nwhat to expect from different versions, and should be carefully\nchosen based on the product plan.\n\nThe major version is also reflected in the package name of the\ninterface, which must end in `v\u003cmajor-version\u003e`, as in\n`google.feature.v1`. For major versions 0 and 1, the suffix can\nbe omitted. Zero major versions must only be used for\nexperimental, non-GA interfaces.\n",
- "type": "string"
- },
"mixins": {
"description": "Included interfaces. See Mixin.",
"items": {
@@ -1160,6 +144,37 @@
"$ref": "Option"
},
"type": "array"
+ },
+ "methods": {
+ "description": "The methods of this interface, in unspecified order.",
+ "items": {
+ "$ref": "Method"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "The fully qualified name of this interface, including package name\nfollowed by the interface's simple name.",
+ "type": "string"
+ },
+ "syntax": {
+ "enumDescriptions": [
+ "Syntax `proto2`.",
+ "Syntax `proto3`."
+ ],
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ],
+ "description": "The source syntax of the service.",
+ "type": "string"
+ },
+ "sourceContext": {
+ "$ref": "SourceContext",
+ "description": "Source context for the protocol buffer service represented by this\nmessage."
+ },
+ "version": {
+ "description": "A version string for this interface. If specified, must have the form\n`major-version.minor-version`, as in `1.10`. If the minor version is\nomitted, it defaults to zero. If the entire version field is empty, the\nmajor version is derived from the package name, as outlined below. If the\nfield is not empty, the version in the package name will be verified to be\nconsistent with what is provided here.\n\nThe versioning schema uses [semantic\nversioning](http://semver.org) where the major version number\nindicates a breaking change and the minor version an additive,\nnon-breaking change. Both version numbers are signals to users\nwhat to expect from different versions, and should be carefully\nchosen based on the product plan.\n\nThe major version is also reflected in the package name of the\ninterface, which must end in `v\u003cmajor-version\u003e`, as in\n`google.feature.v1`. For major versions 0 and 1, the suffix can\nbe omitted. Zero major versions must only be used for\nexperimental, non-GA interfaces.\n",
+ "type": "string"
}
},
"id": "Api"
@@ -1169,12 +184,12 @@
"type": "object",
"properties": {
"metricCosts": {
- "description": "Metrics to update when the selected methods are called, and the associated\ncost applied to each metric.\n\nThe key of the map is the metric name, and the values are the amount\nincreased for the metric against which the quota limits are defined.\nThe value must not be negative.",
- "type": "object",
"additionalProperties": {
- "type": "string",
- "format": "int64"
- }
+ "format": "int64",
+ "type": "string"
+ },
+ "description": "Metrics to update when the selected methods are called, and the associated\ncost applied to each metric.\n\nThe key of the map is the metric name, and the values are the amount\nincreased for the metric against which the quota limits are defined.\nThe value must not be negative.",
+ "type": "object"
},
"selector": {
"description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
@@ -1184,6 +199,7 @@
"id": "MetricRule"
},
"Authentication": {
+ "id": "Authentication",
"description": "`Authentication` defines the authentication configuration for an API.\n\nExample for an API targeted for external use:\n\n name: calendar.googleapis.com\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth",
"type": "object",
"properties": {
@@ -1195,23 +211,18 @@
"type": "array"
},
"providers": {
- "description": "Defines a set of authentication providers that a service supports.",
"items": {
"$ref": "AuthProvider"
},
- "type": "array"
+ "type": "array",
+ "description": "Defines a set of authentication providers that a service supports."
}
- },
- "id": "Authentication"
+ }
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"type": "object",
"properties": {
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
- "type": "string"
- },
"error": {
"$ref": "Status",
"description": "The error result of the operation in case of failure or cancellation."
@@ -1235,31 +246,35 @@
},
"description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
"type": "object"
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
+ "type": "string"
}
},
"id": "Operation"
},
"Page": {
- "description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.",
"type": "object",
"properties": {
- "content": {
- "description": "The Markdown content of the page. You can use \u003ccode\u003e(== include {path} ==)\u003c/code\u003e\nto include content from a Markdown file.",
+ "name": {
+ "description": "The name of the page. It will be used as an identity of the page to\ngenerate URI of the page, text of the link to this page in navigation,\netc. The full page name (start from the root page name to this page\nconcatenated with `.`) can be used as reference to the page in your\ndocumentation. For example:\n\u003cpre\u003e\u003ccode\u003epages:\n- name: Tutorial\n content: (== include tutorial.md ==)\n subpages:\n - name: Java\n content: (== include tutorial_java.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nYou can reference `Java` page using Markdown reference link syntax:\n`Java`.",
"type": "string"
},
+ "content": {
+ "type": "string",
+ "description": "The Markdown content of the page. You can use \u003ccode\u003e(== include {path} ==)\u003c/code\u003e\nto include content from a Markdown file."
+ },
"subpages": {
"description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset.",
"items": {
"$ref": "Page"
},
"type": "array"
- },
- "name": {
- "description": "The name of the page. It will be used as an identity of the page to\ngenerate URI of the page, text of the link to this page in navigation,\netc. The full page name (start from the root page name to this page\nconcatenated with `.`) can be used as reference to the page in your\ndocumentation. For example:\n\u003cpre\u003e\u003ccode\u003epages:\n- name: Tutorial\n content: (== include tutorial.md ==)\n subpages:\n - name: Java\n content: (== include tutorial_java.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nYou can reference `Java` page using Markdown reference link syntax:\n`Java`.",
- "type": "string"
}
},
- "id": "Page"
+ "id": "Page",
+ "description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure."
},
"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.",
@@ -1278,8 +293,8 @@
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
"additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
},
"type": "object"
},
@@ -1292,10 +307,6 @@
"description": "Configuration for an anthentication provider, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).",
"type": "object",
"properties": {
- "jwksUri": {
- "description": "URL of the provider's public key set to validate signature of the JWT. See\n[OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).\nOptional if the key set document:\n - can be retrieved from\n [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html\n of the issuer.\n - can be inferred from the email domain of the issuer (e.g. a Google service account).\n\nExample: https://www.googleapis.com/oauth2/v1/certs",
- "type": "string"
- },
"audiences": {
"description": "The list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com",
"type": "string"
@@ -1311,11 +322,17 @@
"id": {
"description": "The unique identifier of the auth provider. It will be referred to by\n`AuthRequirement.provider_id`.\n\nExample: \"bookstore_auth\".",
"type": "string"
+ },
+ "jwksUri": {
+ "description": "URL of the provider's public key set to validate signature of the JWT. See\n[OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).\nOptional if the key set document:\n - can be retrieved from\n [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html\n of the issuer.\n - can be inferred from the email domain of the issuer (e.g. a Google service account).\n\nExample: https://www.googleapis.com/oauth2/v1/certs",
+ "type": "string"
}
},
"id": "AuthProvider"
},
"EnumValue": {
+ "description": "Enum value definition.",
+ "type": "object",
"properties": {
"name": {
"description": "Enum value name.",
@@ -1329,37 +346,129 @@
"type": "array"
},
"number": {
- "type": "integer",
"format": "int32",
- "description": "Enum value number."
+ "description": "Enum value number.",
+ "type": "integer"
}
},
- "id": "EnumValue",
- "description": "Enum value definition.",
- "type": "object"
+ "id": "EnumValue"
},
"Service": {
"description": "`Service` is the root object of Google service configuration schema. It\ndescribes basic information about a service, such as the name and the\ntitle, and delegates other aspects to sub-sections. Each sub-section is\neither a proto message or a repeated proto message that configures a\nspecific aspect, such as auth. See each proto message definition for details.\n\nExample:\n\n type: google.api.Service\n config_version: 3\n name: calendar.googleapis.com\n title: Google Calendar API\n apis:\n - name: google.calendar.v3.Calendar\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth",
"type": "object",
"properties": {
+ "name": {
+ "type": "string",
+ "description": "The DNS address at which this service is available,\ne.g. `calendar.googleapis.com`."
+ },
+ "billing": {
+ "$ref": "Billing",
+ "description": "Billing configuration."
+ },
+ "customError": {
+ "description": "Custom error configuration.",
+ "$ref": "CustomError"
+ },
+ "title": {
+ "description": "The product title for this service.",
+ "type": "string"
+ },
+ "endpoints": {
+ "description": "Configuration for network endpoints. If this is empty, then an endpoint\nwith the same name as the service is automatically generated to service all\ndefined APIs.",
+ "items": {
+ "$ref": "Endpoint"
+ },
+ "type": "array"
+ },
+ "apis": {
+ "description": "A list of API interfaces exported by this service. Only the `name` field\nof the google.protobuf.Api needs to be provided by the configuration\nauthor, as the remaining fields will be derived from the IDL during the\nnormalization process. It is an error to specify an API interface here\nwhich cannot be resolved against the associated IDL files.",
+ "items": {
+ "$ref": "Api"
+ },
+ "type": "array"
+ },
+ "logs": {
+ "description": "Defines the logs used by this service.",
+ "items": {
+ "$ref": "LogDescriptor"
+ },
+ "type": "array"
+ },
+ "types": {
+ "description": "A list of all proto message types included in this API service.\nTypes referenced directly or indirectly by the `apis` are\nautomatically included. Messages which are not referenced but\nshall be included, such as types used by the `google.protobuf.Any` type,\nshould be listed here by name. Example:\n\n types:\n - name: google.protobuf.Int32",
+ "items": {
+ "$ref": "Type"
+ },
+ "type": "array"
+ },
+ "sourceInfo": {
+ "description": "Output only. The source information for this configuration if available.",
+ "$ref": "SourceInfo"
+ },
+ "http": {
+ "$ref": "Http",
+ "description": "HTTP configuration."
+ },
+ "systemParameters": {
+ "$ref": "SystemParameters",
+ "description": "System parameter configuration."
+ },
+ "backend": {
+ "$ref": "Backend",
+ "description": "API backend configuration."
+ },
+ "documentation": {
+ "$ref": "Documentation",
+ "description": "Additional API documentation."
+ },
+ "logging": {
+ "$ref": "Logging",
+ "description": "Logging configuration."
+ },
+ "monitoredResources": {
+ "items": {
+ "$ref": "MonitoredResourceDescriptor"
+ },
+ "type": "array",
+ "description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging configurations."
+ },
+ "context": {
+ "description": "Context configuration.",
+ "$ref": "Context"
+ },
+ "enums": {
+ "description": "A list of all enum types included in this API service. Enums\nreferenced directly or indirectly by the `apis` are automatically\nincluded. Enums which are not referenced but shall be included\nshould be listed here by name. Example:\n\n enums:\n - name: google.someapi.v1.SomeEnum",
+ "items": {
+ "$ref": "Enum"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "A unique ID for a specific instance of this message, typically assigned\nby the client for tracking purpose. If empty, the server may choose to\ngenerate one instead.",
+ "type": "string"
+ },
+ "usage": {
+ "$ref": "Usage",
+ "description": "Configuration controlling usage of this service."
+ },
"metrics": {
+ "description": "Defines the metrics used by this service.",
"items": {
"$ref": "MetricDescriptor"
},
- "type": "array",
- "description": "Defines the metrics used by this service."
+ "type": "array"
},
"authentication": {
- "description": "Auth configuration.",
- "$ref": "Authentication"
+ "$ref": "Authentication",
+ "description": "Auth configuration."
},
"experimental": {
- "description": "Experimental configuration.",
- "$ref": "Experimental"
+ "$ref": "Experimental",
+ "description": "Experimental configuration."
},
"control": {
- "$ref": "Control",
- "description": "Configuration for the service control plane."
+ "description": "Configuration for the service control plane.",
+ "$ref": "Control"
},
"configVersion": {
"format": "uint32",
@@ -1382,106 +491,12 @@
"type": "array"
},
"visibility": {
- "description": "API visibility configuration.",
- "$ref": "Visibility"
+ "$ref": "Visibility",
+ "description": "API visibility configuration."
},
"quota": {
"$ref": "Quota",
"description": "Quota configuration."
- },
- "name": {
- "description": "The DNS address at which this service is available,\ne.g. `calendar.googleapis.com`.",
- "type": "string"
- },
- "billing": {
- "description": "Billing configuration.",
- "$ref": "Billing"
- },
- "customError": {
- "$ref": "CustomError",
- "description": "Custom error configuration."
- },
- "title": {
- "description": "The product title for this service.",
- "type": "string"
- },
- "endpoints": {
- "description": "Configuration for network endpoints. If this is empty, then an endpoint\nwith the same name as the service is automatically generated to service all\ndefined APIs.",
- "items": {
- "$ref": "Endpoint"
- },
- "type": "array"
- },
- "logs": {
- "description": "Defines the logs used by this service.",
- "items": {
- "$ref": "LogDescriptor"
- },
- "type": "array"
- },
- "apis": {
- "description": "A list of API interfaces exported by this service. Only the `name` field\nof the google.protobuf.Api needs to be provided by the configuration\nauthor, as the remaining fields will be derived from the IDL during the\nnormalization process. It is an error to specify an API interface here\nwhich cannot be resolved against the associated IDL files.",
- "items": {
- "$ref": "Api"
- },
- "type": "array"
- },
- "types": {
- "description": "A list of all proto message types included in this API service.\nTypes referenced directly or indirectly by the `apis` are\nautomatically included. Messages which are not referenced but\nshall be included, such as types used by the `google.protobuf.Any` type,\nshould be listed here by name. Example:\n\n types:\n - name: google.protobuf.Int32",
- "items": {
- "$ref": "Type"
- },
- "type": "array"
- },
- "sourceInfo": {
- "$ref": "SourceInfo",
- "description": "Output only. The source information for this configuration if available."
- },
- "http": {
- "description": "HTTP configuration.",
- "$ref": "Http"
- },
- "backend": {
- "$ref": "Backend",
- "description": "API backend configuration."
- },
- "systemParameters": {
- "description": "System parameter configuration.",
- "$ref": "SystemParameters"
- },
- "documentation": {
- "description": "Additional API documentation.",
- "$ref": "Documentation"
- },
- "monitoredResources": {
- "description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging configurations.",
- "items": {
- "$ref": "MonitoredResourceDescriptor"
- },
- "type": "array"
- },
- "logging": {
- "description": "Logging configuration.",
- "$ref": "Logging"
- },
- "enums": {
- "description": "A list of all enum types included in this API service. Enums\nreferenced directly or indirectly by the `apis` are automatically\nincluded. Enums which are not referenced but shall be included\nshould be listed here by name. Example:\n\n enums:\n - name: google.someapi.v1.SomeEnum",
- "items": {
- "$ref": "Enum"
- },
- "type": "array"
- },
- "context": {
- "$ref": "Context",
- "description": "Context configuration."
- },
- "id": {
- "description": "A unique ID for a specific instance of this message, typically assigned\nby the client for tracking purpose. If empty, the server may choose to\ngenerate one instead.",
- "type": "string"
- },
- "usage": {
- "$ref": "Usage",
- "description": "Configuration controlling usage of this service."
}
},
"id": "Service"
@@ -1490,13 +505,13 @@
"description": "A custom pattern is used for defining custom HTTP verb.",
"type": "object",
"properties": {
+ "path": {
+ "description": "The path matched by this custom verb.",
+ "type": "string"
+ },
"kind": {
"description": "The name of this custom HTTP verb.",
"type": "string"
- },
- "path": {
- "type": "string",
- "description": "The path matched by this custom verb."
}
},
"id": "CustomHttpPattern"
@@ -1505,11 +520,6 @@
"description": "The metadata associated with a long running operation resource.",
"type": "object",
"properties": {
- "startTime": {
- "format": "google-datetime",
- "description": "The start time of the operation.",
- "type": "string"
- },
"steps": {
"description": "Detailed status information for each step. The order is undetermined.",
"items": {
@@ -1528,45 +538,49 @@
"format": "int32",
"description": "Percentage of completion of this operation, ranging from 0 to 100.",
"type": "integer"
+ },
+ "startTime": {
+ "format": "google-datetime",
+ "description": "The start time of the operation.",
+ "type": "string"
}
},
"id": "OperationMetadata"
},
"PublishedService": {
- "description": "The published version of a Service that is managed by\nGoogle Service Management.",
- "type": "object",
"properties": {
"service": {
- "description": "The service's published configuration.",
- "$ref": "Service"
+ "$ref": "Service",
+ "description": "The service's published configuration."
},
"name": {
"description": "The resource name of the service.\n\nA valid name would be:\n- services/serviceuser.googleapis.com",
"type": "string"
}
},
- "id": "PublishedService"
+ "id": "PublishedService",
+ "description": "The published version of a Service that is managed by\nGoogle Service Management.",
+ "type": "object"
},
"SystemParameterRule": {
"description": "Define a system parameter rule mapping system parameter definitions to\nmethods.",
"type": "object",
"properties": {
- "selector": {
- "description": "Selects the methods to which this rule applies. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for syntax details.",
- "type": "string"
- },
"parameters": {
- "description": "Define parameters. Multiple names may be defined for a parameter.\nFor a given method call, only one of them should be used. If multiple\nnames are used the behavior is implementation-dependent.\nIf none of the specified names are present the behavior is\nparameter-dependent.",
"items": {
"$ref": "SystemParameter"
},
- "type": "array"
+ "type": "array",
+ "description": "Define parameters. Multiple names may be defined for a parameter.\nFor a given method call, only one of them should be used. If multiple\nnames are used the behavior is implementation-dependent.\nIf none of the specified names are present the behavior is\nparameter-dependent."
+ },
+ "selector": {
+ "type": "string",
+ "description": "Selects the methods to which this rule applies. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for syntax details."
}
},
"id": "SystemParameterRule"
},
"VisibilityRule": {
- "description": "A visibility rule provides visibility configuration for an individual API\nelement.",
"type": "object",
"properties": {
"restriction": {
@@ -1574,14 +588,39 @@
"type": "string"
},
"selector": {
- "description": "Selects methods, messages, fields, enums, etc. to which this rule applies.\n\nRefer to selector for syntax details.",
- "type": "string"
+ "type": "string",
+ "description": "Selects methods, messages, fields, enums, etc. to which this rule applies.\n\nRefer to selector for syntax details."
}
},
- "id": "VisibilityRule"
+ "id": "VisibilityRule",
+ "description": "A visibility rule provides visibility configuration for an individual API\nelement."
},
"HttpRule": {
+ "type": "object",
"properties": {
+ "body": {
+ "description": "The name of the request field whose value is mapped to the HTTP body, or\n`*` for mapping all fields not captured by the path pattern to the HTTP\nbody. NOTE: the referred field must not be a repeated field and must be\npresent at the top-level of request message type.",
+ "type": "string"
+ },
+ "post": {
+ "description": "Used for creating a resource.",
+ "type": "string"
+ },
+ "mediaDownload": {
+ "$ref": "MediaDownload",
+ "description": "Use this only for Scotty Requests. Do not use this for bytestream methods.\nFor media support, add instead [][google.bytestream.RestByteStream] as an\nAPI to your configuration."
+ },
+ "additionalBindings": {
+ "description": "Additional HTTP bindings for the selector. Nested bindings must\nnot contain an `additional_bindings` field themselves (that is,\nthe nesting may only be one level deep).",
+ "items": {
+ "$ref": "HttpRule"
+ },
+ "type": "array"
+ },
+ "responseBody": {
+ "type": "string",
+ "description": "The name of the response field whose value is mapped to the HTTP body of\nresponse. Other response fields are ignored. This field is optional. When\nnot set, the response message will be used as HTTP body of response.\nNOTE: the referred field must be not a repeated field and must be present\nat the top-level of response message type."
+ },
"mediaUpload": {
"$ref": "MediaUpload",
"description": "Use this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead\n[][google.bytestream.RestByteStream] as an API to your\nconfiguration for Bytestream methods."
@@ -1594,14 +633,14 @@
"$ref": "CustomHttpPattern",
"description": "The custom pattern is used for specifying an HTTP method that is not\nincluded in the `pattern` field, such as HEAD, or \"*\" to leave the\nHTTP method unspecified for this rule. The wild-card rule is useful\nfor services that provide content to Web (HTML) clients."
},
+ "get": {
+ "description": "Used for listing and getting information about resources.",
+ "type": "string"
+ },
"patch": {
"description": "Used for updating a resource.",
"type": "string"
},
- "get": {
- "type": "string",
- "description": "Used for listing and getting information about resources."
- },
"put": {
"description": "Used for updating a resource.",
"type": "string"
@@ -1609,36 +648,13 @@
"delete": {
"description": "Used for deleting a resource.",
"type": "string"
- },
- "body": {
- "description": "The name of the request field whose value is mapped to the HTTP body, or\n`*` for mapping all fields not captured by the path pattern to the HTTP\nbody. NOTE: the referred field must not be a repeated field and must be\npresent at the top-level of request message type.",
- "type": "string"
- },
- "mediaDownload": {
- "$ref": "MediaDownload",
- "description": "Use this only for Scotty Requests. Do not use this for bytestream methods.\nFor media support, add instead [][google.bytestream.RestByteStream] as an\nAPI to your configuration."
- },
- "post": {
- "type": "string",
- "description": "Used for creating a resource."
- },
- "additionalBindings": {
- "description": "Additional HTTP bindings for the selector. Nested bindings must\nnot contain an `additional_bindings` field themselves (that is,\nthe nesting may only be one level deep).",
- "items": {
- "$ref": "HttpRule"
- },
- "type": "array"
- },
- "responseBody": {
- "type": "string",
- "description": "The name of the response field whose value is mapped to the HTTP body of\nresponse. Other response fields are ignored. This field is optional. When\nnot set, the response message will be used as HTTP body of response.\nNOTE: the referred field must be not a repeated field and must be present\nat the top-level of response message type."
}
},
"id": "HttpRule",
- "description": "`HttpRule` defines the mapping of an RPC method to one or more HTTP\nREST API methods. The mapping specifies how different portions of the RPC\nrequest message are mapped to URL path, URL query parameters, and\nHTTP request body. The mapping is typically specified as an\n`google.api.http` annotation on the RPC method,\nsee \"google/api/annotations.proto\" for details.\n\nThe mapping consists of a field specifying the path template and\nmethod kind. The path template can refer to fields in the request\nmessage, as in the example below which describes a REST GET\noperation on a resource collection of messages:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}/{sub.subfield}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n SubMessage sub = 2; // `sub.subfield` is url-mapped\n }\n message Message {\n string text = 1; // content of the resource\n }\n\nThe same http annotation can alternatively be expressed inside the\n`GRPC API Configuration` YAML file.\n\n http:\n rules:\n - selector: \u003cproto_package_name\u003e.Messaging.GetMessage\n get: /v1/messages/{message_id}/{sub.subfield}\n\nThis definition enables an automatic, bidrectional mapping of HTTP\nJSON to RPC. Example:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456/foo` | `GetMessage(message_id: \"123456\" sub: SubMessage(subfield: \"foo\"))`\n\nIn general, not only fields but also field paths can be referenced\nfrom a path pattern. Fields mapped to the path pattern cannot be\nrepeated and must have a primitive (non-message) type.\n\nAny fields in the request message which are not bound by the path\npattern automatically become (optional) HTTP query\nparameters. Assume the following definition of the request message:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n int64 revision = 2; // becomes a parameter\n SubMessage sub = 3; // `sub.subfield` becomes a parameter\n }\n\n\nThis enables a HTTP JSON to RPC mapping as below:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))`\n\nNote that fields which are mapped to HTTP parameters must have a\nprimitive type or a repeated primitive type. Message types are not\nallowed. In the case of a repeated type, the parameter can be\nrepeated in the URL, as in `...?param=A¶m=B`.\n\nFor HTTP method kinds which allow a request body, the `body` field\nspecifies the mapping. Consider a REST update method on the\nmessage resource collection:\n\n\n service Messaging {\n rpc UpdateMessage(UpdateMessageRequest) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"message\"\n };\n }\n }\n message UpdateMessageRequest {\n string message_id = 1; // mapped to the URL\n Message message = 2; // mapped to the body\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled, where the\nrepresentation of the JSON in the request body is determined by\nprotos JSON encoding:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })`\n\nThe special name `*` can be used in the body mapping to define that\nevery field not bound by the path template should be mapped to the\nrequest body. This enables the following alternative definition of\nthe update method:\n\n service Messaging {\n rpc UpdateMessage(Message) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"*\"\n };\n }\n }\n message Message {\n string message_id = 1;\n string text = 2;\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" text: \"Hi!\")`\n\nNote that when using `*` in the body mapping, it is not possible to\nhave HTTP parameters, as all fields not bound by the path end in\nthe body. This makes this option more rarely used in practice of\ndefining REST APIs. The common usage of `*` is in custom methods\nwhich don't use the URL at all for transferring data.\n\nIt is possible to define multiple HTTP methods for one RPC by using\nthe `additional_bindings` option. Example:\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http) = {\n get: \"/v1/messages/{message_id}\"\n additional_bindings {\n get: \"/v1/users/{user_id}/messages/{message_id}\"\n }\n };\n }\n }\n message GetMessageRequest {\n string message_id = 1;\n string user_id = 2;\n }\n\n\nThis enables the following two alternative HTTP JSON to RPC\nmappings:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456` | `GetMessage(message_id: \"123456\")`\n`GET /v1/users/me/messages/123456` | `GetMessage(user_id: \"me\" message_id: \"123456\")`\n\n# Rules for HTTP mapping\n\nThe rules for mapping HTTP path, query parameters, and body fields\nto the request message are as follows:\n\n1. The `body` field specifies either `*` or a field path, or is\n omitted. If omitted, it indicates there is no HTTP request body.\n2. Leaf fields (recursive expansion of nested messages in the\n request) can be classified into three types:\n (a) Matched in the URL template.\n (b) Covered by body (if body is `*`, everything except (a) fields;\n else everything under the body field)\n (c) All other fields.\n3. URL query parameters found in the HTTP request are mapped to (c) fields.\n4. Any body sent with an HTTP request can contain only (b) fields.\n\nThe syntax of the path template is as follows:\n\n Template = \"/\" Segments [ Verb ] ;\n Segments = Segment { \"/\" Segment } ;\n Segment = \"*\" | \"**\" | LITERAL | Variable ;\n Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ;\n FieldPath = IDENT { \".\" IDENT } ;\n Verb = \":\" LITERAL ;\n\nThe syntax `*` matches a single path segment. The syntax `**` matches zero\nor more path segments, which must be the last part of the path except the\n`Verb`. The syntax `LITERAL` matches literal text in the path.\n\nThe syntax `Variable` matches part of the URL path as specified by its\ntemplate. A variable template must not contain other variables. If a variable\nmatches a single path segment, its template may be omitted, e.g. `{var}`\nis equivalent to `{var=*}`.\n\nIf a variable contains exactly one path segment, such as `\"{var}\"` or\n`\"{var=*}\"`, when such a variable is expanded into a URL path, all characters\nexcept `[-_.~0-9a-zA-Z]` are percent-encoded. Such variables show up in the\nDiscovery Document as `{var}`.\n\nIf a variable contains one or more path segments, such as `\"{var=foo/*}\"`\nor `\"{var=**}\"`, when such a variable is expanded into a URL path, all\ncharacters except `[-_.~/0-9a-zA-Z]` are percent-encoded. Such variables\nshow up in the Discovery Document as `{+var}`.\n\nNOTE: While the single segment variable matches the semantics of\n[RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2\nSimple String Expansion, the multi segment variable **does not** match\nRFC 6570 Reserved Expansion. The reason is that the Reserved Expansion\ndoes not expand special characters like `?` and `#`, which would lead\nto invalid URLs.\n\nNOTE: the field paths in variables and in the `body` must not refer to\nrepeated fields or map fields.",
- "type": "object"
+ "description": "`HttpRule` defines the mapping of an RPC method to one or more HTTP\nREST API methods. The mapping specifies how different portions of the RPC\nrequest message are mapped to URL path, URL query parameters, and\nHTTP request body. The mapping is typically specified as an\n`google.api.http` annotation on the RPC method,\nsee \"google/api/annotations.proto\" for details.\n\nThe mapping consists of a field specifying the path template and\nmethod kind. The path template can refer to fields in the request\nmessage, as in the example below which describes a REST GET\noperation on a resource collection of messages:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}/{sub.subfield}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n SubMessage sub = 2; // `sub.subfield` is url-mapped\n }\n message Message {\n string text = 1; // content of the resource\n }\n\nThe same http annotation can alternatively be expressed inside the\n`GRPC API Configuration` YAML file.\n\n http:\n rules:\n - selector: \u003cproto_package_name\u003e.Messaging.GetMessage\n get: /v1/messages/{message_id}/{sub.subfield}\n\nThis definition enables an automatic, bidrectional mapping of HTTP\nJSON to RPC. Example:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456/foo` | `GetMessage(message_id: \"123456\" sub: SubMessage(subfield: \"foo\"))`\n\nIn general, not only fields but also field paths can be referenced\nfrom a path pattern. Fields mapped to the path pattern cannot be\nrepeated and must have a primitive (non-message) type.\n\nAny fields in the request message which are not bound by the path\npattern automatically become (optional) HTTP query\nparameters. Assume the following definition of the request message:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n int64 revision = 2; // becomes a parameter\n SubMessage sub = 3; // `sub.subfield` becomes a parameter\n }\n\n\nThis enables a HTTP JSON to RPC mapping as below:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))`\n\nNote that fields which are mapped to HTTP parameters must have a\nprimitive type or a repeated primitive type. Message types are not\nallowed. In the case of a repeated type, the parameter can be\nrepeated in the URL, as in `...?param=A¶m=B`.\n\nFor HTTP method kinds which allow a request body, the `body` field\nspecifies the mapping. Consider a REST update method on the\nmessage resource collection:\n\n\n service Messaging {\n rpc UpdateMessage(UpdateMessageRequest) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"message\"\n };\n }\n }\n message UpdateMessageRequest {\n string message_id = 1; // mapped to the URL\n Message message = 2; // mapped to the body\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled, where the\nrepresentation of the JSON in the request body is determined by\nprotos JSON encoding:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })`\n\nThe special name `*` can be used in the body mapping to define that\nevery field not bound by the path template should be mapped to the\nrequest body. This enables the following alternative definition of\nthe update method:\n\n service Messaging {\n rpc UpdateMessage(Message) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"*\"\n };\n }\n }\n message Message {\n string message_id = 1;\n string text = 2;\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" text: \"Hi!\")`\n\nNote that when using `*` in the body mapping, it is not possible to\nhave HTTP parameters, as all fields not bound by the path end in\nthe body. This makes this option more rarely used in practice of\ndefining REST APIs. The common usage of `*` is in custom methods\nwhich don't use the URL at all for transferring data.\n\nIt is possible to define multiple HTTP methods for one RPC by using\nthe `additional_bindings` option. Example:\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http) = {\n get: \"/v1/messages/{message_id}\"\n additional_bindings {\n get: \"/v1/users/{user_id}/messages/{message_id}\"\n }\n };\n }\n }\n message GetMessageRequest {\n string message_id = 1;\n string user_id = 2;\n }\n\n\nThis enables the following two alternative HTTP JSON to RPC\nmappings:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456` | `GetMessage(message_id: \"123456\")`\n`GET /v1/users/me/messages/123456` | `GetMessage(user_id: \"me\" message_id: \"123456\")`\n\n# Rules for HTTP mapping\n\nThe rules for mapping HTTP path, query parameters, and body fields\nto the request message are as follows:\n\n1. The `body` field specifies either `*` or a field path, or is\n omitted. If omitted, it indicates there is no HTTP request body.\n2. Leaf fields (recursive expansion of nested messages in the\n request) can be classified into three types:\n (a) Matched in the URL template.\n (b) Covered by body (if body is `*`, everything except (a) fields;\n else everything under the body field)\n (c) All other fields.\n3. URL query parameters found in the HTTP request are mapped to (c) fields.\n4. Any body sent with an HTTP request can contain only (b) fields.\n\nThe syntax of the path template is as follows:\n\n Template = \"/\" Segments [ Verb ] ;\n Segments = Segment { \"/\" Segment } ;\n Segment = \"*\" | \"**\" | LITERAL | Variable ;\n Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ;\n FieldPath = IDENT { \".\" IDENT } ;\n Verb = \":\" LITERAL ;\n\nThe syntax `*` matches a single path segment. The syntax `**` matches zero\nor more path segments, which must be the last part of the path except the\n`Verb`. The syntax `LITERAL` matches literal text in the path.\n\nThe syntax `Variable` matches part of the URL path as specified by its\ntemplate. A variable template must not contain other variables. If a variable\nmatches a single path segment, its template may be omitted, e.g. `{var}`\nis equivalent to `{var=*}`.\n\nIf a variable contains exactly one path segment, such as `\"{var}\"` or\n`\"{var=*}\"`, when such a variable is expanded into a URL path, all characters\nexcept `[-_.~0-9a-zA-Z]` are percent-encoded. Such variables show up in the\nDiscovery Document as `{var}`.\n\nIf a variable contains one or more path segments, such as `\"{var=foo/*}\"`\nor `\"{var=**}\"`, when such a variable is expanded into a URL path, all\ncharacters except `[-_.~/0-9a-zA-Z]` are percent-encoded. Such variables\nshow up in the Discovery Document as `{+var}`.\n\nNOTE: While the single segment variable matches the semantics of\n[RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2\nSimple String Expansion, the multi segment variable **does not** match\nRFC 6570 Reserved Expansion. The reason is that the Reserved Expansion\ndoes not expand special characters like `?` and `#`, which would lead\nto invalid URLs.\n\nNOTE: the field paths in variables and in the `body` must not refer to\nrepeated fields or map fields."
},
"MonitoringDestination": {
+ "id": "MonitoringDestination",
"description": "Configuration of a specific monitoring destination (the producer project\nor the consumer project).",
"type": "object",
"properties": {
@@ -1653,8 +669,7 @@
},
"type": "array"
}
- },
- "id": "MonitoringDestination"
+ }
},
"Visibility": {
"description": "`Visibility` defines restrictions for the visibility of service\nelements. Restrictions are specified using visibility labels\n(e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects.\n\nUsers and projects can have access to more than one visibility label. The\neffective visibility for multiple labels is the union of each label's\nelements, plus any unrestricted elements.\n\nIf an element and its parents have no restrictions, visibility is\nunconditionally granted.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: TRUSTED_TESTER\n - selector: google.calendar.Calendar.Delegate\n restriction: GOOGLE_INTERNAL\n\nHere, all methods are publicly visible except for the restricted methods\nEnhancedSearch and Delegate.",
@@ -1710,6 +725,8 @@
"type": "object",
"properties": {
"status": {
+ "description": "The status code.",
+ "type": "string",
"enumDescriptions": [
"Unspecifed code.",
"The operation or step has completed without errors.",
@@ -1725,19 +742,16 @@
"IN_PROGRESS",
"FAILED",
"CANCELLED"
- ],
- "description": "The status code.",
- "type": "string"
+ ]
},
"description": {
- "type": "string",
- "description": "The short description of the step."
+ "description": "The short description of the step.",
+ "type": "string"
}
},
"id": "Step"
},
"LoggingDestination": {
- "description": "Configuration of a specific logging destination (the producer project\nor the consumer project).",
"type": "object",
"properties": {
"logs": {
@@ -1752,16 +766,14 @@
"type": "string"
}
},
- "id": "LoggingDestination"
+ "id": "LoggingDestination",
+ "description": "Configuration of a specific logging destination (the producer project\nor the consumer project)."
},
"Option": {
+ "id": "Option",
"description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc.",
"type": "object",
"properties": {
- "name": {
- "description": "The option's name. For protobuf built-in options (options defined in\ndescriptor.proto), this is the short name. For example, `\"map_entry\"`.\nFor custom options, it should be the fully-qualified name. For example,\n`\"google.api.http\"`.",
- "type": "string"
- },
"value": {
"type": "object",
"additionalProperties": {
@@ -1769,75 +781,76 @@
"type": "any"
},
"description": "The option's value packed in an Any message. If the value is a primitive,\nthe corresponding wrapper type defined in google/protobuf/wrappers.proto\nshould be used. If the value is an enum, it should be stored as an int32\nvalue using the google.protobuf.Int32Value type."
+ },
+ "name": {
+ "description": "The option's name. For protobuf built-in options (options defined in\ndescriptor.proto), this is the short name. For example, `\"map_entry\"`.\nFor custom options, it should be the fully-qualified name. For example,\n`\"google.api.http\"`.",
+ "type": "string"
}
- },
- "id": "Option"
+ }
},
"Logging": {
+ "description": "Logging configuration of the service.\n\nThe following example shows how to configure logs to be sent to the\nproducer and consumer projects. In the example, the `activity_history`\nlog is sent to both the producer and consumer projects, whereas the\n`purchase_history` log is only sent to the producer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n logs:\n - name: activity_history\n labels:\n - key: /customer_id\n - name: purchase_history\n logging:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history\n - purchase_history\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history",
"type": "object",
"properties": {
- "consumerDestinations": {
- "items": {
- "$ref": "LoggingDestination"
- },
- "type": "array",
- "description": "Logging configurations for sending logs to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none consumer destination."
- },
"producerDestinations": {
"description": "Logging configurations for sending logs to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none producer destination.",
"items": {
"$ref": "LoggingDestination"
},
"type": "array"
+ },
+ "consumerDestinations": {
+ "description": "Logging configurations for sending logs to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none consumer destination.",
+ "items": {
+ "$ref": "LoggingDestination"
+ },
+ "type": "array"
}
},
- "id": "Logging",
- "description": "Logging configuration of the service.\n\nThe following example shows how to configure logs to be sent to the\nproducer and consumer projects. In the example, the `activity_history`\nlog is sent to both the producer and consumer projects, whereas the\n`purchase_history` log is only sent to the producer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n logs:\n - name: activity_history\n labels:\n - key: /customer_id\n - name: purchase_history\n logging:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history\n - purchase_history\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history"
+ "id": "Logging"
},
"QuotaLimit": {
- "description": "`QuotaLimit` defines a specific limit that applies over a specified duration\nfor a limit type. There can be at most one limit for a duration and limit\ntype combination defined within a `QuotaGroup`.",
- "type": "object",
"properties": {
- "metric": {
- "description": "The name of the metric this quota limit applies to. The quota limits with\nthe same metric will be checked together during runtime. The metric must be\ndefined within the service config.\n\nUsed by metric-based quotas only.",
- "type": "string"
- },
"description": {
"description": "Optional. User-visible, extended description for this quota limit.\nShould be used only when more context is needed to understand this limit\nthan provided by the limit's display name (see: `display_name`).",
"type": "string"
},
- "displayName": {
- "description": "User-visible display name for this limit.\nOptional. If not set, the UI will provide a default display name based on\nthe quota configuration. This field can be used to override the default\ndisplay name generated from the configuration.",
+ "metric": {
+ "description": "The name of the metric this quota limit applies to. The quota limits with\nthe same metric will be checked together during runtime. The metric must be\ndefined within the service config.",
"type": "string"
},
+ "displayName": {
+ "type": "string",
+ "description": "User-visible display name for this limit.\nOptional. If not set, the UI will provide a default display name based on\nthe quota configuration. This field can be used to override the default\ndisplay name generated from the configuration."
+ },
"values": {
"additionalProperties": {
"format": "int64",
"type": "string"
},
- "description": "Tiered limit values, currently only STANDARD is supported.",
+ "description": "Tiered limit values. You must specify this as a key:value pair, with an\ninteger value that is the maximum number of requests allowed for the\nspecified unit. Currently only STANDARD is supported.",
"type": "object"
},
"unit": {
- "description": "Specify the unit of the quota limit. It uses the same syntax as\nMetric.unit. The supported unit kinds are determined by the quota\nbackend system.\n\nThe [Google Service Control](https://cloud.google.com/service-control)\nsupports the following unit components:\n* One of the time intevals:\n * \"/min\" for quota every minute.\n * \"/d\" for quota every 24 hours, starting 00:00 US Pacific Time.\n * Otherwise the quota won't be reset by time, such as storage limit.\n* One and only one of the granted containers:\n * \"/{project}\" quota for a project\n\nHere are some examples:\n* \"1/min/{project}\" for quota per minute per project.\n\nNote: the order of unit components is insignificant.\nThe \"1\" at the beginning is required to follow the metric unit syntax.\n\nUsed by metric-based quotas only.",
+ "description": "Specify the unit of the quota limit. It uses the same syntax as\nMetric.unit. The supported unit kinds are determined by the quota\nbackend system.\n\nHere are some examples:\n* \"1/min/{project}\" for quota per minute per project.\n\nNote: the order of unit components is insignificant.\nThe \"1\" at the beginning is required to follow the metric unit syntax.",
"type": "string"
},
"maxLimit": {
+ "type": "string",
"format": "int64",
- "description": "Maximum number of tokens that can be consumed during the specified\nduration. Client application developers can override the default limit up\nto this maximum. If specified, this value cannot be set to a value less\nthan the default limit. If not specified, it is set to the default limit.\n\nTo allow clients to apply overrides with no upper bound, set this to -1,\nindicating unlimited maximum quota.\n\nUsed by group-based quotas only.",
- "type": "string"
+ "description": "Maximum number of tokens that can be consumed during the specified\nduration. Client application developers can override the default limit up\nto this maximum. If specified, this value cannot be set to a value less\nthan the default limit. If not specified, it is set to the default limit.\n\nTo allow clients to apply overrides with no upper bound, set this to -1,\nindicating unlimited maximum quota.\n\nUsed by group-based quotas only."
},
"name": {
- "description": "Name of the quota limit. The name is used to refer to the limit when\noverriding the default limit on per-consumer basis.\n\nFor metric-based quota limits, the name must be provided, and it must be\nunique within the service. The name can only include alphanumeric\ncharacters as well as '-'.\n\nThe maximum length of the limit name is 64 characters.\n\nThe name of a limit is used as a unique identifier for this limit.\nTherefore, once a limit has been put into use, its name should be\nimmutable. You can use the display_name field to provide a user-friendly\nname for the limit. The display name can be evolved over time without\naffecting the identity of the limit.",
- "type": "string"
- },
- "duration": {
- "description": "Duration of this limit in textual notation. Example: \"100s\", \"24h\", \"1d\".\nFor duration longer than a day, only multiple of days is supported. We\nsupport only \"100s\" and \"1d\" for now. Additional support will be added in\nthe future. \"0\" indicates indefinite duration.\n\nUsed by group-based quotas only.",
+ "description": "Name of the quota limit.\n\nThe name must be provided, and it must be unique within the service. The\nname can only include alphanumeric characters as well as '-'.\n\nThe maximum length of the limit name is 64 characters.",
"type": "string"
},
"freeTier": {
+ "type": "string",
"format": "int64",
- "description": "Free tier value displayed in the Developers Console for this limit.\nThe free tier is the number of tokens that will be subtracted from the\nbilled amount when billing is enabled.\nThis field can only be set on a limit with duration \"1d\", in a billable\ngroup; it is invalid on any other limit. If this field is not set, it\ndefaults to 0, indicating that there is no free tier for this service.\n\nUsed by group-based quotas only.",
+ "description": "Free tier value displayed in the Developers Console for this limit.\nThe free tier is the number of tokens that will be subtracted from the\nbilled amount when billing is enabled.\nThis field can only be set on a limit with duration \"1d\", in a billable\ngroup; it is invalid on any other limit. If this field is not set, it\ndefaults to 0, indicating that there is no free tier for this service.\n\nUsed by group-based quotas only."
+ },
+ "duration": {
+ "description": "Duration of this limit in textual notation. Example: \"100s\", \"24h\", \"1d\".\nFor duration longer than a day, only multiple of days is supported. We\nsupport only \"100s\" and \"1d\" for now. Additional support will be added in\nthe future. \"0\" indicates indefinite duration.\n\nUsed by group-based quotas only.",
"type": "string"
},
"defaultLimit": {
@@ -1846,34 +859,41 @@
"type": "string"
}
},
- "id": "QuotaLimit"
+ "id": "QuotaLimit",
+ "description": "`QuotaLimit` defines a specific limit that applies over a specified duration\nfor a limit type. There can be at most one limit for a duration and limit\ntype combination defined within a `QuotaGroup`.",
+ "type": "object"
},
"Method": {
+ "description": "Method represents a method of an API interface.",
"type": "object",
"properties": {
+ "name": {
+ "description": "The simple name of this method.",
+ "type": "string"
+ },
"requestTypeUrl": {
"description": "A URL of the input message type.",
"type": "string"
},
"requestStreaming": {
- "description": "If true, the request is streamed.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "If true, the request is streamed."
},
"syntax": {
- "type": "string",
- "enumDescriptions": [
- "Syntax `proto2`.",
- "Syntax `proto3`."
- ],
"enum": [
"SYNTAX_PROTO2",
"SYNTAX_PROTO3"
],
- "description": "The source syntax of this method."
+ "description": "The source syntax of this method.",
+ "type": "string",
+ "enumDescriptions": [
+ "Syntax `proto2`.",
+ "Syntax `proto3`."
+ ]
},
"responseTypeUrl": {
- "type": "string",
- "description": "The URL of the output message type."
+ "description": "The URL of the output message type.",
+ "type": "string"
},
"options": {
"description": "Any metadata attached to the method.",
@@ -1885,14 +905,9 @@
"responseStreaming": {
"description": "If true, the response is streamed.",
"type": "boolean"
- },
- "name": {
- "description": "The simple name of this method.",
- "type": "string"
}
},
- "id": "Method",
- "description": "Method represents a method of an API interface."
+ "id": "Method"
},
"Mixin": {
"description": "Declares an API Interface to be included in this interface. The including\ninterface must redeclare all the methods from the included interface, but\ndocumentation and options are inherited as follows:\n\n- If after comment and whitespace stripping, the documentation\n string of the redeclared method is empty, it will be inherited\n from the original method.\n\n- Each annotation belonging to the service config (http,\n visibility) which is not set in the redeclared method will be\n inherited.\n\n- If an http annotation is inherited, the path pattern will be\n modified as follows. Any version prefix will be replaced by the\n version of the including interface plus the root path if\n specified.\n\nExample of a simple mixin:\n\n package google.acl.v1;\n service AccessControl {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v1/{resource=**}:getAcl\";\n }\n }\n\n package google.storage.v2;\n service Storage {\n // rpc GetAcl(GetAclRequest) returns (Acl);\n\n // Get a data record.\n rpc GetData(GetDataRequest) returns (Data) {\n option (google.api.http).get = \"/v2/{resource=**}\";\n }\n }\n\nExample of a mixin configuration:\n\n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.AccessControl\n\nThe mixin construct implies that all methods in `AccessControl` are\nalso declared with same name and request/response types in\n`Storage`. A documentation generator or annotation processor will\nsee the effective `Storage.GetAcl` method after inherting\ndocumentation and annotations as follows:\n\n service Storage {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v2/{resource=**}:getAcl\";\n }\n ...\n }\n\nNote how the version in the path pattern changed from `v1` to `v2`.\n\nIf the `root` field in the mixin is specified, it should be a\nrelative path under which inherited HTTP paths are placed. Example:\n\n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.AccessControl\n root: acls\n\nThis implies the following inherited HTTP annotation:\n\n service Storage {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\";\n }\n ...\n }",
@@ -1910,6 +925,8 @@
"id": "Mixin"
},
"CustomError": {
+ "description": "Customize service error responses. For example, list any service\nspecific protobuf types that can appear in error detail lists of\nerror responses.\n\nExample:\n\n custom_error:\n types:\n - google.foo.v1.CustomError\n - google.foo.v1.AnotherError",
+ "type": "object",
"properties": {
"types": {
"description": "The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.",
@@ -1926,12 +943,9 @@
"type": "array"
}
},
- "id": "CustomError",
- "description": "Customize service error responses. For example, list any service\nspecific protobuf types that can appear in error detail lists of\nerror responses.\n\nExample:\n\n custom_error:\n types:\n - google.foo.v1.CustomError\n - google.foo.v1.AnotherError",
- "type": "object"
+ "id": "CustomError"
},
"Http": {
- "type": "object",
"properties": {
"fullyDecodeReservedExpansion": {
"description": "When set to true, URL path parmeters will be fully URI-decoded except in\ncases of single segment matches in reserved expansion, where \"%2F\" will be\nleft encoded.\n\nThe default behavior is to not decode RFC 6570 reserved characters in multi\nsegment matches.",
@@ -1946,7 +960,8 @@
}
},
"id": "Http",
- "description": "Defines the HTTP configuration for an API service. It contains a list of\nHttpRule, each specifying the mapping of an RPC method\nto one or more HTTP REST API methods."
+ "description": "Defines the HTTP configuration for an API service. It contains a list of\nHttpRule, each specifying the mapping of an RPC method\nto one or more HTTP REST API methods.",
+ "type": "object"
},
"SourceInfo": {
"type": "object",
@@ -1954,11 +969,11 @@
"sourceFiles": {
"description": "All files used during config generation.",
"items": {
- "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- }
+ },
+ "type": "object"
},
"type": "array"
}
@@ -1967,22 +982,776 @@
"description": "Source information used to create a Service Config"
},
"Control": {
- "id": "Control",
"description": "Selects and configures the service controller used by the service. The\nservice controller handles features like abuse, quota, billing, logging,\nmonitoring, etc.",
"type": "object",
"properties": {
"environment": {
+ "description": "The service control environment to use. If empty, no control plane\nfeature (like quota and billing) will be enabled.",
+ "type": "string"
+ }
+ },
+ "id": "Control"
+ },
+ "SystemParameter": {
+ "description": "Define a parameter's name and location. The parameter may be passed as either\nan HTTP header or a URL query parameter, and if both are passed the behavior\nis implementation-dependent.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Define the name of the parameter, such as \"api_key\" . It is case sensitive.",
+ "type": "string"
+ },
+ "urlQueryParameter": {
+ "description": "Define the URL query parameter name to use for the parameter. It is case\nsensitive.",
+ "type": "string"
+ },
+ "httpHeader": {
+ "description": "Define the HTTP header name to use for the parameter. It is case\ninsensitive.",
+ "type": "string"
+ }
+ },
+ "id": "SystemParameter"
+ },
+ "Field": {
+ "description": "A single field of a message type.",
+ "type": "object",
+ "properties": {
+ "options": {
+ "description": "The protocol buffer options.",
+ "items": {
+ "$ref": "Option"
+ },
+ "type": "array"
+ },
+ "oneofIndex": {
+ "format": "int32",
+ "description": "The index of the field type in `Type.oneofs`, for message or enumeration\ntypes. The first type has index 1; zero means the type is not in the list.",
+ "type": "integer"
+ },
+ "cardinality": {
"type": "string",
- "description": "The service control environment to use. If empty, no control plane\nfeature (like quota and billing) will be enabled."
+ "enumDescriptions": [
+ "For fields with unknown cardinality.",
+ "For optional fields.",
+ "For required fields. Proto2 syntax only.",
+ "For repeated fields."
+ ],
+ "enum": [
+ "CARDINALITY_UNKNOWN",
+ "CARDINALITY_OPTIONAL",
+ "CARDINALITY_REQUIRED",
+ "CARDINALITY_REPEATED"
+ ],
+ "description": "The field cardinality."
+ },
+ "packed": {
+ "type": "boolean",
+ "description": "Whether to use alternative packed wire representation."
+ },
+ "defaultValue": {
+ "description": "The string value of the default value of this field. Proto2 syntax only.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The field name.",
+ "type": "string"
+ },
+ "typeUrl": {
+ "description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.Timestamp\"`.",
+ "type": "string"
+ },
+ "number": {
+ "format": "int32",
+ "description": "The field number.",
+ "type": "integer"
+ },
+ "jsonName": {
+ "description": "The field JSON name.",
+ "type": "string"
+ },
+ "kind": {
+ "enumDescriptions": [
+ "Field type unknown.",
+ "Field type double.",
+ "Field type float.",
+ "Field type int64.",
+ "Field type uint64.",
+ "Field type int32.",
+ "Field type fixed64.",
+ "Field type fixed32.",
+ "Field type bool.",
+ "Field type string.",
+ "Field type group. Proto2 syntax only, and deprecated.",
+ "Field type message.",
+ "Field type bytes.",
+ "Field type uint32.",
+ "Field type enum.",
+ "Field type sfixed32.",
+ "Field type sfixed64.",
+ "Field type sint32.",
+ "Field type sint64."
+ ],
+ "enum": [
+ "TYPE_UNKNOWN",
+ "TYPE_DOUBLE",
+ "TYPE_FLOAT",
+ "TYPE_INT64",
+ "TYPE_UINT64",
+ "TYPE_INT32",
+ "TYPE_FIXED64",
+ "TYPE_FIXED32",
+ "TYPE_BOOL",
+ "TYPE_STRING",
+ "TYPE_GROUP",
+ "TYPE_MESSAGE",
+ "TYPE_BYTES",
+ "TYPE_UINT32",
+ "TYPE_ENUM",
+ "TYPE_SFIXED32",
+ "TYPE_SFIXED64",
+ "TYPE_SINT32",
+ "TYPE_SINT64"
+ ],
+ "description": "The field type.",
+ "type": "string"
+ }
+ },
+ "id": "Field"
+ },
+ "Monitoring": {
+ "description": "Monitoring configuration of the service.\n\nThe example below shows how to configure monitored resources and metrics\nfor monitoring. In the example, a monitored resource and two metrics are\ndefined. The `library.googleapis.com/book/returned_count` metric is sent\nto both producer and consumer projects, whereas the\n`library.googleapis.com/book/overdue_count` metric is only sent to the\nconsumer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/returned_count\n metric_kind: DELTA\n value_type: INT64\n labels:\n - key: /customer_id\n - name: library.googleapis.com/book/overdue_count\n metric_kind: GAUGE\n value_type: INT64\n labels:\n - key: /customer_id\n monitoring:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n - library.googleapis.com/book/overdue_count",
+ "type": "object",
+ "properties": {
+ "consumerDestinations": {
+ "description": "Monitoring configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none consumer destination.",
+ "items": {
+ "$ref": "MonitoringDestination"
+ },
+ "type": "array"
+ },
+ "producerDestinations": {
+ "description": "Monitoring configurations for sending metrics to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none producer destination.",
+ "items": {
+ "$ref": "MonitoringDestination"
+ },
+ "type": "array"
+ }
+ },
+ "id": "Monitoring"
+ },
+ "Enum": {
+ "id": "Enum",
+ "description": "Enum type definition.",
+ "type": "object",
+ "properties": {
+ "enumvalue": {
+ "description": "Enum value definitions.",
+ "items": {
+ "$ref": "EnumValue"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "Enum type name.",
+ "type": "string"
+ },
+ "options": {
+ "description": "Protocol buffer options.",
+ "items": {
+ "$ref": "Option"
+ },
+ "type": "array"
+ },
+ "syntax": {
+ "enumDescriptions": [
+ "Syntax `proto2`.",
+ "Syntax `proto3`."
+ ],
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ],
+ "description": "The source syntax.",
+ "type": "string"
+ },
+ "sourceContext": {
+ "description": "The source context.",
+ "$ref": "SourceContext"
+ }
+ }
+ },
+ "EnableServiceRequest": {
+ "description": "Request message for EnableService method.",
+ "type": "object",
+ "properties": {},
+ "id": "EnableServiceRequest"
+ },
+ "LabelDescriptor": {
+ "description": "A description of a label.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "A human-readable description for the label.",
+ "type": "string"
+ },
+ "valueType": {
+ "enumDescriptions": [
+ "A variable-length string. This is the default.",
+ "Boolean; true or false.",
+ "A 64-bit signed integer."
+ ],
+ "enum": [
+ "STRING",
+ "BOOL",
+ "INT64"
+ ],
+ "description": "The type of data that can be assigned to the label.",
+ "type": "string"
+ },
+ "key": {
+ "description": "The label key.",
+ "type": "string"
+ }
+ },
+ "id": "LabelDescriptor"
+ },
+ "Type": {
+ "type": "object",
+ "properties": {
+ "options": {
+ "description": "The protocol buffer options.",
+ "items": {
+ "$ref": "Option"
+ },
+ "type": "array"
+ },
+ "fields": {
+ "items": {
+ "$ref": "Field"
+ },
+ "type": "array",
+ "description": "The list of fields."
+ },
+ "name": {
+ "description": "The fully qualified message name.",
+ "type": "string"
+ },
+ "oneofs": {
+ "description": "The list of types appearing in `oneof` definitions in this type.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "syntax": {
+ "type": "string",
+ "enumDescriptions": [
+ "Syntax `proto2`.",
+ "Syntax `proto3`."
+ ],
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ],
+ "description": "The source syntax."
+ },
+ "sourceContext": {
+ "$ref": "SourceContext",
+ "description": "The source context."
+ }
+ },
+ "id": "Type",
+ "description": "A protocol buffer message type."
+ },
+ "Experimental": {
+ "description": "Experimental service configuration. These configuration options can\nonly be used by whitelisted users.",
+ "type": "object",
+ "properties": {
+ "authorization": {
+ "description": "Authorization configuration.",
+ "$ref": "AuthorizationConfig"
+ }
+ },
+ "id": "Experimental"
+ },
+ "Backend": {
+ "description": "`Backend` defines the backend configuration for a service.",
+ "type": "object",
+ "properties": {
+ "rules": {
+ "description": "A list of API backend rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
+ "items": {
+ "$ref": "BackendRule"
+ },
+ "type": "array"
+ }
+ },
+ "id": "Backend"
+ },
+ "DocumentationRule": {
+ "description": "A documentation rule provides information about individual API elements.",
+ "type": "object",
+ "properties": {
+ "deprecationDescription": {
+ "description": "Deprecation description of the selected element(s). It can be provided if an\nelement is marked as `deprecated`.",
+ "type": "string"
+ },
+ "selector": {
+ "description": "The selector is a comma-separated list of patterns. Each pattern is a\nqualified name of the element which may end in \"*\", indicating a wildcard.\nWildcards are only allowed at the end and for a whole component of the\nqualified name, i.e. \"foo.*\" is ok, but not \"foo.b*\" or \"foo.*.bar\". To\nspecify a default for all applicable elements, the whole pattern \"*\"\nis used.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Description of the selected API(s).",
+ "type": "string"
+ }
+ },
+ "id": "DocumentationRule"
+ },
+ "AuthorizationConfig": {
+ "description": "Configuration of authorization.\n\nThis section determines the authorization provider, if unspecified, then no\nauthorization check will be done.\n\nExample:\n\n experimental:\n authorization:\n provider: firebaserules.googleapis.com",
+ "type": "object",
+ "properties": {
+ "provider": {
+ "description": "The name of the authorization provider, such as\nfirebaserules.googleapis.com.",
+ "type": "string"
+ }
+ },
+ "id": "AuthorizationConfig"
+ },
+ "ContextRule": {
+ "properties": {
+ "requested": {
+ "description": "A list of full type names of requested contexts.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "selector": {
+ "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ },
+ "provided": {
+ "description": "A list of full type names of provided contexts.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ContextRule",
+ "description": "A context rule provides information about the context for an individual API\nelement.",
+ "type": "object"
+ },
+ "Billing": {
+ "description": "Billing related configuration of the service.\n\nThe following example shows how to configure monitored resources and metrics\nfor billing:\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/borrowed_count\n metric_kind: DELTA\n value_type: INT64\n billing:\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/borrowed_count",
+ "type": "object",
+ "properties": {
+ "consumerDestinations": {
+ "description": "Billing configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations per service, each one must have\na different monitored resource type. A metric can be used in at most\none consumer destination.",
+ "items": {
+ "$ref": "BillingDestination"
+ },
+ "type": "array"
+ }
+ },
+ "id": "Billing"
+ },
+ "MetricDescriptor": {
+ "id": "MetricDescriptor",
+ "description": "Defines a metric type and its schema. Once a metric descriptor is created,\ndeleting or altering it stops data collection and makes the metric type's\nexisting data unusable.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "The metric type, including its DNS name prefix. The type is not\nURL-encoded. All user-defined custom metric types have the DNS name\n`custom.googleapis.com`. Metric types should use a natural hierarchical\ngrouping. For example:\n\n \"custom.googleapis.com/invoice/paid/amount\"\n \"appengine.googleapis.com/http/server/response_latencies\""
+ },
+ "valueType": {
+ "enumDescriptions": [
+ "Do not use this default value.",
+ "The value is a boolean.\nThis value type can be used only if the metric kind is `GAUGE`.",
+ "The value is a signed 64-bit integer.",
+ "The value is a double precision floating point number.",
+ "The value is a text string.\nThis value type can be used only if the metric kind is `GAUGE`.",
+ "The value is a `Distribution`.",
+ "The value is money."
+ ],
+ "enum": [
+ "VALUE_TYPE_UNSPECIFIED",
+ "BOOL",
+ "INT64",
+ "DOUBLE",
+ "STRING",
+ "DISTRIBUTION",
+ "MONEY"
+ ],
+ "description": "Whether the measurement is an integer, a floating-point number, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported.",
+ "type": "string"
+ },
+ "metricKind": {
+ "description": "Whether the metric records instantaneous values, changes to a value, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported.",
+ "type": "string",
+ "enumDescriptions": [
+ "Do not use this default value.",
+ "An instantaneous measurement of a value.",
+ "The change in a value during a time interval.",
+ "A value accumulated over a time interval. Cumulative\nmeasurements in a time series should have the same start time\nand increasing end times, until an event resets the cumulative\nvalue to zero and sets a new start time for the following\npoints."
+ ],
+ "enum": [
+ "METRIC_KIND_UNSPECIFIED",
+ "GAUGE",
+ "DELTA",
+ "CUMULATIVE"
+ ]
+ },
+ "description": {
+ "description": "A detailed description of the metric, which can be used in documentation.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "A concise name for the metric, which can be displayed in user interfaces.\nUse sentence case without an ending period, for example \"Request count\".\nThis field is optional but it is recommended to be set for any metrics\nassociated with user-visible concepts, such as Quota.",
+ "type": "string"
+ },
+ "unit": {
+ "description": "The unit in which the metric value is reported. It is only applicable\nif the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The\nsupported units are a subset of [The Unified Code for Units of\nMeasure](http://unitsofmeasure.org/ucum.html) standard:\n\n**Basic units (UNIT)**\n\n* `bit` bit\n* `By` byte\n* `s` second\n* `min` minute\n* `h` hour\n* `d` day\n\n**Prefixes (PREFIX)**\n\n* `k` kilo (10**3)\n* `M` mega (10**6)\n* `G` giga (10**9)\n* `T` tera (10**12)\n* `P` peta (10**15)\n* `E` exa (10**18)\n* `Z` zetta (10**21)\n* `Y` yotta (10**24)\n* `m` milli (10**-3)\n* `u` micro (10**-6)\n* `n` nano (10**-9)\n* `p` pico (10**-12)\n* `f` femto (10**-15)\n* `a` atto (10**-18)\n* `z` zepto (10**-21)\n* `y` yocto (10**-24)\n* `Ki` kibi (2**10)\n* `Mi` mebi (2**20)\n* `Gi` gibi (2**30)\n* `Ti` tebi (2**40)\n\n**Grammar**\n\nThe grammar includes the dimensionless unit `1`, such as `1/s`.\n\nThe grammar also includes these connectors:\n\n* `/` division (as an infix operator, e.g. `1/s`).\n* `.` multiplication (as an infix operator, e.g. `GBy.d`)\n\nThe grammar for a unit is as follows:\n\n Expression = Component { \".\" Component } { \"/\" Component } ;\n\n Component = [ PREFIX ] UNIT [ Annotation ]\n | Annotation\n | \"1\"\n ;\n\n Annotation = \"{\" NAME \"}\" ;\n\nNotes:\n\n* `Annotation` is just a comment if it follows a `UNIT` and is\n equivalent to `1` if it is used alone. For examples,\n `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.\n* `NAME` is a sequence of non-blank printable ASCII characters not\n containing '{' or '}'.",
+ "type": "string"
+ },
+ "labels": {
+ "description": "The set of labels that can be used to describe a specific\ninstance of this metric type. For example, the\n`appengine.googleapis.com/http/server/response_latencies` metric\ntype has a label for the HTTP response code, `response_code`, so\nyou can look at latencies for successful responses or just\nfor responses that failed.",
+ "items": {
+ "$ref": "LabelDescriptor"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "The resource name of the metric descriptor.",
+ "type": "string"
+ }
+ }
+ },
+ "SourceContext": {
+ "description": "`SourceContext` represents information about the source of a\nprotobuf element, like the file in which it is defined.",
+ "type": "object",
+ "properties": {
+ "fileName": {
+ "description": "The path-qualified name of the .proto file that contained the associated\nprotobuf element. For example: `\"google/protobuf/source_context.proto\"`.",
+ "type": "string"
+ }
+ },
+ "id": "SourceContext"
+ },
+ "Endpoint": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The canonical name of this endpoint.",
+ "type": "string"
+ },
+ "target": {
+ "description": "The specification of an Internet routable address of API frontend that will\nhandle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary).\nIt should be either a valid IPv4 address or a fully-qualified domain name.\nFor example, \"8.8.8.8\" or \"myservice.appspot.com\".",
+ "type": "string"
+ },
+ "features": {
+ "description": "The list of features enabled on this endpoint.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "apis": {
+ "description": "The list of APIs served by this endpoint.\n\nIf no APIs are specified this translates to \"all APIs\" exported by the\nservice, as defined in the top-level service configuration.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "allowCors": {
+ "description": "Allowing\n[CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka\ncross-domain traffic, would allow the backends served from this endpoint to\nreceive and respond to HTTP OPTIONS requests. The response will be used by\nthe browser to determine whether the subsequent cross-origin request is\nallowed to proceed.",
+ "type": "boolean"
+ },
+ "aliases": {
+ "description": "DEPRECATED: This field is no longer supported. Instead of using aliases,\nplease specify multiple google.api.Endpoint for each of the intented\nalias.\n\nAdditional names that this endpoint will be hosted on.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "Endpoint",
+ "description": "`Endpoint` describes a network endpoint that serves a set of APIs.\nA service may expose any number of endpoints, and all endpoints share the\nsame service configuration, such as quota configuration and monitoring\nconfiguration.\n\nExample service configuration:\n\n name: library-example.googleapis.com\n endpoints:\n # Below entry makes 'google.example.library.v1.Library'\n # API be served from endpoint address library-example.googleapis.com.\n # It also allows HTTP OPTIONS calls to be passed to the backend, for\n # it to decide whether the subsequent cross-origin request is\n # allowed to proceed.\n - name: library-example.googleapis.com\n allow_cors: true"
+ },
+ "ListEnabledServicesResponse": {
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Token that can be passed to `ListEnabledServices` to resume a paginated\nquery.",
+ "type": "string"
+ },
+ "services": {
+ "description": "Services enabled for the specified parent.",
+ "items": {
+ "$ref": "PublishedService"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListEnabledServicesResponse",
+ "description": "Response message for `ListEnabledServices` method."
+ },
+ "OAuthRequirements": {
+ "properties": {
+ "canonicalScopes": {
+ "description": "The list of publicly documented OAuth scopes that are allowed access. An\nOAuth token containing any of these scopes will be accepted.\n\nExample:\n\n canonical_scopes: https://www.googleapis.com/auth/calendar,\n https://www.googleapis.com/auth/calendar.read",
+ "type": "string"
+ }
+ },
+ "id": "OAuthRequirements",
+ "description": "OAuth scopes are a way to define data and permissions on data. For example,\nthere are scopes defined for \"Read-only access to Google Calendar\" and\n\"Access to Cloud Platform\". Users can consent to a scope for an application,\ngiving it permission to access that data on their behalf.\n\nOAuth scope specifications should be fairly coarse grained; a user will need\nto see and understand the text description of what your scope means.\n\nIn most cases: use one or at most two OAuth scopes for an entire family of\nproducts. If your product has multiple APIs, you should probably be sharing\nthe OAuth scope across all of those APIs.\n\nWhen you need finer grained OAuth consent screens: talk with your product\nmanagement about how developers will use them in practice.\n\nPlease note that even though each of the canonical scopes is enough for a\nrequest to be accepted and passed to the backend, a request can still fail\ndue to the backend requiring additional scopes or permissions.",
+ "type": "object"
+ },
+ "Usage": {
+ "type": "object",
+ "properties": {
+ "requirements": {
+ "description": "Requirements that must be satisfied before a consumer project can use the\nservice. Each requirement is of the form \u003cservice.name\u003e/\u003crequirement-id\u003e;\nfor example 'serviceusage.googleapis.com/billing-enabled'.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "producerNotificationChannel": {
+ "description": "The full resource name of a channel used for sending notifications to the\nservice producer.\n\nGoogle Service Management currently only supports\n[Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification\nchannel. To use Google Cloud Pub/Sub as the channel, this must be the name\nof a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format\ndocumented in https://cloud.google.com/pubsub/docs/overview.",
+ "type": "string"
+ },
+ "rules": {
+ "description": "A list of usage rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
+ "items": {
+ "$ref": "UsageRule"
+ },
+ "type": "array"
+ }
+ },
+ "id": "Usage",
+ "description": "Configuration controlling usage of a service."
+ },
+ "Context": {
+ "description": "`Context` defines which contexts an API requests.\n\nExample:\n\n context:\n rules:\n - selector: \"*\"\n requested:\n - google.rpc.context.ProjectContext\n - google.rpc.context.OriginContext\n\nThe above specifies that all methods in the API request\n`google.rpc.context.ProjectContext` and\n`google.rpc.context.OriginContext`.\n\nAvailable context types are defined in package\n`google.rpc.context`.",
+ "type": "object",
+ "properties": {
+ "rules": {
+ "description": "A list of RPC context rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
+ "items": {
+ "$ref": "ContextRule"
+ },
+ "type": "array"
+ }
+ },
+ "id": "Context"
+ },
+ "LogDescriptor": {
+ "type": "object",
+ "properties": {
+ "labels": {
+ "items": {
+ "$ref": "LabelDescriptor"
+ },
+ "type": "array",
+ "description": "The set of labels that are available to describe a specific log entry.\nRuntime requests that contain labels not specified here are\nconsidered invalid."
+ },
+ "name": {
+ "description": "The name of the log. It must be less than 512 characters long and can\ninclude the following characters: upper- and lower-case alphanumeric\ncharacters [A-Za-z0-9], and punctuation characters including\nslash, underscore, hyphen, period [/_-.].",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "The human-readable name for this log. This information appears on\nthe user interface and should be concise.",
+ "type": "string"
+ },
+ "description": {
+ "description": "A human-readable description of this log. This information appears in\nthe documentation and can contain details.",
+ "type": "string"
+ }
+ },
+ "id": "LogDescriptor",
+ "description": "A description of a log type. Example in YAML format:\n\n - name: library.googleapis.com/activity_history\n description: The history of borrowing and returning library items.\n display_name: Activity\n labels:\n - key: /customer_id\n description: Identifier of a library customer"
+ },
+ "MonitoredResourceDescriptor": {
+ "id": "MonitoredResourceDescriptor",
+ "description": "An object that describes the schema of a MonitoredResource object using a\ntype name and a set of labels. For example, the monitored resource\ndescriptor for Google Compute Engine VM instances has a type of\n`\"gce_instance\"` and specifies the use of the labels `\"instance_id\"` and\n`\"zone\"` to identify particular VM instances.\n\nDifferent APIs can support different monitored resource types. APIs generally\nprovide a `list` method that returns the monitored resource descriptors used\nby the API.",
+ "type": "object",
+ "properties": {
+ "labels": {
+ "description": "Required. A set of labels used to describe instances of this monitored\nresource type. For example, an individual Google Cloud SQL database is\nidentified by values for the labels `\"database_id\"` and `\"zone\"`.",
+ "items": {
+ "$ref": "LabelDescriptor"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "Optional. The resource name of the monitored resource descriptor:\n`\"projects/{project_id}/monitoredResourceDescriptors/{type}\"` where\n{type} is the value of the `type` field in this object and\n{project_id} is a project ID that provides API-specific context for\naccessing the type. APIs that do not use project information can use the\nresource name format `\"monitoredResourceDescriptors/{type}\"`.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Optional. A detailed description of the monitored resource type that might\nbe used in documentation.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Optional. A concise name for the monitored resource type that might be\ndisplayed in user interfaces. It should be a Title Cased Noun Phrase,\nwithout any article or other determiners. For example,\n`\"Google Cloud SQL Database\"`.",
+ "type": "string"
+ },
+ "type": {
+ "type": "string",
+ "description": "Required. The monitored resource type. For example, the type\n`\"cloudsql_database\"` represents databases in Google Cloud SQL.\nThe maximum length of this value is 256 characters."
+ }
+ }
+ },
+ "CustomErrorRule": {
+ "description": "A custom error rule.",
+ "type": "object",
+ "properties": {
+ "isErrorType": {
+ "type": "boolean",
+ "description": "Mark this message as possible payload in error response. Otherwise,\nobjects of this type will be filtered when they appear in error payload."
+ },
+ "selector": {
+ "description": "Selects messages to which this rule applies.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ }
+ },
+ "id": "CustomErrorRule"
+ },
+ "CustomAuthRequirements": {
+ "description": "Configuration for a custom authentication provider.",
+ "type": "object",
+ "properties": {
+ "provider": {
+ "description": "A configuration string containing connection information for the\nauthentication provider, typically formatted as a SmartService string\n(go/smartservice).",
+ "type": "string"
+ }
+ },
+ "id": "CustomAuthRequirements"
+ },
+ "MediaDownload": {
+ "description": "Defines the Media configuration for a service in case of a download.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.",
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "description": "Whether download is enabled.",
+ "type": "boolean"
+ },
+ "downloadService": {
+ "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the download service if one is used for download.",
+ "type": "string"
+ },
+ "completeNotification": {
+ "description": "A boolean that determines whether a notification for the completion of a\ndownload should be sent to the backend.",
+ "type": "boolean"
+ },
+ "maxDirectDownloadSize": {
+ "format": "int64",
+ "description": "Optional maximum acceptable size for direct download.\nThe size is specified in bytes.",
+ "type": "string"
+ },
+ "dropzone": {
+ "description": "Name of the Scotty dropzone to use for the current API.",
+ "type": "string"
+ },
+ "useDirectDownload": {
+ "type": "boolean",
+ "description": "A boolean that determines if direct download from ESF should be used for\ndownload of this media."
+ }
+ },
+ "id": "MediaDownload"
+ },
+ "DisableServiceRequest": {
+ "description": "Request message for DisableService method.",
+ "type": "object",
+ "properties": {},
+ "id": "DisableServiceRequest"
+ },
+ "SearchServicesResponse": {
+ "description": "Response message for SearchServices method.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Token that can be passed to `ListAvailableServices` to resume a paginated\nquery.",
+ "type": "string"
+ },
+ "services": {
+ "description": "Services available publicly or available to the authenticated caller.",
+ "items": {
+ "$ref": "PublishedService"
+ },
+ "type": "array"
+ }
+ },
+ "id": "SearchServicesResponse"
+ },
+ "MediaUpload": {
+ "description": "Defines the Media configuration for a service in case of an upload.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.",
+ "type": "object",
+ "properties": {
+ "mimeTypes": {
+ "description": "An array of mimetype patterns. Esf will only accept uploads that match one\nof the given patterns.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "maxSize": {
+ "format": "int64",
+ "description": "Optional maximum acceptable size for an upload.\nThe size is specified in bytes.",
+ "type": "string"
+ },
+ "completeNotification": {
+ "description": "A boolean that determines whether a notification for the completion of an\nupload should be sent to the backend. These notifications will not be seen\nby the client and will not consume quota.",
+ "type": "boolean"
+ },
+ "progressNotification": {
+ "description": "Whether to receive a notification for progress changes of media upload.",
+ "type": "boolean"
+ },
+ "enabled": {
+ "description": "Whether upload is enabled.",
+ "type": "boolean"
+ },
+ "dropzone": {
+ "description": "Name of the Scotty dropzone to use for the current API.",
+ "type": "string"
+ },
+ "startNotification": {
+ "description": "Whether to receive a notification on the start of media upload.",
+ "type": "boolean"
+ },
+ "uploadService": {
+ "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the upload service if one is used for upload.",
+ "type": "string"
+ }
+ },
+ "id": "MediaUpload"
+ },
+ "BillingDestination": {
+ "id": "BillingDestination",
+ "description": "Configuration of a specific billing destination (Currently only support\nbill against consumer project).",
+ "type": "object",
+ "properties": {
+ "monitoredResource": {
+ "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section.",
+ "type": "string"
+ },
+ "metrics": {
+ "description": "Names of the metrics to report to this billing destination.\nEach name must be defined in Service.metrics section.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
}
}
},
+ "protocol": "rest",
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
- "protocol": "rest",
"canonicalName": "Service User",
"auth": {
"oauth2": {
@@ -2004,5 +1773,236 @@
"name": "serviceuser",
"batchPath": "batch",
"title": "Google Service User API",
- "ownerName": "Google"
+ "ownerName": "Google",
+ "resources": {
+ "services": {
+ "methods": {
+ "search": {
+ "response": {
+ "$ref": "SearchServicesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Token identifying which result to start with; returned by a previous list\ncall.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Requested size of the next page of data.",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/services:search",
+ "id": "serviceuser.services.search",
+ "path": "v1/services:search",
+ "description": "Search available services.\n\nWhen no filter is specified, returns all accessible services. For\nauthenticated users, also returns all services the calling user has\n\"servicemanagement.services.bind\" permission for."
+ }
+ }
+ },
+ "projects": {
+ "resources": {
+ "services": {
+ "methods": {
+ "disable": {
+ "request": {
+ "$ref": "DisableServiceRequest"
+ },
+ "description": "Disable a service so it can no longer be used with a\nproject. This prevents unintended usage that may cause unexpected billing\ncharges or security leaks.\n\nOperation\u003cresponse: google.protobuf.Empty\u003e",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "parameters": {
+ "name": {
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/services/[^/]+$",
+ "location": "path",
+ "description": "Name of the consumer and the service to disable for that consumer.\n\nThe Service User implementation accepts the following forms for consumer:\n- \"project:\u003cproject_id\u003e\"\n\nA valid path would be:\n- /v1/projects/my-project/services/servicemanagement.googleapis.com:disable"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/services/{servicesId}:disable",
+ "id": "serviceuser.projects.services.disable",
+ "path": "v1/{+name}:disable"
+ },
+ "enable": {
+ "path": "v1/{+name}:enable",
+ "id": "serviceuser.projects.services.enable",
+ "description": "Enable a service so it can be used with a project.\nSee [Cloud Auth Guide](https://cloud.google.com/docs/authentication) for\nmore information.\n\nOperation\u003cresponse: google.protobuf.Empty\u003e",
+ "request": {
+ "$ref": "EnableServiceRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Name of the consumer and the service to enable for that consumer.\n\nA valid path would be:\n- /v1/projects/my-project/services/servicemanagement.googleapis.com:enable",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/services/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "flatPath": "v1/projects/{projectsId}/services/{servicesId}:enable"
+ },
+ "list": {
+ "description": "List enabled services for the specified consumer.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListEnabledServicesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Token identifying which result to start with; returned by a previous list\ncall.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "Requested size of the next page of data.",
+ "type": "integer"
+ },
+ "parent": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "List enabled services for the specified parent.\n\nAn example valid parent would be:\n- projects/my-project",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/services",
+ "path": "v1/{+parent}/services",
+ "id": "serviceuser.projects.services.list"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "alt": {
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://serviceuser.googleapis.com/",
+ "servicePath": "",
+ "description": "Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use.",
+ "kind": "discovery#restDescription",
+ "basePath": ""
}
diff --git a/serviceuser/v1/serviceuser-gen.go b/serviceuser/v1/serviceuser-gen.go
index ace605a..ea67f5c 100644
--- a/serviceuser/v1/serviceuser-gen.go
+++ b/serviceuser/v1/serviceuser-gen.go
@@ -619,6 +619,7 @@
// The following example shows how to configure monitored resources and
// metrics
// for billing:
+//
// monitored_resources:
// - type: library.googleapis.com/branch
// labels:
@@ -2305,6 +2306,9 @@
// user interfaces.
// Use sentence case without an ending period, for example "Request
// count".
+ // This field is optional but it is recommended to be set for any
+ // metrics
+ // associated with user-visible concepts, such as Quota.
DisplayName string `json:"displayName,omitempty"`
// Labels: The set of labels that can be used to describe a
@@ -2334,21 +2338,7 @@
// points.
MetricKind string `json:"metricKind,omitempty"`
- // Name: The resource name of the metric descriptor. Depending on
- // the
- // implementation, the name typically includes: (1) the parent resource
- // name
- // that defines the scope of the metric type or of its data; and (2)
- // the
- // metric's URL-encoded type, which also appears in the `type` field of
- // this
- // descriptor. For example, following is the resource name of a
- // custom
- // metric within the GCP project `my-project-id`:
- //
- //
- // "projects/my-project-id/metricDescriptors/custom.googleapis.com%2Finvo
- // ice%2Fpaid%2Famount"
+ // Name: The resource name of the metric descriptor.
Name string `json:"name,omitempty"`
// Type: The metric type, including its DNS name prefix. The type is
@@ -3326,31 +3316,15 @@
// the same metric will be checked together during runtime. The metric
// must be
// defined within the service config.
- //
- // Used by metric-based quotas only.
Metric string `json:"metric,omitempty"`
- // Name: Name of the quota limit. The name is used to refer to the limit
- // when
- // overriding the default limit on per-consumer basis.
+ // Name: Name of the quota limit.
//
- // For metric-based quota limits, the name must be provided, and it must
- // be
- // unique within the service. The name can only include
- // alphanumeric
- // characters as well as '-'.
+ // The name must be provided, and it must be unique within the service.
+ // The
+ // name can only include alphanumeric characters as well as '-'.
//
// The maximum length of the limit name is 64 characters.
- //
- // The name of a limit is used as a unique identifier for this
- // limit.
- // Therefore, once a limit has been put into use, its name should
- // be
- // immutable. You can use the display_name field to provide a
- // user-friendly
- // name for the limit. The display name can be evolved over time
- // without
- // affecting the identity of the limit.
Name string `json:"name,omitempty"`
// Unit: Specify the unit of the quota limit. It uses the same syntax
@@ -3359,28 +3333,19 @@
// quota
// backend system.
//
- // The [Google Service
- // Control](https://cloud.google.com/service-control)
- // supports the following unit components:
- // * One of the time intevals:
- // * "/min" for quota every minute.
- // * "/d" for quota every 24 hours, starting 00:00 US Pacific Time.
- // * Otherwise the quota won't be reset by time, such as storage
- // limit.
- // * One and only one of the granted containers:
- // * "/{project}" quota for a project
- //
// Here are some examples:
// * "1/min/{project}" for quota per minute per project.
//
// Note: the order of unit components is insignificant.
// The "1" at the beginning is required to follow the metric unit
// syntax.
- //
- // Used by metric-based quotas only.
Unit string `json:"unit,omitempty"`
- // Values: Tiered limit values, currently only STANDARD is supported.
+ // Values: Tiered limit values. You must specify this as a key:value
+ // pair, with an
+ // integer value that is the maximum number of requests allowed for
+ // the
+ // specified unit. Currently only STANDARD is supported.
Values map[string]string `json:"values,omitempty"`
// ForceSendFields is a list of field names (e.g. "DefaultLimit") to
@@ -4162,6 +4127,9 @@
// SkipServiceControl: True, if the method should skip service control.
// If so, no control plane
// feature (like quota and billing) will be enabled.
+ // This flag is used by ESP to allow some Endpoints customers to
+ // bypass
+ // Google internal checks.
SkipServiceControl bool `json:"skipServiceControl,omitempty"`
// ForceSendFields is a list of field names (e.g.
diff --git a/sheets/v4/sheets-api.json b/sheets/v4/sheets-api.json
index 4602d08..3a62de0 100644
--- a/sheets/v4/sheets-api.json
+++ b/sheets/v4/sheets-api.json
@@ -1,8 +1,851 @@
{
+ "documentationLink": "https://developers.google.com/sheets/",
+ "id": "sheets:v4",
+ "revision": "20171006",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "ClearBasicFilterRequest": {
+ "type": "object",
+ "properties": {
+ "sheetId": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The sheet ID on which the basic filter should be cleared."
+ }
+ },
+ "id": "ClearBasicFilterRequest",
+ "description": "Clears the basic filter, if any exists on the sheet."
+ },
+ "TextToColumnsRequest": {
+ "description": "Splits a column of text into multiple columns,\nbased on a delimiter in each cell.",
+ "type": "object",
+ "properties": {
+ "delimiterType": {
+ "description": "The delimiter type to use.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value. This value must not be used.",
+ "\",\"",
+ "\";\"",
+ "\".\"",
+ "\" \"",
+ "A custom value as defined in delimiter."
+ ],
+ "enum": [
+ "DELIMITER_TYPE_UNSPECIFIED",
+ "COMMA",
+ "SEMICOLON",
+ "PERIOD",
+ "SPACE",
+ "CUSTOM"
+ ]
+ },
+ "source": {
+ "$ref": "GridRange",
+ "description": "The source data range. This must span exactly one column."
+ },
+ "delimiter": {
+ "description": "The delimiter to use. Used only if delimiterType is\nCUSTOM.",
+ "type": "string"
+ }
+ },
+ "id": "TextToColumnsRequest"
+ },
+ "DeleteBandingRequest": {
+ "description": "Removes the banded range with the given ID from the spreadsheet.",
+ "type": "object",
+ "properties": {
+ "bandedRangeId": {
+ "format": "int32",
+ "description": "The ID of the banded range to delete.",
+ "type": "integer"
+ }
+ },
+ "id": "DeleteBandingRequest"
+ },
+ "BatchUpdateSpreadsheetResponse": {
+ "description": "The reply for batch updating a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "updatedSpreadsheet": {
+ "description": "The spreadsheet after updates were applied. This is only set if\n[BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response] is `true`.",
+ "$ref": "Spreadsheet"
+ },
+ "replies": {
+ "items": {
+ "$ref": "Response"
+ },
+ "type": "array",
+ "description": "The reply of the updates. This maps 1:1 with the updates, although\nreplies to some requests may be empty."
+ },
+ "spreadsheetId": {
+ "description": "The spreadsheet the updates were applied to.",
+ "type": "string"
+ }
+ },
+ "id": "BatchUpdateSpreadsheetResponse"
+ },
+ "AppendValuesResponse": {
+ "description": "The response when updating a range of values in a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "spreadsheetId": {
+ "description": "The spreadsheet the updates were applied to.",
+ "type": "string"
+ },
+ "updates": {
+ "description": "Information about the updates that were applied.",
+ "$ref": "UpdateValuesResponse"
+ },
+ "tableRange": {
+ "description": "The range (in A1 notation) of the table that values are being appended to\n(before the values were appended).\nEmpty if no table was found.",
+ "type": "string"
+ }
+ },
+ "id": "AppendValuesResponse"
+ },
+ "PivotFilterCriteria": {
+ "properties": {
+ "visibleValues": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "Values that should be included. Values not listed here are excluded."
+ }
+ },
+ "id": "PivotFilterCriteria",
+ "description": "Criteria for showing/hiding rows in a pivot table.",
+ "type": "object"
+ },
+ "AddFilterViewRequest": {
+ "description": "Adds a filter view.",
+ "type": "object",
+ "properties": {
+ "filter": {
+ "$ref": "FilterView",
+ "description": "The filter to add. The filterViewId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a filter that already exists.)"
+ }
+ },
+ "id": "AddFilterViewRequest"
+ },
+ "MoveDimensionRequest": {
+ "id": "MoveDimensionRequest",
+ "description": "Moves one or more rows or columns.",
+ "type": "object",
+ "properties": {
+ "source": {
+ "$ref": "DimensionRange",
+ "description": "The source dimensions to move."
+ },
+ "destinationIndex": {
+ "format": "int32",
+ "description": "The zero-based start index of where to move the source data to,\nbased on the coordinates *before* the source data is removed\nfrom the grid. Existing data will be shifted down or right\n(depending on the dimension) to make room for the moved dimensions.\nThe source dimensions are removed from the grid, so the\nthe data may end up in a different index than specified.\n\nFor example, given `A1..A5` of `0, 1, 2, 3, 4` and wanting to move\n`\"1\"` and `\"2\"` to between `\"3\"` and `\"4\"`, the source would be\n`ROWS [1..3)`,and the destination index would be `\"4\"`\n(the zero-based index of row 5).\nThe end result would be `A1..A5` of `0, 3, 1, 2, 4`.",
+ "type": "integer"
+ }
+ }
+ },
+ "AddConditionalFormatRuleRequest": {
+ "type": "object",
+ "properties": {
+ "index": {
+ "format": "int32",
+ "description": "The zero-based index where the rule should be inserted.",
+ "type": "integer"
+ },
+ "rule": {
+ "$ref": "ConditionalFormatRule",
+ "description": "The rule to add."
+ }
+ },
+ "id": "AddConditionalFormatRuleRequest",
+ "description": "Adds a new conditional format rule at the given index.\nAll subsequent rules' indexes are incremented."
+ },
+ "ChartSpec": {
+ "properties": {
+ "maximized": {
+ "description": "True to make a chart fill the entire space in which it's rendered with\nminimum padding. False to use the default padding.\n(Not applicable to Geo and Org charts.)",
+ "type": "boolean"
+ },
+ "hiddenDimensionStrategy": {
+ "enum": [
+ "CHART_HIDDEN_DIMENSION_STRATEGY_UNSPECIFIED",
+ "SKIP_HIDDEN_ROWS_AND_COLUMNS",
+ "SKIP_HIDDEN_ROWS",
+ "SKIP_HIDDEN_COLUMNS",
+ "SHOW_ALL"
+ ],
+ "description": "Determines how the charts will use hidden rows or columns.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "Charts will skip hidden rows and columns.",
+ "Charts will skip hidden rows only.",
+ "Charts will skip hidden columns only.",
+ "Charts will not skip any hidden rows or columns."
+ ]
+ },
+ "subtitleTextFormat": {
+ "$ref": "TextFormat",
+ "description": "The subtitle text format.\nStrikethrough and underline are not supported."
+ },
+ "subtitle": {
+ "description": "The subtitle of the chart.",
+ "type": "string"
+ },
+ "subtitleTextPosition": {
+ "description": "The subtitle text position.\nThis field is optional.",
+ "$ref": "TextPosition"
+ },
+ "backgroundColor": {
+ "description": "The background color of the entire chart.\nNot applicable to Org charts.",
+ "$ref": "Color"
+ },
+ "basicChart": {
+ "description": "A basic chart specification, can be one of many kinds of charts.\nSee BasicChartType for the list of all\ncharts this supports.",
+ "$ref": "BasicChartSpec"
+ },
+ "orgChart": {
+ "description": "An org chart specification.",
+ "$ref": "OrgChartSpec"
+ },
+ "pieChart": {
+ "$ref": "PieChartSpec",
+ "description": "A pie chart specification."
+ },
+ "titleTextFormat": {
+ "$ref": "TextFormat",
+ "description": "The title text format.\nStrikethrough and underline are not supported."
+ },
+ "title": {
+ "description": "The title of the chart.",
+ "type": "string"
+ },
+ "altText": {
+ "type": "string",
+ "description": "The alternative text that describes the chart. This is often used\nfor accessibility."
+ },
+ "titleTextPosition": {
+ "$ref": "TextPosition",
+ "description": "The title text position.\nThis field is optional."
+ },
+ "histogramChart": {
+ "$ref": "HistogramChartSpec",
+ "description": "A histogram chart specification."
+ },
+ "candlestickChart": {
+ "$ref": "CandlestickChartSpec",
+ "description": "A candlestick chart specification."
+ },
+ "bubbleChart": {
+ "$ref": "BubbleChartSpec",
+ "description": "A bubble chart specification."
+ },
+ "fontName": {
+ "type": "string",
+ "description": "The name of the font to use by default for all chart text (e.g. title,\naxis labels, legend). If a font is specified for a specific part of the\nchart it will override this font name."
+ }
+ },
+ "id": "ChartSpec",
+ "description": "The specifications of a chart.",
+ "type": "object"
+ },
+ "CreateDeveloperMetadataRequest": {
+ "description": "A request to create developer metadata.",
+ "type": "object",
+ "properties": {
+ "developerMetadata": {
+ "$ref": "DeveloperMetadata",
+ "description": "The developer metadata to create."
+ }
+ },
+ "id": "CreateDeveloperMetadataRequest"
+ },
+ "BatchGetValuesByDataFilterResponse": {
+ "id": "BatchGetValuesByDataFilterResponse",
+ "description": "The response when retrieving more than one range of values in a spreadsheet\nselected by DataFilters.",
+ "type": "object",
+ "properties": {
+ "valueRanges": {
+ "description": "The requested values with the list of data filters that matched them.",
+ "items": {
+ "$ref": "MatchedValueRange"
+ },
+ "type": "array"
+ },
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet the data was retrieved from.",
+ "type": "string"
+ }
+ }
+ },
+ "DataFilterValueRange": {
+ "description": "A range of values whose location is specified by a DataFilter.",
+ "type": "object",
+ "properties": {
+ "dataFilter": {
+ "description": "The data filter describing the location of the values in the spreadsheet.",
+ "$ref": "DataFilter"
+ },
+ "values": {
+ "description": "The data to be written. If the provided values exceed any of the ranges\nmatched by the data filter then the request will fail. If the provided\nvalues are less than the matched ranges only the specified values will be\nwritten, existing values in the matched ranges will remain unaffected.",
+ "items": {
+ "items": {
+ "type": "any"
+ },
+ "type": "array"
+ },
+ "type": "array"
+ },
+ "majorDimension": {
+ "description": "The major dimension of the values.",
+ "type": "string",
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Operates on the rows of a sheet.",
+ "Operates on the columns of a sheet."
+ ],
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ]
+ }
+ },
+ "id": "DataFilterValueRange"
+ },
+ "NumberFormat": {
+ "id": "NumberFormat",
+ "description": "The number format of a cell.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enumDescriptions": [
+ "The number format is not specified\nand is based on the contents of the cell.\nDo not explicitly use this.",
+ "Text formatting, e.g `1000.12`",
+ "Number formatting, e.g, `1,000.12`",
+ "Percent formatting, e.g `10.12%`",
+ "Currency formatting, e.g `$1,000.12`",
+ "Date formatting, e.g `9/26/2008`",
+ "Time formatting, e.g `3:59:00 PM`",
+ "Date+Time formatting, e.g `9/26/08 15:59:00`",
+ "Scientific number formatting, e.g `1.01E+03`"
+ ],
+ "enum": [
+ "NUMBER_FORMAT_TYPE_UNSPECIFIED",
+ "TEXT",
+ "NUMBER",
+ "PERCENT",
+ "CURRENCY",
+ "DATE",
+ "TIME",
+ "DATE_TIME",
+ "SCIENTIFIC"
+ ],
+ "description": "The type of the number format.\nWhen writing, this field must be set."
+ },
+ "pattern": {
+ "description": "Pattern string used for formatting. If not set, a default pattern based on\nthe user's locale will be used if necessary for the given type.\nSee the [Date and Number Formats guide](/sheets/api/guides/formats) for more\ninformation about the supported patterns.",
+ "type": "string"
+ }
+ }
+ },
+ "CandlestickDomain": {
+ "description": "The domain of a CandlestickChart.",
+ "type": "object",
+ "properties": {
+ "data": {
+ "$ref": "ChartData",
+ "description": "The data of the CandlestickDomain."
+ },
+ "reversed": {
+ "description": "True to reverse the order of the domain values (horizontal axis).",
+ "type": "boolean"
+ }
+ },
+ "id": "CandlestickDomain"
+ },
+ "SheetProperties": {
+ "description": "Properties of a sheet.",
+ "type": "object",
+ "properties": {
+ "title": {
+ "description": "The name of the sheet.",
+ "type": "string"
+ },
+ "tabColor": {
+ "$ref": "Color",
+ "description": "The color of the tab in the UI."
+ },
+ "index": {
+ "format": "int32",
+ "description": "The index of the sheet within the spreadsheet.\nWhen adding or updating sheet properties, if this field\nis excluded then the sheet will be added or moved to the end\nof the sheet list. When updating sheet indices or inserting\nsheets, movement is considered in \"before the move\" indexes.\nFor example, if there were 3 sheets (S1, S2, S3) in order to\nmove S1 ahead of S2 the index would have to be set to 2. A sheet\nindex update request will be ignored if the requested index is\nidentical to the sheets current index or if the requested new\nindex is equal to the current sheet index + 1.",
+ "type": "integer"
+ },
+ "sheetId": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The ID of the sheet. Must be non-negative.\nThis field cannot be changed once set."
+ },
+ "rightToLeft": {
+ "description": "True if the sheet is an RTL sheet instead of an LTR sheet.",
+ "type": "boolean"
+ },
+ "hidden": {
+ "description": "True if the sheet is hidden in the UI, false if it's visible.",
+ "type": "boolean"
+ },
+ "sheetType": {
+ "enum": [
+ "SHEET_TYPE_UNSPECIFIED",
+ "GRID",
+ "OBJECT"
+ ],
+ "description": "The type of sheet. Defaults to GRID.\nThis field cannot be changed once set.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "The sheet is a grid.",
+ "The sheet has no grid and instead has an object like a chart or image."
+ ]
+ },
+ "gridProperties": {
+ "$ref": "GridProperties",
+ "description": "Additional properties of the sheet if this sheet is a grid.\n(If the sheet is an object sheet, containing a chart or image, then\nthis field will be absent.)\nWhen writing it is an error to set any grid properties on non-grid sheets."
+ }
+ },
+ "id": "SheetProperties"
+ },
+ "UpdateDimensionPropertiesRequest": {
+ "description": "Updates properties of dimensions within the specified range.",
+ "type": "object",
+ "properties": {
+ "fields": {
+ "format": "google-fieldmask",
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root `properties` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "type": "string"
+ },
+ "properties": {
+ "$ref": "DimensionProperties",
+ "description": "Properties to update."
+ },
+ "range": {
+ "description": "The rows or columns to update.",
+ "$ref": "DimensionRange"
+ }
+ },
+ "id": "UpdateDimensionPropertiesRequest"
+ },
+ "SourceAndDestination": {
+ "description": "A combination of a source range and how to extend that source.",
+ "type": "object",
+ "properties": {
+ "source": {
+ "$ref": "GridRange",
+ "description": "The location of the data to use as the source of the autofill."
+ },
+ "dimension": {
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Operates on the rows of a sheet.",
+ "Operates on the columns of a sheet."
+ ],
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ],
+ "description": "The dimension that data should be filled into.",
+ "type": "string"
+ },
+ "fillLength": {
+ "format": "int32",
+ "description": "The number of rows or columns that data should be filled into.\nPositive numbers expand beyond the last row or last column\nof the source. Negative numbers expand before the first row\nor first column of the source.",
+ "type": "integer"
+ }
+ },
+ "id": "SourceAndDestination"
+ },
+ "FilterView": {
+ "id": "FilterView",
+ "description": "A filter view.",
+ "type": "object",
+ "properties": {
+ "namedRangeId": {
+ "description": "The named range this filter view is backed by, if any.\n\nWhen writing, only one of range or named_range_id\nmay be set.",
+ "type": "string"
+ },
+ "filterViewId": {
+ "format": "int32",
+ "description": "The ID of the filter view.",
+ "type": "integer"
+ },
+ "criteria": {
+ "description": "The criteria for showing/hiding values per column.\nThe map's key is the column index, and the value is the criteria for\nthat column.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "FilterCriteria"
+ }
+ },
+ "title": {
+ "description": "The name of the filter view.",
+ "type": "string"
+ },
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range this filter view covers.\n\nWhen writing, only one of range or named_range_id\nmay be set."
+ },
+ "sortSpecs": {
+ "description": "The sort order per column. Later specifications are used when values\nare equal in the earlier specifications.",
+ "items": {
+ "$ref": "SortSpec"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "OrgChartSpec": {
+ "id": "OrgChartSpec",
+ "description": "An \u003ca href=\"/chart/interactive/docs/gallery/orgchart\"\u003eorg chart\u003c/a\u003e.\nOrg charts require a unique set of labels in labels and may\noptionally include parent_labels and tooltips.\nparent_labels contain, for each node, the label identifying the parent\nnode. tooltips contain, for each node, an optional tooltip.\n\nFor example, to describe an OrgChart with Alice as the CEO, Bob as the\nPresident (reporting to Alice) and Cathy as VP of Sales (also reporting to\nAlice), have labels contain \"Alice\", \"Bob\", \"Cathy\",\nparent_labels contain \"\", \"Alice\", \"Alice\" and tooltips contain\n\"CEO\", \"President\", \"VP Sales\".",
+ "type": "object",
+ "properties": {
+ "parentLabels": {
+ "$ref": "ChartData",
+ "description": "The data containing the label of the parent for the corresponding node.\nA blank value indicates that the node has no parent and is a top-level\nnode.\nThis field is optional."
+ },
+ "nodeSize": {
+ "enum": [
+ "ORG_CHART_LABEL_SIZE_UNSPECIFIED",
+ "SMALL",
+ "MEDIUM",
+ "LARGE"
+ ],
+ "description": "The size of the org chart nodes.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "The small org chart node size.",
+ "The medium org chart node size.",
+ "The large org chart node size."
+ ]
+ },
+ "labels": {
+ "$ref": "ChartData",
+ "description": "The data containing the labels for all the nodes in the chart. Labels\nmust be unique."
+ },
+ "nodeColor": {
+ "$ref": "Color",
+ "description": "The color of the org chart nodes."
+ },
+ "tooltips": {
+ "$ref": "ChartData",
+ "description": "The data containing the tooltip for the corresponding node. A blank value\nresults in no tooltip being displayed for the node.\nThis field is optional."
+ },
+ "selectedNodeColor": {
+ "description": "The color of the selected org chart nodes.",
+ "$ref": "Color"
+ }
+ }
+ },
+ "SearchDeveloperMetadataRequest": {
+ "description": "A request to retrieve all developer metadata matching the set of specified\ncriteria.",
+ "type": "object",
+ "properties": {
+ "dataFilters": {
+ "description": "The data filters describing the criteria used to determine which\nDeveloperMetadata entries to return. DeveloperMetadata matching any of the\nspecified filters will be included in the response.",
+ "items": {
+ "$ref": "DataFilter"
+ },
+ "type": "array"
+ }
+ },
+ "id": "SearchDeveloperMetadataRequest"
+ },
+ "BandingProperties": {
+ "id": "BandingProperties",
+ "description": "Properties referring a single dimension (either row or column). If both\nBandedRange.row_properties and BandedRange.column_properties are\nset, the fill colors are applied to cells according to the following rules:\n\n* header_color and footer_color take priority over band colors.\n* first_band_color takes priority over second_band_color.\n* row_properties takes priority over column_properties.\n\nFor example, the first row color takes priority over the first column\ncolor, but the first column color takes priority over the second row color.\nSimilarly, the row header takes priority over the column header in the\ntop left cell, but the column header takes priority over the first row\ncolor if the row header is not set.",
+ "type": "object",
+ "properties": {
+ "firstBandColor": {
+ "$ref": "Color",
+ "description": "The first color that is alternating. (Required)"
+ },
+ "secondBandColor": {
+ "description": "The second color that is alternating. (Required)",
+ "$ref": "Color"
+ },
+ "footerColor": {
+ "$ref": "Color",
+ "description": "The color of the last row or column. If this field is not set, the last\nrow or column will be filled with either first_band_color or\nsecond_band_color, depending on the color of the previous row or\ncolumn."
+ },
+ "headerColor": {
+ "$ref": "Color",
+ "description": "The color of the first row or column. If this field is set, the first\nrow or column will be filled with this color and the colors will\nalternate between first_band_color and second_band_color starting\nfrom the second row or column. Otherwise, the first row or column will be\nfilled with first_band_color and the colors will proceed to alternate\nas they normally would."
+ }
+ }
+ },
+ "AddProtectedRangeResponse": {
+ "description": "The result of adding a new protected range.",
+ "type": "object",
+ "properties": {
+ "protectedRange": {
+ "$ref": "ProtectedRange",
+ "description": "The newly added protected range."
+ }
+ },
+ "id": "AddProtectedRangeResponse"
+ },
+ "BasicFilter": {
+ "description": "The default filter associated with a sheet.",
+ "type": "object",
+ "properties": {
+ "criteria": {
+ "description": "The criteria for showing/hiding values per column.\nThe map's key is the column index, and the value is the criteria for\nthat column.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "FilterCriteria"
+ }
+ },
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range the filter covers."
+ },
+ "sortSpecs": {
+ "items": {
+ "$ref": "SortSpec"
+ },
+ "type": "array",
+ "description": "The sort order per column. Later specifications are used when values\nare equal in the earlier specifications."
+ }
+ },
+ "id": "BasicFilter"
+ },
+ "CandlestickSeries": {
+ "properties": {
+ "data": {
+ "$ref": "ChartData",
+ "description": "The data of the CandlestickSeries."
+ }
+ },
+ "id": "CandlestickSeries",
+ "description": "The series of a CandlestickData.",
+ "type": "object"
+ },
+ "HistogramChartSpec": {
+ "description": "A \u003ca href=\"/chart/interactive/docs/gallery/histogram\"\u003ehistogram chart\u003c/a\u003e.\nA histogram chart groups data items into bins, displaying each bin as a\ncolumn of stacked items. Histograms are used to display the distribution\nof a dataset. Each column of items represents a range into which those\nitems fall. The number of bins can be chosen automatically or specified\nexplicitly.",
+ "type": "object",
+ "properties": {
+ "outlierPercentile": {
+ "format": "double",
+ "description": "The outlier percentile is used to ensure that outliers do not adversely\naffect the calculation of bucket sizes. For example, setting an outlier\npercentile of 0.05 indicates that the top and bottom 5% of values when\ncalculating buckets. The values are still included in the chart, they will\nbe added to the first or last buckets instead of their own buckets.\nMust be between 0.0 and 0.5.",
+ "type": "number"
+ },
+ "showItemDividers": {
+ "description": "Whether horizontal divider lines should be displayed between items in each\ncolumn.",
+ "type": "boolean"
+ },
+ "series": {
+ "description": "The series for a histogram may be either a single series of values to be\nbucketed or multiple series, each of the same length, containing the name\nof the series followed by the values to be bucketed for that series.",
+ "items": {
+ "$ref": "HistogramSeries"
+ },
+ "type": "array"
+ },
+ "legendPosition": {
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "The legend is rendered on the bottom of the chart.",
+ "The legend is rendered on the left of the chart.",
+ "The legend is rendered on the right of the chart.",
+ "The legend is rendered on the top of the chart.",
+ "No legend is rendered.",
+ "The legend is rendered inside the chart area."
+ ],
+ "enum": [
+ "HISTOGRAM_CHART_LEGEND_POSITION_UNSPECIFIED",
+ "BOTTOM_LEGEND",
+ "LEFT_LEGEND",
+ "RIGHT_LEGEND",
+ "TOP_LEGEND",
+ "NO_LEGEND",
+ "INSIDE_LEGEND"
+ ],
+ "description": "The position of the chart legend."
+ },
+ "bucketSize": {
+ "format": "double",
+ "description": "By default the bucket size (the range of values stacked in a single\ncolumn) is chosen automatically, but it may be overridden here.\nE.g., A bucket size of 1.5 results in buckets from 0 - 1.5, 1.5 - 3.0, etc.\nCannot be negative.\nThis field is optional.",
+ "type": "number"
+ }
+ },
+ "id": "HistogramChartSpec"
+ },
+ "UpdateValuesResponse": {
+ "description": "The response when updating a range of values in a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "updatedData": {
+ "description": "The values of the cells after updates were applied.\nThis is only included if the request's `includeValuesInResponse` field\nwas `true`.",
+ "$ref": "ValueRange"
+ },
+ "updatedRows": {
+ "format": "int32",
+ "description": "The number of rows where at least one cell in the row was updated.",
+ "type": "integer"
+ },
+ "updatedColumns": {
+ "format": "int32",
+ "description": "The number of columns where at least one cell in the column was updated.",
+ "type": "integer"
+ },
+ "spreadsheetId": {
+ "description": "The spreadsheet the updates were applied to.",
+ "type": "string"
+ },
+ "updatedRange": {
+ "description": "The range (in A1 notation) that updates were applied to.",
+ "type": "string"
+ },
+ "updatedCells": {
+ "format": "int32",
+ "description": "The number of cells updated.",
+ "type": "integer"
+ }
+ },
+ "id": "UpdateValuesResponse"
+ },
+ "ErrorValue": {
+ "description": "An error in a cell.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "enumDescriptions": [
+ "The default error type, do not use this.",
+ "Corresponds to the `#ERROR!` error.",
+ "Corresponds to the `#NULL!` error.",
+ "Corresponds to the `#DIV/0` error.",
+ "Corresponds to the `#VALUE!` error.",
+ "Corresponds to the `#REF!` error.",
+ "Corresponds to the `#NAME?` error.",
+ "Corresponds to the `#NUM`! error.",
+ "Corresponds to the `#N/A` error.",
+ "Corresponds to the `Loading...` state."
+ ],
+ "enum": [
+ "ERROR_TYPE_UNSPECIFIED",
+ "ERROR",
+ "NULL_VALUE",
+ "DIVIDE_BY_ZERO",
+ "VALUE",
+ "REF",
+ "NAME",
+ "NUM",
+ "N_A",
+ "LOADING"
+ ],
+ "description": "The type of error.",
+ "type": "string"
+ },
+ "message": {
+ "description": "A message with more information about the error\n(in the spreadsheet's locale).",
+ "type": "string"
+ }
+ },
+ "id": "ErrorValue"
+ },
+ "PivotValue": {
+ "description": "The definition of how a value in a pivot table should be calculated.",
+ "type": "object",
+ "properties": {
+ "formula": {
+ "description": "A custom formula to calculate the value. The formula must start\nwith an `=` character.",
+ "type": "string"
+ },
+ "summarizeFunction": {
+ "enum": [
+ "PIVOT_STANDARD_VALUE_FUNCTION_UNSPECIFIED",
+ "SUM",
+ "COUNTA",
+ "COUNT",
+ "COUNTUNIQUE",
+ "AVERAGE",
+ "MAX",
+ "MIN",
+ "MEDIAN",
+ "PRODUCT",
+ "STDEV",
+ "STDEVP",
+ "VAR",
+ "VARP",
+ "CUSTOM"
+ ],
+ "description": "A function to summarize the value.\nIf formula is set, the only supported values are\nSUM and\nCUSTOM.\nIf sourceColumnOffset is set, then `CUSTOM`\nis not supported.",
+ "type": "string",
+ "enumDescriptions": [
+ "The default, do not use.",
+ "Corresponds to the `SUM` function.",
+ "Corresponds to the `COUNTA` function.",
+ "Corresponds to the `COUNT` function.",
+ "Corresponds to the `COUNTUNIQUE` function.",
+ "Corresponds to the `AVERAGE` function.",
+ "Corresponds to the `MAX` function.",
+ "Corresponds to the `MIN` function.",
+ "Corresponds to the `MEDIAN` function.",
+ "Corresponds to the `PRODUCT` function.",
+ "Corresponds to the `STDEV` function.",
+ "Corresponds to the `STDEVP` function.",
+ "Corresponds to the `VAR` function.",
+ "Corresponds to the `VARP` function.",
+ "Indicates the formula should be used as-is.\nOnly valid if PivotValue.formula was set."
+ ]
+ },
+ "sourceColumnOffset": {
+ "format": "int32",
+ "description": "The column offset of the source range that this value reads from.\n\nFor example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`\nmeans this value refers to column `C`, whereas the offset `1` would\nrefer to column `D`.",
+ "type": "integer"
+ },
+ "name": {
+ "description": "A name to use for the value. This is only used if formula was set.\nOtherwise, the column name is used.",
+ "type": "string"
+ }
+ },
+ "id": "PivotValue"
+ },
+ "CopySheetToAnotherSpreadsheetRequest": {
+ "description": "The request to copy a sheet across spreadsheets.",
+ "type": "object",
+ "properties": {
+ "destinationSpreadsheetId": {
+ "description": "The ID of the spreadsheet to copy the sheet to.",
+ "type": "string"
+ }
+ },
+ "id": "CopySheetToAnotherSpreadsheetRequest"
+ },
+ "PivotGroupSortValueBucket": {
+ "description": "Information about which values in a pivot group should be used for sorting.",
+ "type": "object",
+ "properties": {
+ "valuesIndex": {
+ "format": "int32",
+ "description": "The offset in the PivotTable.values list which the values in this\ngrouping should be sorted by.",
+ "type": "integer"
+ },
+ "buckets": {
+ "description": "Determines the bucket from which values are chosen to sort.\n\nFor example, in a pivot table with one row group & two column groups,\nthe row group can list up to two values. The first value corresponds\nto a value within the first column group, and the second value\ncorresponds to a value in the second column group. If no values\nare listed, this would indicate that the row should be sorted according\nto the \"Grand Total\" over the column groups. If a single value is listed,\nthis would correspond to using the \"Total\" of that bucket.",
+ "items": {
+ "$ref": "ExtendedValue"
+ },
+ "type": "array"
+ }
+ },
+ "id": "PivotGroupSortValueBucket"
+ },
"DeleteDeveloperMetadataRequest": {
+ "id": "DeleteDeveloperMetadataRequest",
"description": "A request to delete developer metadata.",
"type": "object",
"properties": {
@@ -10,8 +853,7 @@
"description": "The data filter describing the criteria used to select which developer\nmetadata entry to delete.",
"$ref": "DataFilter"
}
- },
- "id": "DeleteDeveloperMetadataRequest"
+ }
},
"CandlestickChartSpec": {
"description": "A \u003ca href=\"/chart/interactive/docs/gallery/candlestickchart\"\u003ecandlestick chart\u003c/a\u003e.",
@@ -25,37 +867,37 @@
"type": "array"
},
"domain": {
- "$ref": "CandlestickDomain",
- "description": "The domain data (horizontal axis) for the candlestick chart. String data\nwill be treated as discrete labels, other data will be treated as\ncontinuous values."
+ "description": "The domain data (horizontal axis) for the candlestick chart. String data\nwill be treated as discrete labels, other data will be treated as\ncontinuous values.",
+ "$ref": "CandlestickDomain"
}
},
"id": "CandlestickChartSpec"
},
"BatchClearValuesByDataFilterResponse": {
- "description": "The response when clearing a range of values selected with\nDataFilters in a spreadsheet.",
"type": "object",
"properties": {
- "spreadsheetId": {
- "description": "The spreadsheet the updates were applied to.",
- "type": "string"
- },
"clearedRanges": {
"description": "The ranges that were cleared, in A1 notation.\n(If the requests were for an unbounded range or a ranger larger\n than the bounds of the sheet, this will be the actual ranges\n that were cleared, bounded to the sheet's limits.)",
"items": {
"type": "string"
},
"type": "array"
+ },
+ "spreadsheetId": {
+ "description": "The spreadsheet the updates were applied to.",
+ "type": "string"
}
},
- "id": "BatchClearValuesByDataFilterResponse"
+ "id": "BatchClearValuesByDataFilterResponse",
+ "description": "The response when clearing a range of values selected with\nDataFilters in a spreadsheet."
},
"CandlestickData": {
"description": "The Candlestick chart data, each containing the low, open, close, and high\nvalues for a series.",
"type": "object",
"properties": {
"closeSeries": {
- "description": "The range data (vertical axis) for the close/final value for each candle.\nThis is the top of the candle body. If greater than the open value the\ncandle will be filled. Otherwise the candle will be hollow.",
- "$ref": "CandlestickSeries"
+ "$ref": "CandlestickSeries",
+ "description": "The range data (vertical axis) for the close/final value for each candle.\nThis is the top of the candle body. If greater than the open value the\ncandle will be filled. Otherwise the candle will be hollow."
},
"lowSeries": {
"$ref": "CandlestickSeries",
@@ -73,14 +915,16 @@
"id": "CandlestickData"
},
"EmbeddedObjectPosition": {
+ "description": "The position of an embedded object such as a chart.",
+ "type": "object",
"properties": {
"newSheet": {
"description": "If true, the embedded object will be put on a new sheet whose ID\nis chosen for you. Used only when writing.",
"type": "boolean"
},
"overlayPosition": {
- "$ref": "OverlayPosition",
- "description": "The position at which the object is overlaid on top of a grid."
+ "description": "The position at which the object is overlaid on top of a grid.",
+ "$ref": "OverlayPosition"
},
"sheetId": {
"format": "int32",
@@ -88,9 +932,7 @@
"type": "integer"
}
},
- "id": "EmbeddedObjectPosition",
- "description": "The position of an embedded object such as a chart.",
- "type": "object"
+ "id": "EmbeddedObjectPosition"
},
"DeleteProtectedRangeRequest": {
"properties": {
@@ -109,6 +951,46 @@
"description": "Selects DeveloperMetadata that matches all of the specified fields. For\nexample, if only a metadata ID is specified this considers the\nDeveloperMetadata with that particular unique ID. If a metadata key is\nspecified, this considers all developer metadata with that key. If a\nkey, visibility, and location type are all specified, this considers all\ndeveloper metadata with that key and visibility that are associated with a\nlocation of that type. In general, this\nselects all DeveloperMetadata that matches the intersection of all the\nspecified fields; any field or combination of fields may be specified.",
"type": "object",
"properties": {
+ "metadataValue": {
+ "description": "Limits the selected developer metadata to that which has a matching\nDeveloperMetadata.metadata_value.",
+ "type": "string"
+ },
+ "metadataLocation": {
+ "$ref": "DeveloperMetadataLocation",
+ "description": "Limits the selected developer metadata to those entries associated with\nthe specified location. This field either matches exact locations or all\nintersecting locations according the specified\nlocationMatchingStrategy."
+ },
+ "locationMatchingStrategy": {
+ "description": "Determines how this lookup matches the location. If this field is\nspecified as EXACT, only developer metadata associated on the exact\nlocation specified is matched. If this field is specified to INTERSECTING,\ndeveloper metadata associated on intersecting locations is also\nmatched. If left unspecified, this field assumes a default value of\nINTERSECTING.\nIf this field is specified, a metadataLocation\nmust also be specified.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value. This value must not be used.",
+ "Indicates that a specified location should be matched exactly. For\nexample, if row three were specified as a location this matching strategy\nwould only match developer metadata also associated on row three. Metadata\nassociated on other locations would not be considered.",
+ "Indicates that a specified location should match that exact location as\nwell as any intersecting locations. For example, if row three were\nspecified as a location this matching strategy would match developer\nmetadata associated on row three as well as metadata associated on\nlocations that intersect row three. If, for instance, there was developer\nmetadata associated on column B, this matching strategy would also match\nthat location because column B intersects row three."
+ ],
+ "enum": [
+ "DEVELOPER_METADATA_LOCATION_MATCHING_STRATEGY_UNSPECIFIED",
+ "EXACT_LOCATION",
+ "INTERSECTING_LOCATION"
+ ]
+ },
+ "locationType": {
+ "enum": [
+ "DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED",
+ "ROW",
+ "COLUMN",
+ "SHEET",
+ "SPREADSHEET"
+ ],
+ "description": "Limits the selected developer metadata to those entries which are\nassociated with locations of the specified type. For example, when this\nfield is specified as ROW this lookup\nonly considers developer metadata associated on rows. If the field is left\nunspecified, all location types are considered. This field cannot be\nspecified as SPREADSHEET when\nthe locationMatchingStrategy\nis specified as INTERSECTING or when the\nmetadataLocation is specified as a\nnon-spreadsheet location: spreadsheet metadata cannot intersect any other\ndeveloper metadata location. This field also must be left unspecified when\nthe locationMatchingStrategy\nis specified as EXACT.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value.",
+ "Developer metadata associated on an entire row dimension.",
+ "Developer metadata associated on an entire column dimension.",
+ "Developer metadata associated on an entire sheet.",
+ "Developer metadata associated on the entire spreadsheet."
+ ]
+ },
"metadataKey": {
"description": "Limits the selected developer metadata to that which has a matching\nDeveloperMetadata.metadata_key.",
"type": "string"
@@ -131,94 +1013,54 @@
"Document-visible metadata is accessible from any developer project with\naccess to the document.",
"Project-visible metadata is only visible to and accessible by the developer\nproject that created the metadata."
]
- },
- "metadataValue": {
- "description": "Limits the selected developer metadata to that which has a matching\nDeveloperMetadata.metadata_value.",
- "type": "string"
- },
- "locationMatchingStrategy": {
- "enum": [
- "DEVELOPER_METADATA_LOCATION_MATCHING_STRATEGY_UNSPECIFIED",
- "EXACT_LOCATION",
- "INTERSECTING_LOCATION"
- ],
- "description": "Determines how this lookup matches the location. If this field is\nspecified as EXACT, only developer metadata associated on the exact\nlocation specified is matched. If this field is specified to INTERSECTING,\ndeveloper metadata associated on intersecting locations is also\nmatched. If left unspecified, this field assumes a default value of\nINTERSECTING.\nIf this field is specified, a metadataLocation\nmust also be specified.",
- "type": "string",
- "enumDescriptions": [
- "Default value. This value must not be used.",
- "Indicates that a specified location should be matched exactly. For\nexample, if row three were specified as a location this matching strategy\nwould only match developer metadata also associated on row three. Metadata\nassociated on other locations would not be considered.",
- "Indicates that a specified location should match that exact location as\nwell as any intersecting locations. For example, if row three were\nspecified as a location this matching strategy would match developer\nmetadata associated on row three as well as metadata associated on\nlocations that intersect row three. If, for instance, there was developer\nmetadata associated on column B, this matching strategy would also match\nthat location because column B intersects row three."
- ]
- },
- "metadataLocation": {
- "description": "Limits the selected developer metadata to those entries associated with\nthe specified location. This field either matches exact locations or all\nintersecting locations according the specified\nlocationMatchingStrategy.",
- "$ref": "DeveloperMetadataLocation"
- },
- "locationType": {
- "enumDescriptions": [
- "Default value.",
- "Developer metadata associated on an entire row dimension.",
- "Developer metadata associated on an entire column dimension.",
- "Developer metadata associated on an entire sheet.",
- "Developer metadata associated on the entire spreadsheet."
- ],
- "enum": [
- "DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED",
- "ROW",
- "COLUMN",
- "SHEET",
- "SPREADSHEET"
- ],
- "description": "Limits the selected developer metadata to those entries which are\nassociated with locations of the specified type. For example, when this\nfield is specified as ROW this lookup\nonly considers developer metadata associated on rows. If the field is left\nunspecified, all location types are considered. This field cannot be\nspecified as SPREADSHEET when\nthe locationMatchingStrategy\nis specified as INTERSECTING or when the\nmetadataLocation is specified as a\nnon-spreadsheet location: spreadsheet metadata cannot intersect any other\ndeveloper metadata location. This field also must be left unspecified when\nthe locationMatchingStrategy\nis specified as EXACT.",
- "type": "string"
}
}
},
"AutoFillRequest": {
- "id": "AutoFillRequest",
"description": "Fills in more data based on existing data.",
"type": "object",
"properties": {
"range": {
- "description": "The range to autofill. This will examine the range and detect\nthe location that has data and automatically fill that data\nin to the rest of the range.",
- "$ref": "GridRange"
+ "$ref": "GridRange",
+ "description": "The range to autofill. This will examine the range and detect\nthe location that has data and automatically fill that data\nin to the rest of the range."
},
"useAlternateSeries": {
"description": "True if we should generate data with the \"alternate\" series.\nThis differs based on the type and amount of source data.",
"type": "boolean"
},
"sourceAndDestination": {
- "description": "The source and destination areas to autofill.\nThis explicitly lists the source of the autofill and where to\nextend that data.",
- "$ref": "SourceAndDestination"
- }
- }
- },
- "GradientRule": {
- "type": "object",
- "properties": {
- "maxpoint": {
- "description": "The final interpolation point.",
- "$ref": "InterpolationPoint"
- },
- "minpoint": {
- "description": "The starting interpolation point.",
- "$ref": "InterpolationPoint"
- },
- "midpoint": {
- "$ref": "InterpolationPoint",
- "description": "An optional midway interpolation point."
+ "$ref": "SourceAndDestination",
+ "description": "The source and destination areas to autofill.\nThis explicitly lists the source of the autofill and where to\nextend that data."
}
},
- "id": "GradientRule",
- "description": "A rule that applies a gradient color scale format, based on\nthe interpolation points listed. The format of a cell will vary\nbased on its contents as compared to the values of the interpolation\npoints."
+ "id": "AutoFillRequest"
+ },
+ "GradientRule": {
+ "description": "A rule that applies a gradient color scale format, based on\nthe interpolation points listed. The format of a cell will vary\nbased on its contents as compared to the values of the interpolation\npoints.",
+ "type": "object",
+ "properties": {
+ "midpoint": {
+ "description": "An optional midway interpolation point.",
+ "$ref": "InterpolationPoint"
+ },
+ "maxpoint": {
+ "$ref": "InterpolationPoint",
+ "description": "The final interpolation point."
+ },
+ "minpoint": {
+ "$ref": "InterpolationPoint",
+ "description": "The starting interpolation point."
+ }
+ },
+ "id": "GradientRule"
},
"SetBasicFilterRequest": {
"description": "Sets the basic filter associated with a sheet.",
"type": "object",
"properties": {
"filter": {
- "$ref": "BasicFilter",
- "description": "The filter to set."
+ "description": "The filter to set.",
+ "$ref": "BasicFilter"
}
},
"id": "SetBasicFilterRequest"
@@ -247,11 +1089,15 @@
"description": "A single interpolation point on a gradient conditional format.\nThese pin the gradient color scale according to the color,\ntype and value chosen.",
"type": "object",
"properties": {
- "color": {
- "description": "The color this interpolation point should use.",
- "$ref": "Color"
- },
"type": {
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "The interpolation point will use the minimum value in the\ncells over the range of the conditional format.",
+ "The interpolation point will use the maximum value in the\ncells over the range of the conditional format.",
+ "The interpolation point will use exactly the value in\nInterpolationPoint.value.",
+ "The interpolation point will be the given percentage over\nall the cells in the range of the conditional format.\nThis is equivalent to NUMBER if the value was:\n`=(MAX(FLATTEN(range)) * (value / 100))\n + (MIN(FLATTEN(range)) * (1 - (value / 100)))`\n(where errors in the range are ignored when flattening).",
+ "The interpolation point will be the given percentile\nover all the cells in the range of the conditional format.\nThis is equivalent to NUMBER if the value was:\n`=PERCENTILE(FLATTEN(range), value / 100)`\n(where errors in the range are ignored when flattening)."
+ ],
"enum": [
"INTERPOLATION_POINT_TYPE_UNSPECIFIED",
"MIN",
@@ -261,35 +1107,31 @@
"PERCENTILE"
],
"description": "How the value should be interpreted.",
- "type": "string",
- "enumDescriptions": [
- "The default value, do not use.",
- "The interpolation point will use the minimum value in the\ncells over the range of the conditional format.",
- "The interpolation point will use the maximum value in the\ncells over the range of the conditional format.",
- "The interpolation point will use exactly the value in\nInterpolationPoint.value.",
- "The interpolation point will be the given percentage over\nall the cells in the range of the conditional format.\nThis is equivalent to NUMBER if the value was:\n`=(MAX(FLATTEN(range)) * (value / 100))\n + (MIN(FLATTEN(range)) * (1 - (value / 100)))`\n(where errors in the range are ignored when flattening).",
- "The interpolation point will be the given percentile\nover all the cells in the range of the conditional format.\nThis is equivalent to NUMBER if the value was:\n`=PERCENTILE(FLATTEN(range), value / 100)`\n(where errors in the range are ignored when flattening)."
- ]
+ "type": "string"
},
"value": {
"description": "The value this interpolation point uses. May be a formula.\nUnused if type is MIN or\nMAX.",
"type": "string"
+ },
+ "color": {
+ "$ref": "Color",
+ "description": "The color this interpolation point should use."
}
},
"id": "InterpolationPoint"
},
"GetSpreadsheetByDataFilterRequest": {
"properties": {
- "includeGridData": {
- "description": "True if grid data should be returned.\nThis parameter is ignored if a field mask was set in the request.",
- "type": "boolean"
- },
"dataFilters": {
+ "description": "The DataFilters used to select which ranges to retrieve from\nthe spreadsheet.",
"items": {
"$ref": "DataFilter"
},
- "type": "array",
- "description": "The DataFilters used to select which ranges to retrieve from\nthe spreadsheet."
+ "type": "array"
+ },
+ "includeGridData": {
+ "description": "True if grid data should be returned.\nThis parameter is ignored if a field mask was set in the request.",
+ "type": "boolean"
}
},
"id": "GetSpreadsheetByDataFilterRequest",
@@ -297,21 +1139,26 @@
"type": "object"
},
"DeleteEmbeddedObjectRequest": {
- "type": "object",
"properties": {
"objectId": {
- "type": "integer",
"format": "int32",
- "description": "The ID of the embedded object to delete."
+ "description": "The ID of the embedded object to delete.",
+ "type": "integer"
}
},
"id": "DeleteEmbeddedObjectRequest",
- "description": "Deletes the embedded object with the given ID."
+ "description": "Deletes the embedded object with the given ID.",
+ "type": "object"
},
"FindReplaceResponse": {
"description": "The result of the find/replace.",
"type": "object",
"properties": {
+ "valuesChanged": {
+ "format": "int32",
+ "description": "The number of non-formula cells changed.",
+ "type": "integer"
+ },
"occurrencesChanged": {
"format": "int32",
"description": "The number of occurrences (possibly multiple within a cell) changed.\nFor example, if replacing `\"e\"` with `\"o\"` in `\"Google Sheets\"`, this would\nbe `\"3\"` because `\"Google Sheets\"` -\u003e `\"Googlo Shoots\"`.",
@@ -331,11 +1178,6 @@
"format": "int32",
"description": "The number of formula cells changed.",
"type": "integer"
- },
- "valuesChanged": {
- "format": "int32",
- "description": "The number of non-formula cells changed.",
- "type": "integer"
}
},
"id": "FindReplaceResponse"
@@ -344,10 +1186,19 @@
"description": "The response when updating a range of values by a data filter in a\nspreadsheet.",
"type": "object",
"properties": {
- "updatedColumns": {
- "type": "integer",
+ "updatedRows": {
"format": "int32",
- "description": "The number of columns where at least one cell in the column was updated."
+ "description": "The number of rows where at least one cell in the row was updated.",
+ "type": "integer"
+ },
+ "updatedData": {
+ "$ref": "ValueRange",
+ "description": "The values of the cells in the range matched by the dataFilter after all\nupdates were applied. This is only included if the request's\n`includeValuesInResponse` field was `true`."
+ },
+ "updatedColumns": {
+ "format": "int32",
+ "description": "The number of columns where at least one cell in the column was updated.",
+ "type": "integer"
},
"updatedRange": {
"description": "The range (in A1 notation) that updates were applied to.",
@@ -361,21 +1212,11 @@
"dataFilter": {
"description": "The data filter that selected the range that was updated.",
"$ref": "DataFilter"
- },
- "updatedData": {
- "description": "The values of the cells in the range matched by the dataFilter after all\nupdates were applied. This is only included if the request's\n`includeValuesInResponse` field was `true`.",
- "$ref": "ValueRange"
- },
- "updatedRows": {
- "type": "integer",
- "format": "int32",
- "description": "The number of rows where at least one cell in the row was updated."
}
},
"id": "UpdateValuesByDataFilterResponse"
},
"DeleteSheetRequest": {
- "description": "Deletes the requested sheet.",
"type": "object",
"properties": {
"sheetId": {
@@ -384,7 +1225,8 @@
"type": "integer"
}
},
- "id": "DeleteSheetRequest"
+ "id": "DeleteSheetRequest",
+ "description": "Deletes the requested sheet."
},
"DuplicateFilterViewRequest": {
"description": "Duplicates a particular filter view.",
@@ -398,6 +1240,44 @@
},
"id": "DuplicateFilterViewRequest"
},
+ "DeveloperMetadataLocation": {
+ "description": "A location where metadata may be associated in a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "dimensionRange": {
+ "$ref": "DimensionRange",
+ "description": "Represents the row or column when metadata is associated with\na dimension. The specified DimensionRange must represent a single row\nor column; it cannot be unbounded or span multiple rows or columns."
+ },
+ "sheetId": {
+ "format": "int32",
+ "description": "The ID of the sheet when metadata is associated with an entire sheet.",
+ "type": "integer"
+ },
+ "spreadsheet": {
+ "description": "True when metadata is associated with an entire spreadsheet.",
+ "type": "boolean"
+ },
+ "locationType": {
+ "type": "string",
+ "enumDescriptions": [
+ "Default value.",
+ "Developer metadata associated on an entire row dimension.",
+ "Developer metadata associated on an entire column dimension.",
+ "Developer metadata associated on an entire sheet.",
+ "Developer metadata associated on the entire spreadsheet."
+ ],
+ "enum": [
+ "DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED",
+ "ROW",
+ "COLUMN",
+ "SHEET",
+ "SPREADSHEET"
+ ],
+ "description": "The type of location this object represents. This field is read-only."
+ }
+ },
+ "id": "DeveloperMetadataLocation"
+ },
"MatchedValueRange": {
"description": "A value range that was matched by one or more data filers.",
"type": "object",
@@ -416,52 +1296,18 @@
},
"id": "MatchedValueRange"
},
- "DeveloperMetadataLocation": {
- "id": "DeveloperMetadataLocation",
- "description": "A location where metadata may be associated in a spreadsheet.",
- "type": "object",
- "properties": {
- "dimensionRange": {
- "description": "Represents the row or column when metadata is associated with\na dimension. The specified DimensionRange must represent a single row\nor column; it cannot be unbounded or span multiple rows or columns.",
- "$ref": "DimensionRange"
- },
- "sheetId": {
- "format": "int32",
- "description": "The ID of the sheet when metadata is associated with an entire sheet.",
- "type": "integer"
- },
- "spreadsheet": {
- "description": "True when metadata is associated with an entire spreadsheet.",
- "type": "boolean"
- },
- "locationType": {
- "enumDescriptions": [
- "Default value.",
- "Developer metadata associated on an entire row dimension.",
- "Developer metadata associated on an entire column dimension.",
- "Developer metadata associated on an entire sheet.",
- "Developer metadata associated on the entire spreadsheet."
- ],
- "enum": [
- "DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED",
- "ROW",
- "COLUMN",
- "SHEET",
- "SPREADSHEET"
- ],
- "description": "The type of location this object represents. This field is read-only.",
- "type": "string"
- }
- }
- },
"UpdateConditionalFormatRuleResponse": {
"description": "The result of updating a conditional format rule.",
"type": "object",
"properties": {
+ "oldRule": {
+ "$ref": "ConditionalFormatRule",
+ "description": "The old (deleted) rule. Not set if a rule was moved\n(because it is the same as new_rule)."
+ },
"newIndex": {
+ "type": "integer",
"format": "int32",
- "description": "The index of the new rule.",
- "type": "integer"
+ "description": "The index of the new rule."
},
"newRule": {
"$ref": "ConditionalFormatRule",
@@ -471,56 +1317,14 @@
"format": "int32",
"description": "The old index of the rule. Not set if a rule was replaced\n(because it is the same as new_index).",
"type": "integer"
- },
- "oldRule": {
- "$ref": "ConditionalFormatRule",
- "description": "The old (deleted) rule. Not set if a rule was moved\n(because it is the same as new_rule)."
}
},
"id": "UpdateConditionalFormatRuleResponse"
},
- "ConditionValue": {
- "type": "object",
- "properties": {
- "userEnteredValue": {
- "description": "A value the condition is based on.\nThe value will be parsed as if the user typed into a cell.\nFormulas are supported (and must begin with an `=`).",
- "type": "string"
- },
- "relativeDate": {
- "enum": [
- "RELATIVE_DATE_UNSPECIFIED",
- "PAST_YEAR",
- "PAST_MONTH",
- "PAST_WEEK",
- "YESTERDAY",
- "TODAY",
- "TOMORROW"
- ],
- "description": "A relative date (based on the current date).\nValid only if the type is\nDATE_BEFORE,\nDATE_AFTER,\nDATE_ON_OR_BEFORE or\nDATE_ON_OR_AFTER.\n\nRelative dates are not supported in data validation.\nThey are supported only in conditional formatting and\nconditional filters.",
- "type": "string",
- "enumDescriptions": [
- "Default value, do not use.",
- "The value is one year before today.",
- "The value is one month before today.",
- "The value is one week before today.",
- "The value is yesterday.",
- "The value is today.",
- "The value is tomorrow."
- ]
- }
- },
- "id": "ConditionValue",
- "description": "The value of the condition."
- },
"DuplicateSheetRequest": {
"description": "Duplicates the contents of a sheet.",
"type": "object",
"properties": {
- "newSheetId": {
- "type": "integer",
- "format": "int32",
- "description": "If set, the ID of the new sheet. If not set, an ID is chosen.\nIf set, the ID must not conflict with any existing sheet ID.\nIf set, it must be non-negative."
- },
"insertSheetIndex": {
"format": "int32",
"description": "The zero-based index where the new sheet should be inserted.\nThe index of all sheets after this are incremented.",
@@ -534,18 +1338,56 @@
"format": "int32",
"description": "The sheet to duplicate.",
"type": "integer"
+ },
+ "newSheetId": {
+ "type": "integer",
+ "format": "int32",
+ "description": "If set, the ID of the new sheet. If not set, an ID is chosen.\nIf set, the ID must not conflict with any existing sheet ID.\nIf set, it must be non-negative."
}
},
"id": "DuplicateSheetRequest"
},
+ "ConditionValue": {
+ "description": "The value of the condition.",
+ "type": "object",
+ "properties": {
+ "userEnteredValue": {
+ "description": "A value the condition is based on.\nThe value will be parsed as if the user typed into a cell.\nFormulas are supported (and must begin with an `=`).",
+ "type": "string"
+ },
+ "relativeDate": {
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "The value is one year before today.",
+ "The value is one month before today.",
+ "The value is one week before today.",
+ "The value is yesterday.",
+ "The value is today.",
+ "The value is tomorrow."
+ ],
+ "enum": [
+ "RELATIVE_DATE_UNSPECIFIED",
+ "PAST_YEAR",
+ "PAST_MONTH",
+ "PAST_WEEK",
+ "YESTERDAY",
+ "TODAY",
+ "TOMORROW"
+ ],
+ "description": "A relative date (based on the current date).\nValid only if the type is\nDATE_BEFORE,\nDATE_AFTER,\nDATE_ON_OR_BEFORE or\nDATE_ON_OR_AFTER.\n\nRelative dates are not supported in data validation.\nThey are supported only in conditional formatting and\nconditional filters.",
+ "type": "string"
+ }
+ },
+ "id": "ConditionValue"
+ },
"ExtendedValue": {
"description": "The kinds of value that a cell in a spreadsheet can have.",
"type": "object",
"properties": {
"numberValue": {
+ "type": "number",
"format": "double",
- "description": "Represents a double value.\nNote: Dates, Times and DateTimes are represented as doubles in\n\"serial number\" format.",
- "type": "number"
+ "description": "Represents a double value.\nNote: Dates, Times and DateTimes are represented as doubles in\n\"serial number\" format."
},
"errorValue": {
"$ref": "ErrorValue",
@@ -560,8 +1402,8 @@
"type": "boolean"
},
"stringValue": {
- "type": "string",
- "description": "Represents a string value.\nLeading single quotes are not included. For example, if the user typed\n`'123` into the UI, this would be represented as a `stringValue` of\n`\"123\"`."
+ "description": "Represents a string value.\nLeading single quotes are not included. For example, if the user typed\n`'123` into the UI, this would be represented as a `stringValue` of\n`\"123\"`.",
+ "type": "string"
}
},
"id": "ExtendedValue"
@@ -575,17 +1417,17 @@
"description": "Properties for column bands. These properties will be applied on a column-\nby-column basis throughout all the columns in the range. At least one of\nrow_properties or column_properties must be specified."
},
"rowProperties": {
- "description": "Properties for row bands. These properties will be applied on a row-by-row\nbasis throughout all the rows in the range. At least one of\nrow_properties or column_properties must be specified.",
- "$ref": "BandingProperties"
+ "$ref": "BandingProperties",
+ "description": "Properties for row bands. These properties will be applied on a row-by-row\nbasis throughout all the rows in the range. At least one of\nrow_properties or column_properties must be specified."
},
"range": {
"$ref": "GridRange",
"description": "The range over which these properties are applied."
},
"bandedRangeId": {
+ "type": "integer",
"format": "int32",
- "description": "The id of the banded range.",
- "type": "integer"
+ "description": "The id of the banded range."
}
},
"id": "BandedRange"
@@ -594,13 +1436,13 @@
"description": "A histogram series containing the series color and data.",
"type": "object",
"properties": {
- "data": {
- "description": "The data for this histogram series.",
- "$ref": "ChartData"
- },
"barColor": {
"$ref": "Color",
"description": "The color of the column representing this series in each bucket.\nThis field is optional."
+ },
+ "data": {
+ "$ref": "ChartData",
+ "description": "The data for this histogram series."
}
},
"id": "HistogramSeries"
@@ -624,28 +1466,15 @@
"id": "BatchClearValuesResponse"
},
"Spreadsheet": {
+ "type": "object",
"properties": {
- "developerMetadata": {
- "items": {
- "$ref": "DeveloperMetadata"
- },
- "type": "array",
- "description": "The developer metadata associated with a spreadsheet."
- },
- "sheets": {
- "description": "The sheets that are part of a spreadsheet.",
- "items": {
- "$ref": "Sheet"
- },
- "type": "array"
- },
- "spreadsheetUrl": {
- "description": "The url of the spreadsheet.\nThis field is read-only.",
- "type": "string"
- },
"properties": {
- "description": "Overall properties of a spreadsheet.",
- "$ref": "SpreadsheetProperties"
+ "$ref": "SpreadsheetProperties",
+ "description": "Overall properties of a spreadsheet."
+ },
+ "spreadsheetId": {
+ "type": "string",
+ "description": "The ID of the spreadsheet.\nThis field is read-only."
},
"namedRanges": {
"description": "The named ranges defined in a spreadsheet.",
@@ -654,16 +1483,30 @@
},
"type": "array"
},
- "spreadsheetId": {
- "description": "The ID of the spreadsheet.\nThis field is read-only.",
+ "developerMetadata": {
+ "description": "The developer metadata associated with a spreadsheet.",
+ "items": {
+ "$ref": "DeveloperMetadata"
+ },
+ "type": "array"
+ },
+ "sheets": {
+ "items": {
+ "$ref": "Sheet"
+ },
+ "type": "array",
+ "description": "The sheets that are part of a spreadsheet."
+ },
+ "spreadsheetUrl": {
+ "description": "The url of the spreadsheet.\nThis field is read-only.",
"type": "string"
}
},
"id": "Spreadsheet",
- "description": "Resource that represents a spreadsheet.",
- "type": "object"
+ "description": "Resource that represents a spreadsheet."
},
"AddChartRequest": {
+ "id": "AddChartRequest",
"description": "Adds a chart to a sheet in the spreadsheet.",
"type": "object",
"properties": {
@@ -671,11 +1514,9 @@
"$ref": "EmbeddedChart",
"description": "The chart that should be added to the spreadsheet, including the position\nwhere it should be placed. The chartId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a chart that already exists.)"
}
- },
- "id": "AddChartRequest"
+ }
},
"UpdateProtectedRangeRequest": {
- "type": "object",
"properties": {
"fields": {
"format": "google-fieldmask",
@@ -683,50 +1524,50 @@
"type": "string"
},
"protectedRange": {
- "description": "The protected range to update with the new properties.",
- "$ref": "ProtectedRange"
+ "$ref": "ProtectedRange",
+ "description": "The protected range to update with the new properties."
}
},
"id": "UpdateProtectedRangeRequest",
- "description": "Updates an existing protected range with the specified\nprotectedRangeId."
+ "description": "Updates an existing protected range with the specified\nprotectedRangeId.",
+ "type": "object"
},
"DataFilter": {
"description": "Filter that describes what data should be selected or returned from a\nrequest.",
"type": "object",
"properties": {
"gridRange": {
- "$ref": "GridRange",
- "description": "Selects data that matches the range described by the GridRange."
+ "description": "Selects data that matches the range described by the GridRange.",
+ "$ref": "GridRange"
},
"developerMetadataLookup": {
"$ref": "DeveloperMetadataLookup",
"description": "Selects data associated with the developer metadata matching the criteria\ndescribed by this DeveloperMetadataLookup."
},
"a1Range": {
- "description": "Selects data that matches the specified A1 range.",
- "type": "string"
+ "type": "string",
+ "description": "Selects data that matches the specified A1 range."
}
},
"id": "DataFilter"
},
"TextFormat": {
- "type": "object",
"properties": {
"underline": {
"description": "True if the text is underlined.",
"type": "boolean"
},
"bold": {
- "type": "boolean",
- "description": "True if the text is bold."
+ "description": "True if the text is bold.",
+ "type": "boolean"
},
"foregroundColor": {
"description": "The foreground color of the text.",
"$ref": "Color"
},
"fontFamily": {
- "type": "string",
- "description": "The font family."
+ "description": "The font family.",
+ "type": "string"
},
"italic": {
"description": "True if the text is italicized.",
@@ -743,29 +1584,30 @@
}
},
"id": "TextFormat",
- "description": "The format of a run of text in a cell.\nAbsent values indicate that the field isn't specified."
+ "description": "The format of a run of text in a cell.\nAbsent values indicate that the field isn't specified.",
+ "type": "object"
},
"AddSheetResponse": {
"description": "The result of adding a sheet.",
"type": "object",
"properties": {
"properties": {
- "description": "The properties of the newly added sheet.",
- "$ref": "SheetProperties"
+ "$ref": "SheetProperties",
+ "description": "The properties of the newly added sheet."
}
},
"id": "AddSheetResponse"
},
"AddFilterViewResponse": {
+ "description": "The result of adding a filter view.",
"type": "object",
"properties": {
"filter": {
- "description": "The newly added filter view.",
- "$ref": "FilterView"
+ "$ref": "FilterView",
+ "description": "The newly added filter view."
}
},
- "id": "AddFilterViewResponse",
- "description": "The result of adding a filter view."
+ "id": "AddFilterViewResponse"
},
"IterativeCalculationSettings": {
"description": "Settings to control how circular dependencies are resolved with iterative\ncalculation.",
@@ -784,7 +1626,51 @@
},
"id": "IterativeCalculationSettings"
},
+ "SpreadsheetProperties": {
+ "description": "Properties of a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "autoRecalc": {
+ "description": "The amount of time to wait before volatile functions are recalculated.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value. This value must not be used.",
+ "Volatile functions are updated on every change.",
+ "Volatile functions are updated on every change and every minute.",
+ "Volatile functions are updated on every change and hourly."
+ ],
+ "enum": [
+ "RECALCULATION_INTERVAL_UNSPECIFIED",
+ "ON_CHANGE",
+ "MINUTE",
+ "HOUR"
+ ]
+ },
+ "defaultFormat": {
+ "$ref": "CellFormat",
+ "description": "The default format of all cells in the spreadsheet.\nCellData.effectiveFormat will not be set if the\ncell's format is equal to this default format.\nThis field is read-only."
+ },
+ "timeZone": {
+ "description": "The time zone of the spreadsheet, in CLDR format such as\n`America/New_York`. If the time zone isn't recognized, this may\nbe a custom time zone such as `GMT-07:00`.",
+ "type": "string"
+ },
+ "title": {
+ "description": "The title of the spreadsheet.",
+ "type": "string"
+ },
+ "locale": {
+ "description": "The locale of the spreadsheet in one of the following formats:\n\n* an ISO 639-1 language code such as `en`\n\n* an ISO 639-2 language code such as `fil`, if no 639-1 code exists\n\n* a combination of the ISO language code and country code, such as `en_US`\n\nNote: when updating this field, not all locales/languages are supported.",
+ "type": "string"
+ },
+ "iterativeCalculationSettings": {
+ "$ref": "IterativeCalculationSettings",
+ "description": "Determines whether and how circular references are resolved with iterative\ncalculation. Absence of this field means that circular references will\nresult in calculation errors."
+ }
+ },
+ "id": "SpreadsheetProperties"
+ },
"OverlayPosition": {
+ "type": "object",
"properties": {
"widthPixels": {
"format": "int32",
@@ -792,13 +1678,13 @@
"type": "integer"
},
"offsetXPixels": {
- "type": "integer",
"format": "int32",
- "description": "The horizontal offset, in pixels, that the object is offset\nfrom the anchor cell."
+ "description": "The horizontal offset, in pixels, that the object is offset\nfrom the anchor cell.",
+ "type": "integer"
},
"anchorCell": {
- "description": "The cell the object is anchored to.",
- "$ref": "GridCoordinate"
+ "$ref": "GridCoordinate",
+ "description": "The cell the object is anchored to."
},
"heightPixels": {
"format": "int32",
@@ -812,59 +1698,16 @@
}
},
"id": "OverlayPosition",
- "description": "The location an object is overlaid on top of a grid.",
- "type": "object"
- },
- "SpreadsheetProperties": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string",
- "description": "The title of the spreadsheet."
- },
- "timeZone": {
- "description": "The time zone of the spreadsheet, in CLDR format such as\n`America/New_York`. If the time zone isn't recognized, this may\nbe a custom time zone such as `GMT-07:00`.",
- "type": "string"
- },
- "locale": {
- "description": "The locale of the spreadsheet in one of the following formats:\n\n* an ISO 639-1 language code such as `en`\n\n* an ISO 639-2 language code such as `fil`, if no 639-1 code exists\n\n* a combination of the ISO language code and country code, such as `en_US`\n\nNote: when updating this field, not all locales/languages are supported.",
- "type": "string"
- },
- "iterativeCalculationSettings": {
- "$ref": "IterativeCalculationSettings",
- "description": "Determines whether and how circular references are resolved with iterative\ncalculation. Absence of this field means that circular references will\nresult in calculation errors."
- },
- "autoRecalc": {
- "enum": [
- "RECALCULATION_INTERVAL_UNSPECIFIED",
- "ON_CHANGE",
- "MINUTE",
- "HOUR"
- ],
- "description": "The amount of time to wait before volatile functions are recalculated.",
- "type": "string",
- "enumDescriptions": [
- "Default value. This value must not be used.",
- "Volatile functions are updated on every change.",
- "Volatile functions are updated on every change and every minute.",
- "Volatile functions are updated on every change and hourly."
- ]
- },
- "defaultFormat": {
- "description": "The default format of all cells in the spreadsheet.\nCellData.effectiveFormat will not be set if the\ncell's format is equal to this default format.\nThis field is read-only.",
- "$ref": "CellFormat"
- }
- },
- "id": "SpreadsheetProperties",
- "description": "Properties of a spreadsheet."
+ "description": "The location an object is overlaid on top of a grid."
},
"RepeatCellRequest": {
+ "id": "RepeatCellRequest",
"description": "Updates all cells in the range to the values in the given Cell object.\nOnly the fields listed in the fields field are updated; others are\nunchanged.\n\nIf writing a cell with a formula, the formula's ranges will automatically\nincrement for each field in the range.\nFor example, if writing a cell with formula `=A1` into range B2:C4,\nB2 would be `=A1`, B3 would be `=A2`, B4 would be `=A3`,\nC2 would be `=B1`, C3 would be `=B2`, C4 would be `=B3`.\n\nTo keep the formula's ranges static, use the `$` indicator.\nFor example, use the formula `=$A$1` to prevent both the row and the\ncolumn from incrementing.",
"type": "object",
"properties": {
"range": {
- "$ref": "GridRange",
- "description": "The range to repeat the cell in."
+ "description": "The range to repeat the cell in.",
+ "$ref": "GridRange"
},
"fields": {
"format": "google-fieldmask",
@@ -875,38 +1718,35 @@
"$ref": "CellData",
"description": "The data to write."
}
- },
- "id": "RepeatCellRequest"
+ }
},
"AddChartResponse": {
+ "description": "The result of adding a chart to a spreadsheet.",
+ "type": "object",
"properties": {
"chart": {
- "$ref": "EmbeddedChart",
- "description": "The newly added chart."
+ "description": "The newly added chart.",
+ "$ref": "EmbeddedChart"
}
},
- "id": "AddChartResponse",
- "description": "The result of adding a chart to a spreadsheet.",
- "type": "object"
+ "id": "AddChartResponse"
},
"InsertDimensionRequest": {
+ "description": "Inserts rows or columns in a sheet at a particular index.",
+ "type": "object",
"properties": {
"inheritFromBefore": {
"description": "Whether dimension properties should be extended from the dimensions\nbefore or after the newly inserted dimensions.\nTrue to inherit from the dimensions before (in which case the start\nindex must be greater than 0), and false to inherit from the dimensions\nafter.\n\nFor example, if row index 0 has red background and row index 1\nhas a green background, then inserting 2 rows at index 1 can inherit\neither the green or red background. If `inheritFromBefore` is true,\nthe two new rows will be red (because the row before the insertion point\nwas red), whereas if `inheritFromBefore` is false, the two new rows will\nbe green (because the row after the insertion point was green).",
"type": "boolean"
},
"range": {
- "$ref": "DimensionRange",
- "description": "The dimensions to insert. Both the start and end indexes must be bounded."
+ "description": "The dimensions to insert. Both the start and end indexes must be bounded.",
+ "$ref": "DimensionRange"
}
},
- "id": "InsertDimensionRequest",
- "description": "Inserts rows or columns in a sheet at a particular index.",
- "type": "object"
+ "id": "InsertDimensionRequest"
},
"UpdateSpreadsheetPropertiesRequest": {
- "description": "Updates properties of a spreadsheet.",
- "type": "object",
"properties": {
"fields": {
"type": "string",
@@ -918,57 +1758,15 @@
"$ref": "SpreadsheetProperties"
}
},
- "id": "UpdateSpreadsheetPropertiesRequest"
- },
- "ProtectedRange": {
- "description": "A protected range.",
- "type": "object",
- "properties": {
- "namedRangeId": {
- "description": "The named range this protected range is backed by, if any.\n\nWhen writing, only one of range or named_range_id\nmay be set.",
- "type": "string"
- },
- "protectedRangeId": {
- "type": "integer",
- "format": "int32",
- "description": "The ID of the protected range.\nThis field is read-only."
- },
- "warningOnly": {
- "description": "True if this protected range will show a warning when editing.\nWarning-based protection means that every user can edit data in the\nprotected range, except editing will prompt a warning asking the user\nto confirm the edit.\n\nWhen writing: if this field is true, then editors is ignored.\nAdditionally, if this field is changed from true to false and the\n`editors` field is not set (nor included in the field mask), then\nthe editors will be set to all the editors in the document.",
- "type": "boolean"
- },
- "requestingUserCanEdit": {
- "type": "boolean",
- "description": "True if the user who requested this protected range can edit the\nprotected area.\nThis field is read-only."
- },
- "editors": {
- "$ref": "Editors",
- "description": "The users and groups with edit access to the protected range.\nThis field is only visible to users with edit access to the protected\nrange and the document.\nEditors are not supported with warning_only protection."
- },
- "range": {
- "description": "The range that is being protected.\nThe range may be fully unbounded, in which case this is considered\na protected sheet.\n\nWhen writing, only one of range or named_range_id\nmay be set.",
- "$ref": "GridRange"
- },
- "description": {
- "description": "The description of this protected range.",
- "type": "string"
- },
- "unprotectedRanges": {
- "description": "The list of unprotected ranges within a protected sheet.\nUnprotected ranges are only supported on protected sheets.",
- "items": {
- "$ref": "GridRange"
- },
- "type": "array"
- }
- },
- "id": "ProtectedRange"
+ "id": "UpdateSpreadsheetPropertiesRequest",
+ "description": "Updates properties of a spreadsheet.",
+ "type": "object"
},
"BatchUpdateValuesRequest": {
"description": "The request for updating more than one range of values in a spreadsheet.",
"type": "object",
"properties": {
"responseValueRenderOption": {
- "type": "string",
"enumDescriptions": [
"Values will be calculated & formatted in the reply according to the\ncell's formatting. Formatting is based on the spreadsheet's locale,\nnot the requesting user's locale.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return `\"$1.23\"`.",
"Values will be calculated, but not formatted in the reply.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return the number `1.23`.",
@@ -979,7 +1777,8 @@
"UNFORMATTED_VALUE",
"FORMULA"
],
- "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE."
+ "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
+ "type": "string"
},
"includeValuesInResponse": {
"description": "Determines if the update response should include the values\nof the cells that were updated. By default, responses\ndo not include the updated values. The `updatedData` field within\neach of the BatchUpdateValuesResponse.responses will contain\nthe updated values. If the range to write was larger than than the range\nactually written, the response will include all values in the requested\nrange (excluding trailing empty rows and columns).",
@@ -1021,22 +1820,65 @@
},
"id": "BatchUpdateValuesRequest"
},
+ "ProtectedRange": {
+ "description": "A protected range.",
+ "type": "object",
+ "properties": {
+ "namedRangeId": {
+ "description": "The named range this protected range is backed by, if any.\n\nWhen writing, only one of range or named_range_id\nmay be set.",
+ "type": "string"
+ },
+ "protectedRangeId": {
+ "format": "int32",
+ "description": "The ID of the protected range.\nThis field is read-only.",
+ "type": "integer"
+ },
+ "warningOnly": {
+ "description": "True if this protected range will show a warning when editing.\nWarning-based protection means that every user can edit data in the\nprotected range, except editing will prompt a warning asking the user\nto confirm the edit.\n\nWhen writing: if this field is true, then editors is ignored.\nAdditionally, if this field is changed from true to false and the\n`editors` field is not set (nor included in the field mask), then\nthe editors will be set to all the editors in the document.",
+ "type": "boolean"
+ },
+ "requestingUserCanEdit": {
+ "description": "True if the user who requested this protected range can edit the\nprotected area.\nThis field is read-only.",
+ "type": "boolean"
+ },
+ "editors": {
+ "description": "The users and groups with edit access to the protected range.\nThis field is only visible to users with edit access to the protected\nrange and the document.\nEditors are not supported with warning_only protection.",
+ "$ref": "Editors"
+ },
+ "range": {
+ "description": "The range that is being protected.\nThe range may be fully unbounded, in which case this is considered\na protected sheet.\n\nWhen writing, only one of range or named_range_id\nmay be set.",
+ "$ref": "GridRange"
+ },
+ "description": {
+ "description": "The description of this protected range.",
+ "type": "string"
+ },
+ "unprotectedRanges": {
+ "description": "The list of unprotected ranges within a protected sheet.\nUnprotected ranges are only supported on protected sheets.",
+ "items": {
+ "$ref": "GridRange"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ProtectedRange"
+ },
"DimensionProperties": {
"description": "Properties about a dimension.",
"type": "object",
"properties": {
"pixelSize": {
+ "type": "integer",
"format": "int32",
- "description": "The height (if a row) or width (if a column) of the dimension in pixels.",
- "type": "integer"
+ "description": "The height (if a row) or width (if a column) of the dimension in pixels."
},
"hiddenByUser": {
"description": "True if this dimension is explicitly hidden.",
"type": "boolean"
},
"hiddenByFilter": {
- "description": "True if this dimension is being filtered.\nThis field is read-only.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "True if this dimension is being filtered.\nThis field is read-only."
},
"developerMetadata": {
"description": "The developer metadata associated with a single row or column.",
@@ -1049,28 +1891,8 @@
"id": "DimensionProperties"
},
"DimensionRange": {
- "description": "A range along a single dimension on a sheet.\nAll indexes are zero-based.\nIndexes are half open: the start index is inclusive\nand the end index is exclusive.\nMissing indexes indicate the range is unbounded on that side.",
"type": "object",
"properties": {
- "sheetId": {
- "format": "int32",
- "description": "The sheet this span is on.",
- "type": "integer"
- },
- "dimension": {
- "enumDescriptions": [
- "The default value, do not use.",
- "Operates on the rows of a sheet.",
- "Operates on the columns of a sheet."
- ],
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
- ],
- "description": "The dimension of the span.",
- "type": "string"
- },
"endIndex": {
"format": "int32",
"description": "The end (exclusive) of the span, or not set if unbounded.",
@@ -1080,38 +1902,54 @@
"format": "int32",
"description": "The start (inclusive) of the span, or not set if unbounded.",
"type": "integer"
+ },
+ "sheetId": {
+ "format": "int32",
+ "description": "The sheet this span is on.",
+ "type": "integer"
+ },
+ "dimension": {
+ "description": "The dimension of the span.",
+ "type": "string",
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Operates on the rows of a sheet.",
+ "Operates on the columns of a sheet."
+ ],
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ]
}
},
- "id": "DimensionRange"
+ "id": "DimensionRange",
+ "description": "A range along a single dimension on a sheet.\nAll indexes are zero-based.\nIndexes are half open: the start index is inclusive\nand the end index is exclusive.\nMissing indexes indicate the range is unbounded on that side."
},
"NamedRange": {
"description": "A named range.",
"type": "object",
"properties": {
- "namedRangeId": {
- "type": "string",
- "description": "The ID of the named range."
- },
- "range": {
- "$ref": "GridRange",
- "description": "The range this represents."
- },
"name": {
"description": "The name of the named range.",
"type": "string"
+ },
+ "namedRangeId": {
+ "description": "The ID of the named range.",
+ "type": "string"
+ },
+ "range": {
+ "description": "The range this represents.",
+ "$ref": "GridRange"
}
},
"id": "NamedRange"
},
"CutPasteRequest": {
- "description": "Moves data from the source to the destination.",
- "type": "object",
"properties": {
- "destination": {
- "$ref": "GridCoordinate",
- "description": "The top-left coordinate where the data should be pasted."
- },
"pasteType": {
+ "description": "What kind of data to paste. All the source data will be cut, regardless\nof what is pasted.",
+ "type": "string",
"enumDescriptions": [
"Paste values, formulas, formats, and merges.",
"Paste the values ONLY without formats, formulas, or merges.",
@@ -1129,42 +1967,45 @@
"PASTE_FORMULA",
"PASTE_DATA_VALIDATION",
"PASTE_CONDITIONAL_FORMATTING"
- ],
- "description": "What kind of data to paste. All the source data will be cut, regardless\nof what is pasted.",
- "type": "string"
+ ]
},
"source": {
- "description": "The source data to cut.",
- "$ref": "GridRange"
+ "$ref": "GridRange",
+ "description": "The source data to cut."
+ },
+ "destination": {
+ "description": "The top-left coordinate where the data should be pasted.",
+ "$ref": "GridCoordinate"
}
},
- "id": "CutPasteRequest"
+ "id": "CutPasteRequest",
+ "description": "Moves data from the source to the destination.",
+ "type": "object"
},
"Borders": {
- "id": "Borders",
- "description": "The borders of the cell.",
"type": "object",
"properties": {
- "right": {
- "description": "The right border of the cell.",
+ "left": {
+ "description": "The left border of the cell.",
"$ref": "Border"
},
+ "right": {
+ "$ref": "Border",
+ "description": "The right border of the cell."
+ },
"bottom": {
- "description": "The bottom border of the cell.",
- "$ref": "Border"
+ "$ref": "Border",
+ "description": "The bottom border of the cell."
},
"top": {
"$ref": "Border",
"description": "The top border of the cell."
- },
- "left": {
- "$ref": "Border",
- "description": "The left border of the cell."
}
- }
+ },
+ "id": "Borders",
+ "description": "The borders of the cell."
},
"BasicChartSeries": {
- "type": "object",
"properties": {
"type": {
"enum": [
@@ -1195,6 +2036,8 @@
"description": "The data being visualized in this chart series."
},
"targetAxis": {
+ "description": "The minor axis that will specify the range of values for this series.\nFor example, if charting stocks over time, the \"Volume\" series\nmay want to be pinned to the right with the prices pinned to the left,\nbecause the scale of trading volume is different than the scale of\nprices.\nIt is an error to specify an axis that isn't a valid minor axis\nfor the chart's type.",
+ "type": "string",
"enumDescriptions": [
"Default value, do not use.",
"The axis rendered at the bottom of a chart.\nFor most charts, this is the standard major axis.\nFor bar charts, this is a minor axis.",
@@ -1206,13 +2049,12 @@
"BOTTOM_AXIS",
"LEFT_AXIS",
"RIGHT_AXIS"
- ],
- "description": "The minor axis that will specify the range of values for this series.\nFor example, if charting stocks over time, the \"Volume\" series\nmay want to be pinned to the right with the prices pinned to the left,\nbecause the scale of trading volume is different than the scale of\nprices.\nIt is an error to specify an axis that isn't a valid minor axis\nfor the chart's type.",
- "type": "string"
+ ]
}
},
"id": "BasicChartSeries",
- "description": "A single series of data in a chart.\nFor example, if charting stock prices over time, multiple series may exist,\none for the \"Open Price\", \"High Price\", \"Low Price\" and \"Close Price\"."
+ "description": "A single series of data in a chart.\nFor example, if charting stock prices over time, multiple series may exist,\none for the \"Open Price\", \"High Price\", \"Low Price\" and \"Close Price\".",
+ "type": "object"
},
"AutoResizeDimensionsRequest": {
"description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension.",
@@ -1226,50 +2068,46 @@
"id": "AutoResizeDimensionsRequest"
},
"UpdateBordersRequest": {
- "description": "Updates the borders of a range.\nIf a field is not set in the request, that means the border remains as-is.\nFor example, with two subsequent UpdateBordersRequest:\n\n 1. range: A1:A5 `{ top: RED, bottom: WHITE }`\n 2. range: A1:A5 `{ left: BLUE }`\n\nThat would result in A1:A5 having a borders of\n`{ top: RED, bottom: WHITE, left: BLUE }`.\nIf you want to clear a border, explicitly set the style to\nNONE.",
"type": "object",
"properties": {
+ "right": {
+ "$ref": "Border",
+ "description": "The border to put at the right of the range."
+ },
+ "range": {
+ "description": "The range whose borders should be updated.",
+ "$ref": "GridRange"
+ },
"innerHorizontal": {
"description": "The horizontal border to put within the range.",
"$ref": "Border"
},
"top": {
- "description": "The border to put at the top of the range.",
- "$ref": "Border"
+ "$ref": "Border",
+ "description": "The border to put at the top of the range."
},
"left": {
"$ref": "Border",
"description": "The border to put at the left of the range."
},
"bottom": {
- "$ref": "Border",
- "description": "The border to put at the bottom of the range."
+ "description": "The border to put at the bottom of the range.",
+ "$ref": "Border"
},
"innerVertical": {
"$ref": "Border",
"description": "The vertical border to put within the range."
- },
- "right": {
- "description": "The border to put at the right of the range.",
- "$ref": "Border"
- },
- "range": {
- "description": "The range whose borders should be updated.",
- "$ref": "GridRange"
}
},
- "id": "UpdateBordersRequest"
+ "id": "UpdateBordersRequest",
+ "description": "Updates the borders of a range.\nIf a field is not set in the request, that means the border remains as-is.\nFor example, with two subsequent UpdateBordersRequest:\n\n 1. range: A1:A5 `{ top: RED, bottom: WHITE }`\n 2. range: A1:A5 `{ left: BLUE }`\n\nThat would result in A1:A5 having a borders of\n`{ top: RED, bottom: WHITE, left: BLUE }`.\nIf you want to clear a border, explicitly set the style to\nNONE."
},
"CellFormat": {
- "id": "CellFormat",
- "description": "The format of a cell.",
"type": "object",
"properties": {
- "backgroundColor": {
- "$ref": "Color",
- "description": "The background color of the cell."
- },
"verticalAlignment": {
+ "description": "The vertical alignment of the value in the cell.",
+ "type": "string",
"enumDescriptions": [
"The vertical alignment is not specified. Do not use this.",
"The text is explicitly aligned to the top of the cell.",
@@ -1281,15 +2119,15 @@
"TOP",
"MIDDLE",
"BOTTOM"
- ],
- "description": "The vertical alignment of the value in the cell.",
- "type": "string"
+ ]
},
"padding": {
"$ref": "Padding",
"description": "The padding of the cell."
},
"textDirection": {
+ "description": "The direction of the text in the cell.",
+ "type": "string",
"enumDescriptions": [
"The text direction is not specified. Do not use this.",
"The text direction of left-to-right was set by the user.",
@@ -1299,16 +2137,13 @@
"TEXT_DIRECTION_UNSPECIFIED",
"LEFT_TO_RIGHT",
"RIGHT_TO_LEFT"
- ],
- "description": "The direction of the text in the cell.",
- "type": "string"
+ ]
},
"borders": {
"$ref": "Borders",
"description": "The borders of the cell."
},
"wrapStrategy": {
- "description": "The wrap strategy for the value in the cell.",
"type": "string",
"enumDescriptions": [
"The default value, do not use.",
@@ -1323,15 +2158,16 @@
"LEGACY_WRAP",
"CLIP",
"WRAP"
- ]
+ ],
+ "description": "The wrap strategy for the value in the cell."
},
"textRotation": {
- "$ref": "TextRotation",
- "description": "The rotation applied to text in a cell"
+ "description": "The rotation applied to text in a cell",
+ "$ref": "TextRotation"
},
"numberFormat": {
- "description": "A format describing how number values should be represented to the user.",
- "$ref": "NumberFormat"
+ "$ref": "NumberFormat",
+ "description": "A format describing how number values should be represented to the user."
},
"hyperlinkDisplayType": {
"enumDescriptions": [
@@ -1366,26 +2202,31 @@
"textFormat": {
"$ref": "TextFormat",
"description": "The format of the text in the cell (unless overridden by a format run)."
+ },
+ "backgroundColor": {
+ "$ref": "Color",
+ "description": "The background color of the cell."
}
- }
+ },
+ "id": "CellFormat",
+ "description": "The format of a cell."
},
"ClearValuesResponse": {
"description": "The response when clearing a range of values in a spreadsheet.",
"type": "object",
"properties": {
- "spreadsheetId": {
- "description": "The spreadsheet the updates were applied to.",
- "type": "string"
- },
"clearedRange": {
"description": "The range (in A1 notation) that was cleared.\n(If the request was for an unbounded range or a ranger larger\n than the bounds of the sheet, this will be the actual range\n that was cleared, bounded to the sheet's limits.)",
"type": "string"
+ },
+ "spreadsheetId": {
+ "description": "The spreadsheet the updates were applied to.",
+ "type": "string"
}
},
"id": "ClearValuesResponse"
},
"DeleteConditionalFormatRuleRequest": {
- "description": "Deletes a conditional format rule at the given index.\nAll subsequent rules' indexes are decremented.",
"type": "object",
"properties": {
"index": {
@@ -1394,20 +2235,21 @@
"type": "integer"
},
"sheetId": {
+ "type": "integer",
"format": "int32",
- "description": "The sheet the rule is being deleted from.",
- "type": "integer"
+ "description": "The sheet the rule is being deleted from."
}
},
- "id": "DeleteConditionalFormatRuleRequest"
+ "id": "DeleteConditionalFormatRuleRequest",
+ "description": "Deletes a conditional format rule at the given index.\nAll subsequent rules' indexes are decremented."
},
"AddBandingResponse": {
"description": "The result of adding a banded range.",
"type": "object",
"properties": {
"bandedRange": {
- "$ref": "BandedRange",
- "description": "The banded range that was added."
+ "description": "The banded range that was added.",
+ "$ref": "BandedRange"
}
},
"id": "AddBandingResponse"
@@ -1438,21 +2280,23 @@
"description": "The response when retrieving more than one range of values in a spreadsheet.",
"type": "object",
"properties": {
- "valueRanges": {
- "description": "The requested values. The order of the ValueRanges is the same as the\norder of the requested ranges.",
- "items": {
- "$ref": "ValueRange"
- },
- "type": "array"
- },
"spreadsheetId": {
"description": "The ID of the spreadsheet the data was retrieved from.",
"type": "string"
+ },
+ "valueRanges": {
+ "items": {
+ "$ref": "ValueRange"
+ },
+ "type": "array",
+ "description": "The requested values. The order of the ValueRanges is the same as the\norder of the requested ranges."
}
},
"id": "BatchGetValuesResponse"
},
"UpdateBandingRequest": {
+ "description": "Updates properties of the supplied banded range.",
+ "type": "object",
"properties": {
"fields": {
"format": "google-fieldmask",
@@ -1464,16 +2308,21 @@
"description": "The banded range to update with the new properties."
}
},
- "id": "UpdateBandingRequest",
- "description": "Updates properties of the supplied banded range.",
- "type": "object"
+ "id": "UpdateBandingRequest"
},
"Color": {
+ "description": "Represents a color in the RGBA color space. This representation is designed\nfor simplicity of conversion to/from color representations in various\nlanguages over compactness; for example, the fields of this representation\ncan be trivially provided to the constructor of \"java.awt.Color\" in Java; it\ncan also be trivially provided to UIColor's \"+colorWithRed:green:blue:alpha\"\nmethod in iOS; and, with just a little work, it can be easily formatted into\na CSS \"rgba()\" string in JavaScript, as well. Here are some examples:\n\nExample (Java):\n\n import com.google.type.Color;\n\n // ...\n public static java.awt.Color fromProto(Color protocolor) {\n float alpha = protocolor.hasAlpha()\n ? protocolor.getAlpha().getValue()\n : 1.0;\n\n return new java.awt.Color(\n protocolor.getRed(),\n protocolor.getGreen(),\n protocolor.getBlue(),\n alpha);\n }\n\n public static Color toProto(java.awt.Color color) {\n float red = (float) color.getRed();\n float green = (float) color.getGreen();\n float blue = (float) color.getBlue();\n float denominator = 255.0;\n Color.Builder resultBuilder =\n Color\n .newBuilder()\n .setRed(red / denominator)\n .setGreen(green / denominator)\n .setBlue(blue / denominator);\n int alpha = color.getAlpha();\n if (alpha != 255) {\n result.setAlpha(\n FloatValue\n .newBuilder()\n .setValue(((float) alpha) / denominator)\n .build());\n }\n return resultBuilder.build();\n }\n // ...\n\nExample (iOS / Obj-C):\n\n // ...\n static UIColor* fromProto(Color* protocolor) {\n float red = [protocolor red];\n float green = [protocolor green];\n float blue = [protocolor blue];\n FloatValue* alpha_wrapper = [protocolor alpha];\n float alpha = 1.0;\n if (alpha_wrapper != nil) {\n alpha = [alpha_wrapper value];\n }\n return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];\n }\n\n static Color* toProto(UIColor* color) {\n CGFloat red, green, blue, alpha;\n if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {\n return nil;\n }\n Color* result = [Color alloc] init];\n [result setRed:red];\n [result setGreen:green];\n [result setBlue:blue];\n if (alpha \u003c= 0.9999) {\n [result setAlpha:floatWrapperWithValue(alpha)];\n }\n [result autorelease];\n return result;\n }\n // ...\n\n Example (JavaScript):\n\n // ...\n\n var protoToCssColor = function(rgb_color) {\n var redFrac = rgb_color.red || 0.0;\n var greenFrac = rgb_color.green || 0.0;\n var blueFrac = rgb_color.blue || 0.0;\n var red = Math.floor(redFrac * 255);\n var green = Math.floor(greenFrac * 255);\n var blue = Math.floor(blueFrac * 255);\n\n if (!('alpha' in rgb_color)) {\n return rgbToCssColor_(red, green, blue);\n }\n\n var alphaFrac = rgb_color.alpha.value || 0.0;\n var rgbParams = [red, green, blue].join(',');\n return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');\n };\n\n var rgbToCssColor_ = function(red, green, blue) {\n var rgbNumber = new Number((red \u003c\u003c 16) | (green \u003c\u003c 8) | blue);\n var hexString = rgbNumber.toString(16);\n var missingZeros = 6 - hexString.length;\n var resultBuilder = ['#'];\n for (var i = 0; i \u003c missingZeros; i++) {\n resultBuilder.push('0');\n }\n resultBuilder.push(hexString);\n return resultBuilder.join('');\n };\n\n // ...",
+ "type": "object",
"properties": {
- "alpha": {
+ "red": {
"type": "number",
"format": "float",
- "description": "The fraction of this color that should be applied to the pixel. That is,\nthe final pixel color is defined by the equation:\n\n pixel color = alpha * (this color) + (1.0 - alpha) * (background color)\n\nThis means that a value of 1.0 corresponds to a solid color, whereas\na value of 0.0 corresponds to a completely transparent color. This\nuses a wrapper message rather than a simple float scalar so that it is\npossible to distinguish between a default value and the value being unset.\nIf omitted, this color object is to be rendered as a solid color\n(as if the alpha value had been explicitly given with a value of 1.0)."
+ "description": "The amount of red in the color as a value in the interval [0, 1]."
+ },
+ "alpha": {
+ "format": "float",
+ "description": "The fraction of this color that should be applied to the pixel. That is,\nthe final pixel color is defined by the equation:\n\n pixel color = alpha * (this color) + (1.0 - alpha) * (background color)\n\nThis means that a value of 1.0 corresponds to a solid color, whereas\na value of 0.0 corresponds to a completely transparent color. This\nuses a wrapper message rather than a simple float scalar so that it is\npossible to distinguish between a default value and the value being unset.\nIf omitted, this color object is to be rendered as a solid color\n(as if the alpha value had been explicitly given with a value of 1.0).",
+ "type": "number"
},
"blue": {
"format": "float",
@@ -1484,16 +2333,9 @@
"format": "float",
"description": "The amount of green in the color as a value in the interval [0, 1].",
"type": "number"
- },
- "red": {
- "format": "float",
- "description": "The amount of red in the color as a value in the interval [0, 1].",
- "type": "number"
}
},
- "id": "Color",
- "description": "Represents a color in the RGBA color space. This representation is designed\nfor simplicity of conversion to/from color representations in various\nlanguages over compactness; for example, the fields of this representation\ncan be trivially provided to the constructor of \"java.awt.Color\" in Java; it\ncan also be trivially provided to UIColor's \"+colorWithRed:green:blue:alpha\"\nmethod in iOS; and, with just a little work, it can be easily formatted into\na CSS \"rgba()\" string in JavaScript, as well. Here are some examples:\n\nExample (Java):\n\n import com.google.type.Color;\n\n // ...\n public static java.awt.Color fromProto(Color protocolor) {\n float alpha = protocolor.hasAlpha()\n ? protocolor.getAlpha().getValue()\n : 1.0;\n\n return new java.awt.Color(\n protocolor.getRed(),\n protocolor.getGreen(),\n protocolor.getBlue(),\n alpha);\n }\n\n public static Color toProto(java.awt.Color color) {\n float red = (float) color.getRed();\n float green = (float) color.getGreen();\n float blue = (float) color.getBlue();\n float denominator = 255.0;\n Color.Builder resultBuilder =\n Color\n .newBuilder()\n .setRed(red / denominator)\n .setGreen(green / denominator)\n .setBlue(blue / denominator);\n int alpha = color.getAlpha();\n if (alpha != 255) {\n result.setAlpha(\n FloatValue\n .newBuilder()\n .setValue(((float) alpha) / denominator)\n .build());\n }\n return resultBuilder.build();\n }\n // ...\n\nExample (iOS / Obj-C):\n\n // ...\n static UIColor* fromProto(Color* protocolor) {\n float red = [protocolor red];\n float green = [protocolor green];\n float blue = [protocolor blue];\n FloatValue* alpha_wrapper = [protocolor alpha];\n float alpha = 1.0;\n if (alpha_wrapper != nil) {\n alpha = [alpha_wrapper value];\n }\n return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];\n }\n\n static Color* toProto(UIColor* color) {\n CGFloat red, green, blue, alpha;\n if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {\n return nil;\n }\n Color* result = [Color alloc] init];\n [result setRed:red];\n [result setGreen:green];\n [result setBlue:blue];\n if (alpha \u003c= 0.9999) {\n [result setAlpha:floatWrapperWithValue(alpha)];\n }\n [result autorelease];\n return result;\n }\n // ...\n\n Example (JavaScript):\n\n // ...\n\n var protoToCssColor = function(rgb_color) {\n var redFrac = rgb_color.red || 0.0;\n var greenFrac = rgb_color.green || 0.0;\n var blueFrac = rgb_color.blue || 0.0;\n var red = Math.floor(redFrac * 255);\n var green = Math.floor(greenFrac * 255);\n var blue = Math.floor(blueFrac * 255);\n\n if (!('alpha' in rgb_color)) {\n return rgbToCssColor_(red, green, blue);\n }\n\n var alphaFrac = rgb_color.alpha.value || 0.0;\n var rgbParams = [red, green, blue].join(',');\n return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');\n };\n\n var rgbToCssColor_ = function(red, green, blue) {\n var rgbNumber = new Number((red \u003c\u003c 16) | (green \u003c\u003c 8) | blue);\n var hexString = rgbNumber.toString(16);\n var missingZeros = 6 - hexString.length;\n var resultBuilder = ['#'];\n for (var i = 0; i \u003c missingZeros; i++) {\n resultBuilder.push('0');\n }\n resultBuilder.push(hexString);\n return resultBuilder.join('');\n };\n\n // ...",
- "type": "object"
+ "id": "Color"
},
"PivotGroup": {
"description": "A single grouping (either row or column) in a pivot table.",
@@ -1518,20 +2360,20 @@
"description": "The bucket of the opposite pivot group to sort by.\nIf not specified, sorting is alphabetical by this group's values."
},
"valueMetadata": {
- "description": "Metadata about values in the grouping.",
"items": {
"$ref": "PivotGroupValueMetadata"
},
- "type": "array"
+ "type": "array",
+ "description": "Metadata about values in the grouping."
},
"showTotals": {
"description": "True if the pivot table should include the totals for this grouping.",
"type": "boolean"
},
"sourceColumnOffset": {
- "type": "integer",
"format": "int32",
- "description": "The column offset of the source range that this grouping is based on.\n\nFor example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`\nmeans this group refers to column `C`, whereas the offset `1` would refer\nto column `D`."
+ "description": "The column offset of the source range that this grouping is based on.\n\nFor example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`\nmeans this group refers to column `C`, whereas the offset `1` would refer\nto column `D`.",
+ "type": "integer"
}
},
"id": "PivotGroup"
@@ -1555,6 +2397,7 @@
"type": "array"
},
"valueLayout": {
+ "description": "Whether values should be listed horizontally (as columns)\nor vertically (as rows).",
"type": "string",
"enumDescriptions": [
"Values are laid out horizontally (as columns).",
@@ -1563,15 +2406,7 @@
"enum": [
"HORIZONTAL",
"VERTICAL"
- ],
- "description": "Whether values should be listed horizontally (as columns)\nor vertically (as rows)."
- },
- "values": {
- "description": "A list of values to include in the pivot table.",
- "items": {
- "$ref": "PivotValue"
- },
- "type": "array"
+ ]
},
"source": {
"description": "The range the pivot table is reading data from.",
@@ -1583,12 +2418,18 @@
"$ref": "PivotGroup"
},
"type": "array"
+ },
+ "values": {
+ "description": "A list of values to include in the pivot table.",
+ "items": {
+ "$ref": "PivotValue"
+ },
+ "type": "array"
}
},
"id": "PivotTable"
},
"ChartSourceRange": {
- "id": "ChartSourceRange",
"description": "Source ranges for a chart.",
"type": "object",
"properties": {
@@ -1599,7 +2440,8 @@
},
"type": "array"
}
- }
+ },
+ "id": "ChartSourceRange"
},
"SearchDeveloperMetadataResponse": {
"properties": {
@@ -1616,8 +2458,13 @@
"type": "object"
},
"ValueRange": {
+ "description": "Data within a range of the spreadsheet.",
"type": "object",
"properties": {
+ "range": {
+ "description": "The range the values cover, in A1 notation.\nFor output, this range indicates the entire requested range,\neven though the values will exclude trailing rows and columns.\nWhen appending values, this field represents the range to search for a\ntable, after which values will be appended.",
+ "type": "string"
+ },
"values": {
"description": "The data that was read or to be written. This is an array of arrays,\nthe outer array representing all the data and each inner array\nrepresenting a major dimension. Each item in the inner array\ncorresponds with one cell.\n\nFor output, empty trailing rows and columns will not be included.\n\nFor input, supported value types are: bool, string, and double.\nNull values will be skipped.\nTo set a cell to an empty value, set the string value to an empty string.",
"items": {
@@ -1629,28 +2476,25 @@
"type": "array"
},
"majorDimension": {
- "enumDescriptions": [
- "The default value, do not use.",
- "Operates on the rows of a sheet.",
- "Operates on the columns of a sheet."
- ],
"enum": [
"DIMENSION_UNSPECIFIED",
"ROWS",
"COLUMNS"
],
"description": "The major dimension of the values.\n\nFor output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,\nthen requesting `range=A1:B2,majorDimension=ROWS` will return\n`[[1,2],[3,4]]`,\nwhereas requesting `range=A1:B2,majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`.\n\nFor input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]`\nwill set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS`\nthen `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`.\n\nWhen writing, if this field is not set, it defaults to ROWS.",
- "type": "string"
- },
- "range": {
- "description": "The range the values cover, in A1 notation.\nFor output, this range indicates the entire requested range,\neven though the values will exclude trailing rows and columns.\nWhen appending values, this field represents the range to search for a\ntable, after which values will be appended.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Operates on the rows of a sheet.",
+ "Operates on the columns of a sheet."
+ ]
}
},
- "id": "ValueRange",
- "description": "Data within a range of the spreadsheet."
+ "id": "ValueRange"
},
"AppendCellsRequest": {
+ "description": "Adds new cells after the last row with data in a sheet,\ninserting new rows into the sheet if necessary.",
+ "type": "object",
"properties": {
"fields": {
"format": "google-fieldmask",
@@ -1670,9 +2514,7 @@
"type": "integer"
}
},
- "id": "AppendCellsRequest",
- "description": "Adds new cells after the last row with data in a sheet,\ninserting new rows into the sheet if necessary.",
- "type": "object"
+ "id": "AppendCellsRequest"
},
"AddBandingRequest": {
"description": "Adds a new banded range to the spreadsheet.",
@@ -1690,12 +2532,12 @@
"type": "object",
"properties": {
"addFilterView": {
- "description": "A reply from adding a filter view.",
- "$ref": "AddFilterViewResponse"
+ "$ref": "AddFilterViewResponse",
+ "description": "A reply from adding a filter view."
},
"addBanding": {
- "$ref": "AddBandingResponse",
- "description": "A reply from adding a banded range."
+ "description": "A reply from adding a banded range.",
+ "$ref": "AddBandingResponse"
},
"addProtectedRange": {
"description": "A reply from adding a protected range.",
@@ -1710,8 +2552,8 @@
"$ref": "DeleteConditionalFormatRuleResponse"
},
"updateEmbeddedObjectPosition": {
- "$ref": "UpdateEmbeddedObjectPositionResponse",
- "description": "A reply from updating an embedded object's position."
+ "description": "A reply from updating an embedded object's position.",
+ "$ref": "UpdateEmbeddedObjectPositionResponse"
},
"duplicateFilterView": {
"description": "A reply from duplicating a filter view.",
@@ -1722,28 +2564,28 @@
"description": "A reply from adding a chart."
},
"updateDeveloperMetadata": {
- "description": "A reply from updating a developer metadata entry.",
- "$ref": "UpdateDeveloperMetadataResponse"
+ "$ref": "UpdateDeveloperMetadataResponse",
+ "description": "A reply from updating a developer metadata entry."
},
"findReplace": {
"$ref": "FindReplaceResponse",
"description": "A reply from doing a find/replace."
},
"addSheet": {
- "$ref": "AddSheetResponse",
- "description": "A reply from adding a sheet."
- },
- "updateConditionalFormatRule": {
- "description": "A reply from updating a conditional format rule.",
- "$ref": "UpdateConditionalFormatRuleResponse"
+ "description": "A reply from adding a sheet.",
+ "$ref": "AddSheetResponse"
},
"createDeveloperMetadata": {
- "description": "A reply from creating a developer metadata entry.",
- "$ref": "CreateDeveloperMetadataResponse"
+ "$ref": "CreateDeveloperMetadataResponse",
+ "description": "A reply from creating a developer metadata entry."
+ },
+ "updateConditionalFormatRule": {
+ "$ref": "UpdateConditionalFormatRuleResponse",
+ "description": "A reply from updating a conditional format rule."
},
"addNamedRange": {
- "description": "A reply from adding a named range.",
- "$ref": "AddNamedRangeResponse"
+ "$ref": "AddNamedRangeResponse",
+ "description": "A reply from adding a named range."
},
"deleteDeveloperMetadata": {
"$ref": "DeleteDeveloperMetadataResponse",
@@ -1753,20 +2595,21 @@
"id": "Response"
},
"InsertRangeRequest": {
+ "description": "Inserts cells into a range, shifting the existing cells over or down.",
"type": "object",
"properties": {
"shiftDimension": {
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ],
"description": "The dimension which will be shifted when inserting cells.\nIf ROWS, existing cells will be shifted down.\nIf COLUMNS, existing cells will be shifted right.",
"type": "string",
"enumDescriptions": [
"The default value, do not use.",
"Operates on the rows of a sheet.",
"Operates on the columns of a sheet."
- ],
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
]
},
"range": {
@@ -1774,10 +2617,10 @@
"description": "The range to insert new cells into."
}
},
- "id": "InsertRangeRequest",
- "description": "Inserts cells into a range, shifting the existing cells over or down."
+ "id": "InsertRangeRequest"
},
"TextFormatRun": {
+ "description": "A run of a text format. The format of this run continues until the start\nindex of the next run.\nWhen updating, all fields must be set.",
"type": "object",
"properties": {
"startIndex": {
@@ -1790,10 +2633,10 @@
"description": "The format of this run. Absent values inherit the cell's format."
}
},
- "id": "TextFormatRun",
- "description": "A run of a text format. The format of this run continues until the start\nindex of the next run.\nWhen updating, all fields must be set."
+ "id": "TextFormatRun"
},
"EmbeddedChart": {
+ "description": "A chart embedded in a sheet.",
"type": "object",
"properties": {
"chartId": {
@@ -1802,29 +2645,30 @@
"type": "integer"
},
"position": {
- "$ref": "EmbeddedObjectPosition",
- "description": "The position of the chart."
+ "description": "The position of the chart.",
+ "$ref": "EmbeddedObjectPosition"
},
"spec": {
- "$ref": "ChartSpec",
- "description": "The specification of the chart."
+ "description": "The specification of the chart.",
+ "$ref": "ChartSpec"
}
},
- "id": "EmbeddedChart",
- "description": "A chart embedded in a sheet."
+ "id": "EmbeddedChart"
},
"AddNamedRangeResponse": {
+ "id": "AddNamedRangeResponse",
"description": "The result of adding a named range.",
"type": "object",
"properties": {
"namedRange": {
- "$ref": "NamedRange",
- "description": "The named range to add."
+ "description": "The named range to add.",
+ "$ref": "NamedRange"
}
- },
- "id": "AddNamedRangeResponse"
+ }
},
"BatchUpdateValuesByDataFilterResponse": {
+ "description": "The response when updating a range of values in a spreadsheet.",
+ "type": "object",
"properties": {
"totalUpdatedRows": {
"format": "int32",
@@ -1832,11 +2676,11 @@
"type": "integer"
},
"responses": {
+ "description": "The response for each range updated.",
"items": {
"$ref": "UpdateValuesByDataFilterResponse"
},
- "type": "array",
- "description": "The response for each range updated."
+ "type": "array"
},
"totalUpdatedSheets": {
"format": "int32",
@@ -1858,12 +2702,9 @@
"type": "string"
}
},
- "id": "BatchUpdateValuesByDataFilterResponse",
- "description": "The response when updating a range of values in a spreadsheet.",
- "type": "object"
+ "id": "BatchUpdateValuesByDataFilterResponse"
},
"RowData": {
- "description": "Data about each cell in a row.",
"type": "object",
"properties": {
"values": {
@@ -1874,7 +2715,8 @@
"type": "array"
}
},
- "id": "RowData"
+ "id": "RowData",
+ "description": "Data about each cell in a row."
},
"GridData": {
"description": "Data in the grid, as well as metadata about the dimensions.",
@@ -1893,11 +2735,11 @@
"type": "integer"
},
"rowMetadata": {
+ "description": "Metadata about the requested rows in the grid, starting with the row\nin start_row.",
"items": {
"$ref": "DimensionProperties"
},
- "type": "array",
- "description": "Metadata about the requested rows in the grid, starting with the row\nin start_row."
+ "type": "array"
},
"rowData": {
"description": "The data in the grid, one entry per row,\nstarting with the row in startRow.\nThe values in RowData will correspond to columns starting\nat start_column.",
@@ -1919,13 +2761,11 @@
"type": "object",
"properties": {
"width": {
+ "type": "integer",
"format": "int32",
- "description": "The width of the border, in pixels.\nDeprecated; the width is determined by the \"style\" field.",
- "type": "integer"
+ "description": "The width of the border, in pixels.\nDeprecated; the width is determined by the \"style\" field."
},
"style": {
- "description": "The style of the border.",
- "type": "string",
"enumDescriptions": [
"The style is not specified. Do not use this.",
"The border is dotted.",
@@ -1945,11 +2785,13 @@
"SOLID_THICK",
"NONE",
"DOUBLE"
- ]
+ ],
+ "description": "The style of the border.",
+ "type": "string"
},
"color": {
- "$ref": "Color",
- "description": "The color of the border."
+ "description": "The color of the border.",
+ "$ref": "Color"
}
},
"id": "Border"
@@ -1958,27 +2800,19 @@
"description": "Finds and replaces data in cells over a range, sheet, or all sheets.",
"type": "object",
"properties": {
- "replacement": {
- "description": "The value to use as the replacement.",
- "type": "string"
- },
- "range": {
- "description": "The range to find/replace over.",
- "$ref": "GridRange"
- },
"sheetId": {
"format": "int32",
"description": "The sheet to find/replace over.",
"type": "integer"
},
- "allSheets": {
- "description": "True to find/replace over all sheets.",
- "type": "boolean"
- },
"matchCase": {
"description": "True if the search is case sensitive.",
"type": "boolean"
},
+ "allSheets": {
+ "description": "True to find/replace over all sheets.",
+ "type": "boolean"
+ },
"includeFormulas": {
"description": "True if the search should include cells with formulas.\nFalse to skip cells with formulas.",
"type": "boolean"
@@ -1987,18 +2821,27 @@
"description": "True if the find value should match the entire cell.",
"type": "boolean"
},
+ "searchByRegex": {
+ "description": "True if the find value is a regex.\nThe regular expression and replacement should follow Java regex rules\nat https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html.\nThe replacement string is allowed to refer to capturing groups.\nFor example, if one cell has the contents `\"Google Sheets\"` and another\nhas `\"Google Docs\"`, then searching for `\"o.* (.*)\"` with a replacement of\n`\"$1 Rocks\"` would change the contents of the cells to\n`\"GSheets Rocks\"` and `\"GDocs Rocks\"` respectively.",
+ "type": "boolean"
+ },
"find": {
"type": "string",
"description": "The value to search."
},
- "searchByRegex": {
- "description": "True if the find value is a regex.\nThe regular expression and replacement should follow Java regex rules\nat https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html.\nThe replacement string is allowed to refer to capturing groups.\nFor example, if one cell has the contents `\"Google Sheets\"` and another\nhas `\"Google Docs\"`, then searching for `\"o.* (.*)\"` with a replacement of\n`\"$1 Rocks\"` would change the contents of the cells to\n`\"GSheets Rocks\"` and `\"GDocs Rocks\"` respectively.",
- "type": "boolean"
+ "replacement": {
+ "description": "The value to use as the replacement.",
+ "type": "string"
+ },
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range to find/replace over."
}
},
"id": "FindReplaceRequest"
},
"UpdateNamedRangeRequest": {
+ "id": "UpdateNamedRangeRequest",
"description": "Updates properties of the named range with the specified\nnamedRangeId.",
"type": "object",
"properties": {
@@ -2011,8 +2854,7 @@
"description": "The fields that should be updated. At least one field must be specified.\nThe root `namedRange` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
"type": "string"
}
- },
- "id": "UpdateNamedRangeRequest"
+ }
},
"AddSheetRequest": {
"description": "Adds a new sheet.\nWhen a sheet is added at a given index,\nall subsequent sheets' indexes are incremented.\nTo add an object sheet, use AddChartRequest instead and specify\nEmbeddedObjectPosition.sheetId or\nEmbeddedObjectPosition.newSheet.",
@@ -2034,8 +2876,8 @@
"$ref": "GridCoordinate"
},
"range": {
- "$ref": "GridRange",
- "description": "The range to write data to.\n\nIf the data in rows does not cover the entire requested range,\nthe fields matching those set in fields will be cleared."
+ "description": "The range to write data to.\n\nIf the data in rows does not cover the entire requested range,\nthe fields matching those set in fields will be cleared.",
+ "$ref": "GridRange"
},
"fields": {
"format": "google-fieldmask",
@@ -2043,47 +2885,42 @@
"type": "string"
},
"rows": {
- "description": "The data to write.",
"items": {
"$ref": "RowData"
},
- "type": "array"
+ "type": "array",
+ "description": "The data to write."
}
},
"id": "UpdateCellsRequest"
},
+ "RandomizeRangeRequest": {
+ "properties": {
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range to randomize."
+ }
+ },
+ "id": "RandomizeRangeRequest",
+ "description": "Randomizes the order of the rows in a range.",
+ "type": "object"
+ },
"DeleteConditionalFormatRuleResponse": {
- "id": "DeleteConditionalFormatRuleResponse",
"description": "The result of deleting a conditional format rule.",
"type": "object",
"properties": {
"rule": {
- "description": "The rule that was deleted.",
- "$ref": "ConditionalFormatRule"
- }
- }
- },
- "RandomizeRangeRequest": {
- "description": "Randomizes the order of the rows in a range.",
- "type": "object",
- "properties": {
- "range": {
- "description": "The range to randomize.",
- "$ref": "GridRange"
+ "$ref": "ConditionalFormatRule",
+ "description": "The rule that was deleted."
}
},
- "id": "RandomizeRangeRequest"
+ "id": "DeleteConditionalFormatRuleResponse"
},
"DeleteRangeRequest": {
+ "description": "Deletes a range of cells, shifting other cells into the deleted area.",
"type": "object",
"properties": {
- "range": {
- "description": "The range of cells to delete.",
- "$ref": "GridRange"
- },
"shiftDimension": {
- "description": "The dimension from which deleted cells will be replaced with.\nIf ROWS, existing cells will be shifted upward to\nreplace the deleted cells. If COLUMNS, existing cells\nwill be shifted left to replace the deleted cells.",
- "type": "string",
"enumDescriptions": [
"The default value, do not use.",
"Operates on the rows of a sheet.",
@@ -2093,21 +2930,21 @@
"DIMENSION_UNSPECIFIED",
"ROWS",
"COLUMNS"
- ]
+ ],
+ "description": "The dimension from which deleted cells will be replaced with.\nIf ROWS, existing cells will be shifted upward to\nreplace the deleted cells. If COLUMNS, existing cells\nwill be shifted left to replace the deleted cells.",
+ "type": "string"
+ },
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range of cells to delete."
}
},
- "id": "DeleteRangeRequest",
- "description": "Deletes a range of cells, shifting other cells into the deleted area."
+ "id": "DeleteRangeRequest"
},
"GridCoordinate": {
"description": "A coordinate in a sheet.\nAll indexes are zero-based.",
"type": "object",
"properties": {
- "sheetId": {
- "format": "int32",
- "description": "The sheet this coordinate is on.",
- "type": "integer"
- },
"columnIndex": {
"format": "int32",
"description": "The column index of the coordinate.",
@@ -2117,6 +2954,11 @@
"format": "int32",
"description": "The row index of the coordinate.",
"type": "integer"
+ },
+ "sheetId": {
+ "format": "int32",
+ "description": "The sheet this coordinate is on.",
+ "type": "integer"
}
},
"id": "GridCoordinate"
@@ -2125,41 +2967,23 @@
"description": "Updates properties of the sheet with the specified\nsheetId.",
"type": "object",
"properties": {
+ "fields": {
+ "type": "string",
+ "format": "google-fieldmask",
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root `properties` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field."
+ },
"properties": {
"$ref": "SheetProperties",
"description": "The properties to update."
- },
- "fields": {
- "format": "google-fieldmask",
- "description": "The fields that should be updated. At least one field must be specified.\nThe root `properties` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "type": "string"
}
},
"id": "UpdateSheetPropertiesRequest"
},
- "UnmergeCellsRequest": {
- "description": "Unmerges cells in the given range.",
- "type": "object",
- "properties": {
- "range": {
- "$ref": "GridRange",
- "description": "The range within which all cells should be unmerged.\nIf the range spans multiple merges, all will be unmerged.\nThe range must not partially span any merge."
- }
- },
- "id": "UnmergeCellsRequest"
- },
"GridProperties": {
+ "id": "GridProperties",
+ "description": "Properties of a grid.",
"type": "object",
"properties": {
- "hideGridlines": {
- "description": "True if the grid isn't showing gridlines in the UI.",
- "type": "boolean"
- },
- "frozenRowCount": {
- "format": "int32",
- "description": "The number of rows that are frozen in the grid.",
- "type": "integer"
- },
"frozenColumnCount": {
"format": "int32",
"description": "The number of columns that are frozen in the grid.",
@@ -2174,57 +2998,67 @@
"format": "int32",
"description": "The number of rows in the grid.",
"type": "integer"
+ },
+ "hideGridlines": {
+ "description": "True if the grid isn't showing gridlines in the UI.",
+ "type": "boolean"
+ },
+ "frozenRowCount": {
+ "format": "int32",
+ "description": "The number of rows that are frozen in the grid.",
+ "type": "integer"
}
- },
- "id": "GridProperties",
- "description": "Properties of a grid."
+ }
},
- "UpdateEmbeddedObjectPositionResponse": {
- "description": "The result of updating an embedded object's position.",
+ "UnmergeCellsRequest": {
+ "description": "Unmerges cells in the given range.",
"type": "object",
"properties": {
- "position": {
- "description": "The new position of the embedded object.",
- "$ref": "EmbeddedObjectPosition"
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range within which all cells should be unmerged.\nIf the range spans multiple merges, all will be unmerged.\nThe range must not partially span any merge."
}
},
- "id": "UpdateEmbeddedObjectPositionResponse"
+ "id": "UnmergeCellsRequest"
+ },
+ "SortSpec": {
+ "description": "A sort order associated with a specific column or row.",
+ "type": "object",
+ "properties": {
+ "sortOrder": {
+ "enumDescriptions": [
+ "Default value, do not use this.",
+ "Sort ascending.",
+ "Sort descending."
+ ],
+ "enum": [
+ "SORT_ORDER_UNSPECIFIED",
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "description": "The order data should be sorted.",
+ "type": "string"
+ },
+ "dimensionIndex": {
+ "format": "int32",
+ "description": "The dimension the sort should be applied to.",
+ "type": "integer"
+ }
+ },
+ "id": "SortSpec"
},
"Sheet": {
- "description": "A sheet in a spreadsheet.",
- "type": "object",
"properties": {
- "developerMetadata": {
- "description": "The developer metadata associated with a sheet.",
- "items": {
- "$ref": "DeveloperMetadata"
- },
- "type": "array"
- },
- "protectedRanges": {
- "description": "The protected ranges in this sheet.",
- "items": {
- "$ref": "ProtectedRange"
- },
- "type": "array"
- },
- "conditionalFormats": {
- "description": "The conditional format rules in this sheet.",
- "items": {
- "$ref": "ConditionalFormatRule"
- },
- "type": "array"
- },
"basicFilter": {
"$ref": "BasicFilter",
"description": "The filter on this sheet, if any."
},
"merges": {
- "description": "The ranges that are merged together.",
"items": {
"$ref": "GridRange"
},
- "type": "array"
+ "type": "array",
+ "description": "The ranges that are merged together."
},
"data": {
"description": "Data in the grid, if this is a grid sheet.\nThe number of GridData objects returned is dependent on the number of\nranges requested on this sheet. For example, if this is representing\n`Sheet1`, and the spreadsheet was requested with ranges\n`Sheet1!A1:C10` and `Sheet1!D15:E20`, then the first GridData will have a\nstartRow/startColumn of `0`,\nwhile the second one will have `startRow 14` (zero-based row 15),\nand `startColumn 3` (zero-based column D).",
@@ -2240,10 +3074,6 @@
},
"type": "array"
},
- "properties": {
- "description": "The properties of the sheet.",
- "$ref": "SheetProperties"
- },
"charts": {
"description": "The specifications of every chart on this sheet.",
"items": {
@@ -2251,53 +3081,65 @@
},
"type": "array"
},
+ "properties": {
+ "$ref": "SheetProperties",
+ "description": "The properties of the sheet."
+ },
"filterViews": {
"description": "The filter views in this sheet.",
"items": {
"$ref": "FilterView"
},
"type": "array"
- }
- },
- "id": "Sheet"
- },
- "SortSpec": {
- "description": "A sort order associated with a specific column or row.",
- "type": "object",
- "properties": {
- "dimensionIndex": {
- "format": "int32",
- "description": "The dimension the sort should be applied to.",
- "type": "integer"
},
- "sortOrder": {
- "description": "The order data should be sorted.",
- "type": "string",
- "enumDescriptions": [
- "Default value, do not use this.",
- "Sort ascending.",
- "Sort descending."
- ],
- "enum": [
- "SORT_ORDER_UNSPECIFIED",
- "ASCENDING",
- "DESCENDING"
- ]
+ "conditionalFormats": {
+ "description": "The conditional format rules in this sheet.",
+ "items": {
+ "$ref": "ConditionalFormatRule"
+ },
+ "type": "array"
+ },
+ "protectedRanges": {
+ "description": "The protected ranges in this sheet.",
+ "items": {
+ "$ref": "ProtectedRange"
+ },
+ "type": "array"
+ },
+ "developerMetadata": {
+ "description": "The developer metadata associated with a sheet.",
+ "items": {
+ "$ref": "DeveloperMetadata"
+ },
+ "type": "array"
}
},
- "id": "SortSpec"
+ "id": "Sheet",
+ "description": "A sheet in a spreadsheet.",
+ "type": "object"
+ },
+ "UpdateEmbeddedObjectPositionResponse": {
+ "properties": {
+ "position": {
+ "$ref": "EmbeddedObjectPosition",
+ "description": "The new position of the embedded object."
+ }
+ },
+ "id": "UpdateEmbeddedObjectPositionResponse",
+ "description": "The result of updating an embedded object's position.",
+ "type": "object"
},
"BooleanRule": {
"description": "A rule that may or may not match, depending on the condition.",
"type": "object",
"properties": {
- "condition": {
- "description": "The condition of the rule. If the condition evaluates to true,\nthe format will be applied.",
- "$ref": "BooleanCondition"
- },
"format": {
"$ref": "CellFormat",
"description": "The format to apply.\nConditional formatting can only apply a subset of formatting:\nbold, italic,\nstrikethrough,\nforeground color &\nbackground color."
+ },
+ "condition": {
+ "$ref": "BooleanCondition",
+ "description": "The condition of the rule. If the condition evaluates to true,\nthe format will be applied."
}
},
"id": "BooleanRule"
@@ -2311,11 +3153,11 @@
"description": "A condition that must be true for values to be shown.\n(This does not override hiddenValues -- if a value is listed there,\n it will still be hidden.)"
},
"hiddenValues": {
+ "description": "Values that should be hidden.",
"items": {
"type": "string"
},
- "type": "array",
- "description": "Values that should be hidden."
+ "type": "array"
}
},
"id": "FilterCriteria"
@@ -2325,8 +3167,8 @@
"type": "object",
"properties": {
"value": {
- "description": "The calculated value the metadata corresponds to.\n(Note that formulaValue is not valid,\n because the values will be calculated.)",
- "$ref": "ExtendedValue"
+ "$ref": "ExtendedValue",
+ "description": "The calculated value the metadata corresponds to.\n(Note that formulaValue is not valid,\n because the values will be calculated.)"
},
"collapsed": {
"description": "True if the data corresponding to the value is collapsed.",
@@ -2347,8 +3189,8 @@
"type": "array"
},
"domainUsersCanEdit": {
- "description": "True if anyone in the document's domain has edit access to the protected\nrange. Domain protection is only supported on documents within a domain.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "True if anyone in the document's domain has edit access to the protected\nrange. Domain protection is only supported on documents within a domain."
},
"groups": {
"items": {
@@ -2361,9 +3203,11 @@
"id": "Editors"
},
"UpdateConditionalFormatRuleRequest": {
- "description": "Updates a conditional format rule at the given index,\nor moves a conditional format rule to another index.",
- "type": "object",
"properties": {
+ "rule": {
+ "$ref": "ConditionalFormatRule",
+ "description": "The rule that should replace the rule at the given index."
+ },
"index": {
"format": "int32",
"description": "The zero-based index of the rule that should be replaced or moved.",
@@ -2378,15 +3222,14 @@
"format": "int32",
"description": "The zero-based new index the rule should end up at.",
"type": "integer"
- },
- "rule": {
- "$ref": "ConditionalFormatRule",
- "description": "The rule that should replace the rule at the given index."
}
},
- "id": "UpdateConditionalFormatRuleRequest"
+ "id": "UpdateConditionalFormatRuleRequest",
+ "description": "Updates a conditional format rule at the given index,\nor moves a conditional format rule to another index.",
+ "type": "object"
},
"BasicChartDomain": {
+ "description": "The domain of a chart.\nFor example, if charting stock prices over time, this would be the date.",
"type": "object",
"properties": {
"domain": {
@@ -2398,14 +3241,14 @@
"type": "boolean"
}
},
- "id": "BasicChartDomain",
- "description": "The domain of a chart.\nFor example, if charting stock prices over time, this would be the date."
+ "id": "BasicChartDomain"
},
"DataValidationRule": {
+ "type": "object",
"properties": {
"showCustomUi": {
- "description": "True if the UI should be customized based on the kind of condition.\nIf true, \"List\" conditions will show a dropdown.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "True if the UI should be customized based on the kind of condition.\nIf true, \"List\" conditions will show a dropdown."
},
"strict": {
"description": "True if invalid data should be rejected.",
@@ -2416,29 +3259,18 @@
"type": "string"
},
"condition": {
- "description": "The condition that data in the cell must match.",
- "$ref": "BooleanCondition"
+ "$ref": "BooleanCondition",
+ "description": "The condition that data in the cell must match."
}
},
"id": "DataValidationRule",
- "description": "A data validation rule.",
- "type": "object"
+ "description": "A data validation rule."
},
"PasteDataRequest": {
"description": "Inserts data into the spreadsheet starting at the specified coordinate.",
"type": "object",
"properties": {
"type": {
- "type": "string",
- "enumDescriptions": [
- "Paste values, formulas, formats, and merges.",
- "Paste the values ONLY without formats, formulas, or merges.",
- "Paste the format and data validation only.",
- "Like PASTE_NORMAL but without borders.",
- "Paste the formulas only.",
- "Paste the data validation only.",
- "Paste the conditional formatting rules only."
- ],
"enum": [
"PASTE_NORMAL",
"PASTE_VALUES",
@@ -2448,7 +3280,17 @@
"PASTE_DATA_VALIDATION",
"PASTE_CONDITIONAL_FORMATTING"
],
- "description": "How the data should be pasted."
+ "description": "How the data should be pasted.",
+ "type": "string",
+ "enumDescriptions": [
+ "Paste values, formulas, formats, and merges.",
+ "Paste the values ONLY without formats, formulas, or merges.",
+ "Paste the format and data validation only.",
+ "Like PASTE_NORMAL but without borders.",
+ "Paste the formulas only.",
+ "Paste the data validation only.",
+ "Paste the conditional formatting rules only."
+ ]
},
"html": {
"description": "True if the data is HTML.",
@@ -2474,59 +3316,58 @@
"type": "object",
"properties": {
"developerMetadata": {
+ "description": "The updated developer metadata.",
"items": {
"$ref": "DeveloperMetadata"
},
- "type": "array",
- "description": "The updated developer metadata."
+ "type": "array"
}
},
"id": "UpdateDeveloperMetadataResponse"
},
"AppendDimensionRequest": {
- "description": "Appends rows or columns to the end of a sheet.",
- "type": "object",
"properties": {
- "sheetId": {
- "format": "int32",
- "description": "The sheet to append rows or columns to.",
- "type": "integer"
- },
"dimension": {
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Operates on the rows of a sheet.",
+ "Operates on the columns of a sheet."
+ ],
"enum": [
"DIMENSION_UNSPECIFIED",
"ROWS",
"COLUMNS"
],
"description": "Whether rows or columns should be appended.",
- "type": "string",
- "enumDescriptions": [
- "The default value, do not use.",
- "Operates on the rows of a sheet.",
- "Operates on the columns of a sheet."
- ]
+ "type": "string"
},
"length": {
"format": "int32",
"description": "The number of rows or columns to append.",
"type": "integer"
+ },
+ "sheetId": {
+ "format": "int32",
+ "description": "The sheet to append rows or columns to.",
+ "type": "integer"
}
},
- "id": "AppendDimensionRequest"
+ "id": "AppendDimensionRequest",
+ "description": "Appends rows or columns to the end of a sheet.",
+ "type": "object"
},
"AddNamedRangeRequest": {
- "description": "Adds a named range to the spreadsheet.",
- "type": "object",
"properties": {
"namedRange": {
"$ref": "NamedRange",
"description": "The named range to add. The namedRangeId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a range that already exists.)"
}
},
- "id": "AddNamedRangeRequest"
+ "id": "AddNamedRangeRequest",
+ "description": "Adds a named range to the spreadsheet.",
+ "type": "object"
},
"CreateDeveloperMetadataResponse": {
- "description": "The response from creating developer metadata.",
"type": "object",
"properties": {
"developerMetadata": {
@@ -2534,28 +3375,29 @@
"description": "The developer metadata that was created."
}
},
- "id": "CreateDeveloperMetadataResponse"
+ "id": "CreateDeveloperMetadataResponse",
+ "description": "The response from creating developer metadata."
},
"UpdateEmbeddedObjectPositionRequest": {
- "id": "UpdateEmbeddedObjectPositionRequest",
"description": "Update an embedded object's position (such as a moving or resizing a\nchart or image).",
"type": "object",
"properties": {
"newPosition": {
- "description": "An explicit position to move the embedded object to.\nIf newPosition.sheetId is set,\na new sheet with that ID will be created.\nIf newPosition.newSheet is set to true,\na new sheet will be created with an ID that will be chosen for you.",
- "$ref": "EmbeddedObjectPosition"
+ "$ref": "EmbeddedObjectPosition",
+ "description": "An explicit position to move the embedded object to.\nIf newPosition.sheetId is set,\na new sheet with that ID will be created.\nIf newPosition.newSheet is set to true,\na new sheet will be created with an ID that will be chosen for you."
},
"fields": {
+ "type": "string",
"format": "google-fieldmask",
- "description": "The fields of OverlayPosition\nthat should be updated when setting a new position. Used only if\nnewPosition.overlayPosition\nis set, in which case at least one field must\nbe specified. The root `newPosition.overlayPosition` is implied and\nshould not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "type": "string"
+ "description": "The fields of OverlayPosition\nthat should be updated when setting a new position. Used only if\nnewPosition.overlayPosition\nis set, in which case at least one field must\nbe specified. The root `newPosition.overlayPosition` is implied and\nshould not be specified.\nA single `\"*\"` can be used as short-hand for listing every field."
},
"objectId": {
"format": "int32",
"description": "The ID of the object to moved.",
"type": "integer"
}
- }
+ },
+ "id": "UpdateEmbeddedObjectPositionRequest"
},
"TextRotation": {
"description": "The rotation applied to text in a cell.",
@@ -2573,55 +3415,7 @@
},
"id": "TextRotation"
},
- "PieChartSpec": {
- "type": "object",
- "properties": {
- "pieHole": {
- "format": "double",
- "description": "The size of the hole in the pie chart.",
- "type": "number"
- },
- "legendPosition": {
- "type": "string",
- "enumDescriptions": [
- "Default value, do not use.",
- "The legend is rendered on the bottom of the chart.",
- "The legend is rendered on the left of the chart.",
- "The legend is rendered on the right of the chart.",
- "The legend is rendered on the top of the chart.",
- "No legend is rendered.",
- "Each pie slice has a label attached to it."
- ],
- "enum": [
- "PIE_CHART_LEGEND_POSITION_UNSPECIFIED",
- "BOTTOM_LEGEND",
- "LEFT_LEGEND",
- "RIGHT_LEGEND",
- "TOP_LEGEND",
- "NO_LEGEND",
- "LABELED_LEGEND"
- ],
- "description": "Where the legend of the pie chart should be drawn."
- },
- "threeDimensional": {
- "description": "True if the pie is three dimensional.",
- "type": "boolean"
- },
- "domain": {
- "description": "The data that covers the domain of the pie chart.",
- "$ref": "ChartData"
- },
- "series": {
- "$ref": "ChartData",
- "description": "The data that covers the one and only series of the pie chart."
- }
- },
- "id": "PieChartSpec",
- "description": "A \u003ca href=\"/chart/interactive/docs/gallery/piechart\"\u003epie chart\u003c/a\u003e."
- },
"UpdateDeveloperMetadataRequest": {
- "description": "A request to update properties of developer metadata.\nUpdates the properties of the developer metadata selected by the filters to\nthe values provided in the DeveloperMetadata resource. Callers must\nspecify the properties they wish to update in the fields parameter, as well\nas specify at least one DataFilter matching the metadata they wish to\nupdate.",
- "type": "object",
"properties": {
"dataFilters": {
"description": "The filters matching the developer metadata entries to update.",
@@ -2640,31 +3434,84 @@
"description": "The value that all metadata matched by the data filters will be updated to."
}
},
- "id": "UpdateDeveloperMetadataRequest"
+ "id": "UpdateDeveloperMetadataRequest",
+ "description": "A request to update properties of developer metadata.\nUpdates the properties of the developer metadata selected by the filters to\nthe values provided in the DeveloperMetadata resource. Callers must\nspecify the properties they wish to update in the fields parameter, as well\nas specify at least one DataFilter matching the metadata they wish to\nupdate.",
+ "type": "object"
+ },
+ "PieChartSpec": {
+ "description": "A \u003ca href=\"/chart/interactive/docs/gallery/piechart\"\u003epie chart\u003c/a\u003e.",
+ "type": "object",
+ "properties": {
+ "pieHole": {
+ "format": "double",
+ "description": "The size of the hole in the pie chart.",
+ "type": "number"
+ },
+ "legendPosition": {
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "The legend is rendered on the bottom of the chart.",
+ "The legend is rendered on the left of the chart.",
+ "The legend is rendered on the right of the chart.",
+ "The legend is rendered on the top of the chart.",
+ "No legend is rendered.",
+ "Each pie slice has a label attached to it."
+ ],
+ "enum": [
+ "PIE_CHART_LEGEND_POSITION_UNSPECIFIED",
+ "BOTTOM_LEGEND",
+ "LEFT_LEGEND",
+ "RIGHT_LEGEND",
+ "TOP_LEGEND",
+ "NO_LEGEND",
+ "LABELED_LEGEND"
+ ],
+ "description": "Where the legend of the pie chart should be drawn.",
+ "type": "string"
+ },
+ "threeDimensional": {
+ "description": "True if the pie is three dimensional.",
+ "type": "boolean"
+ },
+ "domain": {
+ "$ref": "ChartData",
+ "description": "The data that covers the domain of the pie chart."
+ },
+ "series": {
+ "$ref": "ChartData",
+ "description": "The data that covers the one and only series of the pie chart."
+ }
+ },
+ "id": "PieChartSpec"
},
"UpdateFilterViewRequest": {
"description": "Updates properties of the filter view.",
"type": "object",
"properties": {
+ "filter": {
+ "description": "The new properties of the filter view.",
+ "$ref": "FilterView"
+ },
"fields": {
"format": "google-fieldmask",
"description": "The fields that should be updated. At least one field must be specified.\nThe root `filter` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
"type": "string"
- },
- "filter": {
- "$ref": "FilterView",
- "description": "The new properties of the filter view."
}
},
"id": "UpdateFilterViewRequest"
},
"ConditionalFormatRule": {
+ "id": "ConditionalFormatRule",
"description": "A rule describing a conditional format.",
"type": "object",
"properties": {
+ "gradientRule": {
+ "$ref": "GradientRule",
+ "description": "The formatting will vary based on the gradients in the rule."
+ },
"booleanRule": {
- "$ref": "BooleanRule",
- "description": "The formatting is either \"on\" or \"off\" according to the rule."
+ "description": "The formatting is either \"on\" or \"off\" according to the rule.",
+ "$ref": "BooleanRule"
},
"ranges": {
"description": "The ranges that will be formatted if the condition is true.\nAll the ranges must be on the same grid.",
@@ -2672,19 +3519,15 @@
"$ref": "GridRange"
},
"type": "array"
- },
- "gradientRule": {
- "description": "The formatting will vary based on the gradients in the rule.",
- "$ref": "GradientRule"
}
- },
- "id": "ConditionalFormatRule"
+ }
},
"CopyPasteRequest": {
"description": "Copies data from the source to the destination.",
"type": "object",
"properties": {
"pasteType": {
+ "type": "string",
"enumDescriptions": [
"Paste values, formulas, formats, and merges.",
"Paste the values ONLY without formats, formulas, or merges.",
@@ -2703,55 +3546,80 @@
"PASTE_DATA_VALIDATION",
"PASTE_CONDITIONAL_FORMATTING"
],
- "description": "What kind of data to paste.",
- "type": "string"
+ "description": "What kind of data to paste."
},
"source": {
"$ref": "GridRange",
"description": "The source range to copy."
},
"destination": {
- "description": "The location to paste to. If the range covers a span that's\na multiple of the source's height or width, then the\ndata will be repeated to fill in the destination range.\nIf the range is smaller than the source range, the entire\nsource data will still be copied (beyond the end of the destination range).",
- "$ref": "GridRange"
+ "$ref": "GridRange",
+ "description": "The location to paste to. If the range covers a span that's\na multiple of the source's height or width, then the\ndata will be repeated to fill in the destination range.\nIf the range is smaller than the source range, the entire\nsource data will still be copied (beyond the end of the destination range)."
},
"pasteOrientation": {
+ "enumDescriptions": [
+ "Paste normally.",
+ "Paste transposed, where all rows become columns and vice versa."
+ ],
"enum": [
"NORMAL",
"TRANSPOSE"
],
"description": "How that data should be oriented when pasting.",
- "type": "string",
- "enumDescriptions": [
- "Paste normally.",
- "Paste transposed, where all rows become columns and vice versa."
- ]
+ "type": "string"
}
},
"id": "CopyPasteRequest"
},
"Request": {
- "description": "A single kind of update to apply to a spreadsheet.",
- "type": "object",
"properties": {
- "updateProtectedRange": {
- "$ref": "UpdateProtectedRangeRequest",
- "description": "Updates a protected range."
+ "sortRange": {
+ "description": "Sorts data in a range.",
+ "$ref": "SortRangeRequest"
+ },
+ "deleteProtectedRange": {
+ "description": "Deletes a protected range.",
+ "$ref": "DeleteProtectedRangeRequest"
+ },
+ "duplicateFilterView": {
+ "description": "Duplicates a filter view.",
+ "$ref": "DuplicateFilterViewRequest"
+ },
+ "addChart": {
+ "$ref": "AddChartRequest",
+ "description": "Adds a chart."
+ },
+ "findReplace": {
+ "$ref": "FindReplaceRequest",
+ "description": "Finds and replaces occurrences of some text with other text."
+ },
+ "textToColumns": {
+ "description": "Converts a column of text into many columns of text.",
+ "$ref": "TextToColumnsRequest"
+ },
+ "updateChartSpec": {
+ "$ref": "UpdateChartSpecRequest",
+ "description": "Updates a chart's specifications."
},
"addSheet": {
"description": "Adds a sheet.",
"$ref": "AddSheetRequest"
},
- "copyPaste": {
- "$ref": "CopyPasteRequest",
- "description": "Copies data from one area and pastes it to another."
+ "updateProtectedRange": {
+ "$ref": "UpdateProtectedRangeRequest",
+ "description": "Updates a protected range."
},
"deleteFilterView": {
"$ref": "DeleteFilterViewRequest",
"description": "Deletes a filter view from a sheet."
},
+ "copyPaste": {
+ "description": "Copies data from one area and pastes it to another.",
+ "$ref": "CopyPasteRequest"
+ },
"insertDimension": {
- "description": "Inserts new rows or columns in a sheet.",
- "$ref": "InsertDimensionRequest"
+ "$ref": "InsertDimensionRequest",
+ "description": "Inserts new rows or columns in a sheet."
},
"deleteRange": {
"$ref": "DeleteRangeRequest",
@@ -2762,8 +3630,8 @@
"description": "Removes a banded range"
},
"addFilterView": {
- "$ref": "AddFilterViewRequest",
- "description": "Adds a filter view."
+ "description": "Adds a filter view.",
+ "$ref": "AddFilterViewRequest"
},
"setDataValidation": {
"$ref": "SetDataValidationRequest",
@@ -2774,8 +3642,8 @@
"description": "Updates the borders in a range of cells."
},
"deleteConditionalFormatRule": {
- "description": "Deletes an existing conditional format rule.",
- "$ref": "DeleteConditionalFormatRuleRequest"
+ "$ref": "DeleteConditionalFormatRuleRequest",
+ "description": "Deletes an existing conditional format rule."
},
"repeatCell": {
"$ref": "RepeatCellRequest",
@@ -2786,20 +3654,20 @@
"$ref": "ClearBasicFilterRequest"
},
"appendDimension": {
- "description": "Appends dimensions to the end of a sheet.",
- "$ref": "AppendDimensionRequest"
+ "$ref": "AppendDimensionRequest",
+ "description": "Appends dimensions to the end of a sheet."
+ },
+ "updateConditionalFormatRule": {
+ "$ref": "UpdateConditionalFormatRuleRequest",
+ "description": "Updates an existing conditional format rule."
},
"createDeveloperMetadata": {
"$ref": "CreateDeveloperMetadataRequest",
"description": "Creates new developer metadata"
},
- "updateConditionalFormatRule": {
- "description": "Updates an existing conditional format rule.",
- "$ref": "UpdateConditionalFormatRuleRequest"
- },
"insertRange": {
- "description": "Inserts new cells in a sheet, shifting the existing cells.",
- "$ref": "InsertRangeRequest"
+ "$ref": "InsertRangeRequest",
+ "description": "Inserts new cells in a sheet, shifting the existing cells."
},
"deleteDeveloperMetadata": {
"description": "Deletes developer metadata",
@@ -2818,32 +3686,32 @@
"description": "Updates a banded range"
},
"addProtectedRange": {
- "description": "Adds a protected range.",
- "$ref": "AddProtectedRangeRequest"
+ "$ref": "AddProtectedRangeRequest",
+ "description": "Adds a protected range."
},
"deleteNamedRange": {
- "$ref": "DeleteNamedRangeRequest",
- "description": "Deletes a named range."
+ "description": "Deletes a named range.",
+ "$ref": "DeleteNamedRangeRequest"
},
"duplicateSheet": {
"$ref": "DuplicateSheetRequest",
"description": "Duplicates a sheet."
},
"deleteSheet": {
- "description": "Deletes a sheet.",
- "$ref": "DeleteSheetRequest"
+ "$ref": "DeleteSheetRequest",
+ "description": "Deletes a sheet."
},
"unmergeCells": {
- "description": "Unmerges merged cells.",
- "$ref": "UnmergeCellsRequest"
+ "$ref": "UnmergeCellsRequest",
+ "description": "Unmerges merged cells."
},
"updateEmbeddedObjectPosition": {
- "$ref": "UpdateEmbeddedObjectPositionRequest",
- "description": "Updates an embedded object's (e.g. chart, image) position."
+ "description": "Updates an embedded object's (e.g. chart, image) position.",
+ "$ref": "UpdateEmbeddedObjectPositionRequest"
},
"updateDimensionProperties": {
- "$ref": "UpdateDimensionPropertiesRequest",
- "description": "Updates dimensions' properties."
+ "description": "Updates dimensions' properties.",
+ "$ref": "UpdateDimensionPropertiesRequest"
},
"updateDeveloperMetadata": {
"description": "Updates an existing developer metadata entry",
@@ -2854,45 +3722,45 @@
"description": "Pastes data (HTML or delimited) into a sheet."
},
"setBasicFilter": {
- "description": "Sets the basic filter on a sheet.",
- "$ref": "SetBasicFilterRequest"
+ "$ref": "SetBasicFilterRequest",
+ "description": "Sets the basic filter on a sheet."
},
"addConditionalFormatRule": {
- "$ref": "AddConditionalFormatRuleRequest",
- "description": "Adds a new conditional format rule."
+ "description": "Adds a new conditional format rule.",
+ "$ref": "AddConditionalFormatRuleRequest"
},
"updateCells": {
"$ref": "UpdateCellsRequest",
"description": "Updates many cells at once."
},
"addNamedRange": {
- "$ref": "AddNamedRangeRequest",
- "description": "Adds a named range."
+ "description": "Adds a named range.",
+ "$ref": "AddNamedRangeRequest"
},
"updateSpreadsheetProperties": {
"$ref": "UpdateSpreadsheetPropertiesRequest",
"description": "Updates the spreadsheet's properties."
},
"deleteEmbeddedObject": {
- "$ref": "DeleteEmbeddedObjectRequest",
- "description": "Deletes an embedded object (e.g, chart, image) in a sheet."
+ "description": "Deletes an embedded object (e.g, chart, image) in a sheet.",
+ "$ref": "DeleteEmbeddedObjectRequest"
},
"updateFilterView": {
"$ref": "UpdateFilterViewRequest",
"description": "Updates the properties of a filter view."
},
"addBanding": {
- "description": "Adds a new banded range",
- "$ref": "AddBandingRequest"
+ "$ref": "AddBandingRequest",
+ "description": "Adds a new banded range"
+ },
+ "autoResizeDimensions": {
+ "description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension.",
+ "$ref": "AutoResizeDimensionsRequest"
},
"appendCells": {
"$ref": "AppendCellsRequest",
"description": "Appends cells after the last row with data in a sheet."
},
- "autoResizeDimensions": {
- "$ref": "AutoResizeDimensionsRequest",
- "description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension."
- },
"cutPaste": {
"$ref": "CutPasteRequest",
"description": "Cuts data from one area and pastes it to another."
@@ -2914,42 +3782,15 @@
"description": "Deletes rows or columns in a sheet."
},
"autoFill": {
- "description": "Automatically fills in more data based on existing data.",
- "$ref": "AutoFillRequest"
- },
- "sortRange": {
- "description": "Sorts data in a range.",
- "$ref": "SortRangeRequest"
- },
- "deleteProtectedRange": {
- "$ref": "DeleteProtectedRangeRequest",
- "description": "Deletes a protected range."
- },
- "duplicateFilterView": {
- "$ref": "DuplicateFilterViewRequest",
- "description": "Duplicates a filter view."
- },
- "addChart": {
- "$ref": "AddChartRequest",
- "description": "Adds a chart."
- },
- "findReplace": {
- "$ref": "FindReplaceRequest",
- "description": "Finds and replaces occurrences of some text with other text."
- },
- "textToColumns": {
- "$ref": "TextToColumnsRequest",
- "description": "Converts a column of text into many columns of text."
- },
- "updateChartSpec": {
- "$ref": "UpdateChartSpecRequest",
- "description": "Updates a chart's specifications."
+ "$ref": "AutoFillRequest",
+ "description": "Automatically fills in more data based on existing data."
}
},
- "id": "Request"
+ "id": "Request",
+ "description": "A single kind of update to apply to a spreadsheet.",
+ "type": "object"
},
"BooleanCondition": {
- "type": "object",
"properties": {
"values": {
"description": "The values of the condition. The number of supported values depends\non the condition type. Some support zero values,\nothers one or two values,\nand ConditionType.ONE_OF_LIST supports an arbitrary number of values.",
@@ -2959,7 +3800,6 @@
"type": "array"
},
"type": {
- "type": "string",
"enumDescriptions": [
"The default value, do not use.",
"The cell's value must be greater than the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
@@ -3022,21 +3862,18 @@
"NOT_BLANK",
"CUSTOM_FORMULA"
],
- "description": "The type of condition."
+ "description": "The type of condition.",
+ "type": "string"
}
},
"id": "BooleanCondition",
- "description": "A condition that can evaluate to true or false.\nBooleanConditions are used by conditional formatting,\ndata validation, and the criteria in filters."
+ "description": "A condition that can evaluate to true or false.\nBooleanConditions are used by conditional formatting,\ndata validation, and the criteria in filters.",
+ "type": "object"
},
"GridRange": {
"description": "A range on a sheet.\nAll indexes are zero-based.\nIndexes are half open, e.g the start index is inclusive\nand the end index is exclusive -- [start_index, end_index).\nMissing indexes indicate the range is unbounded on that side.\n\nFor example, if `\"Sheet1\"` is sheet ID 0, then:\n\n `Sheet1!A1:A1 == sheet_id: 0,\n start_row_index: 0, end_row_index: 1,\n start_column_index: 0, end_column_index: 1`\n\n `Sheet1!A3:B4 == sheet_id: 0,\n start_row_index: 2, end_row_index: 4,\n start_column_index: 0, end_column_index: 2`\n\n `Sheet1!A:B == sheet_id: 0,\n start_column_index: 0, end_column_index: 2`\n\n `Sheet1!A5:B == sheet_id: 0,\n start_row_index: 4,\n start_column_index: 0, end_column_index: 2`\n\n `Sheet1 == sheet_id:0`\n\nThe start index must always be less than or equal to the end index.\nIf the start index equals the end index, then the range is empty.\nEmpty ranges are typically not meaningful and are usually rendered in the\nUI as `#REF!`.",
"type": "object",
"properties": {
- "startColumnIndex": {
- "format": "int32",
- "description": "The start column (inclusive) of the range, or not set if unbounded.",
- "type": "integer"
- },
"sheetId": {
"format": "int32",
"description": "The sheet this range is on.",
@@ -3048,14 +3885,19 @@
"type": "integer"
},
"endRowIndex": {
- "type": "integer",
"format": "int32",
- "description": "The end row (exclusive) of the range, or not set if unbounded."
+ "description": "The end row (exclusive) of the range, or not set if unbounded.",
+ "type": "integer"
},
"startRowIndex": {
- "type": "integer",
"format": "int32",
- "description": "The start row (inclusive) of the range, or not set if unbounded."
+ "description": "The start row (inclusive) of the range, or not set if unbounded.",
+ "type": "integer"
+ },
+ "startColumnIndex": {
+ "format": "int32",
+ "description": "The start column (inclusive) of the range, or not set if unbounded.",
+ "type": "integer"
}
},
"id": "GridRange"
@@ -3095,12 +3937,6 @@
"type": "integer"
},
"stackedType": {
- "enum": [
- "BASIC_CHART_STACKED_TYPE_UNSPECIFIED",
- "NOT_STACKED",
- "STACKED",
- "PERCENT_STACKED"
- ],
"description": "The stacked type for charts that support vertical stacking.\nApplies to Area, Bar, Column, and Stepped Area charts.",
"type": "string",
"enumDescriptions": [
@@ -3108,8 +3944,18 @@
"Series are not stacked.",
"Series values are stacked, each value is rendered vertically beginning\nfrom the top of the value below it.",
"Vertical stacks are stretched to reach the top of the chart, with\nvalues laid out as percentages of each other."
+ ],
+ "enum": [
+ "BASIC_CHART_STACKED_TYPE_UNSPECIFIED",
+ "NOT_STACKED",
+ "STACKED",
+ "PERCENT_STACKED"
]
},
+ "threeDimensional": {
+ "description": "True to make the chart 3D.\nApplies to Bar and Column charts.",
+ "type": "boolean"
+ },
"axis": {
"description": "The axis on the chart.",
"items": {
@@ -3117,15 +3963,8 @@
},
"type": "array"
},
- "threeDimensional": {
- "description": "True to make the chart 3D.\nApplies to Bar and Column charts.",
- "type": "boolean"
- },
- "interpolateNulls": {
- "description": "If some values in a series are missing, gaps may appear in the chart (e.g,\nsegments of lines in a line chart will be missing). To eliminate these\ngaps set this to true.\nApplies to Line, Area, and Combo charts.",
- "type": "boolean"
- },
"chartType": {
+ "type": "string",
"enumDescriptions": [
"Default value, do not use.",
"A \u003ca href=\"/chart/interactive/docs/gallery/barchart\"\u003ebar chart\u003c/a\u003e.",
@@ -3146,8 +3985,11 @@
"COMBO",
"STEPPED_AREA"
],
- "description": "The type of the chart.",
- "type": "string"
+ "description": "The type of the chart."
+ },
+ "interpolateNulls": {
+ "description": "If some values in a series are missing, gaps may appear in the chart (e.g,\nsegments of lines in a line chart will be missing). To eliminate these\ngaps set this to true.\nApplies to Line, Area, and Combo charts.",
+ "type": "boolean"
},
"series": {
"description": "The data this chart is visualizing.",
@@ -3180,7 +4022,13 @@
"id": "BasicChartSpec"
},
"BubbleChartSpec": {
+ "description": "A \u003ca href=\"/chart/interactive/docs/gallery/bubblechart\"\u003ebubble chart\u003c/a\u003e.",
+ "type": "object",
"properties": {
+ "domain": {
+ "$ref": "ChartData",
+ "description": "The data containing the bubble x-values. These values locate the bubbles\nin the chart horizontally."
+ },
"bubbleOpacity": {
"format": "float",
"description": "The opacity of the bubbles between 0 and 1.0.\n0 is fully transparent and 1 is fully opaque.",
@@ -3190,21 +4038,17 @@
"description": "The data contianing the bubble sizes. Bubble sizes are used to draw\nthe bubbles at different sizes relative to each other.\nIf specified, group_ids must also be specified. This field is\noptional.",
"$ref": "ChartData"
},
- "domain": {
- "description": "The data containing the bubble x-values. These values locate the bubbles\nin the chart horizontally.",
- "$ref": "ChartData"
+ "bubbleBorderColor": {
+ "$ref": "Color",
+ "description": "The bubble border color."
},
"bubbleTextStyle": {
"$ref": "TextFormat",
"description": "The format of the text inside the bubbles.\nUnderline and Strikethrough are not supported."
},
- "bubbleBorderColor": {
- "$ref": "Color",
- "description": "The bubble border color."
- },
"groupIds": {
- "description": "The data containing the bubble group IDs. All bubbles with the same group\nID will be drawn in the same color. If bubble_sizes is specified then\nthis field must also be specified but may contain blank values.\nThis field is optional.",
- "$ref": "ChartData"
+ "$ref": "ChartData",
+ "description": "The data containing the bubble group IDs. All bubbles with the same group\nID will be drawn in the same color. If bubble_sizes is specified then\nthis field must also be specified but may contain blank values.\nThis field is optional."
},
"bubbleLabels": {
"$ref": "ChartData",
@@ -3247,29 +4091,42 @@
]
}
},
- "id": "BubbleChartSpec",
- "description": "A \u003ca href=\"/chart/interactive/docs/gallery/bubblechart\"\u003ebubble chart\u003c/a\u003e.",
- "type": "object"
+ "id": "BubbleChartSpec"
},
"SetDataValidationRequest": {
+ "id": "SetDataValidationRequest",
"description": "Sets a data validation rule to every cell in the range.\nTo clear validation in a range, call this with no rule specified.",
"type": "object",
"properties": {
- "range": {
- "description": "The range the data validation rule should apply to.",
- "$ref": "GridRange"
- },
"rule": {
"description": "The data validation rule to set on each cell in the range,\nor empty to clear the data validation in the range.",
"$ref": "DataValidationRule"
+ },
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range the data validation rule should apply to."
}
- },
- "id": "SetDataValidationRequest"
+ }
},
"CellData": {
"description": "Data about a specific cell.",
"type": "object",
"properties": {
+ "formattedValue": {
+ "description": "The formatted value of the cell.\nThis is the value as it's shown to the user.\nThis field is read-only.",
+ "type": "string"
+ },
+ "textFormatRuns": {
+ "description": "Runs of rich text applied to subsections of the cell. Runs are only valid\non user entered strings, not formulas, bools, or numbers.\nRuns start at specific indexes in the text and continue until the next\nrun. Properties of a run will continue unless explicitly changed\nin a subsequent run (and properties of the first run will continue\nthe properties of the cell unless explicitly changed).\n\nWhen writing, the new runs will overwrite any prior runs. When writing a\nnew user_entered_value, previous runs will be erased.",
+ "items": {
+ "$ref": "TextFormatRun"
+ },
+ "type": "array"
+ },
+ "hyperlink": {
+ "description": "A hyperlink this cell points to, if any.\nThis field is read-only. (To set it, use a `=HYPERLINK` formula\nin the userEnteredValue.formulaValue\nfield.)",
+ "type": "string"
+ },
"pivotTable": {
"$ref": "PivotTable",
"description": "A pivot table anchored at this cell. The size of pivot table itself\nis computed dynamically based on its data, grouping, filters, values,\netc. Only the top-left cell of the pivot table contains the pivot table\ndefinition. The other cells will contain the calculated values of the\nresults of the pivot in their effective_value fields."
@@ -3278,14 +4135,14 @@
"description": "The format the user entered for the cell.\n\nWhen writing, the new format will be merged with the existing format.",
"$ref": "CellFormat"
},
+ "effectiveFormat": {
+ "description": "The effective format being used by the cell.\nThis includes the results of applying any conditional formatting and,\nif the cell contains a formula, the computed number format.\nIf the effective format is the default format, effective format will\nnot be written.\nThis field is read-only.",
+ "$ref": "CellFormat"
+ },
"note": {
"description": "Any note on the cell.",
"type": "string"
},
- "effectiveFormat": {
- "$ref": "CellFormat",
- "description": "The effective format being used by the cell.\nThis includes the results of applying any conditional formatting and,\nif the cell contains a formula, the computed number format.\nIf the effective format is the default format, effective format will\nnot be written.\nThis field is read-only."
- },
"dataValidation": {
"$ref": "DataValidationRule",
"description": "A data validation rule on the cell, if any.\n\nWhen writing, the new data validation rule will overwrite any prior rule."
@@ -3297,21 +4154,6 @@
"effectiveValue": {
"$ref": "ExtendedValue",
"description": "The effective value of the cell. For cells with formulas, this will be\nthe calculated value. For cells with literals, this will be\nthe same as the user_entered_value.\nThis field is read-only."
- },
- "textFormatRuns": {
- "description": "Runs of rich text applied to subsections of the cell. Runs are only valid\non user entered strings, not formulas, bools, or numbers.\nRuns start at specific indexes in the text and continue until the next\nrun. Properties of a run will continue unless explicitly changed\nin a subsequent run (and properties of the first run will continue\nthe properties of the cell unless explicitly changed).\n\nWhen writing, the new runs will overwrite any prior runs. When writing a\nnew user_entered_value, previous runs will be erased.",
- "items": {
- "$ref": "TextFormatRun"
- },
- "type": "array"
- },
- "formattedValue": {
- "description": "The formatted value of the cell.\nThis is the value as it's shown to the user.\nThis field is read-only.",
- "type": "string"
- },
- "hyperlink": {
- "description": "A hyperlink this cell points to, if any.\nThis field is read-only. (To set it, use a `=HYPERLINK` formula\nin the userEnteredValue.formulaValue\nfield.)",
- "type": "string"
}
},
"id": "CellData"
@@ -3321,7 +4163,6 @@
"type": "object",
"properties": {
"horizontalAlignment": {
- "description": "Horizontal alignment setting for the piece of text.",
"type": "string",
"enumDescriptions": [
"The horizontal alignment is not specified. Do not use this.",
@@ -3334,17 +4175,16 @@
"LEFT",
"CENTER",
"RIGHT"
- ]
+ ],
+ "description": "Horizontal alignment setting for the piece of text."
}
},
"id": "TextPosition"
},
"BatchUpdateValuesByDataFilterRequest": {
- "description": "The request for updating more than one range of values in a spreadsheet.",
"type": "object",
"properties": {
"responseValueRenderOption": {
- "type": "string",
"enumDescriptions": [
"Values will be calculated & formatted in the reply according to the\ncell's formatting. Formatting is based on the spreadsheet's locale,\nnot the requesting user's locale.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return `\"$1.23\"`.",
"Values will be calculated, but not formatted in the reply.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return the number `1.23`.",
@@ -3355,34 +4195,37 @@
"UNFORMATTED_VALUE",
"FORMULA"
],
- "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE."
+ "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
+ "type": "string"
},
"includeValuesInResponse": {
"description": "Determines if the update response should include the values\nof the cells that were updated. By default, responses\ndo not include the updated values. The `updatedData` field within\neach of the BatchUpdateValuesResponse.responses will contain\nthe updated values. If the range to write was larger than than the range\nactually written, the response will include all values in the requested\nrange (excluding trailing empty rows and columns).",
"type": "boolean"
},
"data": {
+ "description": "The new values to apply to the spreadsheet. If more than one range is\nmatched by the specified DataFilter the specified values will be\napplied to all of those ranges.",
"items": {
"$ref": "DataFilterValueRange"
},
- "type": "array",
- "description": "The new values to apply to the spreadsheet. If more than one range is\nmatched by the specified DataFilter the specified values will be\napplied to all of those ranges."
+ "type": "array"
},
"valueInputOption": {
- "enum": [
- "INPUT_VALUE_OPTION_UNSPECIFIED",
- "RAW",
- "USER_ENTERED"
- ],
"description": "How the input data should be interpreted.",
"type": "string",
"enumDescriptions": [
"Default input value. This value must not be used.",
"The values the user has entered will not be parsed and will be stored\nas-is.",
"The values will be parsed as if the user typed them into the UI.\nNumbers will stay as numbers, but strings may be converted to numbers,\ndates, etc. following the same rules that are applied when entering\ntext into a cell via the Google Sheets UI."
+ ],
+ "enum": [
+ "INPUT_VALUE_OPTION_UNSPECIFIED",
+ "RAW",
+ "USER_ENTERED"
]
},
"responseDateTimeRenderOption": {
+ "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is\nDateTimeRenderOption.SERIAL_NUMBER.",
+ "type": "string",
"enumDescriptions": [
"Instructs date, time, datetime, and duration fields to be output\nas doubles in \"serial number\" format, as popularized by Lotus 1-2-3.\nThe whole number portion of the value (left of the decimal) counts\nthe days since December 30th 1899. The fractional portion (right of\nthe decimal) counts the time as a fraction of the day. For example,\nJanuary 1st 1900 at noon would be 2.5, 2 because it's 2 days after\nDecember 30st 1899, and .5 because noon is half a day. February 1st\n1900 at 3pm would be 33.625. This correctly treats the year 1900 as\nnot a leap year.",
"Instructs date, time, datetime, and duration fields to be output\nas strings in their given number format (which is dependent\non the spreadsheet locale)."
@@ -3390,16 +4233,13 @@
"enum": [
"SERIAL_NUMBER",
"FORMATTED_STRING"
- ],
- "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is\nDateTimeRenderOption.SERIAL_NUMBER.",
- "type": "string"
+ ]
}
},
- "id": "BatchUpdateValuesByDataFilterRequest"
+ "id": "BatchUpdateValuesByDataFilterRequest",
+ "description": "The request for updating more than one range of values in a spreadsheet."
},
"BatchUpdateSpreadsheetRequest": {
- "description": "The request for updating any aspect of a spreadsheet.",
- "type": "object",
"properties": {
"responseIncludeGridData": {
"description": "True if grid data should be returned. Meaningful only if\nif include_spreadsheet_response is 'true'.\nThis parameter is ignored if a field mask was set in the request.",
@@ -3424,31 +4264,15 @@
"type": "array"
}
},
- "id": "BatchUpdateSpreadsheetRequest"
+ "id": "BatchUpdateSpreadsheetRequest",
+ "description": "The request for updating any aspect of a spreadsheet.",
+ "type": "object"
},
"BasicChartAxis": {
+ "id": "BasicChartAxis",
+ "description": "An axis of the chart.\nA chart may not have more than one axis per\naxis position.",
"type": "object",
"properties": {
- "title": {
- "description": "The title of this axis. If set, this overrides any title inferred\nfrom headers of the data.",
- "type": "string"
- },
- "position": {
- "description": "The position of this axis.",
- "type": "string",
- "enumDescriptions": [
- "Default value, do not use.",
- "The axis rendered at the bottom of a chart.\nFor most charts, this is the standard major axis.\nFor bar charts, this is a minor axis.",
- "The axis rendered at the left of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is the standard major axis.",
- "The axis rendered at the right of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is an unusual major axis."
- ],
- "enum": [
- "BASIC_CHART_AXIS_POSITION_UNSPECIFIED",
- "BOTTOM_AXIS",
- "LEFT_AXIS",
- "RIGHT_AXIS"
- ]
- },
"titleTextPosition": {
"$ref": "TextPosition",
"description": "The axis title text position."
@@ -3456,19 +4280,37 @@
"format": {
"$ref": "TextFormat",
"description": "The format of the title.\nOnly valid if the axis is not associated with the domain."
+ },
+ "title": {
+ "description": "The title of this axis. If set, this overrides any title inferred\nfrom headers of the data.",
+ "type": "string"
+ },
+ "position": {
+ "enum": [
+ "BASIC_CHART_AXIS_POSITION_UNSPECIFIED",
+ "BOTTOM_AXIS",
+ "LEFT_AXIS",
+ "RIGHT_AXIS"
+ ],
+ "description": "The position of this axis.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "The axis rendered at the bottom of a chart.\nFor most charts, this is the standard major axis.\nFor bar charts, this is a minor axis.",
+ "The axis rendered at the left of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is the standard major axis.",
+ "The axis rendered at the right of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is an unusual major axis."
+ ]
}
- },
- "id": "BasicChartAxis",
- "description": "An axis of the chart.\nA chart may not have more than one axis per\naxis position."
+ }
},
"Padding": {
"description": "The amount of padding around the cell, in pixels.\nWhen updating padding, every field must be specified.",
"type": "object",
"properties": {
"top": {
- "type": "integer",
"format": "int32",
- "description": "The top padding of the cell."
+ "description": "The top padding of the cell.",
+ "type": "integer"
},
"left": {
"format": "int32",
@@ -3489,17 +4331,18 @@
"id": "Padding"
},
"DeleteDimensionRequest": {
+ "description": "Deletes the dimensions from the sheet.",
+ "type": "object",
"properties": {
"range": {
"description": "The dimensions to delete from the sheet.",
"$ref": "DimensionRange"
}
},
- "id": "DeleteDimensionRequest",
- "description": "Deletes the dimensions from the sheet.",
- "type": "object"
+ "id": "DeleteDimensionRequest"
},
"UpdateChartSpecRequest": {
+ "id": "UpdateChartSpecRequest",
"description": "Updates a chart's specifications.\n(This does not move or resize a chart. To move or resize a chart, use\n UpdateEmbeddedObjectPositionRequest.)",
"type": "object",
"properties": {
@@ -3509,11 +4352,10 @@
"type": "integer"
},
"spec": {
- "description": "The specification to apply to the chart.",
- "$ref": "ChartSpec"
+ "$ref": "ChartSpec",
+ "description": "The specification to apply to the chart."
}
- },
- "id": "UpdateChartSpecRequest"
+ }
},
"DeleteFilterViewRequest": {
"description": "Deletes a particular filter view.",
@@ -3528,11 +4370,10 @@
"id": "DeleteFilterViewRequest"
},
"BatchGetValuesByDataFilterRequest": {
- "id": "BatchGetValuesByDataFilterRequest",
- "description": "The request for retrieving a range of values in a spreadsheet selected by a\nset of DataFilters.",
"type": "object",
"properties": {
"majorDimension": {
+ "description": "The major dimension that results should use.\n\nFor example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,\nthen a request that selects that range and sets `majorDimension=ROWS` will\nreturn `[[1,2],[3,4]]`,\nwhereas a request that sets `majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`.",
"type": "string",
"enumDescriptions": [
"The default value, do not use.",
@@ -3543,15 +4384,14 @@
"DIMENSION_UNSPECIFIED",
"ROWS",
"COLUMNS"
- ],
- "description": "The major dimension that results should use.\n\nFor example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,\nthen a request that selects that range and sets `majorDimension=ROWS` will\nreturn `[[1,2],[3,4]]`,\nwhereas a request that sets `majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`."
+ ]
},
"dataFilters": {
+ "description": "The data filters used to match the ranges of values to retrieve. Ranges\nthat match any of the specified data filters will be included in the\nresponse.",
"items": {
"$ref": "DataFilter"
},
- "type": "array",
- "description": "The data filters used to match the ranges of values to retrieve. Ranges\nthat match any of the specified data filters will be included in the\nresponse."
+ "type": "array"
},
"dateTimeRenderOption": {
"enum": [
@@ -3566,6 +4406,7 @@
]
},
"valueRenderOption": {
+ "description": "How values should be represented in the output.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
"type": "string",
"enumDescriptions": [
"Values will be calculated & formatted in the reply according to the\ncell's formatting. Formatting is based on the spreadsheet's locale,\nnot the requesting user's locale.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return `\"$1.23\"`.",
@@ -3576,10 +4417,11 @@
"FORMATTED_VALUE",
"UNFORMATTED_VALUE",
"FORMULA"
- ],
- "description": "How values should be represented in the output.\nThe default render option is ValueRenderOption.FORMATTED_VALUE."
+ ]
}
- }
+ },
+ "id": "BatchGetValuesByDataFilterRequest",
+ "description": "The request for retrieving a range of values in a spreadsheet selected by a\nset of DataFilters."
},
"DeleteDeveloperMetadataResponse": {
"description": "The response from deleting developer metadata.",
@@ -3596,7 +4438,14 @@
"id": "DeleteDeveloperMetadataResponse"
},
"BatchUpdateValuesResponse": {
+ "description": "The response when updating a range of values in a spreadsheet.",
+ "type": "object",
"properties": {
+ "totalUpdatedCells": {
+ "format": "int32",
+ "description": "The total number of cells updated.",
+ "type": "integer"
+ },
"totalUpdatedColumns": {
"format": "int32",
"description": "The total number of columns where at least one cell in the column was\nupdated.",
@@ -3619,19 +4468,12 @@
"type": "array"
},
"totalUpdatedSheets": {
- "type": "integer",
"format": "int32",
- "description": "The total number of sheets where at least one cell in the sheet was\nupdated."
- },
- "totalUpdatedCells": {
- "format": "int32",
- "description": "The total number of cells updated.",
+ "description": "The total number of sheets where at least one cell in the sheet was\nupdated.",
"type": "integer"
}
},
- "id": "BatchUpdateValuesResponse",
- "description": "The response when updating a range of values in a spreadsheet.",
- "type": "object"
+ "id": "BatchUpdateValuesResponse"
},
"SortRangeRequest": {
"description": "Sorts data in rows based on a sort order per column.",
@@ -3652,95 +4494,86 @@
"id": "SortRangeRequest"
},
"MatchedDeveloperMetadata": {
- "id": "MatchedDeveloperMetadata",
- "description": "A developer metadata entry and the data filters specified in the original\nrequest that matched it.",
"type": "object",
"properties": {
- "developerMetadata": {
- "$ref": "DeveloperMetadata",
- "description": "The developer metadata matching the specified filters."
- },
"dataFilters": {
+ "description": "All filters matching the returned developer metadata.",
"items": {
"$ref": "DataFilter"
},
- "type": "array",
- "description": "All filters matching the returned developer metadata."
+ "type": "array"
+ },
+ "developerMetadata": {
+ "$ref": "DeveloperMetadata",
+ "description": "The developer metadata matching the specified filters."
}
- }
+ },
+ "id": "MatchedDeveloperMetadata",
+ "description": "A developer metadata entry and the data filters specified in the original\nrequest that matched it."
},
"MergeCellsRequest": {
+ "description": "Merges all cells in the range.",
"type": "object",
"properties": {
- "range": {
- "description": "The range of cells to merge.",
- "$ref": "GridRange"
- },
"mergeType": {
+ "enumDescriptions": [
+ "Create a single merge from the range",
+ "Create a merge for each column in the range",
+ "Create a merge for each row in the range"
+ ],
"enum": [
"MERGE_ALL",
"MERGE_COLUMNS",
"MERGE_ROWS"
],
"description": "How the cells should be merged.",
- "type": "string",
- "enumDescriptions": [
- "Create a single merge from the range",
- "Create a merge for each column in the range",
- "Create a merge for each row in the range"
- ]
+ "type": "string"
+ },
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range of cells to merge."
}
},
- "id": "MergeCellsRequest",
- "description": "Merges all cells in the range."
+ "id": "MergeCellsRequest"
},
"AddProtectedRangeRequest": {
"description": "Adds a new protected range.",
"type": "object",
"properties": {
"protectedRange": {
- "$ref": "ProtectedRange",
- "description": "The protected range to be added. The\nprotectedRangeId field is optional; if\none is not set, an id will be randomly generated. (It is an error to\nspecify the ID of a range that already exists.)"
+ "description": "The protected range to be added. The\nprotectedRangeId field is optional; if\none is not set, an id will be randomly generated. (It is an error to\nspecify the ID of a range that already exists.)",
+ "$ref": "ProtectedRange"
}
},
"id": "AddProtectedRangeRequest"
},
"BatchClearValuesRequest": {
+ "id": "BatchClearValuesRequest",
+ "description": "The request for clearing more than one range of values in a spreadsheet.",
+ "type": "object",
"properties": {
"ranges": {
+ "description": "The ranges to clear, in A1 notation.",
"items": {
"type": "string"
},
- "type": "array",
- "description": "The ranges to clear, in A1 notation."
+ "type": "array"
}
- },
- "id": "BatchClearValuesRequest",
- "description": "The request for clearing more than one range of values in a spreadsheet.",
- "type": "object"
- },
- "DuplicateFilterViewResponse": {
- "description": "The result of a filter view being duplicated.",
- "type": "object",
- "properties": {
- "filter": {
- "$ref": "FilterView",
- "description": "The newly created filter."
- }
- },
- "id": "DuplicateFilterViewResponse"
+ }
},
"DeveloperMetadata": {
- "id": "DeveloperMetadata",
"description": "Developer metadata associated with a location or object in a spreadsheet.\nDeveloper metadata may be used to associate arbitrary data with various\nparts of a spreadsheet and will remain associated at those locations as they\nmove around and the spreadsheet is edited. For example, if developer\nmetadata is associated with row 5 and another row is then subsequently\ninserted above row 5, that original metadata will still be associated with\nthe row it was first associated with (what is now row 6). If the associated\nobject is deleted its metadata will be deleted too.",
"type": "object",
"properties": {
+ "metadataValue": {
+ "description": "Data associated with the metadata's key.",
+ "type": "string"
+ },
"metadataKey": {
"description": "The metadata key. There may be multiple metadata in a spreadsheet with the\nsame key. Developer metadata must always have a key specified.",
"type": "string"
},
"visibility": {
- "type": "string",
"enumDescriptions": [
"Default value.",
"Document-visible metadata is accessible from any developer project with\naccess to the document.",
@@ -3751,872 +4584,42 @@
"DOCUMENT",
"PROJECT"
],
- "description": "The metadata visibility. Developer metadata must always have a visibility\nspecified."
+ "description": "The metadata visibility. Developer metadata must always have a visibility\nspecified.",
+ "type": "string"
},
"location": {
- "$ref": "DeveloperMetadataLocation",
- "description": "The location where the metadata is associated."
+ "description": "The location where the metadata is associated.",
+ "$ref": "DeveloperMetadataLocation"
},
"metadataId": {
"format": "int32",
"description": "The spreadsheet-scoped unique ID that identifies the metadata. IDs may be\nspecified when metadata is created, otherwise one will be randomly\ngenerated and assigned. Must be positive.",
"type": "integer"
- },
- "metadataValue": {
- "description": "Data associated with the metadata's key.",
- "type": "string"
}
- }
+ },
+ "id": "DeveloperMetadata"
+ },
+ "DuplicateFilterViewResponse": {
+ "description": "The result of a filter view being duplicated.",
+ "type": "object",
+ "properties": {
+ "filter": {
+ "description": "The newly created filter.",
+ "$ref": "FilterView"
+ }
+ },
+ "id": "DuplicateFilterViewResponse"
},
"DuplicateSheetResponse": {
+ "id": "DuplicateSheetResponse",
+ "description": "The result of duplicating a sheet.",
"type": "object",
"properties": {
"properties": {
"$ref": "SheetProperties",
"description": "The properties of the duplicate sheet."
}
- },
- "id": "DuplicateSheetResponse",
- "description": "The result of duplicating a sheet."
- },
- "TextToColumnsRequest": {
- "description": "Splits a column of text into multiple columns,\nbased on a delimiter in each cell.",
- "type": "object",
- "properties": {
- "delimiterType": {
- "enum": [
- "DELIMITER_TYPE_UNSPECIFIED",
- "COMMA",
- "SEMICOLON",
- "PERIOD",
- "SPACE",
- "CUSTOM"
- ],
- "description": "The delimiter type to use.",
- "type": "string",
- "enumDescriptions": [
- "Default value. This value must not be used.",
- "\",\"",
- "\";\"",
- "\".\"",
- "\" \"",
- "A custom value as defined in delimiter."
- ]
- },
- "source": {
- "$ref": "GridRange",
- "description": "The source data range. This must span exactly one column."
- },
- "delimiter": {
- "description": "The delimiter to use. Used only if delimiterType is\nCUSTOM.",
- "type": "string"
- }
- },
- "id": "TextToColumnsRequest"
- },
- "ClearBasicFilterRequest": {
- "description": "Clears the basic filter, if any exists on the sheet.",
- "type": "object",
- "properties": {
- "sheetId": {
- "format": "int32",
- "description": "The sheet ID on which the basic filter should be cleared.",
- "type": "integer"
- }
- },
- "id": "ClearBasicFilterRequest"
- },
- "DeleteBandingRequest": {
- "type": "object",
- "properties": {
- "bandedRangeId": {
- "format": "int32",
- "description": "The ID of the banded range to delete.",
- "type": "integer"
- }
- },
- "id": "DeleteBandingRequest",
- "description": "Removes the banded range with the given ID from the spreadsheet."
- },
- "BatchUpdateSpreadsheetResponse": {
- "description": "The reply for batch updating a spreadsheet.",
- "type": "object",
- "properties": {
- "updatedSpreadsheet": {
- "$ref": "Spreadsheet",
- "description": "The spreadsheet after updates were applied. This is only set if\n[BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response] is `true`."
- },
- "replies": {
- "description": "The reply of the updates. This maps 1:1 with the updates, although\nreplies to some requests may be empty.",
- "items": {
- "$ref": "Response"
- },
- "type": "array"
- },
- "spreadsheetId": {
- "description": "The spreadsheet the updates were applied to.",
- "type": "string"
- }
- },
- "id": "BatchUpdateSpreadsheetResponse"
- },
- "AppendValuesResponse": {
- "description": "The response when updating a range of values in a spreadsheet.",
- "type": "object",
- "properties": {
- "updates": {
- "$ref": "UpdateValuesResponse",
- "description": "Information about the updates that were applied."
- },
- "tableRange": {
- "description": "The range (in A1 notation) of the table that values are being appended to\n(before the values were appended).\nEmpty if no table was found.",
- "type": "string"
- },
- "spreadsheetId": {
- "type": "string",
- "description": "The spreadsheet the updates were applied to."
- }
- },
- "id": "AppendValuesResponse"
- },
- "MoveDimensionRequest": {
- "description": "Moves one or more rows or columns.",
- "type": "object",
- "properties": {
- "destinationIndex": {
- "format": "int32",
- "description": "The zero-based start index of where to move the source data to,\nbased on the coordinates *before* the source data is removed\nfrom the grid. Existing data will be shifted down or right\n(depending on the dimension) to make room for the moved dimensions.\nThe source dimensions are removed from the grid, so the\nthe data may end up in a different index than specified.\n\nFor example, given `A1..A5` of `0, 1, 2, 3, 4` and wanting to move\n`\"1\"` and `\"2\"` to between `\"3\"` and `\"4\"`, the source would be\n`ROWS [1..3)`,and the destination index would be `\"4\"`\n(the zero-based index of row 5).\nThe end result would be `A1..A5` of `0, 3, 1, 2, 4`.",
- "type": "integer"
- },
- "source": {
- "description": "The source dimensions to move.",
- "$ref": "DimensionRange"
- }
- },
- "id": "MoveDimensionRequest"
- },
- "AddFilterViewRequest": {
- "description": "Adds a filter view.",
- "type": "object",
- "properties": {
- "filter": {
- "description": "The filter to add. The filterViewId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a filter that already exists.)",
- "$ref": "FilterView"
- }
- },
- "id": "AddFilterViewRequest"
- },
- "PivotFilterCriteria": {
- "description": "Criteria for showing/hiding rows in a pivot table.",
- "type": "object",
- "properties": {
- "visibleValues": {
- "description": "Values that should be included. Values not listed here are excluded.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "PivotFilterCriteria"
- },
- "AddConditionalFormatRuleRequest": {
- "type": "object",
- "properties": {
- "index": {
- "format": "int32",
- "description": "The zero-based index where the rule should be inserted.",
- "type": "integer"
- },
- "rule": {
- "$ref": "ConditionalFormatRule",
- "description": "The rule to add."
- }
- },
- "id": "AddConditionalFormatRuleRequest",
- "description": "Adds a new conditional format rule at the given index.\nAll subsequent rules' indexes are incremented."
- },
- "ChartSpec": {
- "properties": {
- "subtitle": {
- "description": "The subtitle of the chart.",
- "type": "string"
- },
- "backgroundColor": {
- "$ref": "Color",
- "description": "The background color of the entire chart.\nNot applicable to Org charts."
- },
- "subtitleTextPosition": {
- "description": "The subtitle text position.\nThis field is optional.",
- "$ref": "TextPosition"
- },
- "basicChart": {
- "$ref": "BasicChartSpec",
- "description": "A basic chart specification, can be one of many kinds of charts.\nSee BasicChartType for the list of all\ncharts this supports."
- },
- "orgChart": {
- "description": "An org chart specification.",
- "$ref": "OrgChartSpec"
- },
- "pieChart": {
- "$ref": "PieChartSpec",
- "description": "A pie chart specification."
- },
- "titleTextFormat": {
- "$ref": "TextFormat",
- "description": "The title text format.\nStrikethrough and underline are not supported."
- },
- "title": {
- "description": "The title of the chart.",
- "type": "string"
- },
- "altText": {
- "description": "The alternative text that describes the chart. This is often used\nfor accessibility.",
- "type": "string"
- },
- "titleTextPosition": {
- "$ref": "TextPosition",
- "description": "The title text position.\nThis field is optional."
- },
- "histogramChart": {
- "description": "A histogram chart specification.",
- "$ref": "HistogramChartSpec"
- },
- "candlestickChart": {
- "description": "A candlestick chart specification.",
- "$ref": "CandlestickChartSpec"
- },
- "bubbleChart": {
- "$ref": "BubbleChartSpec",
- "description": "A bubble chart specification."
- },
- "fontName": {
- "description": "The name of the font to use by default for all chart text (e.g. title,\naxis labels, legend). If a font is specified for a specific part of the\nchart it will override this font name.",
- "type": "string"
- },
- "maximized": {
- "description": "True to make a chart fill the entire space in which it's rendered with\nminimum padding. False to use the default padding.\n(Not applicable to Geo and Org charts.)",
- "type": "boolean"
- },
- "hiddenDimensionStrategy": {
- "enum": [
- "CHART_HIDDEN_DIMENSION_STRATEGY_UNSPECIFIED",
- "SKIP_HIDDEN_ROWS_AND_COLUMNS",
- "SKIP_HIDDEN_ROWS",
- "SKIP_HIDDEN_COLUMNS",
- "SHOW_ALL"
- ],
- "description": "Determines how the charts will use hidden rows or columns.",
- "type": "string",
- "enumDescriptions": [
- "Default value, do not use.",
- "Charts will skip hidden rows and columns.",
- "Charts will skip hidden rows only.",
- "Charts will skip hidden columns only.",
- "Charts will not skip any hidden rows or columns."
- ]
- },
- "subtitleTextFormat": {
- "description": "The subtitle text format.\nStrikethrough and underline are not supported.",
- "$ref": "TextFormat"
- }
- },
- "id": "ChartSpec",
- "description": "The specifications of a chart.",
- "type": "object"
- },
- "CreateDeveloperMetadataRequest": {
- "description": "A request to create developer metadata.",
- "type": "object",
- "properties": {
- "developerMetadata": {
- "description": "The developer metadata to create.",
- "$ref": "DeveloperMetadata"
- }
- },
- "id": "CreateDeveloperMetadataRequest"
- },
- "BatchGetValuesByDataFilterResponse": {
- "description": "The response when retrieving more than one range of values in a spreadsheet\nselected by DataFilters.",
- "type": "object",
- "properties": {
- "spreadsheetId": {
- "description": "The ID of the spreadsheet the data was retrieved from.",
- "type": "string"
- },
- "valueRanges": {
- "description": "The requested values with the list of data filters that matched them.",
- "items": {
- "$ref": "MatchedValueRange"
- },
- "type": "array"
- }
- },
- "id": "BatchGetValuesByDataFilterResponse"
- },
- "DataFilterValueRange": {
- "properties": {
- "dataFilter": {
- "$ref": "DataFilter",
- "description": "The data filter describing the location of the values in the spreadsheet."
- },
- "values": {
- "items": {
- "items": {
- "type": "any"
- },
- "type": "array"
- },
- "type": "array",
- "description": "The data to be written. If the provided values exceed any of the ranges\nmatched by the data filter then the request will fail. If the provided\nvalues are less than the matched ranges only the specified values will be\nwritten, existing values in the matched ranges will remain unaffected."
- },
- "majorDimension": {
- "enumDescriptions": [
- "The default value, do not use.",
- "Operates on the rows of a sheet.",
- "Operates on the columns of a sheet."
- ],
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
- ],
- "description": "The major dimension of the values.",
- "type": "string"
- }
- },
- "id": "DataFilterValueRange",
- "description": "A range of values whose location is specified by a DataFilter.",
- "type": "object"
- },
- "NumberFormat": {
- "id": "NumberFormat",
- "description": "The number format of a cell.",
- "type": "object",
- "properties": {
- "pattern": {
- "description": "Pattern string used for formatting. If not set, a default pattern based on\nthe user's locale will be used if necessary for the given type.\nSee the [Date and Number Formats guide](/sheets/api/guides/formats) for more\ninformation about the supported patterns.",
- "type": "string"
- },
- "type": {
- "enumDescriptions": [
- "The number format is not specified\nand is based on the contents of the cell.\nDo not explicitly use this.",
- "Text formatting, e.g `1000.12`",
- "Number formatting, e.g, `1,000.12`",
- "Percent formatting, e.g `10.12%`",
- "Currency formatting, e.g `$1,000.12`",
- "Date formatting, e.g `9/26/2008`",
- "Time formatting, e.g `3:59:00 PM`",
- "Date+Time formatting, e.g `9/26/08 15:59:00`",
- "Scientific number formatting, e.g `1.01E+03`"
- ],
- "enum": [
- "NUMBER_FORMAT_TYPE_UNSPECIFIED",
- "TEXT",
- "NUMBER",
- "PERCENT",
- "CURRENCY",
- "DATE",
- "TIME",
- "DATE_TIME",
- "SCIENTIFIC"
- ],
- "description": "The type of the number format.\nWhen writing, this field must be set.",
- "type": "string"
- }
}
- },
- "CandlestickDomain": {
- "properties": {
- "reversed": {
- "type": "boolean",
- "description": "True to reverse the order of the domain values (horizontal axis)."
- },
- "data": {
- "$ref": "ChartData",
- "description": "The data of the CandlestickDomain."
- }
- },
- "id": "CandlestickDomain",
- "description": "The domain of a CandlestickChart.",
- "type": "object"
- },
- "SheetProperties": {
- "id": "SheetProperties",
- "description": "Properties of a sheet.",
- "type": "object",
- "properties": {
- "rightToLeft": {
- "description": "True if the sheet is an RTL sheet instead of an LTR sheet.",
- "type": "boolean"
- },
- "hidden": {
- "description": "True if the sheet is hidden in the UI, false if it's visible.",
- "type": "boolean"
- },
- "sheetType": {
- "description": "The type of sheet. Defaults to GRID.\nThis field cannot be changed once set.",
- "type": "string",
- "enumDescriptions": [
- "Default value, do not use.",
- "The sheet is a grid.",
- "The sheet has no grid and instead has an object like a chart or image."
- ],
- "enum": [
- "SHEET_TYPE_UNSPECIFIED",
- "GRID",
- "OBJECT"
- ]
- },
- "gridProperties": {
- "description": "Additional properties of the sheet if this sheet is a grid.\n(If the sheet is an object sheet, containing a chart or image, then\nthis field will be absent.)\nWhen writing it is an error to set any grid properties on non-grid sheets.",
- "$ref": "GridProperties"
- },
- "title": {
- "description": "The name of the sheet.",
- "type": "string"
- },
- "tabColor": {
- "$ref": "Color",
- "description": "The color of the tab in the UI."
- },
- "index": {
- "format": "int32",
- "description": "The index of the sheet within the spreadsheet.\nWhen adding or updating sheet properties, if this field\nis excluded then the sheet will be added or moved to the end\nof the sheet list. When updating sheet indices or inserting\nsheets, movement is considered in \"before the move\" indexes.\nFor example, if there were 3 sheets (S1, S2, S3) in order to\nmove S1 ahead of S2 the index would have to be set to 2. A sheet\nindex update request will be ignored if the requested index is\nidentical to the sheets current index or if the requested new\nindex is equal to the current sheet index + 1.",
- "type": "integer"
- },
- "sheetId": {
- "format": "int32",
- "description": "The ID of the sheet. Must be non-negative.\nThis field cannot be changed once set.",
- "type": "integer"
- }
- }
- },
- "UpdateDimensionPropertiesRequest": {
- "description": "Updates properties of dimensions within the specified range.",
- "type": "object",
- "properties": {
- "properties": {
- "$ref": "DimensionProperties",
- "description": "Properties to update."
- },
- "range": {
- "$ref": "DimensionRange",
- "description": "The rows or columns to update."
- },
- "fields": {
- "format": "google-fieldmask",
- "description": "The fields that should be updated. At least one field must be specified.\nThe root `properties` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "type": "string"
- }
- },
- "id": "UpdateDimensionPropertiesRequest"
- },
- "SourceAndDestination": {
- "description": "A combination of a source range and how to extend that source.",
- "type": "object",
- "properties": {
- "source": {
- "$ref": "GridRange",
- "description": "The location of the data to use as the source of the autofill."
- },
- "dimension": {
- "enumDescriptions": [
- "The default value, do not use.",
- "Operates on the rows of a sheet.",
- "Operates on the columns of a sheet."
- ],
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
- ],
- "description": "The dimension that data should be filled into.",
- "type": "string"
- },
- "fillLength": {
- "format": "int32",
- "description": "The number of rows or columns that data should be filled into.\nPositive numbers expand beyond the last row or last column\nof the source. Negative numbers expand before the first row\nor first column of the source.",
- "type": "integer"
- }
- },
- "id": "SourceAndDestination"
- },
- "OrgChartSpec": {
- "type": "object",
- "properties": {
- "tooltips": {
- "$ref": "ChartData",
- "description": "The data containing the tooltip for the corresponding node. A blank value\nresults in no tooltip being displayed for the node.\nThis field is optional."
- },
- "selectedNodeColor": {
- "description": "The color of the selected org chart nodes.",
- "$ref": "Color"
- },
- "parentLabels": {
- "$ref": "ChartData",
- "description": "The data containing the label of the parent for the corresponding node.\nA blank value indicates that the node has no parent and is a top-level\nnode.\nThis field is optional."
- },
- "nodeSize": {
- "description": "The size of the org chart nodes.",
- "type": "string",
- "enumDescriptions": [
- "Default value, do not use.",
- "The small org chart node size.",
- "The medium org chart node size.",
- "The large org chart node size."
- ],
- "enum": [
- "ORG_CHART_LABEL_SIZE_UNSPECIFIED",
- "SMALL",
- "MEDIUM",
- "LARGE"
- ]
- },
- "labels": {
- "$ref": "ChartData",
- "description": "The data containing the labels for all the nodes in the chart. Labels\nmust be unique."
- },
- "nodeColor": {
- "$ref": "Color",
- "description": "The color of the org chart nodes."
- }
- },
- "id": "OrgChartSpec",
- "description": "An \u003ca href=\"/chart/interactive/docs/gallery/orgchart\"\u003eorg chart\u003c/a\u003e.\nOrg charts require a unique set of labels in labels and may\noptionally include parent_labels and tooltips.\nparent_labels contain, for each node, the label identifying the parent\nnode. tooltips contain, for each node, an optional tooltip.\n\nFor example, to describe an OrgChart with Alice as the CEO, Bob as the\nPresident (reporting to Alice) and Cathy as VP of Sales (also reporting to\nAlice), have labels contain \"Alice\", \"Bob\", \"Cathy\",\nparent_labels contain \"\", \"Alice\", \"Alice\" and tooltips contain\n\"CEO\", \"President\", \"VP Sales\"."
- },
- "FilterView": {
- "description": "A filter view.",
- "type": "object",
- "properties": {
- "filterViewId": {
- "format": "int32",
- "description": "The ID of the filter view.",
- "type": "integer"
- },
- "criteria": {
- "additionalProperties": {
- "$ref": "FilterCriteria"
- },
- "description": "The criteria for showing/hiding values per column.\nThe map's key is the column index, and the value is the criteria for\nthat column.",
- "type": "object"
- },
- "title": {
- "description": "The name of the filter view.",
- "type": "string"
- },
- "range": {
- "$ref": "GridRange",
- "description": "The range this filter view covers.\n\nWhen writing, only one of range or named_range_id\nmay be set."
- },
- "sortSpecs": {
- "description": "The sort order per column. Later specifications are used when values\nare equal in the earlier specifications.",
- "items": {
- "$ref": "SortSpec"
- },
- "type": "array"
- },
- "namedRangeId": {
- "description": "The named range this filter view is backed by, if any.\n\nWhen writing, only one of range or named_range_id\nmay be set.",
- "type": "string"
- }
- },
- "id": "FilterView"
- },
- "SearchDeveloperMetadataRequest": {
- "description": "A request to retrieve all developer metadata matching the set of specified\ncriteria.",
- "type": "object",
- "properties": {
- "dataFilters": {
- "description": "The data filters describing the criteria used to determine which\nDeveloperMetadata entries to return. DeveloperMetadata matching any of the\nspecified filters will be included in the response.",
- "items": {
- "$ref": "DataFilter"
- },
- "type": "array"
- }
- },
- "id": "SearchDeveloperMetadataRequest"
- },
- "BandingProperties": {
- "description": "Properties referring a single dimension (either row or column). If both\nBandedRange.row_properties and BandedRange.column_properties are\nset, the fill colors are applied to cells according to the following rules:\n\n* header_color and footer_color take priority over band colors.\n* first_band_color takes priority over second_band_color.\n* row_properties takes priority over column_properties.\n\nFor example, the first row color takes priority over the first column\ncolor, but the first column color takes priority over the second row color.\nSimilarly, the row header takes priority over the column header in the\ntop left cell, but the column header takes priority over the first row\ncolor if the row header is not set.",
- "type": "object",
- "properties": {
- "firstBandColor": {
- "$ref": "Color",
- "description": "The first color that is alternating. (Required)"
- },
- "secondBandColor": {
- "description": "The second color that is alternating. (Required)",
- "$ref": "Color"
- },
- "footerColor": {
- "$ref": "Color",
- "description": "The color of the last row or column. If this field is not set, the last\nrow or column will be filled with either first_band_color or\nsecond_band_color, depending on the color of the previous row or\ncolumn."
- },
- "headerColor": {
- "$ref": "Color",
- "description": "The color of the first row or column. If this field is set, the first\nrow or column will be filled with this color and the colors will\nalternate between first_band_color and second_band_color starting\nfrom the second row or column. Otherwise, the first row or column will be\nfilled with first_band_color and the colors will proceed to alternate\nas they normally would."
- }
- },
- "id": "BandingProperties"
- },
- "AddProtectedRangeResponse": {
- "type": "object",
- "properties": {
- "protectedRange": {
- "$ref": "ProtectedRange",
- "description": "The newly added protected range."
- }
- },
- "id": "AddProtectedRangeResponse",
- "description": "The result of adding a new protected range."
- },
- "BasicFilter": {
- "description": "The default filter associated with a sheet.",
- "type": "object",
- "properties": {
- "criteria": {
- "type": "object",
- "additionalProperties": {
- "$ref": "FilterCriteria"
- },
- "description": "The criteria for showing/hiding values per column.\nThe map's key is the column index, and the value is the criteria for\nthat column."
- },
- "range": {
- "$ref": "GridRange",
- "description": "The range the filter covers."
- },
- "sortSpecs": {
- "description": "The sort order per column. Later specifications are used when values\nare equal in the earlier specifications.",
- "items": {
- "$ref": "SortSpec"
- },
- "type": "array"
- }
- },
- "id": "BasicFilter"
- },
- "CandlestickSeries": {
- "description": "The series of a CandlestickData.",
- "type": "object",
- "properties": {
- "data": {
- "$ref": "ChartData",
- "description": "The data of the CandlestickSeries."
- }
- },
- "id": "CandlestickSeries"
- },
- "HistogramChartSpec": {
- "properties": {
- "outlierPercentile": {
- "format": "double",
- "description": "The outlier percentile is used to ensure that outliers do not adversely\naffect the calculation of bucket sizes. For example, setting an outlier\npercentile of 0.05 indicates that the top and bottom 5% of values when\ncalculating buckets. The values are still included in the chart, they will\nbe added to the first or last buckets instead of their own buckets.\nMust be between 0.0 and 0.5.",
- "type": "number"
- },
- "showItemDividers": {
- "description": "Whether horizontal divider lines should be displayed between items in each\ncolumn.",
- "type": "boolean"
- },
- "series": {
- "description": "The series for a histogram may be either a single series of values to be\nbucketed or multiple series, each of the same length, containing the name\nof the series followed by the values to be bucketed for that series.",
- "items": {
- "$ref": "HistogramSeries"
- },
- "type": "array"
- },
- "legendPosition": {
- "enum": [
- "HISTOGRAM_CHART_LEGEND_POSITION_UNSPECIFIED",
- "BOTTOM_LEGEND",
- "LEFT_LEGEND",
- "RIGHT_LEGEND",
- "TOP_LEGEND",
- "NO_LEGEND",
- "INSIDE_LEGEND"
- ],
- "description": "The position of the chart legend.",
- "type": "string",
- "enumDescriptions": [
- "Default value, do not use.",
- "The legend is rendered on the bottom of the chart.",
- "The legend is rendered on the left of the chart.",
- "The legend is rendered on the right of the chart.",
- "The legend is rendered on the top of the chart.",
- "No legend is rendered.",
- "The legend is rendered inside the chart area."
- ]
- },
- "bucketSize": {
- "format": "double",
- "description": "By default the bucket size (the range of values stacked in a single\ncolumn) is chosen automatically, but it may be overridden here.\nE.g., A bucket size of 1.5 results in buckets from 0 - 1.5, 1.5 - 3.0, etc.\nCannot be negative.\nThis field is optional.",
- "type": "number"
- }
- },
- "id": "HistogramChartSpec",
- "description": "A \u003ca href=\"/chart/interactive/docs/gallery/histogram\"\u003ehistogram chart\u003c/a\u003e.\nA histogram chart groups data items into bins, displaying each bin as a\ncolumn of stacked items. Histograms are used to display the distribution\nof a dataset. Each column of items represents a range into which those\nitems fall. The number of bins can be chosen automatically or specified\nexplicitly.",
- "type": "object"
- },
- "UpdateValuesResponse": {
- "properties": {
- "updatedColumns": {
- "format": "int32",
- "description": "The number of columns where at least one cell in the column was updated.",
- "type": "integer"
- },
- "spreadsheetId": {
- "description": "The spreadsheet the updates were applied to.",
- "type": "string"
- },
- "updatedRange": {
- "description": "The range (in A1 notation) that updates were applied to.",
- "type": "string"
- },
- "updatedCells": {
- "format": "int32",
- "description": "The number of cells updated.",
- "type": "integer"
- },
- "updatedData": {
- "description": "The values of the cells after updates were applied.\nThis is only included if the request's `includeValuesInResponse` field\nwas `true`.",
- "$ref": "ValueRange"
- },
- "updatedRows": {
- "format": "int32",
- "description": "The number of rows where at least one cell in the row was updated.",
- "type": "integer"
- }
- },
- "id": "UpdateValuesResponse",
- "description": "The response when updating a range of values in a spreadsheet.",
- "type": "object"
- },
- "ErrorValue": {
- "type": "object",
- "properties": {
- "message": {
- "description": "A message with more information about the error\n(in the spreadsheet's locale).",
- "type": "string"
- },
- "type": {
- "enumDescriptions": [
- "The default error type, do not use this.",
- "Corresponds to the `#ERROR!` error.",
- "Corresponds to the `#NULL!` error.",
- "Corresponds to the `#DIV/0` error.",
- "Corresponds to the `#VALUE!` error.",
- "Corresponds to the `#REF!` error.",
- "Corresponds to the `#NAME?` error.",
- "Corresponds to the `#NUM`! error.",
- "Corresponds to the `#N/A` error.",
- "Corresponds to the `Loading...` state."
- ],
- "enum": [
- "ERROR_TYPE_UNSPECIFIED",
- "ERROR",
- "NULL_VALUE",
- "DIVIDE_BY_ZERO",
- "VALUE",
- "REF",
- "NAME",
- "NUM",
- "N_A",
- "LOADING"
- ],
- "description": "The type of error.",
- "type": "string"
- }
- },
- "id": "ErrorValue",
- "description": "An error in a cell."
- },
- "PivotValue": {
- "type": "object",
- "properties": {
- "formula": {
- "description": "A custom formula to calculate the value. The formula must start\nwith an `=` character.",
- "type": "string"
- },
- "summarizeFunction": {
- "type": "string",
- "enumDescriptions": [
- "The default, do not use.",
- "Corresponds to the `SUM` function.",
- "Corresponds to the `COUNTA` function.",
- "Corresponds to the `COUNT` function.",
- "Corresponds to the `COUNTUNIQUE` function.",
- "Corresponds to the `AVERAGE` function.",
- "Corresponds to the `MAX` function.",
- "Corresponds to the `MIN` function.",
- "Corresponds to the `MEDIAN` function.",
- "Corresponds to the `PRODUCT` function.",
- "Corresponds to the `STDEV` function.",
- "Corresponds to the `STDEVP` function.",
- "Corresponds to the `VAR` function.",
- "Corresponds to the `VARP` function.",
- "Indicates the formula should be used as-is.\nOnly valid if PivotValue.formula was set."
- ],
- "enum": [
- "PIVOT_STANDARD_VALUE_FUNCTION_UNSPECIFIED",
- "SUM",
- "COUNTA",
- "COUNT",
- "COUNTUNIQUE",
- "AVERAGE",
- "MAX",
- "MIN",
- "MEDIAN",
- "PRODUCT",
- "STDEV",
- "STDEVP",
- "VAR",
- "VARP",
- "CUSTOM"
- ],
- "description": "A function to summarize the value.\nIf formula is set, the only supported values are\nSUM and\nCUSTOM.\nIf sourceColumnOffset is set, then `CUSTOM`\nis not supported."
- },
- "sourceColumnOffset": {
- "format": "int32",
- "description": "The column offset of the source range that this value reads from.\n\nFor example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`\nmeans this value refers to column `C`, whereas the offset `1` would\nrefer to column `D`.",
- "type": "integer"
- },
- "name": {
- "description": "A name to use for the value. This is only used if formula was set.\nOtherwise, the column name is used.",
- "type": "string"
- }
- },
- "id": "PivotValue",
- "description": "The definition of how a value in a pivot table should be calculated."
- },
- "CopySheetToAnotherSpreadsheetRequest": {
- "description": "The request to copy a sheet across spreadsheets.",
- "type": "object",
- "properties": {
- "destinationSpreadsheetId": {
- "description": "The ID of the spreadsheet to copy the sheet to.",
- "type": "string"
- }
- },
- "id": "CopySheetToAnotherSpreadsheetRequest"
- },
- "PivotGroupSortValueBucket": {
- "description": "Information about which values in a pivot group should be used for sorting.",
- "type": "object",
- "properties": {
- "buckets": {
- "description": "Determines the bucket from which values are chosen to sort.\n\nFor example, in a pivot table with one row group & two column groups,\nthe row group can list up to two values. The first value corresponds\nto a value within the first column group, and the second value\ncorresponds to a value in the second column group. If no values\nare listed, this would indicate that the row should be sorted according\nto the \"Grand Total\" over the column groups. If a single value is listed,\nthis would correspond to using the \"Total\" of that bucket.",
- "items": {
- "$ref": "ExtendedValue"
- },
- "type": "array"
- },
- "valuesIndex": {
- "format": "int32",
- "description": "The offset in the PivotTable.values list which the values in this\ngrouping should be sorted by.",
- "type": "integer"
- }
- },
- "id": "PivotGroupSortValueBucket"
}
},
"icons": {
@@ -4654,161 +4657,39 @@
"ownerName": "Google",
"resources": {
"spreadsheets": {
- "methods": {
- "getByDataFilter": {
- "response": {
- "$ref": "Spreadsheet"
- },
- "parameterOrder": [
- "spreadsheetId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "spreadsheetId": {
- "location": "path",
- "description": "The spreadsheet to request.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "flatPath": "v4/spreadsheets/{spreadsheetId}:getByDataFilter",
- "id": "sheets.spreadsheets.getByDataFilter",
- "path": "v4/spreadsheets/{spreadsheetId}:getByDataFilter",
- "description": "Returns the spreadsheet at the given ID.\nThe caller must specify the spreadsheet ID.\n\nThis method differs from GetSpreadsheet in that it allows selecting\nwhich subsets of spreadsheet data to return by specifying a\ndataFilters parameter.\nMultiple DataFilters can be specified. Specifying one or\nmore data filters will return the portions of the spreadsheet that\nintersect ranges matched by any of the filters.\n\nBy default, data within grids will not be returned.\nYou can include grid data one of two ways:\n\n* Specify a field mask listing your desired fields using the `fields` URL\nparameter in HTTP\n\n* Set the includeGridData\nparameter to true. If a field mask is set, the `includeGridData`\nparameter is ignored\n\nFor large spreadsheets, it is recommended to retrieve only the specific\nfields of the spreadsheet that you want.",
- "request": {
- "$ref": "GetSpreadsheetByDataFilterRequest"
- }
- },
- "get": {
- "parameters": {
- "includeGridData": {
- "location": "query",
- "description": "True if grid data should be returned.\nThis parameter is ignored if a field mask was set in the request.",
- "type": "boolean"
- },
- "ranges": {
- "description": "The ranges to retrieve from the spreadsheet.",
- "type": "string",
- "repeated": true,
- "location": "query"
- },
- "spreadsheetId": {
- "description": "The spreadsheet to request.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/drive.readonly",
- "https://www.googleapis.com/auth/spreadsheets",
- "https://www.googleapis.com/auth/spreadsheets.readonly"
- ],
- "flatPath": "v4/spreadsheets/{spreadsheetId}",
- "path": "v4/spreadsheets/{spreadsheetId}",
- "id": "sheets.spreadsheets.get",
- "description": "Returns the spreadsheet at the given ID.\nThe caller must specify the spreadsheet ID.\n\nBy default, data within grids will not be returned.\nYou can include grid data one of two ways:\n\n* Specify a field mask listing your desired fields using the `fields` URL\nparameter in HTTP\n\n* Set the includeGridData\nURL parameter to true. If a field mask is set, the `includeGridData`\nparameter is ignored\n\nFor large spreadsheets, it is recommended to retrieve only the specific\nfields of the spreadsheet that you want.\n\nTo retrieve only subsets of the spreadsheet, use the\nranges URL parameter.\nMultiple ranges can be specified. Limiting the range will\nreturn only the portions of the spreadsheet that intersect the requested\nranges. Ranges are specified using A1 notation.",
- "httpMethod": "GET",
- "parameterOrder": [
- "spreadsheetId"
- ],
- "response": {
- "$ref": "Spreadsheet"
- }
- },
- "batchUpdate": {
- "request": {
- "$ref": "BatchUpdateSpreadsheetRequest"
- },
- "description": "Applies one or more updates to the spreadsheet.\n\nEach request is validated before\nbeing applied. If any request is not valid then the entire request will\nfail and nothing will be applied.\n\nSome requests have replies to\ngive you some information about how\nthey are applied. The replies will mirror the requests. For example,\nif you applied 4 updates and the 3rd one had a reply, then the\nresponse will have 2 empty replies, the actual reply, and another empty\nreply, in that order.\n\nDue to the collaborative nature of spreadsheets, it is not guaranteed that\nthe spreadsheet will reflect exactly your changes after this completes,\nhowever it is guaranteed that the updates in the request will be\napplied together atomically. Your changes may be altered with respect to\ncollaborator changes. If there are no collaborators, the spreadsheet\nshould reflect your changes.",
- "httpMethod": "POST",
- "parameterOrder": [
- "spreadsheetId"
- ],
- "response": {
- "$ref": "BatchUpdateSpreadsheetResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "parameters": {
- "spreadsheetId": {
- "description": "The spreadsheet to apply the updates to.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v4/spreadsheets/{spreadsheetId}:batchUpdate",
- "path": "v4/spreadsheets/{spreadsheetId}:batchUpdate",
- "id": "sheets.spreadsheets.batchUpdate"
- },
- "create": {
- "description": "Creates a spreadsheet, returning the newly created spreadsheet.",
- "request": {
- "$ref": "Spreadsheet"
- },
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Spreadsheet"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "flatPath": "v4/spreadsheets",
- "path": "v4/spreadsheets",
- "id": "sheets.spreadsheets.create"
- }
- },
"resources": {
"developerMetadata": {
"methods": {
"search": {
- "id": "sheets.spreadsheets.developerMetadata.search",
- "path": "v4/spreadsheets/{spreadsheetId}/developerMetadata:search",
- "description": "Returns all developer metadata matching the specified DataFilter.\nIf the provided DataFilter represents a DeveloperMetadataLookup object,\nthis will return all DeveloperMetadata entries selected by it. If the\nDataFilter represents a location in a spreadsheet, this will return all\ndeveloper metadata associated with locations intersecting that region.",
- "request": {
- "$ref": "SearchDeveloperMetadataRequest"
- },
- "response": {
- "$ref": "SearchDeveloperMetadataResponse"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"spreadsheetId"
],
- "httpMethod": "POST",
- "parameters": {
- "spreadsheetId": {
- "description": "The ID of the spreadsheet to retrieve metadata from.",
- "type": "string",
- "required": true,
- "location": "path"
- }
+ "response": {
+ "$ref": "SearchDeveloperMetadataResponse"
},
"scopes": [
"https://www.googleapis.com/auth/drive",
"https://www.googleapis.com/auth/drive.file",
"https://www.googleapis.com/auth/spreadsheets"
],
- "flatPath": "v4/spreadsheets/{spreadsheetId}/developerMetadata:search"
+ "parameters": {
+ "spreadsheetId": {
+ "location": "path",
+ "description": "The ID of the spreadsheet to retrieve metadata from.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/developerMetadata:search",
+ "path": "v4/spreadsheets/{spreadsheetId}/developerMetadata:search",
+ "id": "sheets.spreadsheets.developerMetadata.search",
+ "request": {
+ "$ref": "SearchDeveloperMetadataRequest"
+ },
+ "description": "Returns all developer metadata matching the specified DataFilter.\nIf the provided DataFilter represents a DeveloperMetadataLookup object,\nthis will return all DeveloperMetadata entries selected by it. If the\nDataFilter represents a location in a spreadsheet, this will return all\ndeveloper metadata associated with locations intersecting that region."
},
"get": {
- "id": "sheets.spreadsheets.developerMetadata.get",
- "path": "v4/spreadsheets/{spreadsheetId}/developerMetadata/{metadataId}",
- "description": "Returns the developer metadata with the specified ID.\nThe caller must specify the spreadsheet ID and the developer metadata's\nunique metadataId.",
"response": {
"$ref": "DeveloperMetadata"
},
@@ -4824,10 +4705,10 @@
],
"parameters": {
"spreadsheetId": {
- "location": "path",
- "description": "The ID of the spreadsheet to retrieve metadata from.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path",
+ "description": "The ID of the spreadsheet to retrieve metadata from."
},
"metadataId": {
"location": "path",
@@ -4837,18 +4718,74 @@
"required": true
}
},
- "flatPath": "v4/spreadsheets/{spreadsheetId}/developerMetadata/{metadataId}"
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/developerMetadata/{metadataId}",
+ "id": "sheets.spreadsheets.developerMetadata.get",
+ "path": "v4/spreadsheets/{spreadsheetId}/developerMetadata/{metadataId}",
+ "description": "Returns the developer metadata with the specified ID.\nThe caller must specify the spreadsheet ID and the developer metadata's\nunique metadataId."
}
}
},
"values": {
"methods": {
+ "batchGetByDataFilter": {
+ "request": {
+ "$ref": "BatchGetValuesByDataFilterRequest"
+ },
+ "description": "Returns one or more ranges of values that match the specified data filters.\nThe caller must specify the spreadsheet ID and one or more\nDataFilters. Ranges that match any of the data filters in\nthe request will be returned.",
+ "response": {
+ "$ref": "BatchGetValuesByDataFilterResponse"
+ },
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "parameters": {
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet to retrieve data from.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchGetByDataFilter",
+ "id": "sheets.spreadsheets.values.batchGetByDataFilter",
+ "path": "v4/spreadsheets/{spreadsheetId}/values:batchGetByDataFilter"
+ },
+ "batchClear": {
+ "description": "Clears one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more ranges.\nOnly values are cleared -- all other properties of the cell (such as\nformatting, data validation, etc..) are kept.",
+ "request": {
+ "$ref": "BatchClearValuesRequest"
+ },
+ "response": {
+ "$ref": "BatchClearValuesResponse"
+ },
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet to update.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchClear",
+ "id": "sheets.spreadsheets.values.batchClear",
+ "path": "v4/spreadsheets/{spreadsheetId}/values:batchClear"
+ },
"get": {
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}",
- "path": "v4/spreadsheets/{spreadsheetId}/values/{range}",
- "id": "sheets.spreadsheets.values.get",
- "description": "Returns a range of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and a range.",
- "httpMethod": "GET",
"response": {
"$ref": "ValueRange"
},
@@ -4856,22 +4793,258 @@
"spreadsheetId",
"range"
],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/drive.readonly",
+ "https://www.googleapis.com/auth/spreadsheets",
+ "https://www.googleapis.com/auth/spreadsheets.readonly"
+ ],
"parameters": {
- "range": {
- "description": "The A1 notation of the values to retrieve.",
+ "majorDimension": {
+ "description": "The major dimension that results should use.\n\nFor example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,\nthen requesting `range=A1:B2,majorDimension=ROWS` will return\n`[[1,2],[3,4]]`,\nwhereas requesting `range=A1:B2,majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ]
+ },
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet to retrieve data from.",
"type": "string",
"required": true,
"location": "path"
},
- "dateTimeRenderOption": {
- "description": "How dates, times, and durations should be represented in the output.\nThis is ignored if value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
+ "range": {
+ "location": "path",
+ "description": "The A1 notation of the values to retrieve.",
"type": "string",
+ "required": true
+ },
+ "dateTimeRenderOption": {
"location": "query",
"enum": [
"SERIAL_NUMBER",
"FORMATTED_STRING"
+ ],
+ "description": "How dates, times, and durations should be represented in the output.\nThis is ignored if value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
+ "type": "string"
+ },
+ "valueRenderOption": {
+ "location": "query",
+ "enum": [
+ "FORMATTED_VALUE",
+ "UNFORMATTED_VALUE",
+ "FORMULA"
+ ],
+ "description": "How values should be represented in the output.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}",
+ "id": "sheets.spreadsheets.values.get",
+ "path": "v4/spreadsheets/{spreadsheetId}/values/{range}",
+ "description": "Returns a range of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and a range."
+ },
+ "batchUpdateByDataFilter": {
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter",
+ "path": "v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter",
+ "id": "sheets.spreadsheets.values.batchUpdateByDataFilter",
+ "request": {
+ "$ref": "BatchUpdateValuesByDataFilterRequest"
+ },
+ "description": "Sets values in one or more ranges of a spreadsheet.\nThe caller must specify the spreadsheet ID,\na valueInputOption, and one or more\nDataFilterValueRanges.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "response": {
+ "$ref": "BatchUpdateValuesByDataFilterResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "parameters": {
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet to update.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ }
+ },
+ "update": {
+ "response": {
+ "$ref": "UpdateValuesResponse"
+ },
+ "parameterOrder": [
+ "spreadsheetId",
+ "range"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "parameters": {
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet to update.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "responseValueRenderOption": {
+ "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "FORMATTED_VALUE",
+ "UNFORMATTED_VALUE",
+ "FORMULA"
]
},
+ "valueInputOption": {
+ "location": "query",
+ "enum": [
+ "INPUT_VALUE_OPTION_UNSPECIFIED",
+ "RAW",
+ "USER_ENTERED"
+ ],
+ "description": "How the input data should be interpreted.",
+ "type": "string"
+ },
+ "responseDateTimeRenderOption": {
+ "enum": [
+ "SERIAL_NUMBER",
+ "FORMATTED_STRING"
+ ],
+ "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
+ "type": "string",
+ "location": "query"
+ },
+ "includeValuesInResponse": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Determines if the update response should include the values\nof the cells that were updated. By default, responses\ndo not include the updated values.\nIf the range to write was larger than than the range actually written,\nthe response will include all values in the requested range (excluding\ntrailing empty rows and columns)."
+ },
+ "range": {
+ "description": "The A1 notation of the values to update.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}",
+ "id": "sheets.spreadsheets.values.update",
+ "path": "v4/spreadsheets/{spreadsheetId}/values/{range}",
+ "request": {
+ "$ref": "ValueRange"
+ },
+ "description": "Sets values in a range of a spreadsheet.\nThe caller must specify the spreadsheet ID, range, and\na valueInputOption."
+ },
+ "batchUpdate": {
+ "description": "Sets values in one or more ranges of a spreadsheet.\nThe caller must specify the spreadsheet ID,\na valueInputOption, and one or more\nValueRanges.",
+ "request": {
+ "$ref": "BatchUpdateValuesRequest"
+ },
+ "response": {
+ "$ref": "BatchUpdateValuesResponse"
+ },
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "spreadsheetId": {
+ "location": "path",
+ "description": "The ID of the spreadsheet to update.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchUpdate",
+ "id": "sheets.spreadsheets.values.batchUpdate",
+ "path": "v4/spreadsheets/{spreadsheetId}/values:batchUpdate"
+ },
+ "clear": {
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}:clear",
+ "id": "sheets.spreadsheets.values.clear",
+ "path": "v4/spreadsheets/{spreadsheetId}/values/{range}:clear",
+ "description": "Clears values from a spreadsheet.\nThe caller must specify the spreadsheet ID and range.\nOnly values are cleared -- all other properties of the cell (such as\nformatting, data validation, etc..) are kept.",
+ "request": {
+ "$ref": "ClearValuesRequest"
+ },
+ "response": {
+ "$ref": "ClearValuesResponse"
+ },
+ "parameterOrder": [
+ "spreadsheetId",
+ "range"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "spreadsheetId": {
+ "location": "path",
+ "description": "The ID of the spreadsheet to update.",
+ "type": "string",
+ "required": true
+ },
+ "range": {
+ "location": "path",
+ "description": "The A1 notation of the values to clear.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ]
+ },
+ "batchGet": {
+ "description": "Returns one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more ranges.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "response": {
+ "$ref": "BatchGetValuesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/drive.readonly",
+ "https://www.googleapis.com/auth/spreadsheets",
+ "https://www.googleapis.com/auth/spreadsheets.readonly"
+ ],
+ "parameters": {
+ "spreadsheetId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The ID of the spreadsheet to retrieve data from."
+ },
+ "dateTimeRenderOption": {
+ "location": "query",
+ "enum": [
+ "SERIAL_NUMBER",
+ "FORMATTED_STRING"
+ ],
+ "description": "How dates, times, and durations should be represented in the output.\nThis is ignored if value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
+ "type": "string"
+ },
"valueRenderOption": {
"location": "query",
"enum": [
@@ -4892,309 +5065,100 @@
"description": "The major dimension that results should use.\n\nFor example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,\nthen requesting `range=A1:B2,majorDimension=ROWS` will return\n`[[1,2],[3,4]]`,\nwhereas requesting `range=A1:B2,majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`.",
"type": "string"
},
- "spreadsheetId": {
+ "ranges": {
+ "description": "The A1 notation of the values to retrieve.",
"type": "string",
- "required": true,
+ "repeated": true,
+ "location": "query"
+ }
+ },
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchGet",
+ "path": "v4/spreadsheets/{spreadsheetId}/values:batchGet",
+ "id": "sheets.spreadsheets.values.batchGet"
+ },
+ "batchClearByDataFilter": {
+ "response": {
+ "$ref": "BatchClearValuesByDataFilterResponse"
+ },
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "spreadsheetId": {
"location": "path",
- "description": "The ID of the spreadsheet to retrieve data from."
+ "description": "The ID of the spreadsheet to update.",
+ "type": "string",
+ "required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/drive",
"https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/drive.readonly",
- "https://www.googleapis.com/auth/spreadsheets",
- "https://www.googleapis.com/auth/spreadsheets.readonly"
- ]
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter",
+ "id": "sheets.spreadsheets.values.batchClearByDataFilter",
+ "path": "v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter",
+ "description": "Clears one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more\nDataFilters. Ranges matching any of the specified data\nfilters will be cleared. Only values are cleared -- all other properties\nof the cell (such as formatting, data validation, etc..) are kept.",
+ "request": {
+ "$ref": "BatchClearValuesByDataFilterRequest"
+ }
},
- "update": {
+ "append": {
+ "request": {
+ "$ref": "ValueRange"
+ },
+ "description": "Appends values to a spreadsheet. The input range is used to search for\nexisting data and find a \"table\" within that range. Values will be\nappended to the next row of the table, starting with the first column of\nthe table. See the\n[guide](/sheets/api/guides/values#appending_values)\nand\n[sample code](/sheets/api/samples/writing#append_values)\nfor specific details of how tables are detected and data is appended.\n\nThe caller must specify the spreadsheet ID, range, and\na valueInputOption. The `valueInputOption` only\ncontrols how the input data will be added to the sheet (column-wise or\nrow-wise), it does not influence what cell the data starts being written\nto.",
"response": {
- "$ref": "UpdateValuesResponse"
+ "$ref": "AppendValuesResponse"
},
"parameterOrder": [
"spreadsheetId",
"range"
],
- "httpMethod": "PUT",
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/drive",
"https://www.googleapis.com/auth/drive.file",
"https://www.googleapis.com/auth/spreadsheets"
],
"parameters": {
- "includeValuesInResponse": {
- "location": "query",
- "description": "Determines if the update response should include the values\nof the cells that were updated. By default, responses\ndo not include the updated values.\nIf the range to write was larger than than the range actually written,\nthe response will include all values in the requested range (excluding\ntrailing empty rows and columns).",
- "type": "boolean"
- },
- "range": {
- "location": "path",
- "description": "The A1 notation of the values to update.",
- "type": "string",
- "required": true
- },
- "spreadsheetId": {
- "description": "The ID of the spreadsheet to update.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "responseValueRenderOption": {
- "location": "query",
- "enum": [
- "FORMATTED_VALUE",
- "UNFORMATTED_VALUE",
- "FORMULA"
- ],
- "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
- "type": "string"
- },
- "valueInputOption": {
- "location": "query",
- "enum": [
- "INPUT_VALUE_OPTION_UNSPECIFIED",
- "RAW",
- "USER_ENTERED"
- ],
- "description": "How the input data should be interpreted.",
- "type": "string"
- },
"responseDateTimeRenderOption": {
- "location": "query",
"enum": [
"SERIAL_NUMBER",
"FORMATTED_STRING"
],
"description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
- "type": "string"
- }
- },
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}",
- "id": "sheets.spreadsheets.values.update",
- "path": "v4/spreadsheets/{spreadsheetId}/values/{range}",
- "request": {
- "$ref": "ValueRange"
- },
- "description": "Sets values in a range of a spreadsheet.\nThe caller must specify the spreadsheet ID, range, and\na valueInputOption."
- },
- "batchUpdateByDataFilter": {
- "request": {
- "$ref": "BatchUpdateValuesByDataFilterRequest"
- },
- "description": "Sets values in one or more ranges of a spreadsheet.\nThe caller must specify the spreadsheet ID,\na valueInputOption, and one or more\nDataFilterValueRanges.",
- "response": {
- "$ref": "BatchUpdateValuesByDataFilterResponse"
- },
- "parameterOrder": [
- "spreadsheetId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "parameters": {
- "spreadsheetId": {
- "location": "path",
- "description": "The ID of the spreadsheet to update.",
"type": "string",
- "required": true
- }
- },
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter",
- "id": "sheets.spreadsheets.values.batchUpdateByDataFilter",
- "path": "v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter"
- },
- "batchUpdate": {
- "request": {
- "$ref": "BatchUpdateValuesRequest"
- },
- "description": "Sets values in one or more ranges of a spreadsheet.\nThe caller must specify the spreadsheet ID,\na valueInputOption, and one or more\nValueRanges.",
- "response": {
- "$ref": "BatchUpdateValuesResponse"
- },
- "parameterOrder": [
- "spreadsheetId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "parameters": {
- "spreadsheetId": {
- "description": "The ID of the spreadsheet to update.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchUpdate",
- "id": "sheets.spreadsheets.values.batchUpdate",
- "path": "v4/spreadsheets/{spreadsheetId}/values:batchUpdate"
- },
- "batchGet": {
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/drive.readonly",
- "https://www.googleapis.com/auth/spreadsheets",
- "https://www.googleapis.com/auth/spreadsheets.readonly"
- ],
- "parameters": {
- "dateTimeRenderOption": {
- "description": "How dates, times, and durations should be represented in the output.\nThis is ignored if value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
- "type": "string",
- "location": "query",
- "enum": [
- "SERIAL_NUMBER",
- "FORMATTED_STRING"
- ]
+ "location": "query"
},
- "valueRenderOption": {
- "location": "query",
- "enum": [
- "FORMATTED_VALUE",
- "UNFORMATTED_VALUE",
- "FORMULA"
- ],
- "description": "How values should be represented in the output.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
- "type": "string"
- },
- "majorDimension": {
- "type": "string",
- "location": "query",
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
- ],
- "description": "The major dimension that results should use.\n\nFor example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,\nthen requesting `range=A1:B2,majorDimension=ROWS` will return\n`[[1,2],[3,4]]`,\nwhereas requesting `range=A1:B2,majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`."
- },
- "ranges": {
- "repeated": true,
- "location": "query",
- "description": "The A1 notation of the values to retrieve.",
- "type": "string"
- },
- "spreadsheetId": {
- "description": "The ID of the spreadsheet to retrieve data from.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchGet",
- "path": "v4/spreadsheets/{spreadsheetId}/values:batchGet",
- "id": "sheets.spreadsheets.values.batchGet",
- "description": "Returns one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more ranges.",
- "httpMethod": "GET",
- "parameterOrder": [
- "spreadsheetId"
- ],
- "response": {
- "$ref": "BatchGetValuesResponse"
- }
- },
- "clear": {
- "request": {
- "$ref": "ClearValuesRequest"
- },
- "description": "Clears values from a spreadsheet.\nThe caller must specify the spreadsheet ID and range.\nOnly values are cleared -- all other properties of the cell (such as\nformatting, data validation, etc..) are kept.",
- "httpMethod": "POST",
- "parameterOrder": [
- "spreadsheetId",
- "range"
- ],
- "response": {
- "$ref": "ClearValuesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "parameters": {
- "spreadsheetId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The ID of the spreadsheet to update."
+ "includeValuesInResponse": {
+ "description": "Determines if the update response should include the values\nof the cells that were appended. By default, responses\ndo not include the updated values.",
+ "type": "boolean",
+ "location": "query"
},
"range": {
- "type": "string",
- "required": true,
"location": "path",
- "description": "The A1 notation of the values to clear."
- }
- },
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}:clear",
- "path": "v4/spreadsheets/{spreadsheetId}/values/{range}:clear",
- "id": "sheets.spreadsheets.values.clear"
- },
- "batchClearByDataFilter": {
- "path": "v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter",
- "id": "sheets.spreadsheets.values.batchClearByDataFilter",
- "description": "Clears one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more\nDataFilters. Ranges matching any of the specified data\nfilters will be cleared. Only values are cleared -- all other properties\nof the cell (such as formatting, data validation, etc..) are kept.",
- "request": {
- "$ref": "BatchClearValuesByDataFilterRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "spreadsheetId"
- ],
- "response": {
- "$ref": "BatchClearValuesByDataFilterResponse"
- },
- "parameters": {
- "spreadsheetId": {
- "location": "path",
- "description": "The ID of the spreadsheet to update.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter"
- },
- "append": {
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}:append",
- "path": "v4/spreadsheets/{spreadsheetId}/values/{range}:append",
- "id": "sheets.spreadsheets.values.append",
- "description": "Appends values to a spreadsheet. The input range is used to search for\nexisting data and find a \"table\" within that range. Values will be\nappended to the next row of the table, starting with the first column of\nthe table. See the\n[guide](/sheets/api/guides/values#appending_values)\nand\n[sample code](/sheets/api/samples/writing#append_values)\nfor specific details of how tables are detected and data is appended.\n\nThe caller must specify the spreadsheet ID, range, and\na valueInputOption. The `valueInputOption` only\ncontrols how the input data will be added to the sheet (column-wise or\nrow-wise), it does not influence what cell the data starts being written\nto.",
- "request": {
- "$ref": "ValueRange"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "spreadsheetId",
- "range"
- ],
- "response": {
- "$ref": "AppendValuesResponse"
- },
- "parameters": {
- "spreadsheetId": {
- "location": "path",
- "description": "The ID of the spreadsheet to update.",
+ "description": "The A1 notation of a range to search for a logical table of data.\nValues will be appended after the last row of the table.",
"type": "string",
"required": true
},
- "responseValueRenderOption": {
- "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet to update.",
"type": "string",
- "location": "query",
+ "required": true,
+ "location": "path"
+ },
+ "responseValueRenderOption": {
"enum": [
"FORMATTED_VALUE",
"UNFORMATTED_VALUE",
"FORMULA"
- ]
+ ],
+ "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
+ "type": "string",
+ "location": "query"
},
"insertDataOption": {
"location": "query",
@@ -5214,97 +5178,19 @@
],
"description": "How the input data should be interpreted.",
"type": "string"
- },
- "responseDateTimeRenderOption": {
- "enum": [
- "SERIAL_NUMBER",
- "FORMATTED_STRING"
- ],
- "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
- "type": "string",
- "location": "query"
- },
- "range": {
- "description": "The A1 notation of a range to search for a logical table of data.\nValues will be appended after the last row of the table.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "includeValuesInResponse": {
- "location": "query",
- "description": "Determines if the update response should include the values\nof the cells that were appended. By default, responses\ndo not include the updated values.",
- "type": "boolean"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ]
- },
- "batchGetByDataFilter": {
- "response": {
- "$ref": "BatchGetValuesByDataFilterResponse"
- },
- "parameterOrder": [
- "spreadsheetId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "parameters": {
- "spreadsheetId": {
- "location": "path",
- "description": "The ID of the spreadsheet to retrieve data from.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchGetByDataFilter",
- "id": "sheets.spreadsheets.values.batchGetByDataFilter",
- "path": "v4/spreadsheets/{spreadsheetId}/values:batchGetByDataFilter",
- "request": {
- "$ref": "BatchGetValuesByDataFilterRequest"
- },
- "description": "Returns one or more ranges of values that match the specified data filters.\nThe caller must specify the spreadsheet ID and one or more\nDataFilters. Ranges that match any of the data filters in\nthe request will be returned."
- },
- "batchClear": {
- "request": {
- "$ref": "BatchClearValuesRequest"
- },
- "description": "Clears one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more ranges.\nOnly values are cleared -- all other properties of the cell (such as\nformatting, data validation, etc..) are kept.",
- "response": {
- "$ref": "BatchClearValuesResponse"
- },
- "parameterOrder": [
- "spreadsheetId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "parameters": {
- "spreadsheetId": {
- "description": "The ID of the spreadsheet to update.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchClear",
- "id": "sheets.spreadsheets.values.batchClear",
- "path": "v4/spreadsheets/{spreadsheetId}/values:batchClear"
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}:append",
+ "id": "sheets.spreadsheets.values.append",
+ "path": "v4/spreadsheets/{spreadsheetId}/values/{range}:append"
}
}
},
"sheets": {
"methods": {
"copyTo": {
+ "id": "sheets.spreadsheets.sheets.copyTo",
+ "path": "v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo",
"request": {
"$ref": "CopySheetToAnotherSpreadsheetRequest"
},
@@ -5323,23 +5209,140 @@
"https://www.googleapis.com/auth/spreadsheets"
],
"parameters": {
- "spreadsheetId": {
+ "sheetId": {
+ "type": "integer",
+ "required": true,
"location": "path",
+ "format": "int32",
+ "description": "The ID of the sheet to copy."
+ },
+ "spreadsheetId": {
"description": "The ID of the spreadsheet containing the sheet to copy.",
"type": "string",
- "required": true
- },
- "sheetId": {
- "format": "int32",
- "description": "The ID of the sheet to copy.",
- "type": "integer",
"required": true,
"location": "path"
}
},
- "flatPath": "v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo",
- "id": "sheets.spreadsheets.sheets.copyTo",
- "path": "v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo"
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo"
+ }
+ }
+ }
+ },
+ "methods": {
+ "batchUpdate": {
+ "request": {
+ "$ref": "BatchUpdateSpreadsheetRequest"
+ },
+ "description": "Applies one or more updates to the spreadsheet.\n\nEach request is validated before\nbeing applied. If any request is not valid then the entire request will\nfail and nothing will be applied.\n\nSome requests have replies to\ngive you some information about how\nthey are applied. The replies will mirror the requests. For example,\nif you applied 4 updates and the 3rd one had a reply, then the\nresponse will have 2 empty replies, the actual reply, and another empty\nreply, in that order.\n\nDue to the collaborative nature of spreadsheets, it is not guaranteed that\nthe spreadsheet will reflect exactly your changes after this completes,\nhowever it is guaranteed that the updates in the request will be\napplied together atomically. Your changes may be altered with respect to\ncollaborator changes. If there are no collaborators, the spreadsheet\nshould reflect your changes.",
+ "response": {
+ "$ref": "BatchUpdateSpreadsheetResponse"
+ },
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "parameters": {
+ "spreadsheetId": {
+ "description": "The spreadsheet to apply the updates to.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v4/spreadsheets/{spreadsheetId}:batchUpdate",
+ "id": "sheets.spreadsheets.batchUpdate",
+ "path": "v4/spreadsheets/{spreadsheetId}:batchUpdate"
+ },
+ "create": {
+ "flatPath": "v4/spreadsheets",
+ "path": "v4/spreadsheets",
+ "id": "sheets.spreadsheets.create",
+ "description": "Creates a spreadsheet, returning the newly created spreadsheet.",
+ "request": {
+ "$ref": "Spreadsheet"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Spreadsheet"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ]
+ },
+ "getByDataFilter": {
+ "request": {
+ "$ref": "GetSpreadsheetByDataFilterRequest"
+ },
+ "description": "Returns the spreadsheet at the given ID.\nThe caller must specify the spreadsheet ID.\n\nThis method differs from GetSpreadsheet in that it allows selecting\nwhich subsets of spreadsheet data to return by specifying a\ndataFilters parameter.\nMultiple DataFilters can be specified. Specifying one or\nmore data filters will return the portions of the spreadsheet that\nintersect ranges matched by any of the filters.\n\nBy default, data within grids will not be returned.\nYou can include grid data one of two ways:\n\n* Specify a field mask listing your desired fields using the `fields` URL\nparameter in HTTP\n\n* Set the includeGridData\nparameter to true. If a field mask is set, the `includeGridData`\nparameter is ignored\n\nFor large spreadsheets, it is recommended to retrieve only the specific\nfields of the spreadsheet that you want.",
+ "response": {
+ "$ref": "Spreadsheet"
+ },
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "parameters": {
+ "spreadsheetId": {
+ "location": "path",
+ "description": "The spreadsheet to request.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v4/spreadsheets/{spreadsheetId}:getByDataFilter",
+ "id": "sheets.spreadsheets.getByDataFilter",
+ "path": "v4/spreadsheets/{spreadsheetId}:getByDataFilter"
+ },
+ "get": {
+ "flatPath": "v4/spreadsheets/{spreadsheetId}",
+ "id": "sheets.spreadsheets.get",
+ "path": "v4/spreadsheets/{spreadsheetId}",
+ "description": "Returns the spreadsheet at the given ID.\nThe caller must specify the spreadsheet ID.\n\nBy default, data within grids will not be returned.\nYou can include grid data one of two ways:\n\n* Specify a field mask listing your desired fields using the `fields` URL\nparameter in HTTP\n\n* Set the includeGridData\nURL parameter to true. If a field mask is set, the `includeGridData`\nparameter is ignored\n\nFor large spreadsheets, it is recommended to retrieve only the specific\nfields of the spreadsheet that you want.\n\nTo retrieve only subsets of the spreadsheet, use the\nranges URL parameter.\nMultiple ranges can be specified. Limiting the range will\nreturn only the portions of the spreadsheet that intersect the requested\nranges. Ranges are specified using A1 notation.",
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Spreadsheet"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/drive.readonly",
+ "https://www.googleapis.com/auth/spreadsheets",
+ "https://www.googleapis.com/auth/spreadsheets.readonly"
+ ],
+ "parameters": {
+ "includeGridData": {
+ "description": "True if grid data should be returned.\nThis parameter is ignored if a field mask was set in the request.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "ranges": {
+ "location": "query",
+ "description": "The ranges to retrieve from the spreadsheet.",
+ "type": "string",
+ "repeated": true
+ },
+ "spreadsheetId": {
+ "description": "The spreadsheet to request.",
+ "type": "string",
+ "required": true,
+ "location": "path"
}
}
}
@@ -5347,6 +5350,22 @@
}
},
"parameters": {
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
@@ -5358,23 +5377,17 @@
"type": "boolean",
"location": "query"
},
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
"fields": {
"location": "query",
"description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
},
"$.xgafv": {
- "location": "query",
"enum": [
"1",
"2"
@@ -5384,9 +5397,16 @@
"enumDescriptions": [
"v1 error format",
"v2 error format"
- ]
+ ],
+ "location": "query"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
},
"alt": {
+ "default": "json",
"enum": [
"json",
"media",
@@ -5399,48 +5419,28 @@
"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"
+ "description": "Data format for response."
},
"key": {
"location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string"
},
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
"quotaUser": {
"location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
}
},
"version": "v4",
"baseUrl": "https://sheets.googleapis.com/",
- "servicePath": "",
- "description": "Reads and writes Google Sheets.",
"kind": "discovery#restDescription",
- "basePath": "",
- "revision": "20171006",
- "documentationLink": "https://developers.google.com/sheets/",
- "id": "sheets:v4"
+ "description": "Reads and writes Google Sheets.",
+ "servicePath": "",
+ "basePath": ""
}
diff --git a/slides/v1/slides-api.json b/slides/v1/slides-api.json
index 2d5e7a6..681656f 100644
--- a/slides/v1/slides-api.json
+++ b/slides/v1/slides-api.json
@@ -3,6 +3,9 @@
"presentations": {
"methods": {
"get": {
+ "id": "slides.presentations.get",
+ "path": "v1/presentations/{+presentationId}",
+ "description": "Gets the latest version of the specified presentation.",
"response": {
"$ref": "Presentation"
},
@@ -10,12 +13,6 @@
"presentationId"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.readonly",
- "https://www.googleapis.com/auth/presentations",
- "https://www.googleapis.com/auth/presentations.readonly"
- ],
"parameters": {
"presentationId": {
"type": "string",
@@ -25,16 +22,15 @@
"description": "The ID of the presentation to retrieve."
}
},
- "flatPath": "v1/presentations/{presentationsId}",
- "id": "slides.presentations.get",
- "path": "v1/presentations/{+presentationId}",
- "description": "Gets the latest version of the specified presentation."
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.readonly",
+ "https://www.googleapis.com/auth/presentations",
+ "https://www.googleapis.com/auth/presentations.readonly"
+ ],
+ "flatPath": "v1/presentations/{presentationsId}"
},
"batchUpdate": {
- "request": {
- "$ref": "BatchUpdatePresentationRequest"
- },
- "description": "Applies one or more updates to the presentation.\n\nEach request is validated before\nbeing applied. If any request is not valid, then the entire request will\nfail and nothing will be applied.\n\nSome requests have replies to\ngive you some information about how they are applied. Other requests do\nnot need to return information; these each return an empty reply.\nThe order of replies matches that of the requests.\n\nFor example, suppose you call batchUpdate with four updates, and only the\nthird one returns information. The response would have two empty replies:\nthe reply to the third request, and another empty reply, in that order.\n\nBecause other users may be editing the presentation, the presentation\nmight not exactly reflect your changes: your changes may\nbe altered with respect to collaborator changes. If there are no\ncollaborators, the presentation should reflect your changes. In any case,\nthe updates in your request are guaranteed to be applied together\natomically.",
"response": {
"$ref": "BatchUpdatePresentationResponse"
},
@@ -51,52 +47,58 @@
],
"parameters": {
"presentationId": {
- "type": "string",
- "required": true,
"location": "path",
- "description": "The presentation to apply the updates to."
+ "description": "The presentation to apply the updates to.",
+ "type": "string",
+ "required": true
}
},
"flatPath": "v1/presentations/{presentationId}:batchUpdate",
"id": "slides.presentations.batchUpdate",
- "path": "v1/presentations/{presentationId}:batchUpdate"
+ "path": "v1/presentations/{presentationId}:batchUpdate",
+ "request": {
+ "$ref": "BatchUpdatePresentationRequest"
+ },
+ "description": "Applies one or more updates to the presentation.\n\nEach request is validated before\nbeing applied. If any request is not valid, then the entire request will\nfail and nothing will be applied.\n\nSome requests have replies to\ngive you some information about how they are applied. Other requests do\nnot need to return information; these each return an empty reply.\nThe order of replies matches that of the requests.\n\nFor example, suppose you call batchUpdate with four updates, and only the\nthird one returns information. The response would have two empty replies:\nthe reply to the third request, and another empty reply, in that order.\n\nBecause other users may be editing the presentation, the presentation\nmight not exactly reflect your changes: your changes may\nbe altered with respect to collaborator changes. If there are no\ncollaborators, the presentation should reflect your changes. In any case,\nthe updates in your request are guaranteed to be applied together\natomically."
},
"create": {
+ "request": {
+ "$ref": "Presentation"
+ },
+ "description": "Creates a new presentation using the title given in the request. Other\nfields in the request are ignored.\nReturns the created presentation.",
"response": {
"$ref": "Presentation"
},
"parameterOrder": [],
"httpMethod": "POST",
- "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/drive",
"https://www.googleapis.com/auth/presentations"
],
+ "parameters": {},
"flatPath": "v1/presentations",
"id": "slides.presentations.create",
- "path": "v1/presentations",
- "description": "Creates a new presentation using the title given in the request. Other\nfields in the request are ignored.\nReturns the created presentation.",
- "request": {
- "$ref": "Presentation"
- }
+ "path": "v1/presentations"
}
},
"resources": {
"pages": {
"methods": {
"getThumbnail": {
- "flatPath": "v1/presentations/{presentationId}/pages/{pageObjectId}/thumbnail",
- "id": "slides.presentations.pages.getThumbnail",
- "path": "v1/presentations/{presentationId}/pages/{pageObjectId}/thumbnail",
- "description": "Generates a thumbnail of the latest version of the specified page in the\npresentation and returns a URL to the thumbnail image.",
- "response": {
- "$ref": "Thumbnail"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"presentationId",
"pageObjectId"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "Thumbnail"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.readonly",
+ "https://www.googleapis.com/auth/presentations",
+ "https://www.googleapis.com/auth/presentations.readonly"
+ ],
"parameters": {
"pageObjectId": {
"location": "path",
@@ -105,13 +107,13 @@
"required": true
},
"thumbnailProperties.thumbnailSize": {
+ "type": "string",
"location": "query",
"enum": [
"THUMBNAIL_SIZE_UNSPECIFIED",
"LARGE"
],
- "description": "The optional thumbnail image size.\n\nIf you don't specify the size, the server chooses a default size of the\nimage.",
- "type": "string"
+ "description": "The optional thumbnail image size.\n\nIf you don't specify the size, the server chooses a default size of the\nimage."
},
"thumbnailProperties.mimeType": {
"location": "query",
@@ -128,22 +130,12 @@
"description": "The ID of the presentation to retrieve."
}
},
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.readonly",
- "https://www.googleapis.com/auth/presentations",
- "https://www.googleapis.com/auth/presentations.readonly"
- ]
+ "flatPath": "v1/presentations/{presentationId}/pages/{pageObjectId}/thumbnail",
+ "path": "v1/presentations/{presentationId}/pages/{pageObjectId}/thumbnail",
+ "id": "slides.presentations.pages.getThumbnail",
+ "description": "Generates a thumbnail of the latest version of the specified page in the\npresentation and returns a URL to the thumbnail image."
},
"get": {
- "response": {
- "$ref": "Page"
- },
- "parameterOrder": [
- "presentationId",
- "pageObjectId"
- ],
- "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/drive",
"https://www.googleapis.com/auth/drive.readonly",
@@ -151,23 +143,31 @@
"https://www.googleapis.com/auth/presentations.readonly"
],
"parameters": {
- "pageObjectId": {
- "location": "path",
- "description": "The object ID of the page to retrieve.",
- "type": "string",
- "required": true
- },
"presentationId": {
- "location": "path",
"description": "The ID of the presentation to retrieve.",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
+ },
+ "pageObjectId": {
+ "description": "The object ID of the page to retrieve.",
+ "type": "string",
+ "required": true,
+ "location": "path"
}
},
"flatPath": "v1/presentations/{presentationId}/pages/{pageObjectId}",
- "id": "slides.presentations.pages.get",
"path": "v1/presentations/{presentationId}/pages/{pageObjectId}",
- "description": "Gets the latest version of the specified page in the presentation."
+ "id": "slides.presentations.pages.get",
+ "description": "Gets the latest version of the specified page in the presentation.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "presentationId",
+ "pageObjectId"
+ ],
+ "response": {
+ "$ref": "Page"
+ }
}
}
}
@@ -175,6 +175,48 @@
}
},
"parameters": {
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "bearer_token": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth bearer token."
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
"fields": {
"location": "query",
"description": "Selector specifying which fields to include in a partial response.",
@@ -185,31 +227,25 @@
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
"$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
"location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ]
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
},
"alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -217,49 +253,13 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json"
- },
- "key": {
- "type": "string",
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
"type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "default": "true",
- "type": "boolean",
- "location": "query",
- "description": "Pretty-print response."
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "upload_protocol": {
- "type": "string",
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
}
},
"version": "v1",
@@ -268,3550 +268,25 @@
"description": "An API for creating and editing Google Slides presentations.",
"kind": "discovery#restDescription",
"basePath": "",
- "revision": "20171003",
"id": "slides:v1",
"documentationLink": "https://developers.google.com/slides/",
+ "revision": "20171003",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "CreateShapeRequest": {
- "type": "object",
- "properties": {
- "shapeType": {
- "type": "string",
- "enumDescriptions": [
- "The shape type that is not predefined.",
- "Text box shape.",
- "Rectangle shape. Corresponds to ECMA-376 ST_ShapeType 'rect'.",
- "Round corner rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'roundRect'",
- "Ellipse shape. Corresponds to ECMA-376 ST_ShapeType 'ellipse'",
- "Curved arc shape. Corresponds to ECMA-376 ST_ShapeType 'arc'",
- "Bent arrow shape. Corresponds to ECMA-376 ST_ShapeType 'bentArrow'",
- "Bent up arrow shape. Corresponds to ECMA-376 ST_ShapeType 'bentUpArrow'",
- "Bevel shape. Corresponds to ECMA-376 ST_ShapeType 'bevel'",
- "Block arc shape. Corresponds to ECMA-376 ST_ShapeType 'blockArc'",
- "Brace pair shape. Corresponds to ECMA-376 ST_ShapeType 'bracePair'",
- "Bracket pair shape. Corresponds to ECMA-376 ST_ShapeType 'bracketPair'",
- "Can shape. Corresponds to ECMA-376 ST_ShapeType 'can'",
- "Chevron shape. Corresponds to ECMA-376 ST_ShapeType 'chevron'",
- "Chord shape. Corresponds to ECMA-376 ST_ShapeType 'chord'",
- "Cloud shape. Corresponds to ECMA-376 ST_ShapeType 'cloud'",
- "Corner shape. Corresponds to ECMA-376 ST_ShapeType 'corner'",
- "Cube shape. Corresponds to ECMA-376 ST_ShapeType 'cube'",
- "Curved down arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'curvedDownArrow'",
- "Curved left arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'curvedLeftArrow'",
- "Curved right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'curvedRightArrow'",
- "Curved up arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'curvedUpArrow'",
- "Decagon shape. Corresponds to ECMA-376 ST_ShapeType 'decagon'",
- "Diagonal stripe shape. Corresponds to ECMA-376 ST_ShapeType 'diagStripe'",
- "Diamond shape. Corresponds to ECMA-376 ST_ShapeType 'diamond'",
- "Dodecagon shape. Corresponds to ECMA-376 ST_ShapeType 'dodecagon'",
- "Donut shape. Corresponds to ECMA-376 ST_ShapeType 'donut'",
- "Double wave shape. Corresponds to ECMA-376 ST_ShapeType 'doubleWave'",
- "Down arrow shape. Corresponds to ECMA-376 ST_ShapeType 'downArrow'",
- "Callout down arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'downArrowCallout'",
- "Folded corner shape. Corresponds to ECMA-376 ST_ShapeType 'foldedCorner'",
- "Frame shape. Corresponds to ECMA-376 ST_ShapeType 'frame'",
- "Half frame shape. Corresponds to ECMA-376 ST_ShapeType 'halfFrame'",
- "Heart shape. Corresponds to ECMA-376 ST_ShapeType 'heart'",
- "Heptagon shape. Corresponds to ECMA-376 ST_ShapeType 'heptagon'",
- "Hexagon shape. Corresponds to ECMA-376 ST_ShapeType 'hexagon'",
- "Home plate shape. Corresponds to ECMA-376 ST_ShapeType 'homePlate'",
- "Horizontal scroll shape. Corresponds to ECMA-376 ST_ShapeType\n'horizontalScroll'",
- "Irregular seal 1 shape. Corresponds to ECMA-376 ST_ShapeType\n'irregularSeal1'",
- "Irregular seal 2 shape. Corresponds to ECMA-376 ST_ShapeType\n'irregularSeal2'",
- "Left arrow shape. Corresponds to ECMA-376 ST_ShapeType 'leftArrow'",
- "Callout left arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'leftArrowCallout'",
- "Left brace shape. Corresponds to ECMA-376 ST_ShapeType 'leftBrace'",
- "Left bracket shape. Corresponds to ECMA-376 ST_ShapeType 'leftBracket'",
- "Left right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'leftRightArrow'",
- "Callout left right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'leftRightArrowCallout'",
- "Left right up arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'leftRightUpArrow'",
- "Left up arrow shape. Corresponds to ECMA-376 ST_ShapeType 'leftUpArrow'",
- "Lightning bolt shape. Corresponds to ECMA-376 ST_ShapeType\n'lightningBolt'",
- "Divide math shape. Corresponds to ECMA-376 ST_ShapeType 'mathDivide'",
- "Equal math shape. Corresponds to ECMA-376 ST_ShapeType 'mathEqual'",
- "Minus math shape. Corresponds to ECMA-376 ST_ShapeType 'mathMinus'",
- "Multiply math shape. Corresponds to ECMA-376 ST_ShapeType 'mathMultiply'",
- "Not equal math shape. Corresponds to ECMA-376 ST_ShapeType 'mathNotEqual'",
- "Plus math shape. Corresponds to ECMA-376 ST_ShapeType 'mathPlus'",
- "Moon shape. Corresponds to ECMA-376 ST_ShapeType 'moon'",
- "No smoking shape. Corresponds to ECMA-376 ST_ShapeType 'noSmoking'",
- "Notched right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'notchedRightArrow'",
- "Octagon shape. Corresponds to ECMA-376 ST_ShapeType 'octagon'",
- "Parallelogram shape. Corresponds to ECMA-376 ST_ShapeType 'parallelogram'",
- "Pentagon shape. Corresponds to ECMA-376 ST_ShapeType 'pentagon'",
- "Pie shape. Corresponds to ECMA-376 ST_ShapeType 'pie'",
- "Plaque shape. Corresponds to ECMA-376 ST_ShapeType 'plaque'",
- "Plus shape. Corresponds to ECMA-376 ST_ShapeType 'plus'",
- "Quad-arrow shape. Corresponds to ECMA-376 ST_ShapeType 'quadArrow'",
- "Callout quad-arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'quadArrowCallout'",
- "Ribbon shape. Corresponds to ECMA-376 ST_ShapeType 'ribbon'",
- "Ribbon 2 shape. Corresponds to ECMA-376 ST_ShapeType 'ribbon2'",
- "Right arrow shape. Corresponds to ECMA-376 ST_ShapeType 'rightArrow'",
- "Callout right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'rightArrowCallout'",
- "Right brace shape. Corresponds to ECMA-376 ST_ShapeType 'rightBrace'",
- "Right bracket shape. Corresponds to ECMA-376 ST_ShapeType 'rightBracket'",
- "One round corner rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'round1Rect'",
- "Two diagonal round corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'round2DiagRect'",
- "Two same-side round corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'round2SameRect'",
- "Right triangle shape. Corresponds to ECMA-376 ST_ShapeType 'rtTriangle'",
- "Smiley face shape. Corresponds to ECMA-376 ST_ShapeType 'smileyFace'",
- "One snip corner rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'snip1Rect'",
- "Two diagonal snip corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'snip2DiagRect'",
- "Two same-side snip corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'snip2SameRect'",
- "One snip one round corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'snipRoundRect'",
- "Ten pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star10'",
- "Twelve pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star12'",
- "Sixteen pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star16'",
- "Twenty four pointed star shape. Corresponds to ECMA-376 ST_ShapeType\n'star24'",
- "Thirty two pointed star shape. Corresponds to ECMA-376 ST_ShapeType\n'star32'",
- "Four pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star4'",
- "Five pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star5'",
- "Six pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star6'",
- "Seven pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star7'",
- "Eight pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star8'",
- "Striped right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'stripedRightArrow'",
- "Sun shape. Corresponds to ECMA-376 ST_ShapeType 'sun'",
- "Trapezoid shape. Corresponds to ECMA-376 ST_ShapeType 'trapezoid'",
- "Triangle shape. Corresponds to ECMA-376 ST_ShapeType 'triangle'",
- "Up arrow shape. Corresponds to ECMA-376 ST_ShapeType 'upArrow'",
- "Callout up arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'upArrowCallout'",
- "Up down arrow shape. Corresponds to ECMA-376 ST_ShapeType 'upDownArrow'",
- "U-turn arrow shape. Corresponds to ECMA-376 ST_ShapeType 'uturnArrow'",
- "Vertical scroll shape. Corresponds to ECMA-376 ST_ShapeType\n'verticalScroll'",
- "Wave shape. Corresponds to ECMA-376 ST_ShapeType 'wave'",
- "Callout wedge ellipse shape. Corresponds to ECMA-376 ST_ShapeType\n'wedgeEllipseCallout'",
- "Callout wedge rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'wedgeRectCallout'",
- "Callout wedge round rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'wedgeRoundRectCallout'",
- "Alternate process flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartAlternateProcess'",
- "Collate flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartCollate'",
- "Connector flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartConnector'",
- "Decision flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartDecision'",
- "Delay flow shape. Corresponds to ECMA-376 ST_ShapeType 'flowChartDelay'",
- "Display flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartDisplay'",
- "Document flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartDocument'",
- "Extract flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartExtract'",
- "Input output flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartInputOutput'",
- "Internal storage flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartInternalStorage'",
- "Magnetic disk flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartMagneticDisk'",
- "Magnetic drum flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartMagneticDrum'",
- "Magnetic tape flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartMagneticTape'",
- "Manual input flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartManualInput'",
- "Manual operation flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartManualOperation'",
- "Merge flow shape. Corresponds to ECMA-376 ST_ShapeType 'flowChartMerge'",
- "Multi-document flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartMultidocument'",
- "Offline storage flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartOfflineStorage'",
- "Off-page connector flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartOffpageConnector'",
- "Online storage flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartOnlineStorage'",
- "Or flow shape. Corresponds to ECMA-376 ST_ShapeType 'flowChartOr'",
- "Predefined process flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartPredefinedProcess'",
- "Preparation flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartPreparation'",
- "Process flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartProcess'",
- "Punched card flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartPunchedCard'",
- "Punched tape flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartPunchedTape'",
- "Sort flow shape. Corresponds to ECMA-376 ST_ShapeType 'flowChartSort'",
- "Summing junction flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartSummingJunction'",
- "Terminator flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartTerminator'",
- "East arrow shape.",
- "Northeast arrow shape.",
- "North arrow shape.",
- "Speech shape.",
- "Star burst shape.",
- "Teardrop shape. Corresponds to ECMA-376 ST_ShapeType 'teardrop'",
- "Ellipse ribbon shape. Corresponds to ECMA-376 ST_ShapeType\n'ellipseRibbon'",
- "Ellipse ribbon 2 shape. Corresponds to ECMA-376 ST_ShapeType\n'ellipseRibbon2'",
- "Callout cloud shape. Corresponds to ECMA-376 ST_ShapeType 'cloudCallout'",
- "Custom shape."
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "TEXT_BOX",
- "RECTANGLE",
- "ROUND_RECTANGLE",
- "ELLIPSE",
- "ARC",
- "BENT_ARROW",
- "BENT_UP_ARROW",
- "BEVEL",
- "BLOCK_ARC",
- "BRACE_PAIR",
- "BRACKET_PAIR",
- "CAN",
- "CHEVRON",
- "CHORD",
- "CLOUD",
- "CORNER",
- "CUBE",
- "CURVED_DOWN_ARROW",
- "CURVED_LEFT_ARROW",
- "CURVED_RIGHT_ARROW",
- "CURVED_UP_ARROW",
- "DECAGON",
- "DIAGONAL_STRIPE",
- "DIAMOND",
- "DODECAGON",
- "DONUT",
- "DOUBLE_WAVE",
- "DOWN_ARROW",
- "DOWN_ARROW_CALLOUT",
- "FOLDED_CORNER",
- "FRAME",
- "HALF_FRAME",
- "HEART",
- "HEPTAGON",
- "HEXAGON",
- "HOME_PLATE",
- "HORIZONTAL_SCROLL",
- "IRREGULAR_SEAL_1",
- "IRREGULAR_SEAL_2",
- "LEFT_ARROW",
- "LEFT_ARROW_CALLOUT",
- "LEFT_BRACE",
- "LEFT_BRACKET",
- "LEFT_RIGHT_ARROW",
- "LEFT_RIGHT_ARROW_CALLOUT",
- "LEFT_RIGHT_UP_ARROW",
- "LEFT_UP_ARROW",
- "LIGHTNING_BOLT",
- "MATH_DIVIDE",
- "MATH_EQUAL",
- "MATH_MINUS",
- "MATH_MULTIPLY",
- "MATH_NOT_EQUAL",
- "MATH_PLUS",
- "MOON",
- "NO_SMOKING",
- "NOTCHED_RIGHT_ARROW",
- "OCTAGON",
- "PARALLELOGRAM",
- "PENTAGON",
- "PIE",
- "PLAQUE",
- "PLUS",
- "QUAD_ARROW",
- "QUAD_ARROW_CALLOUT",
- "RIBBON",
- "RIBBON_2",
- "RIGHT_ARROW",
- "RIGHT_ARROW_CALLOUT",
- "RIGHT_BRACE",
- "RIGHT_BRACKET",
- "ROUND_1_RECTANGLE",
- "ROUND_2_DIAGONAL_RECTANGLE",
- "ROUND_2_SAME_RECTANGLE",
- "RIGHT_TRIANGLE",
- "SMILEY_FACE",
- "SNIP_1_RECTANGLE",
- "SNIP_2_DIAGONAL_RECTANGLE",
- "SNIP_2_SAME_RECTANGLE",
- "SNIP_ROUND_RECTANGLE",
- "STAR_10",
- "STAR_12",
- "STAR_16",
- "STAR_24",
- "STAR_32",
- "STAR_4",
- "STAR_5",
- "STAR_6",
- "STAR_7",
- "STAR_8",
- "STRIPED_RIGHT_ARROW",
- "SUN",
- "TRAPEZOID",
- "TRIANGLE",
- "UP_ARROW",
- "UP_ARROW_CALLOUT",
- "UP_DOWN_ARROW",
- "UTURN_ARROW",
- "VERTICAL_SCROLL",
- "WAVE",
- "WEDGE_ELLIPSE_CALLOUT",
- "WEDGE_RECTANGLE_CALLOUT",
- "WEDGE_ROUND_RECTANGLE_CALLOUT",
- "FLOW_CHART_ALTERNATE_PROCESS",
- "FLOW_CHART_COLLATE",
- "FLOW_CHART_CONNECTOR",
- "FLOW_CHART_DECISION",
- "FLOW_CHART_DELAY",
- "FLOW_CHART_DISPLAY",
- "FLOW_CHART_DOCUMENT",
- "FLOW_CHART_EXTRACT",
- "FLOW_CHART_INPUT_OUTPUT",
- "FLOW_CHART_INTERNAL_STORAGE",
- "FLOW_CHART_MAGNETIC_DISK",
- "FLOW_CHART_MAGNETIC_DRUM",
- "FLOW_CHART_MAGNETIC_TAPE",
- "FLOW_CHART_MANUAL_INPUT",
- "FLOW_CHART_MANUAL_OPERATION",
- "FLOW_CHART_MERGE",
- "FLOW_CHART_MULTIDOCUMENT",
- "FLOW_CHART_OFFLINE_STORAGE",
- "FLOW_CHART_OFFPAGE_CONNECTOR",
- "FLOW_CHART_ONLINE_STORAGE",
- "FLOW_CHART_OR",
- "FLOW_CHART_PREDEFINED_PROCESS",
- "FLOW_CHART_PREPARATION",
- "FLOW_CHART_PROCESS",
- "FLOW_CHART_PUNCHED_CARD",
- "FLOW_CHART_PUNCHED_TAPE",
- "FLOW_CHART_SORT",
- "FLOW_CHART_SUMMING_JUNCTION",
- "FLOW_CHART_TERMINATOR",
- "ARROW_EAST",
- "ARROW_NORTH_EAST",
- "ARROW_NORTH",
- "SPEECH",
- "STARBURST",
- "TEARDROP",
- "ELLIPSE_RIBBON",
- "ELLIPSE_RIBBON_2",
- "CLOUD_CALLOUT",
- "CUSTOM"
- ],
- "description": "The shape type."
- },
- "objectId": {
- "description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\nIf empty, a unique identifier will be generated.",
- "type": "string"
- },
- "elementProperties": {
- "$ref": "PageElementProperties",
- "description": "The element properties for the shape."
- }
- },
- "id": "CreateShapeRequest",
- "description": "Creates a new shape."
- },
- "Video": {
- "description": "A PageElement kind representing a\nvideo.",
- "type": "object",
- "properties": {
- "source": {
- "enum": [
- "SOURCE_UNSPECIFIED",
- "YOUTUBE"
- ],
- "description": "The video source.",
- "type": "string",
- "enumDescriptions": [
- "The video source is unspecified.",
- "The video source is YouTube."
- ]
- },
- "id": {
- "type": "string",
- "description": "The video source's unique identifier for this video."
- },
- "url": {
- "description": "An URL to a video. The URL is valid as long as the source video\nexists and sharing settings do not change.",
- "type": "string"
- },
- "videoProperties": {
- "$ref": "VideoProperties",
- "description": "The properties of the video."
- }
- },
- "id": "Video"
- },
- "PageProperties": {
- "description": "The properties of the Page.\n\nThe page will inherit properties from the parent page. Depending on the page\ntype the hierarchy is defined in either\nSlideProperties or\nLayoutProperties.",
- "type": "object",
- "properties": {
- "colorScheme": {
- "$ref": "ColorScheme",
- "description": "The color scheme of the page. If unset, the color scheme is inherited from\na parent page. If the page has no parent, the color scheme uses a default\nSlides color scheme. This field is read-only."
- },
- "pageBackgroundFill": {
- "$ref": "PageBackgroundFill",
- "description": "The background fill of the page. If unset, the background fill is inherited\nfrom a parent page if it exists. If the page has no parent, then the\nbackground fill defaults to the corresponding fill in the Slides editor."
- }
- },
- "id": "PageProperties"
- },
- "TableCell": {
- "type": "object",
- "properties": {
- "rowSpan": {
- "type": "integer",
- "format": "int32",
- "description": "Row span of the cell."
- },
- "location": {
- "$ref": "TableCellLocation",
- "description": "The location of the cell within the table."
- },
- "columnSpan": {
- "type": "integer",
- "format": "int32",
- "description": "Column span of the cell."
- },
- "text": {
- "$ref": "TextContent",
- "description": "The text content of the cell."
- },
- "tableCellProperties": {
- "$ref": "TableCellProperties",
- "description": "The properties of the table cell."
- }
- },
- "id": "TableCell",
- "description": "Properties and contents of each table cell."
- },
- "NestingLevel": {
- "type": "object",
- "properties": {
- "bulletStyle": {
- "$ref": "TextStyle",
- "description": "The style of a bullet at this level of nesting."
- }
- },
- "id": "NestingLevel",
- "description": "Contains properties describing the look and feel of a list bullet at a given\nlevel of nesting."
- },
- "UpdateLinePropertiesRequest": {
- "description": "Updates the properties of a Line.",
- "type": "object",
- "properties": {
- "lineProperties": {
- "$ref": "LineProperties",
- "description": "The line properties to update."
- },
- "fields": {
- "format": "google-fieldmask",
- "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `lineProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the line solid fill color, set `fields` to\n`\"lineFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
- "type": "string"
- },
- "objectId": {
- "description": "The object ID of the line the update is applied to.",
- "type": "string"
- }
- },
- "id": "UpdateLinePropertiesRequest"
- },
- "TableCellBackgroundFill": {
- "description": "The table cell background fill.",
- "type": "object",
- "properties": {
- "solidFill": {
- "$ref": "SolidFill",
- "description": "Solid color fill."
- },
- "propertyState": {
- "enum": [
- "RENDERED",
- "NOT_RENDERED",
- "INHERIT"
- ],
- "description": "The background fill property state.\n\nUpdating the the fill on a table cell will implicitly update this field\nto `RENDERED`, unless another value is specified in the same request. To\nhave no fill on a table cell, set this field to `NOT_RENDERED`. In this\ncase, any other fill fields set in the same request will be ignored.",
- "type": "string",
- "enumDescriptions": [
- "If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.",
- "If a property's state is NOT_RENDERED, then the element does not have the\ncorresponding property when rendered on a page. However, the field may\nstill be set so it can be inherited by child shapes. To remove a property\nfrom a rendered element, set its property_state to NOT_RENDERED.",
- "If a property's state is INHERIT, then the property state uses the value of\ncorresponding `property_state` field on the parent shape. Elements that do\nnot inherit will never have an INHERIT property state."
- ]
- }
- },
- "id": "TableCellBackgroundFill"
- },
- "UpdateSlidesPositionRequest": {
- "type": "object",
- "properties": {
- "insertionIndex": {
- "format": "int32",
- "description": "The index where the slides should be inserted, based on the slide\narrangement before the move takes place. Must be between zero and the\nnumber of slides in the presentation, inclusive.",
- "type": "integer"
- },
- "slideObjectIds": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "The IDs of the slides in the presentation that should be moved.\nThe slides in this list must be in existing presentation order, without\nduplicates."
- }
- },
- "id": "UpdateSlidesPositionRequest",
- "description": "Updates the position of slides in the presentation."
- },
- "UpdatePagePropertiesRequest": {
- "description": "Updates the properties of a Page.",
- "type": "object",
- "properties": {
- "fields": {
- "format": "google-fieldmask",
- "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `pageProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the page background solid fill color, set `fields`\nto `\"pageBackgroundFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
- "type": "string"
- },
- "pageProperties": {
- "$ref": "PageProperties",
- "description": "The page properties to update."
- },
- "objectId": {
- "description": "The object ID of the page the update is applied to.",
- "type": "string"
- }
- },
- "id": "UpdatePagePropertiesRequest"
- },
- "Group": {
- "type": "object",
- "properties": {
- "children": {
- "description": "The collection of elements in the group. The minimum size of a group is 2.",
- "items": {
- "$ref": "PageElement"
- },
- "type": "array"
- }
- },
- "id": "Group",
- "description": "A PageElement kind representing a\njoined collection of PageElements."
- },
- "Placeholder": {
- "description": "The placeholder information that uniquely identifies a placeholder shape.",
- "type": "object",
- "properties": {
- "type": {
- "enum": [
- "NONE",
- "BODY",
- "CHART",
- "CLIP_ART",
- "CENTERED_TITLE",
- "DIAGRAM",
- "DATE_AND_TIME",
- "FOOTER",
- "HEADER",
- "MEDIA",
- "OBJECT",
- "PICTURE",
- "SLIDE_NUMBER",
- "SUBTITLE",
- "TABLE",
- "TITLE",
- "SLIDE_IMAGE"
- ],
- "description": "The type of the placeholder.",
- "type": "string",
- "enumDescriptions": [
- "Default value, signifies it is not a placeholder.",
- "Body text.",
- "Chart or graph.",
- "Clip art image.",
- "Title centered.",
- "Diagram.",
- "Date and time.",
- "Footer text.",
- "Header text.",
- "Multimedia.",
- "Any content type.",
- "Picture.",
- "Number of a slide.",
- "Subtitle.",
- "Table.",
- "Slide title.",
- "Slide image."
- ]
- },
- "parentObjectId": {
- "type": "string",
- "description": "The object ID of this shape's parent placeholder.\nIf unset, the parent placeholder shape does not exist, so the shape does\nnot inherit properties from any other shape."
- },
- "index": {
- "type": "integer",
- "format": "int32",
- "description": "The index of the placeholder. If the same placeholder types are present in\nthe same page, they would have different index values."
- }
- },
- "id": "Placeholder"
- },
- "DuplicateObjectRequest": {
- "type": "object",
- "properties": {
- "objectIds": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "The object being duplicated may contain other objects, for example when\nduplicating a slide or a group page element. This map defines how the IDs\nof duplicated objects are generated: the keys are the IDs of the original\nobjects and its values are the IDs that will be assigned to the\ncorresponding duplicate object. The ID of the source object's duplicate\nmay be specified in this map as well, using the same value of the\n`object_id` field as a key and the newly desired ID as the value.\n\nAll keys must correspond to existing IDs in the presentation. All values\nmust be unique in the presentation and must start with an alphanumeric\ncharacter or an underscore (matches regex `[a-zA-Z0-9_]`); remaining\ncharacters may include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`). The length of the new ID must not be less than 5 or\ngreater than 50.\n\nIf any IDs of source objects are omitted from the map, a new random ID will\nbe assigned. If the map is empty or unset, all duplicate objects will\nreceive a new random ID.",
- "type": "object"
- },
- "objectId": {
- "description": "The ID of the object to duplicate.",
- "type": "string"
- }
- },
- "id": "DuplicateObjectRequest",
- "description": "Duplicates a slide or page element.\n\nWhen duplicating a slide, the duplicate slide will be created immediately\nfollowing the specified slide. When duplicating a page element, the duplicate\nwill be placed on the same page at the same position as the original."
- },
- "ReplaceAllTextRequest": {
- "type": "object",
- "properties": {
- "containsText": {
- "$ref": "SubstringMatchCriteria",
- "description": "Finds text in a shape matching this substring."
- },
- "pageObjectIds": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "If non-empty, limits the matches to page elements only on the given pages.\n\nReturns a 400 bad request error if given the page object ID of a\nnotes master,\nor if a page with that object ID doesn't exist in the presentation."
- },
- "replaceText": {
- "type": "string",
- "description": "The text that will replace the matched text."
- }
- },
- "id": "ReplaceAllTextRequest",
- "description": "Replaces all instances of text matching a criteria with replace text."
- },
- "Page": {
- "type": "object",
- "properties": {
- "layoutProperties": {
- "$ref": "LayoutProperties",
- "description": "Layout specific properties. Only set if page_type = LAYOUT."
- },
- "pageElements": {
- "description": "The page elements rendered on the page.",
- "items": {
- "$ref": "PageElement"
- },
- "type": "array"
- },
- "notesProperties": {
- "$ref": "NotesProperties",
- "description": "Notes specific properties. Only set if page_type = NOTES."
- },
- "pageType": {
- "type": "string",
- "enumDescriptions": [
- "A slide page.",
- "A master slide page.",
- "A layout page.",
- "A notes page.",
- "A notes master page."
- ],
- "enum": [
- "SLIDE",
- "MASTER",
- "LAYOUT",
- "NOTES",
- "NOTES_MASTER"
- ],
- "description": "The type of the page."
- },
- "pageProperties": {
- "$ref": "PageProperties",
- "description": "The properties of the page."
- },
- "slideProperties": {
- "$ref": "SlideProperties",
- "description": "Slide specific properties. Only set if page_type = SLIDE."
- },
- "masterProperties": {
- "$ref": "MasterProperties",
- "description": "Master specific properties. Only set if page_type = MASTER."
- },
- "objectId": {
- "type": "string",
- "description": "The object ID for this page. Object IDs used by\nPage and\nPageElement share the same namespace."
- },
- "revisionId": {
- "description": "The revision ID of the presentation containing this page. Can be used in\nupdate requests to assert that the presentation revision hasn't changed\nsince the last read operation. Only populated if the user has edit access\nto the presentation.\n\nThe format of the revision ID may change over time, so it should be treated\nopaquely. A returned revision ID is only guaranteed to be valid for 24\nhours after it has been returned and cannot be shared across users. If the\nrevision ID is unchanged between calls, then the presentation has not\nchanged. Conversely, a changed ID (for the same presentation and user)\nusually means the presentation has been updated; however, a changed ID can\nalso be due to internal factors such as ID format changes.",
- "type": "string"
- }
- },
- "id": "Page",
- "description": "A page in a presentation."
- },
- "UnmergeTableCellsRequest": {
- "type": "object",
- "properties": {
- "tableRange": {
- "$ref": "TableRange",
- "description": "The table range specifying which cells of the table to unmerge.\n\nAll merged cells in this range will be unmerged, and cells that are already\nunmerged will not be affected. If the range has no merged cells, the\nrequest will do nothing. If there is text in any of the merged cells, the\ntext will remain in the upper-left (\"head\") cell of the resulting block of\nunmerged cells."
- },
- "objectId": {
- "type": "string",
- "description": "The object ID of the table."
- }
- },
- "id": "UnmergeTableCellsRequest",
- "description": "Unmerges cells in a Table."
- },
- "ShapeBackgroundFill": {
- "type": "object",
- "properties": {
- "propertyState": {
- "type": "string",
- "enumDescriptions": [
- "If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.",
- "If a property's state is NOT_RENDERED, then the element does not have the\ncorresponding property when rendered on a page. However, the field may\nstill be set so it can be inherited by child shapes. To remove a property\nfrom a rendered element, set its property_state to NOT_RENDERED.",
- "If a property's state is INHERIT, then the property state uses the value of\ncorresponding `property_state` field on the parent shape. Elements that do\nnot inherit will never have an INHERIT property state."
- ],
- "enum": [
- "RENDERED",
- "NOT_RENDERED",
- "INHERIT"
- ],
- "description": "The background fill property state.\n\nUpdating the the fill on a shape will implicitly update this field to\n`RENDERED`, unless another value is specified in the same request. To\nhave no fill on a shape, set this field to `NOT_RENDERED`. In this case,\nany other fill fields set in the same request will be ignored."
- },
- "solidFill": {
- "$ref": "SolidFill",
- "description": "Solid color fill."
- }
- },
- "id": "ShapeBackgroundFill",
- "description": "The shape background fill."
- },
- "CropProperties": {
- "type": "object",
- "properties": {
- "rightOffset": {
- "format": "float",
- "description": "The offset specifies the right edge of the crop rectangle that is located\nto the left of the original bounding rectangle right edge, relative to the\nobject's original width.",
- "type": "number"
- },
- "bottomOffset": {
- "format": "float",
- "description": "The offset specifies the bottom edge of the crop rectangle that is located\nabove the original bounding rectangle bottom edge, relative to the object's\noriginal height.",
- "type": "number"
- },
- "angle": {
- "type": "number",
- "format": "float",
- "description": "The rotation angle of the crop window around its center, in radians.\nRotation angle is applied after the offset."
- },
- "topOffset": {
- "format": "float",
- "description": "The offset specifies the top edge of the crop rectangle that is located\nbelow the original bounding rectangle top edge, relative to the object's\noriginal height.",
- "type": "number"
- },
- "leftOffset": {
- "type": "number",
- "format": "float",
- "description": "The offset specifies the left edge of the crop rectangle that is located to\nthe right of the original bounding rectangle left edge, relative to the\nobject's original width."
- }
- },
- "id": "CropProperties",
- "description": "The crop properties of an object enclosed in a container. For example, an\nImage.\n\nThe crop properties is represented by the offsets of four edges which define\na crop rectangle. The offsets are measured in percentage from the\ncorresponding edges of the object's original bounding rectangle towards\ninside, relative to the object's original dimensions.\n\n- If the offset is in the interval (0, 1), the corresponding edge of crop\nrectangle is positioned inside of the object's original bounding rectangle.\n- If the offset is negative or greater than 1, the corresponding edge of crop\nrectangle is positioned outside of the object's original bounding rectangle.\n- If the left edge of the crop rectangle is on the right side of its right\nedge, the object will be flipped horizontally.\n- If the top edge of the crop rectangle is below its bottom edge, the object\nwill be flipped vertically.\n- If all offsets and rotation angle is 0, the object is not cropped.\n\nAfter cropping, the content in the crop rectangle will be stretched to fit\nits container."
- },
- "ReplaceAllShapesWithSheetsChartRequest": {
- "description": "Replaces all shapes that match the given criteria with the provided Google\nSheets chart. The chart will be scaled and centered to fit within the bounds\nof the original shape.\n\nNOTE: Replacing shapes with a chart requires at least one of the\nspreadsheets.readonly, spreadsheets, drive.readonly, or drive OAuth scopes.",
- "type": "object",
- "properties": {
- "linkingMode": {
- "type": "string",
- "enumDescriptions": [
- "The chart is not associated with the source spreadsheet and cannot be\nupdated. A chart that is not linked will be inserted as an image.",
- "Linking the chart allows it to be updated, and other collaborators will\nsee a link to the spreadsheet."
- ],
- "enum": [
- "NOT_LINKED_IMAGE",
- "LINKED"
- ],
- "description": "The mode with which the chart is linked to the source spreadsheet. When\nnot specified, the chart will be an image that is not linked."
- },
- "spreadsheetId": {
- "description": "The ID of the Google Sheets spreadsheet that contains the chart.",
- "type": "string"
- },
- "pageObjectIds": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "If non-empty, limits the matches to page elements only on the given pages.\n\nReturns a 400 bad request error if given the page object ID of a\nnotes page or a\nnotes master, or if a\npage with that object ID doesn't exist in the presentation."
- },
- "chartId": {
- "type": "integer",
- "format": "int32",
- "description": "The ID of the specific chart in the Google Sheets spreadsheet."
- },
- "containsText": {
- "$ref": "SubstringMatchCriteria",
- "description": "The criteria that the shapes must match in order to be replaced. The\nrequest will replace all of the shapes that contain the given text."
- }
- },
- "id": "ReplaceAllShapesWithSheetsChartRequest"
- },
- "Range": {
- "description": "Specifies a contiguous range of an indexed collection, such as characters in\ntext.",
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "enumDescriptions": [
- "Unspecified range type. This value must not be used.",
- "A fixed range. Both the `start_index` and\n`end_index` must be specified.",
- "Starts the range at `start_index` and continues until the\nend of the collection. The `end_index` must not be specified.",
- "Sets the range to be the whole length of the collection. Both the\n`start_index` and the `end_index` must not be\nspecified."
- ],
- "enum": [
- "RANGE_TYPE_UNSPECIFIED",
- "FIXED_RANGE",
- "FROM_START_INDEX",
- "ALL"
- ],
- "description": "The type of range."
- },
- "endIndex": {
- "format": "int32",
- "description": "The optional zero-based index of the end of the collection.\nRequired for `FIXED_RANGE` ranges.",
- "type": "integer"
- },
- "startIndex": {
- "type": "integer",
- "format": "int32",
- "description": "The optional zero-based index of the beginning of the collection.\nRequired for `FIXED_RANGE` and `FROM_START_INDEX` ranges."
- }
- },
- "id": "Range"
- },
- "ColorStop": {
- "type": "object",
- "properties": {
- "position": {
- "format": "float",
- "description": "The relative position of the color stop in the gradient band measured\nin percentage. The value should be in the interval [0.0, 1.0].",
- "type": "number"
- },
- "alpha": {
- "type": "number",
- "format": "float",
- "description": "The alpha value of this color in the gradient band. Defaults to 1.0,\nfully opaque."
- },
- "color": {
- "$ref": "OpaqueColor",
- "description": "The color of the gradient stop."
- }
- },
- "id": "ColorStop",
- "description": "A color and position in a gradient band."
- },
- "CreateVideoRequest": {
- "description": "Creates a video.",
- "type": "object",
- "properties": {
- "source": {
- "type": "string",
- "enumDescriptions": [
- "The video source is unspecified.",
- "The video source is YouTube."
- ],
- "enum": [
- "SOURCE_UNSPECIFIED",
- "YOUTUBE"
- ],
- "description": "The video source."
- },
- "objectId": {
- "type": "string",
- "description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated."
- },
- "elementProperties": {
- "$ref": "PageElementProperties",
- "description": "The element properties for the video."
- },
- "id": {
- "type": "string",
- "description": "The video source's unique identifier for this video.\n\ne.g. For YouTube video https://www.youtube.com/watch?v=7U3axjORYZ0,\nthe ID is 7U3axjORYZ0."
- }
- },
- "id": "CreateVideoRequest"
- },
- "DuplicateObjectResponse": {
- "description": "The response of duplicating an object.",
- "type": "object",
- "properties": {
- "objectId": {
- "type": "string",
- "description": "The ID of the new duplicate object."
- }
- },
- "id": "DuplicateObjectResponse"
- },
- "ReplaceAllShapesWithImageRequest": {
- "type": "object",
- "properties": {
- "imageUrl": {
- "type": "string",
- "description": "The image URL.\n\nThe image is fetched once at insertion time and a copy is stored for\ndisplay inside the presentation. Images must be less than 50MB in size,\ncannot exceed 25 megapixels, and must be in either in PNG, JPEG, or GIF\nformat.\n\nThe provided URL can be at maximum 2K bytes large."
- },
- "replaceMethod": {
- "enum": [
- "CENTER_INSIDE",
- "CENTER_CROP"
- ],
- "description": "The replace method.",
- "type": "string",
- "enumDescriptions": [
- "Scales and centers the image to fit within the bounds of the original\nshape and maintains the image's aspect ratio. The rendered size of the\nimage may be smaller than the size of the shape. This is the default\nmethod when one is not specified.",
- "Scales and centers the image to fill the bounds of the original shape.\nThe image may be cropped in order to fill the shape. The rendered size of\nthe image will be the same as that of the original shape."
- ]
- },
- "pageObjectIds": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "If non-empty, limits the matches to page elements only on the given pages.\n\nReturns a 400 bad request error if given the page object ID of a\nnotes page or a\nnotes master, or if a\npage with that object ID doesn't exist in the presentation."
- },
- "containsText": {
- "$ref": "SubstringMatchCriteria",
- "description": "If set, this request will replace all of the shapes that contain the\ngiven text."
- }
- },
- "id": "ReplaceAllShapesWithImageRequest",
- "description": "Replaces all shapes that match the given criteria with the provided image."
- },
- "MergeTableCellsRequest": {
- "type": "object",
- "properties": {
- "tableRange": {
- "$ref": "TableRange",
- "description": "The table range specifying which cells of the table to merge.\n\nAny text in the cells being merged will be concatenated and stored in the\nupper-left (\"head\") cell of the range. If the range is non-rectangular\n(which can occur in some cases where the range covers cells that are\nalready merged), a 400 bad request error is returned."
- },
- "objectId": {
- "type": "string",
- "description": "The object ID of the table."
- }
- },
- "id": "MergeTableCellsRequest",
- "description": "Merges cells in a Table."
- },
- "UngroupObjectsRequest": {
- "type": "object",
- "properties": {
- "objectIds": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "The object IDs of the objects to ungroup.\n\nOnly groups that are not inside other\ngroups can be ungrouped. All the groups\nshould be on the same page. The group itself is deleted. The visual sizes\nand positions of all the children are preserved."
- }
- },
- "id": "UngroupObjectsRequest",
- "description": "Ungroups objects, such as groups."
- },
- "Shadow": {
- "type": "object",
- "properties": {
- "rotateWithShape": {
- "description": "Whether the shadow should rotate with the shape.",
- "type": "boolean"
- },
- "propertyState": {
- "type": "string",
- "enumDescriptions": [
- "If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.",
- "If a property's state is NOT_RENDERED, then the element does not have the\ncorresponding property when rendered on a page. However, the field may\nstill be set so it can be inherited by child shapes. To remove a property\nfrom a rendered element, set its property_state to NOT_RENDERED.",
- "If a property's state is INHERIT, then the property state uses the value of\ncorresponding `property_state` field on the parent shape. Elements that do\nnot inherit will never have an INHERIT property state."
- ],
- "enum": [
- "RENDERED",
- "NOT_RENDERED",
- "INHERIT"
- ],
- "description": "The shadow property state.\n\nUpdating the the shadow on a page element will implicitly update this field\nto `RENDERED`, unless another value is specified in the same request. To\nhave no shadow on a page element, set this field to `NOT_RENDERED`. In this\ncase, any other shadow fields set in the same request will be ignored."
- },
- "blurRadius": {
- "$ref": "Dimension",
- "description": "The radius of the shadow blur. The larger the radius, the more diffuse the\nshadow becomes."
- },
- "type": {
- "type": "string",
- "enumDescriptions": [
- "Unspecified shadow type.",
- "Outer shadow."
- ],
- "enum": [
- "SHADOW_TYPE_UNSPECIFIED",
- "OUTER"
- ],
- "description": "The type of the shadow."
- },
- "transform": {
- "$ref": "AffineTransform",
- "description": "Transform that encodes the translate, scale, and skew of the shadow,\nrelative to the alignment position."
- },
- "alignment": {
- "type": "string",
- "enumDescriptions": [
- "Unspecified.",
- "Top left.",
- "Top center.",
- "Top right.",
- "Left center.",
- "Center.",
- "Right center.",
- "Bottom left.",
- "Bottom center.",
- "Bottom right."
- ],
- "enum": [
- "RECTANGLE_POSITION_UNSPECIFIED",
- "TOP_LEFT",
- "TOP_CENTER",
- "TOP_RIGHT",
- "LEFT_CENTER",
- "CENTER",
- "RIGHT_CENTER",
- "BOTTOM_LEFT",
- "BOTTOM_CENTER",
- "BOTTOM_RIGHT"
- ],
- "description": "The alignment point of the shadow, that sets the origin for translate,\nscale and skew of the shadow."
- },
- "alpha": {
- "format": "float",
- "description": "The alpha of the shadow's color, from 0.0 to 1.0.",
- "type": "number"
- },
- "color": {
- "$ref": "OpaqueColor",
- "description": "The shadow color value."
- }
- },
- "id": "Shadow",
- "description": "The shadow properties of a page element.\n\nIf these fields are unset, they may be inherited from a parent placeholder\nif it exists. If there is no parent, the fields will default to the value\nused for new page elements created in the Slides editor, which may depend on\nthe page element kind."
- },
- "DeleteTableRowRequest": {
- "description": "Deletes a row from a table.",
- "type": "object",
- "properties": {
- "cellLocation": {
- "$ref": "TableCellLocation",
- "description": "The reference table cell location from which a row will be deleted.\n\nThe row this cell spans will be deleted. If this is a merged cell, multiple\nrows will be deleted. If no rows remain in the table after this deletion,\nthe whole table is deleted."
- },
- "tableObjectId": {
- "type": "string",
- "description": "The table to delete rows from."
- }
- },
- "id": "DeleteTableRowRequest"
- },
- "Bullet": {
- "type": "object",
- "properties": {
- "glyph": {
- "type": "string",
- "description": "The rendered bullet glyph for this paragraph."
- },
- "nestingLevel": {
- "type": "integer",
- "format": "int32",
- "description": "The nesting level of this paragraph in the list."
- },
- "bulletStyle": {
- "$ref": "TextStyle",
- "description": "The paragraph specific text style applied to this bullet."
- },
- "listId": {
- "type": "string",
- "description": "The ID of the list this paragraph belongs to."
- }
- },
- "id": "Bullet",
- "description": "Describes the bullet of a paragraph."
- },
- "OutlineFill": {
- "description": "The fill of the outline.",
- "type": "object",
- "properties": {
- "solidFill": {
- "$ref": "SolidFill",
- "description": "Solid color fill."
- }
- },
- "id": "OutlineFill"
- },
- "CreateLineResponse": {
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the created line.",
- "type": "string"
- }
- },
- "id": "CreateLineResponse",
- "description": "The result of creating a line."
- },
- "TableCellLocation": {
- "type": "object",
- "properties": {
- "columnIndex": {
- "type": "integer",
- "format": "int32",
- "description": "The 0-based column index."
- },
- "rowIndex": {
- "type": "integer",
- "format": "int32",
- "description": "The 0-based row index."
- }
- },
- "id": "TableCellLocation",
- "description": "A location of a single table cell within a table."
- },
- "ReplaceAllTextResponse": {
- "type": "object",
- "properties": {
- "occurrencesChanged": {
- "type": "integer",
- "format": "int32",
- "description": "The number of occurrences changed by replacing all text."
- }
- },
- "id": "ReplaceAllTextResponse",
- "description": "The result of replacing text."
- },
- "TableBorderFill": {
- "description": "The fill of the border.",
- "type": "object",
- "properties": {
- "solidFill": {
- "$ref": "SolidFill",
- "description": "Solid fill."
- }
- },
- "id": "TableBorderFill"
- },
- "UpdateParagraphStyleRequest": {
- "type": "object",
- "properties": {
- "fields": {
- "type": "string",
- "format": "google-fieldmask",
- "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `style` is implied and\nshould not be specified. A single `\"*\"` can be used as short-hand for\nlisting every field.\n\nFor example, to update the paragraph alignment, set `fields` to\n`\"alignment\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset."
- },
- "textRange": {
- "$ref": "Range",
- "description": "The range of text containing the paragraph(s) to style."
- },
- "objectId": {
- "type": "string",
- "description": "The object ID of the shape or table with the text to be styled."
- },
- "style": {
- "$ref": "ParagraphStyle",
- "description": "The paragraph's style."
- },
- "cellLocation": {
- "$ref": "TableCellLocation",
- "description": "The location of the cell in the table containing the paragraph(s) to\nstyle. If `object_id` refers to a table, `cell_location` must have a value.\nOtherwise, it must not."
- }
- },
- "id": "UpdateParagraphStyleRequest",
- "description": "Updates the styling for all of the paragraphs within a Shape or Table that\noverlap with the given text index range."
- },
- "ColorScheme": {
- "type": "object",
- "properties": {
- "colors": {
- "items": {
- "$ref": "ThemeColorPair"
- },
- "type": "array",
- "description": "The ThemeColorType and corresponding concrete color pairs."
- }
- },
- "id": "ColorScheme",
- "description": "The palette of predefined colors for a page."
- },
- "Shape": {
- "description": "A PageElement kind representing a\ngeneric shape that does not have a more specific classification.",
- "type": "object",
- "properties": {
- "placeholder": {
- "$ref": "Placeholder",
- "description": "Placeholders are shapes that are inherit from corresponding placeholders on\nlayouts and masters.\n\nIf set, the shape is a placeholder shape and any inherited properties\ncan be resolved by looking at the parent placeholder identified by the\nPlaceholder.parent_object_id field."
- },
- "text": {
- "$ref": "TextContent",
- "description": "The text content of the shape."
- },
- "shapeType": {
- "type": "string",
- "enumDescriptions": [
- "The shape type that is not predefined.",
- "Text box shape.",
- "Rectangle shape. Corresponds to ECMA-376 ST_ShapeType 'rect'.",
- "Round corner rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'roundRect'",
- "Ellipse shape. Corresponds to ECMA-376 ST_ShapeType 'ellipse'",
- "Curved arc shape. Corresponds to ECMA-376 ST_ShapeType 'arc'",
- "Bent arrow shape. Corresponds to ECMA-376 ST_ShapeType 'bentArrow'",
- "Bent up arrow shape. Corresponds to ECMA-376 ST_ShapeType 'bentUpArrow'",
- "Bevel shape. Corresponds to ECMA-376 ST_ShapeType 'bevel'",
- "Block arc shape. Corresponds to ECMA-376 ST_ShapeType 'blockArc'",
- "Brace pair shape. Corresponds to ECMA-376 ST_ShapeType 'bracePair'",
- "Bracket pair shape. Corresponds to ECMA-376 ST_ShapeType 'bracketPair'",
- "Can shape. Corresponds to ECMA-376 ST_ShapeType 'can'",
- "Chevron shape. Corresponds to ECMA-376 ST_ShapeType 'chevron'",
- "Chord shape. Corresponds to ECMA-376 ST_ShapeType 'chord'",
- "Cloud shape. Corresponds to ECMA-376 ST_ShapeType 'cloud'",
- "Corner shape. Corresponds to ECMA-376 ST_ShapeType 'corner'",
- "Cube shape. Corresponds to ECMA-376 ST_ShapeType 'cube'",
- "Curved down arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'curvedDownArrow'",
- "Curved left arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'curvedLeftArrow'",
- "Curved right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'curvedRightArrow'",
- "Curved up arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'curvedUpArrow'",
- "Decagon shape. Corresponds to ECMA-376 ST_ShapeType 'decagon'",
- "Diagonal stripe shape. Corresponds to ECMA-376 ST_ShapeType 'diagStripe'",
- "Diamond shape. Corresponds to ECMA-376 ST_ShapeType 'diamond'",
- "Dodecagon shape. Corresponds to ECMA-376 ST_ShapeType 'dodecagon'",
- "Donut shape. Corresponds to ECMA-376 ST_ShapeType 'donut'",
- "Double wave shape. Corresponds to ECMA-376 ST_ShapeType 'doubleWave'",
- "Down arrow shape. Corresponds to ECMA-376 ST_ShapeType 'downArrow'",
- "Callout down arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'downArrowCallout'",
- "Folded corner shape. Corresponds to ECMA-376 ST_ShapeType 'foldedCorner'",
- "Frame shape. Corresponds to ECMA-376 ST_ShapeType 'frame'",
- "Half frame shape. Corresponds to ECMA-376 ST_ShapeType 'halfFrame'",
- "Heart shape. Corresponds to ECMA-376 ST_ShapeType 'heart'",
- "Heptagon shape. Corresponds to ECMA-376 ST_ShapeType 'heptagon'",
- "Hexagon shape. Corresponds to ECMA-376 ST_ShapeType 'hexagon'",
- "Home plate shape. Corresponds to ECMA-376 ST_ShapeType 'homePlate'",
- "Horizontal scroll shape. Corresponds to ECMA-376 ST_ShapeType\n'horizontalScroll'",
- "Irregular seal 1 shape. Corresponds to ECMA-376 ST_ShapeType\n'irregularSeal1'",
- "Irregular seal 2 shape. Corresponds to ECMA-376 ST_ShapeType\n'irregularSeal2'",
- "Left arrow shape. Corresponds to ECMA-376 ST_ShapeType 'leftArrow'",
- "Callout left arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'leftArrowCallout'",
- "Left brace shape. Corresponds to ECMA-376 ST_ShapeType 'leftBrace'",
- "Left bracket shape. Corresponds to ECMA-376 ST_ShapeType 'leftBracket'",
- "Left right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'leftRightArrow'",
- "Callout left right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'leftRightArrowCallout'",
- "Left right up arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'leftRightUpArrow'",
- "Left up arrow shape. Corresponds to ECMA-376 ST_ShapeType 'leftUpArrow'",
- "Lightning bolt shape. Corresponds to ECMA-376 ST_ShapeType\n'lightningBolt'",
- "Divide math shape. Corresponds to ECMA-376 ST_ShapeType 'mathDivide'",
- "Equal math shape. Corresponds to ECMA-376 ST_ShapeType 'mathEqual'",
- "Minus math shape. Corresponds to ECMA-376 ST_ShapeType 'mathMinus'",
- "Multiply math shape. Corresponds to ECMA-376 ST_ShapeType 'mathMultiply'",
- "Not equal math shape. Corresponds to ECMA-376 ST_ShapeType 'mathNotEqual'",
- "Plus math shape. Corresponds to ECMA-376 ST_ShapeType 'mathPlus'",
- "Moon shape. Corresponds to ECMA-376 ST_ShapeType 'moon'",
- "No smoking shape. Corresponds to ECMA-376 ST_ShapeType 'noSmoking'",
- "Notched right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'notchedRightArrow'",
- "Octagon shape. Corresponds to ECMA-376 ST_ShapeType 'octagon'",
- "Parallelogram shape. Corresponds to ECMA-376 ST_ShapeType 'parallelogram'",
- "Pentagon shape. Corresponds to ECMA-376 ST_ShapeType 'pentagon'",
- "Pie shape. Corresponds to ECMA-376 ST_ShapeType 'pie'",
- "Plaque shape. Corresponds to ECMA-376 ST_ShapeType 'plaque'",
- "Plus shape. Corresponds to ECMA-376 ST_ShapeType 'plus'",
- "Quad-arrow shape. Corresponds to ECMA-376 ST_ShapeType 'quadArrow'",
- "Callout quad-arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'quadArrowCallout'",
- "Ribbon shape. Corresponds to ECMA-376 ST_ShapeType 'ribbon'",
- "Ribbon 2 shape. Corresponds to ECMA-376 ST_ShapeType 'ribbon2'",
- "Right arrow shape. Corresponds to ECMA-376 ST_ShapeType 'rightArrow'",
- "Callout right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'rightArrowCallout'",
- "Right brace shape. Corresponds to ECMA-376 ST_ShapeType 'rightBrace'",
- "Right bracket shape. Corresponds to ECMA-376 ST_ShapeType 'rightBracket'",
- "One round corner rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'round1Rect'",
- "Two diagonal round corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'round2DiagRect'",
- "Two same-side round corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'round2SameRect'",
- "Right triangle shape. Corresponds to ECMA-376 ST_ShapeType 'rtTriangle'",
- "Smiley face shape. Corresponds to ECMA-376 ST_ShapeType 'smileyFace'",
- "One snip corner rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'snip1Rect'",
- "Two diagonal snip corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'snip2DiagRect'",
- "Two same-side snip corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'snip2SameRect'",
- "One snip one round corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'snipRoundRect'",
- "Ten pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star10'",
- "Twelve pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star12'",
- "Sixteen pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star16'",
- "Twenty four pointed star shape. Corresponds to ECMA-376 ST_ShapeType\n'star24'",
- "Thirty two pointed star shape. Corresponds to ECMA-376 ST_ShapeType\n'star32'",
- "Four pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star4'",
- "Five pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star5'",
- "Six pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star6'",
- "Seven pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star7'",
- "Eight pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star8'",
- "Striped right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'stripedRightArrow'",
- "Sun shape. Corresponds to ECMA-376 ST_ShapeType 'sun'",
- "Trapezoid shape. Corresponds to ECMA-376 ST_ShapeType 'trapezoid'",
- "Triangle shape. Corresponds to ECMA-376 ST_ShapeType 'triangle'",
- "Up arrow shape. Corresponds to ECMA-376 ST_ShapeType 'upArrow'",
- "Callout up arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'upArrowCallout'",
- "Up down arrow shape. Corresponds to ECMA-376 ST_ShapeType 'upDownArrow'",
- "U-turn arrow shape. Corresponds to ECMA-376 ST_ShapeType 'uturnArrow'",
- "Vertical scroll shape. Corresponds to ECMA-376 ST_ShapeType\n'verticalScroll'",
- "Wave shape. Corresponds to ECMA-376 ST_ShapeType 'wave'",
- "Callout wedge ellipse shape. Corresponds to ECMA-376 ST_ShapeType\n'wedgeEllipseCallout'",
- "Callout wedge rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'wedgeRectCallout'",
- "Callout wedge round rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'wedgeRoundRectCallout'",
- "Alternate process flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartAlternateProcess'",
- "Collate flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartCollate'",
- "Connector flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartConnector'",
- "Decision flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartDecision'",
- "Delay flow shape. Corresponds to ECMA-376 ST_ShapeType 'flowChartDelay'",
- "Display flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartDisplay'",
- "Document flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartDocument'",
- "Extract flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartExtract'",
- "Input output flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartInputOutput'",
- "Internal storage flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartInternalStorage'",
- "Magnetic disk flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartMagneticDisk'",
- "Magnetic drum flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartMagneticDrum'",
- "Magnetic tape flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartMagneticTape'",
- "Manual input flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartManualInput'",
- "Manual operation flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartManualOperation'",
- "Merge flow shape. Corresponds to ECMA-376 ST_ShapeType 'flowChartMerge'",
- "Multi-document flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartMultidocument'",
- "Offline storage flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartOfflineStorage'",
- "Off-page connector flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartOffpageConnector'",
- "Online storage flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartOnlineStorage'",
- "Or flow shape. Corresponds to ECMA-376 ST_ShapeType 'flowChartOr'",
- "Predefined process flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartPredefinedProcess'",
- "Preparation flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartPreparation'",
- "Process flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartProcess'",
- "Punched card flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartPunchedCard'",
- "Punched tape flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartPunchedTape'",
- "Sort flow shape. Corresponds to ECMA-376 ST_ShapeType 'flowChartSort'",
- "Summing junction flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartSummingJunction'",
- "Terminator flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartTerminator'",
- "East arrow shape.",
- "Northeast arrow shape.",
- "North arrow shape.",
- "Speech shape.",
- "Star burst shape.",
- "Teardrop shape. Corresponds to ECMA-376 ST_ShapeType 'teardrop'",
- "Ellipse ribbon shape. Corresponds to ECMA-376 ST_ShapeType\n'ellipseRibbon'",
- "Ellipse ribbon 2 shape. Corresponds to ECMA-376 ST_ShapeType\n'ellipseRibbon2'",
- "Callout cloud shape. Corresponds to ECMA-376 ST_ShapeType 'cloudCallout'",
- "Custom shape."
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "TEXT_BOX",
- "RECTANGLE",
- "ROUND_RECTANGLE",
- "ELLIPSE",
- "ARC",
- "BENT_ARROW",
- "BENT_UP_ARROW",
- "BEVEL",
- "BLOCK_ARC",
- "BRACE_PAIR",
- "BRACKET_PAIR",
- "CAN",
- "CHEVRON",
- "CHORD",
- "CLOUD",
- "CORNER",
- "CUBE",
- "CURVED_DOWN_ARROW",
- "CURVED_LEFT_ARROW",
- "CURVED_RIGHT_ARROW",
- "CURVED_UP_ARROW",
- "DECAGON",
- "DIAGONAL_STRIPE",
- "DIAMOND",
- "DODECAGON",
- "DONUT",
- "DOUBLE_WAVE",
- "DOWN_ARROW",
- "DOWN_ARROW_CALLOUT",
- "FOLDED_CORNER",
- "FRAME",
- "HALF_FRAME",
- "HEART",
- "HEPTAGON",
- "HEXAGON",
- "HOME_PLATE",
- "HORIZONTAL_SCROLL",
- "IRREGULAR_SEAL_1",
- "IRREGULAR_SEAL_2",
- "LEFT_ARROW",
- "LEFT_ARROW_CALLOUT",
- "LEFT_BRACE",
- "LEFT_BRACKET",
- "LEFT_RIGHT_ARROW",
- "LEFT_RIGHT_ARROW_CALLOUT",
- "LEFT_RIGHT_UP_ARROW",
- "LEFT_UP_ARROW",
- "LIGHTNING_BOLT",
- "MATH_DIVIDE",
- "MATH_EQUAL",
- "MATH_MINUS",
- "MATH_MULTIPLY",
- "MATH_NOT_EQUAL",
- "MATH_PLUS",
- "MOON",
- "NO_SMOKING",
- "NOTCHED_RIGHT_ARROW",
- "OCTAGON",
- "PARALLELOGRAM",
- "PENTAGON",
- "PIE",
- "PLAQUE",
- "PLUS",
- "QUAD_ARROW",
- "QUAD_ARROW_CALLOUT",
- "RIBBON",
- "RIBBON_2",
- "RIGHT_ARROW",
- "RIGHT_ARROW_CALLOUT",
- "RIGHT_BRACE",
- "RIGHT_BRACKET",
- "ROUND_1_RECTANGLE",
- "ROUND_2_DIAGONAL_RECTANGLE",
- "ROUND_2_SAME_RECTANGLE",
- "RIGHT_TRIANGLE",
- "SMILEY_FACE",
- "SNIP_1_RECTANGLE",
- "SNIP_2_DIAGONAL_RECTANGLE",
- "SNIP_2_SAME_RECTANGLE",
- "SNIP_ROUND_RECTANGLE",
- "STAR_10",
- "STAR_12",
- "STAR_16",
- "STAR_24",
- "STAR_32",
- "STAR_4",
- "STAR_5",
- "STAR_6",
- "STAR_7",
- "STAR_8",
- "STRIPED_RIGHT_ARROW",
- "SUN",
- "TRAPEZOID",
- "TRIANGLE",
- "UP_ARROW",
- "UP_ARROW_CALLOUT",
- "UP_DOWN_ARROW",
- "UTURN_ARROW",
- "VERTICAL_SCROLL",
- "WAVE",
- "WEDGE_ELLIPSE_CALLOUT",
- "WEDGE_RECTANGLE_CALLOUT",
- "WEDGE_ROUND_RECTANGLE_CALLOUT",
- "FLOW_CHART_ALTERNATE_PROCESS",
- "FLOW_CHART_COLLATE",
- "FLOW_CHART_CONNECTOR",
- "FLOW_CHART_DECISION",
- "FLOW_CHART_DELAY",
- "FLOW_CHART_DISPLAY",
- "FLOW_CHART_DOCUMENT",
- "FLOW_CHART_EXTRACT",
- "FLOW_CHART_INPUT_OUTPUT",
- "FLOW_CHART_INTERNAL_STORAGE",
- "FLOW_CHART_MAGNETIC_DISK",
- "FLOW_CHART_MAGNETIC_DRUM",
- "FLOW_CHART_MAGNETIC_TAPE",
- "FLOW_CHART_MANUAL_INPUT",
- "FLOW_CHART_MANUAL_OPERATION",
- "FLOW_CHART_MERGE",
- "FLOW_CHART_MULTIDOCUMENT",
- "FLOW_CHART_OFFLINE_STORAGE",
- "FLOW_CHART_OFFPAGE_CONNECTOR",
- "FLOW_CHART_ONLINE_STORAGE",
- "FLOW_CHART_OR",
- "FLOW_CHART_PREDEFINED_PROCESS",
- "FLOW_CHART_PREPARATION",
- "FLOW_CHART_PROCESS",
- "FLOW_CHART_PUNCHED_CARD",
- "FLOW_CHART_PUNCHED_TAPE",
- "FLOW_CHART_SORT",
- "FLOW_CHART_SUMMING_JUNCTION",
- "FLOW_CHART_TERMINATOR",
- "ARROW_EAST",
- "ARROW_NORTH_EAST",
- "ARROW_NORTH",
- "SPEECH",
- "STARBURST",
- "TEARDROP",
- "ELLIPSE_RIBBON",
- "ELLIPSE_RIBBON_2",
- "CLOUD_CALLOUT",
- "CUSTOM"
- ],
- "description": "The type of the shape."
- },
- "shapeProperties": {
- "$ref": "ShapeProperties",
- "description": "The properties of the shape."
- }
- },
- "id": "Shape"
- },
- "Image": {
- "description": "A PageElement kind representing an\nimage.",
- "type": "object",
- "properties": {
- "contentUrl": {
- "type": "string",
- "description": "An URL to an image with a default lifetime of 30 minutes.\nThis URL is tagged with the account of the requester. Anyone with the URL\neffectively accesses the image as the original requester. Access to the\nimage may be lost if the presentation's sharing settings change."
- },
- "imageProperties": {
- "$ref": "ImageProperties",
- "description": "The properties of the image."
- }
- },
- "id": "Image"
- },
- "AffineTransform": {
- "description": "AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ]\nto transform source coordinates (x,y) into destination coordinates (x', y')\naccording to:\n\n x' x = shear_y scale_y translate_y \n 1 [ 1 ]\n\nAfter transformation,\n\n x' = scale_x * x + shear_x * y + translate_x;\n y' = scale_y * y + shear_y * x + translate_y;\n\nThis message is therefore composed of these six matrix elements.",
- "type": "object",
- "properties": {
- "shearX": {
- "format": "double",
- "description": "The X coordinate shearing element.",
- "type": "number"
- },
- "scaleY": {
- "format": "double",
- "description": "The Y coordinate scaling element.",
- "type": "number"
- },
- "translateY": {
- "format": "double",
- "description": "The Y coordinate translation element.",
- "type": "number"
- },
- "translateX": {
- "type": "number",
- "format": "double",
- "description": "The X coordinate translation element."
- },
- "shearY": {
- "type": "number",
- "format": "double",
- "description": "The Y coordinate shearing element."
- },
- "unit": {
- "enum": [
- "UNIT_UNSPECIFIED",
- "EMU",
- "PT"
- ],
- "description": "The units for translate elements.",
- "type": "string",
- "enumDescriptions": [
- "The units are unknown.",
- "An English Metric Unit (EMU) is defined as 1/360,000 of a centimeter\nand thus there are 914,400 EMUs per inch, and 12,700 EMUs per point.",
- "A point, 1/72 of an inch."
- ]
- },
- "scaleX": {
- "format": "double",
- "description": "The X coordinate scaling element.",
- "type": "number"
- }
- },
- "id": "AffineTransform"
- },
- "InsertTextRequest": {
- "description": "Inserts text into a shape or a table cell.",
- "type": "object",
- "properties": {
- "text": {
- "description": "The text to be inserted.\n\nInserting a newline character will implicitly create a new\nParagraphMarker at that index.\nThe paragraph style of the new paragraph will be copied from the paragraph\nat the current insertion index, including lists and bullets.\n\nText styles for inserted text will be determined automatically, generally\npreserving the styling of neighboring text. In most cases, the text will be\nadded to the TextRun that exists at the\ninsertion index.\n\nSome control characters (U+0000-U+0008, U+000C-U+001F) and characters\nfrom the Unicode Basic Multilingual Plane Private Use Area (U+E000-U+F8FF)\nwill be stripped out of the inserted text.",
- "type": "string"
- },
- "objectId": {
- "type": "string",
- "description": "The object ID of the shape or table where the text will be inserted."
- },
- "insertionIndex": {
- "format": "int32",
- "description": "The index where the text will be inserted, in Unicode code units, based\non TextElement indexes.\n\nThe index is zero-based and is computed from the start of the string.\nThe index may be adjusted to prevent insertions inside Unicode grapheme\nclusters. In these cases, the text will be inserted immediately after the\ngrapheme cluster.",
- "type": "integer"
- },
- "cellLocation": {
- "$ref": "TableCellLocation",
- "description": "The optional table cell location if the text is to be inserted into a table\ncell. If present, the object_id must refer to a table."
- }
- },
- "id": "InsertTextRequest"
- },
- "AutoText": {
- "type": "object",
- "properties": {
- "content": {
- "type": "string",
- "description": "The rendered content of this auto text, if available."
- },
- "type": {
- "type": "string",
- "enumDescriptions": [
- "An unspecified autotext type.",
- "Type for autotext that represents the current slide number."
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "SLIDE_NUMBER"
- ],
- "description": "The type of this auto text."
- },
- "style": {
- "$ref": "TextStyle",
- "description": "The styling applied to this auto text."
- }
- },
- "id": "AutoText",
- "description": "A TextElement kind that represents auto text."
- },
- "CreateVideoResponse": {
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the created video.",
- "type": "string"
- }
- },
- "id": "CreateVideoResponse",
- "description": "The result of creating a video."
- },
- "UpdatePageElementTransformRequest": {
- "type": "object",
- "properties": {
- "transform": {
- "$ref": "AffineTransform",
- "description": "The input transform matrix used to update the page element."
- },
- "objectId": {
- "type": "string",
- "description": "The object ID of the page element to update."
- },
- "applyMode": {
- "type": "string",
- "enumDescriptions": [
- "Unspecified mode.",
- "Applies the new AffineTransform matrix to the existing one, and\nreplaces the existing one with the resulting concatenation.",
- "Replaces the existing AffineTransform matrix with the new one."
- ],
- "enum": [
- "APPLY_MODE_UNSPECIFIED",
- "RELATIVE",
- "ABSOLUTE"
- ],
- "description": "The apply mode of the transform update."
- }
- },
- "id": "UpdatePageElementTransformRequest",
- "description": "Updates the transform of a page element.\n\nUpdating the transform of a group will change the absolute transform of the\npage elements in that group, which can change their visual appearance. See\nthe documentation for PageElement.transform for more details."
- },
- "DeleteTextRequest": {
- "type": "object",
- "properties": {
- "textRange": {
- "$ref": "Range",
- "description": "The range of text to delete, based on TextElement indexes.\n\nThere is always an implicit newline character at the end of a shape's or\ntable cell's text that cannot be deleted. `Range.Type.ALL` will use the\ncorrect bounds, but care must be taken when specifying explicit bounds for\nrange types `FROM_START_INDEX` and `FIXED_RANGE`. For example, if the text\nis \"ABC\", followed by an implicit newline, then the maximum value is 2 for\n`text_range.start_index` and 3 for `text_range.end_index`.\n\nDeleting text that crosses a paragraph boundary may result in changes\nto paragraph styles and lists as the two paragraphs are merged.\n\nRanges that include only one code unit of a surrogate pair are expanded to\ninclude both code units."
- },
- "objectId": {
- "description": "The object ID of the shape or table from which the text will be deleted.",
- "type": "string"
- },
- "cellLocation": {
- "$ref": "TableCellLocation",
- "description": "The optional table cell location if the text is to be deleted from a table\ncell. If present, the object_id must refer to a table."
- }
- },
- "id": "DeleteTextRequest",
- "description": "Deletes text from a shape or a table cell."
- },
- "DeleteObjectRequest": {
- "description": "Deletes an object, either pages or\npage elements, from the\npresentation.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the page or page element to delete.\n\nIf after a delete operation a group contains\nonly 1 or no page elements, the group is also deleted.\n\nIf a placeholder is deleted on a layout, any empty inheriting shapes are\nalso deleted.",
- "type": "string"
- }
- },
- "id": "DeleteObjectRequest"
- },
- "TextElement": {
- "type": "object",
- "properties": {
- "endIndex": {
- "format": "int32",
- "description": "The zero-based end index of this text element, exclusive, in Unicode code\nunits.",
- "type": "integer"
- },
- "startIndex": {
- "type": "integer",
- "format": "int32",
- "description": "The zero-based start index of this text element, in Unicode code units."
- },
- "textRun": {
- "$ref": "TextRun",
- "description": "A TextElement representing a run of text where all of the characters\nin the run have the same TextStyle.\n\nThe `start_index` and `end_index` of TextRuns will always be fully\ncontained in the index range of a single `paragraph_marker` TextElement.\nIn other words, a TextRun will never span multiple paragraphs."
- },
- "autoText": {
- "$ref": "AutoText",
- "description": "A TextElement representing a spot in the text that is dynamically\nreplaced with content that can change over time."
- },
- "paragraphMarker": {
- "$ref": "ParagraphMarker",
- "description": "A marker representing the beginning of a new paragraph.\n\nThe `start_index` and `end_index` of this TextElement represent the\nrange of the paragraph. Other TextElements with an index range contained\ninside this paragraph's range are considered to be part of this\nparagraph. The range of indices of two separate paragraphs will never\noverlap."
- }
- },
- "id": "TextElement",
- "description": "A TextElement describes the content of a range of indices in the text content\nof a Shape or TableCell."
- },
- "Dimension": {
- "description": "A magnitude in a single direction in the specified units.",
- "type": "object",
- "properties": {
- "magnitude": {
- "type": "number",
- "format": "double",
- "description": "The magnitude."
- },
- "unit": {
- "type": "string",
- "enumDescriptions": [
- "The units are unknown.",
- "An English Metric Unit (EMU) is defined as 1/360,000 of a centimeter\nand thus there are 914,400 EMUs per inch, and 12,700 EMUs per point.",
- "A point, 1/72 of an inch."
- ],
- "enum": [
- "UNIT_UNSPECIFIED",
- "EMU",
- "PT"
- ],
- "description": "The units for magnitude."
- }
- },
- "id": "Dimension"
- },
- "LineFill": {
- "type": "object",
- "properties": {
- "solidFill": {
- "$ref": "SolidFill",
- "description": "Solid color fill."
- }
- },
- "id": "LineFill",
- "description": "The fill of the line."
- },
- "VideoProperties": {
- "type": "object",
- "properties": {
- "outline": {
- "$ref": "Outline",
- "description": "The outline of the video. The default outline matches the defaults for new\nvideos created in the Slides editor."
- }
- },
- "id": "VideoProperties",
- "description": "The properties of the Video."
- },
- "InsertTableRowsRequest": {
- "description": "Inserts rows into a table.",
- "type": "object",
- "properties": {
- "tableObjectId": {
- "description": "The table to insert rows into.",
- "type": "string"
- },
- "insertBelow": {
- "description": "Whether to insert new rows below the reference cell location.\n\n- `True`: insert below the cell.\n- `False`: insert above the cell.",
- "type": "boolean"
- },
- "number": {
- "type": "integer",
- "format": "int32",
- "description": "The number of rows to be inserted. Maximum 20 per request."
- },
- "cellLocation": {
- "$ref": "TableCellLocation",
- "description": "The reference table cell location from which rows will be inserted.\n\nA new row will be inserted above (or below) the row where the reference\ncell is. If the reference cell is a merged cell, a new row will be\ninserted above (or below) the merged cell."
- }
- },
- "id": "InsertTableRowsRequest"
- },
- "LayoutProperties": {
- "description": "The properties of Page are only\nrelevant for pages with page_type LAYOUT.",
- "type": "object",
- "properties": {
- "masterObjectId": {
- "description": "The object ID of the master that this layout is based on.",
- "type": "string"
- },
- "name": {
- "type": "string",
- "description": "The name of the layout."
- },
- "displayName": {
- "type": "string",
- "description": "The human-readable name of the layout."
- }
- },
- "id": "LayoutProperties"
- },
- "LineProperties": {
- "type": "object",
- "properties": {
- "link": {
- "$ref": "Link",
- "description": "The hyperlink destination of the line. If unset, there is no link."
- },
- "dashStyle": {
- "type": "string",
- "enumDescriptions": [
- "Unspecified dash style.",
- "Solid line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'solid'.\nThis is the default dash style.",
- "Dotted line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dot'.",
- "Dashed line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dash'.",
- "Alternating dashes and dots. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'dashDot'.",
- "Line with large dashes. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'lgDash'.",
- "Alternating large dashes and dots. Corresponds to ECMA-376\nST_PresetLineDashVal value 'lgDashDot'."
- ],
- "enum": [
- "DASH_STYLE_UNSPECIFIED",
- "SOLID",
- "DOT",
- "DASH",
- "DASH_DOT",
- "LONG_DASH",
- "LONG_DASH_DOT"
- ],
- "description": "The dash style of the line."
- },
- "startArrow": {
- "type": "string",
- "enumDescriptions": [
- "An unspecified arrow style.",
- "No arrow.",
- "Arrow with notched back. Corresponds to ECMA-376 ST_LineEndType value\n'stealth'.",
- "Filled arrow. Corresponds to ECMA-376 ST_LineEndType value 'triangle'.",
- "Filled circle. Corresponds to ECMA-376 ST_LineEndType value 'oval'.",
- "Filled square.",
- "Filled diamond. Corresponds to ECMA-376 ST_LineEndType value 'diamond'.",
- "Hollow arrow.",
- "Hollow circle.",
- "Hollow square.",
- "Hollow diamond."
- ],
- "enum": [
- "ARROW_STYLE_UNSPECIFIED",
- "NONE",
- "STEALTH_ARROW",
- "FILL_ARROW",
- "FILL_CIRCLE",
- "FILL_SQUARE",
- "FILL_DIAMOND",
- "OPEN_ARROW",
- "OPEN_CIRCLE",
- "OPEN_SQUARE",
- "OPEN_DIAMOND"
- ],
- "description": "The style of the arrow at the beginning of the line."
- },
- "endArrow": {
- "type": "string",
- "enumDescriptions": [
- "An unspecified arrow style.",
- "No arrow.",
- "Arrow with notched back. Corresponds to ECMA-376 ST_LineEndType value\n'stealth'.",
- "Filled arrow. Corresponds to ECMA-376 ST_LineEndType value 'triangle'.",
- "Filled circle. Corresponds to ECMA-376 ST_LineEndType value 'oval'.",
- "Filled square.",
- "Filled diamond. Corresponds to ECMA-376 ST_LineEndType value 'diamond'.",
- "Hollow arrow.",
- "Hollow circle.",
- "Hollow square.",
- "Hollow diamond."
- ],
- "enum": [
- "ARROW_STYLE_UNSPECIFIED",
- "NONE",
- "STEALTH_ARROW",
- "FILL_ARROW",
- "FILL_CIRCLE",
- "FILL_SQUARE",
- "FILL_DIAMOND",
- "OPEN_ARROW",
- "OPEN_CIRCLE",
- "OPEN_SQUARE",
- "OPEN_DIAMOND"
- ],
- "description": "The style of the arrow at the end of the line."
- },
- "weight": {
- "$ref": "Dimension",
- "description": "The thickness of the line."
- },
- "lineFill": {
- "$ref": "LineFill",
- "description": "The fill of the line. The default line fill matches the defaults for new\nlines created in the Slides editor."
- }
- },
- "id": "LineProperties",
- "description": "The properties of the Line.\n\nWhen unset, these fields default to values that match the appearance of\nnew lines created in the Slides editor."
- },
- "Presentation": {
- "type": "object",
- "properties": {
- "layouts": {
- "items": {
- "$ref": "Page"
- },
- "type": "array",
- "description": "The layouts in the presentation. A layout is a template that determines\nhow content is arranged and styled on the slides that inherit from that\nlayout."
- },
- "title": {
- "type": "string",
- "description": "The title of the presentation."
- },
- "locale": {
- "type": "string",
- "description": "The locale of the presentation, as an IETF BCP 47 language tag."
- },
- "masters": {
- "description": "The slide masters in the presentation. A slide master contains all common\npage elements and the common properties for a set of layouts. They serve\nthree purposes:\n\n- Placeholder shapes on a master contain the default text styles and shape\n properties of all placeholder shapes on pages that use that master.\n- The master page properties define the common page properties inherited by\n its layouts.\n- Any other shapes on the master slide will appear on all slides using that\n master, regardless of their layout.",
- "items": {
- "$ref": "Page"
- },
- "type": "array"
- },
- "pageSize": {
- "$ref": "Size",
- "description": "The size of pages in the presentation."
- },
- "presentationId": {
- "description": "The ID of the presentation.",
- "type": "string"
- },
- "slides": {
- "description": "The slides in the presentation.\nA slide inherits properties from a slide layout.",
- "items": {
- "$ref": "Page"
- },
- "type": "array"
- },
- "revisionId": {
- "description": "The revision ID of the presentation. Can be used in update requests\nto assert that the presentation revision hasn't changed since the last\nread operation. Only populated if the user has edit access to the\npresentation.\n\nThe format of the revision ID may change over time, so it should be treated\nopaquely. A returned revision ID is only guaranteed to be valid for 24\nhours after it has been returned and cannot be shared across users. If the\nrevision ID is unchanged between calls, then the presentation has not\nchanged. Conversely, a changed ID (for the same presentation and user)\nusually means the presentation has been updated; however, a changed ID can\nalso be due to internal factors such as ID format changes.",
- "type": "string"
- },
- "notesMaster": {
- "$ref": "Page",
- "description": "The notes master in the presentation. It serves three purposes:\n\n- Placeholder shapes on a notes master contain the default text styles and\n shape properties of all placeholder shapes on notes pages. Specifically,\n a `SLIDE_IMAGE` placeholder shape contains the slide thumbnail, and a\n `BODY` placeholder shape contains the speaker notes.\n- The notes master page properties define the common page properties\n inherited by all notes pages.\n- Any other shapes on the notes master will appear on all notes pages.\n\nThe notes master is read-only."
- }
- },
- "id": "Presentation",
- "description": "A Google Slides presentation."
- },
- "OpaqueColor": {
- "description": "A themeable solid color value.",
- "type": "object",
- "properties": {
- "rgbColor": {
- "$ref": "RgbColor",
- "description": "An opaque RGB color."
- },
- "themeColor": {
- "type": "string",
- "enumDescriptions": [
- "Unspecified theme color. This value should not be used.",
- "Represents the first dark color.",
- "Represents the first light color.",
- "Represents the second dark color.",
- "Represents the second light color.",
- "Represents the first accent color.",
- "Represents the second accent color.",
- "Represents the third accent color.",
- "Represents the fourth accent color.",
- "Represents the fifth accent color.",
- "Represents the sixth accent color.",
- "Represents the color to use for hyperlinks.",
- "Represents the color to use for visited hyperlinks.",
- "Represents the first text color.",
- "Represents the first background color.",
- "Represents the second text color.",
- "Represents the second background color."
- ],
- "enum": [
- "THEME_COLOR_TYPE_UNSPECIFIED",
- "DARK1",
- "LIGHT1",
- "DARK2",
- "LIGHT2",
- "ACCENT1",
- "ACCENT2",
- "ACCENT3",
- "ACCENT4",
- "ACCENT5",
- "ACCENT6",
- "HYPERLINK",
- "FOLLOWED_HYPERLINK",
- "TEXT1",
- "BACKGROUND1",
- "TEXT2",
- "BACKGROUND2"
- ],
- "description": "An opaque theme color."
- }
- },
- "id": "OpaqueColor"
- },
- "ImageProperties": {
- "description": "The properties of the Image.",
- "type": "object",
- "properties": {
- "brightness": {
- "type": "number",
- "format": "float",
- "description": "The brightness effect of the image. The value should be in the interval\n[-1.0, 1.0], where 0 means no effect. This property is read-only."
- },
- "transparency": {
- "format": "float",
- "description": "The transparency effect of the image. The value should be in the interval\n[0.0, 1.0], where 0 means no effect and 1 means completely transparent.\nThis property is read-only.",
- "type": "number"
- },
- "shadow": {
- "$ref": "Shadow",
- "description": "The shadow of the image. If not set, the image has no shadow. This property\nis read-only."
- },
- "contrast": {
- "format": "float",
- "description": "The contrast effect of the image. The value should be in the interval\n[-1.0, 1.0], where 0 means no effect. This property is read-only.",
- "type": "number"
- },
- "link": {
- "$ref": "Link",
- "description": "The hyperlink destination of the image. If unset, there is no link."
- },
- "recolor": {
- "$ref": "Recolor",
- "description": "The recolor effect of the image. If not set, the image is not recolored.\nThis property is read-only."
- },
- "cropProperties": {
- "$ref": "CropProperties",
- "description": "The crop properties of the image. If not set, the image is not cropped.\nThis property is read-only."
- },
- "outline": {
- "$ref": "Outline",
- "description": "The outline of the image. If not set, the the image has no outline."
- }
- },
- "id": "ImageProperties"
- },
- "ReplaceAllShapesWithImageResponse": {
- "type": "object",
- "properties": {
- "occurrencesChanged": {
- "format": "int32",
- "description": "The number of shapes replaced with images.",
- "type": "integer"
- }
- },
- "id": "ReplaceAllShapesWithImageResponse",
- "description": "The result of replacing shapes with an image."
- },
- "Line": {
- "description": "A PageElement kind representing a\nline, curved connector, or bent connector.",
- "type": "object",
- "properties": {
- "lineType": {
- "type": "string",
- "enumDescriptions": [
- "An unspecified line type.",
- "Straight connector 1 form. Corresponds to ECMA-376 ST_ShapeType\n'straightConnector1'.",
- "Bent connector 2 form. Corresponds to ECMA-376 ST_ShapeType\n'bentConnector2'.",
- "Bent connector 3 form. Corresponds to ECMA-376 ST_ShapeType\n'bentConnector3'.",
- "Bent connector 4 form. Corresponds to ECMA-376 ST_ShapeType\n'bentConnector4'.",
- "Bent connector 5 form. Corresponds to ECMA-376 ST_ShapeType\n'bentConnector5'.",
- "Curved connector 2 form. Corresponds to ECMA-376 ST_ShapeType\n'curvedConnector2'.",
- "Curved connector 3 form. Corresponds to ECMA-376 ST_ShapeType\n'curvedConnector3'.",
- "Curved connector 4 form. Corresponds to ECMA-376 ST_ShapeType\n'curvedConnector4'.",
- "Curved connector 5 form. Corresponds to ECMA-376 ST_ShapeType\n'curvedConnector5'."
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "STRAIGHT_CONNECTOR_1",
- "BENT_CONNECTOR_2",
- "BENT_CONNECTOR_3",
- "BENT_CONNECTOR_4",
- "BENT_CONNECTOR_5",
- "CURVED_CONNECTOR_2",
- "CURVED_CONNECTOR_3",
- "CURVED_CONNECTOR_4",
- "CURVED_CONNECTOR_5"
- ],
- "description": "The type of the line."
- },
- "lineProperties": {
- "$ref": "LineProperties",
- "description": "The properties of the line."
- }
- },
- "id": "Line"
- },
- "BatchUpdatePresentationResponse": {
- "type": "object",
- "properties": {
- "replies": {
- "items": {
- "$ref": "Response"
- },
- "type": "array",
- "description": "The reply of the updates. This maps 1:1 with the updates, although\nreplies to some requests may be empty."
- },
- "presentationId": {
- "description": "The presentation the updates were applied to.",
- "type": "string"
- }
- },
- "id": "BatchUpdatePresentationResponse",
- "description": "Response message from a batch update."
- },
- "CreateSheetsChartRequest": {
- "type": "object",
- "properties": {
- "objectId": {
- "description": "A user-supplied object ID.\n\nIf specified, the ID must be unique among all pages and page elements in\nthe presentation. The ID should start with a word character [a-zA-Z0-9_]\nand then followed by any number of the following characters [a-zA-Z0-9_-:].\nThe length of the ID should not be less than 5 or greater than 50.\nIf empty, a unique identifier will be generated.",
- "type": "string"
- },
- "elementProperties": {
- "$ref": "PageElementProperties",
- "description": "The element properties for the chart.\n\nWhen the aspect ratio of the provided size does not match the chart aspect\nratio, the chart is scaled and centered with respect to the size in order\nto maintain aspect ratio. The provided transform is applied after this\noperation."
- },
- "linkingMode": {
- "type": "string",
- "enumDescriptions": [
- "The chart is not associated with the source spreadsheet and cannot be\nupdated. A chart that is not linked will be inserted as an image.",
- "Linking the chart allows it to be updated, and other collaborators will\nsee a link to the spreadsheet."
- ],
- "enum": [
- "NOT_LINKED_IMAGE",
- "LINKED"
- ],
- "description": "The mode with which the chart is linked to the source spreadsheet. When\nnot specified, the chart will be an image that is not linked."
- },
- "spreadsheetId": {
- "type": "string",
- "description": "The ID of the Google Sheets spreadsheet that contains the chart."
- },
- "chartId": {
- "type": "integer",
- "format": "int32",
- "description": "The ID of the specific chart in the Google Sheets spreadsheet."
- }
- },
- "id": "CreateSheetsChartRequest",
- "description": "Creates an embedded Google Sheets chart.\n\nNOTE: Chart creation requires at least one of the spreadsheets.readonly,\nspreadsheets, drive.readonly, or drive OAuth scopes."
- },
- "CreateImageResponse": {
- "description": "The result of creating an image.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the created image.",
- "type": "string"
- }
- },
- "id": "CreateImageResponse"
- },
- "SlideProperties": {
- "description": "The properties of Page that are only\nrelevant for pages with page_type SLIDE.",
- "type": "object",
- "properties": {
- "masterObjectId": {
- "type": "string",
- "description": "The object ID of the master that this slide is based on."
- },
- "layoutObjectId": {
- "type": "string",
- "description": "The object ID of the layout that this slide is based on."
- },
- "notesPage": {
- "$ref": "Page",
- "description": "The notes page that this slide is associated with. It defines the visual\nappearance of a notes page when printing or exporting slides with speaker\nnotes. A notes page inherits properties from the\nnotes master.\nThe placeholder shape with type BODY on the notes page contains the speaker\nnotes for this slide. The ID of this shape is identified by the\nspeakerNotesObjectId field.\nThe notes page is read-only except for the text content and styles of the\nspeaker notes shape."
- }
- },
- "id": "SlideProperties"
- },
- "MasterProperties": {
- "type": "object",
- "properties": {
- "displayName": {
- "type": "string",
- "description": "The human-readable name of the master."
- }
- },
- "id": "MasterProperties",
- "description": "The properties of Page that are only\nrelevant for pages with page_type MASTER."
- },
- "Response": {
- "description": "A single response from an update.",
- "type": "object",
- "properties": {
- "replaceAllShapesWithImage": {
- "$ref": "ReplaceAllShapesWithImageResponse",
- "description": "The result of replacing all shapes matching some criteria with an\nimage."
- },
- "createTable": {
- "$ref": "CreateTableResponse",
- "description": "The result of creating a table."
- },
- "replaceAllText": {
- "$ref": "ReplaceAllTextResponse",
- "description": "The result of replacing text."
- },
- "createSlide": {
- "$ref": "CreateSlideResponse",
- "description": "The result of creating a slide."
- },
- "duplicateObject": {
- "$ref": "DuplicateObjectResponse",
- "description": "The result of duplicating an object."
- },
- "createLine": {
- "$ref": "CreateLineResponse",
- "description": "The result of creating a line."
- },
- "createImage": {
- "$ref": "CreateImageResponse",
- "description": "The result of creating an image."
- },
- "createVideo": {
- "$ref": "CreateVideoResponse",
- "description": "The result of creating a video."
- },
- "createSheetsChart": {
- "$ref": "CreateSheetsChartResponse",
- "description": "The result of creating a Google Sheets chart."
- },
- "replaceAllShapesWithSheetsChart": {
- "$ref": "ReplaceAllShapesWithSheetsChartResponse",
- "description": "The result of replacing all shapes matching some criteria with a Google\nSheets chart."
- },
- "groupObjects": {
- "$ref": "GroupObjectsResponse",
- "description": "The result of grouping objects."
- },
- "createShape": {
- "$ref": "CreateShapeResponse",
- "description": "The result of creating a shape."
- }
- },
- "id": "Response"
- },
- "SubstringMatchCriteria": {
- "type": "object",
- "properties": {
- "text": {
- "type": "string",
- "description": "The text to search for in the shape or table."
- },
- "matchCase": {
- "description": "Indicates whether the search should respect case:\n\n- `True`: the search is case sensitive.\n- `False`: the search is case insensitive.",
- "type": "boolean"
- }
- },
- "id": "SubstringMatchCriteria",
- "description": "A criteria that matches a specific string of text in a shape or table."
- },
- "LayoutReference": {
- "type": "object",
- "properties": {
- "layoutId": {
- "type": "string",
- "description": "Layout ID: the object ID of one of the layouts in the presentation."
- },
- "predefinedLayout": {
- "type": "string",
- "enumDescriptions": [
- "Unspecified layout.",
- "Blank layout, with no placeholders.",
- "Layout with a caption at the bottom.",
- "Layout with a title and a subtitle.",
- "Layout with a title and body.",
- "Layout with a title and two columns.",
- "Layout with only a title.",
- "Layout with a section title.",
- "Layout with a title and subtitle on one side and description on the other.",
- "Layout with one title and one body, arranged in a single column.",
- "Layout with a main point.",
- "Layout with a big number heading."
- ],
- "enum": [
- "PREDEFINED_LAYOUT_UNSPECIFIED",
- "BLANK",
- "CAPTION_ONLY",
- "TITLE",
- "TITLE_AND_BODY",
- "TITLE_AND_TWO_COLUMNS",
- "TITLE_ONLY",
- "SECTION_HEADER",
- "SECTION_TITLE_AND_DESCRIPTION",
- "ONE_COLUMN_TEXT",
- "MAIN_POINT",
- "BIG_NUMBER"
- ],
- "description": "Predefined layout."
- }
- },
- "id": "LayoutReference",
- "description": "Slide layout reference. This may reference either:\n\n- A predefined layout\n- One of the layouts in the presentation."
- },
- "TextRun": {
- "description": "A TextElement kind that represents a run of text that all has the same\nstyling.",
- "type": "object",
- "properties": {
- "content": {
- "description": "The text of this run.",
- "type": "string"
- },
- "style": {
- "$ref": "TextStyle",
- "description": "The styling applied to this run."
- }
- },
- "id": "TextRun"
- },
- "TableRange": {
- "description": "A table range represents a reference to a subset of a table.\n\nIt's important to note that the cells specified by a table range do not\nnecessarily form a rectangle. For example, let's say we have a 3 x 3 table\nwhere all the cells of the last row are merged together. The table looks\nlike this:\n\n \n [ ]\n\nA table range with location = (0, 0), row span = 3 and column span = 2\nspecifies the following cells:\n\n x x \n [ x ]",
- "type": "object",
- "properties": {
- "rowSpan": {
- "type": "integer",
- "format": "int32",
- "description": "The row span of the table range."
- },
- "location": {
- "$ref": "TableCellLocation",
- "description": "The starting location of the table range."
- },
- "columnSpan": {
- "format": "int32",
- "description": "The column span of the table range.",
- "type": "integer"
- }
- },
- "id": "TableRange"
- },
- "CreateTableRequest": {
- "type": "object",
- "properties": {
- "columns": {
- "type": "integer",
- "format": "int32",
- "description": "Number of columns in the table."
- },
- "objectId": {
- "description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated.",
- "type": "string"
- },
- "elementProperties": {
- "$ref": "PageElementProperties",
- "description": "The element properties for the table.\n\nThe table will be created at the provided size, subject to a minimum size.\nIf no size is provided, the table will be automatically sized.\n\nTable transforms must have a scale of 1 and no shear components. If no\ntransform is provided, the table will be centered on the page."
- },
- "rows": {
- "type": "integer",
- "format": "int32",
- "description": "Number of rows in the table."
- }
- },
- "id": "CreateTableRequest",
- "description": "Creates a new table."
- },
- "CreateTableResponse": {
- "description": "The result of creating a table.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the created table.",
- "type": "string"
- }
- },
- "id": "CreateTableResponse"
- },
- "Table": {
- "type": "object",
- "properties": {
- "verticalBorderRows": {
- "items": {
- "$ref": "TableBorderRow"
- },
- "type": "array",
- "description": "Properties of vertical cell borders.\n\nA table's vertical cell borders are represented as a grid. The grid has the\nsame number of rows as the table and one more column than the number of\ncolumns in the table. For example, if the table is 3 x 3, its vertical\nborders will be represented as a grid with 3 rows and 4 columns."
- },
- "rows": {
- "format": "int32",
- "description": "Number of rows in the table.",
- "type": "integer"
- },
- "tableColumns": {
- "description": "Properties of each column.",
- "items": {
- "$ref": "TableColumnProperties"
- },
- "type": "array"
- },
- "columns": {
- "type": "integer",
- "format": "int32",
- "description": "Number of columns in the table."
- },
- "tableRows": {
- "items": {
- "$ref": "TableRow"
- },
- "type": "array",
- "description": "Properties and contents of each row.\n\nCells that span multiple rows are contained in only one of these rows and\nhave a row_span greater\nthan 1."
- },
- "horizontalBorderRows": {
- "items": {
- "$ref": "TableBorderRow"
- },
- "type": "array",
- "description": "Properties of horizontal cell borders.\n\nA table's horizontal cell borders are represented as a grid. The grid has\none more row than the number of rows in the table and the same number of\ncolumns as the table. For example, if the table is 3 x 3, its horizontal\nborders will be represented as a grid with 4 rows and 3 columns."
- }
- },
- "id": "Table",
- "description": "A PageElement kind representing a\ntable."
- },
- "GroupObjectsRequest": {
- "description": "Groups objects to create an object group. For example, groups PageElements to create a Group on the same page as all the children.",
- "type": "object",
- "properties": {
- "groupObjectId": {
- "type": "string",
- "description": "A user-supplied object ID for the group to be created.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated."
- },
- "childrenObjectIds": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "The object IDs of the objects to group.\n\nOnly page elements can be grouped. There should be at least two page\nelements on the same page that are not already in another group. Some page\nelements, such as videos, tables and placeholder shapes cannot be grouped."
- }
- },
- "id": "GroupObjectsRequest"
- },
- "TableBorderRow": {
- "type": "object",
- "properties": {
- "tableBorderCells": {
- "description": "Properties of each border cell. When a border's adjacent table cells are\nmerged, it is not included in the response.",
- "items": {
- "$ref": "TableBorderCell"
- },
- "type": "array"
- }
- },
- "id": "TableBorderRow",
- "description": "Contents of each border row in a table."
- },
- "PageBackgroundFill": {
- "type": "object",
- "properties": {
- "propertyState": {
- "enum": [
- "RENDERED",
- "NOT_RENDERED",
- "INHERIT"
- ],
- "description": "The background fill property state.\n\nUpdating the fill on a page will implicitly update this field to\n`RENDERED`, unless another value is specified in the same request. To\nhave no fill on a page, set this field to `NOT_RENDERED`. In this case,\nany other fill fields set in the same request will be ignored.",
- "type": "string",
- "enumDescriptions": [
- "If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.",
- "If a property's state is NOT_RENDERED, then the element does not have the\ncorresponding property when rendered on a page. However, the field may\nstill be set so it can be inherited by child shapes. To remove a property\nfrom a rendered element, set its property_state to NOT_RENDERED.",
- "If a property's state is INHERIT, then the property state uses the value of\ncorresponding `property_state` field on the parent shape. Elements that do\nnot inherit will never have an INHERIT property state."
- ]
- },
- "stretchedPictureFill": {
- "$ref": "StretchedPictureFill",
- "description": "Stretched picture fill."
- },
- "solidFill": {
- "$ref": "SolidFill",
- "description": "Solid color fill."
- }
- },
- "id": "PageBackgroundFill",
- "description": "The page background fill."
- },
- "SheetsChart": {
- "type": "object",
- "properties": {
- "sheetsChartProperties": {
- "$ref": "SheetsChartProperties",
- "description": "The properties of the Sheets chart."
- },
- "contentUrl": {
- "description": "The URL of an image of the embedded chart, with a default lifetime of 30\nminutes. This URL is tagged with the account of the requester. Anyone with\nthe URL effectively accesses the image as the original requester. Access to\nthe image may be lost if the presentation's sharing settings change.",
- "type": "string"
- },
- "spreadsheetId": {
- "type": "string",
- "description": "The ID of the Google Sheets spreadsheet that contains the source chart."
- },
- "chartId": {
- "format": "int32",
- "description": "The ID of the specific chart in the Google Sheets spreadsheet that is\nembedded.",
- "type": "integer"
- }
- },
- "id": "SheetsChart",
- "description": "A PageElement kind representing\na linked chart embedded from Google Sheets."
- },
- "SolidFill": {
- "type": "object",
- "properties": {
- "alpha": {
- "format": "float",
- "description": "The fraction of this `color` that should be applied to the pixel.\nThat is, the final pixel color is defined by the equation:\n\n pixel color = alpha * (color) + (1.0 - alpha) * (background color)\n\nThis means that a value of 1.0 corresponds to a solid color, whereas\na value of 0.0 corresponds to a completely transparent color.",
- "type": "number"
- },
- "color": {
- "$ref": "OpaqueColor",
- "description": "The color value of the solid fill."
- }
- },
- "id": "SolidFill",
- "description": "A solid color fill. The page or page element is filled entirely with the\nspecified color value.\n\nIf any field is unset, its value may be inherited from a parent placeholder\nif it exists."
- },
- "ThemeColorPair": {
- "type": "object",
- "properties": {
- "color": {
- "$ref": "RgbColor",
- "description": "The concrete color corresponding to the theme color type above."
- },
- "type": {
- "enum": [
- "THEME_COLOR_TYPE_UNSPECIFIED",
- "DARK1",
- "LIGHT1",
- "DARK2",
- "LIGHT2",
- "ACCENT1",
- "ACCENT2",
- "ACCENT3",
- "ACCENT4",
- "ACCENT5",
- "ACCENT6",
- "HYPERLINK",
- "FOLLOWED_HYPERLINK",
- "TEXT1",
- "BACKGROUND1",
- "TEXT2",
- "BACKGROUND2"
- ],
- "description": "The type of the theme color.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified theme color. This value should not be used.",
- "Represents the first dark color.",
- "Represents the first light color.",
- "Represents the second dark color.",
- "Represents the second light color.",
- "Represents the first accent color.",
- "Represents the second accent color.",
- "Represents the third accent color.",
- "Represents the fourth accent color.",
- "Represents the fifth accent color.",
- "Represents the sixth accent color.",
- "Represents the color to use for hyperlinks.",
- "Represents the color to use for visited hyperlinks.",
- "Represents the first text color.",
- "Represents the first background color.",
- "Represents the second text color.",
- "Represents the second background color."
- ]
- }
- },
- "id": "ThemeColorPair",
- "description": "A pair mapping a theme color type to the concrete color it represents."
- },
- "OptionalColor": {
- "type": "object",
- "properties": {
- "opaqueColor": {
- "$ref": "OpaqueColor",
- "description": "If set, this will be used as an opaque color. If unset, this represents\na transparent color."
- }
- },
- "id": "OptionalColor",
- "description": "A color that can either be fully opaque or fully transparent."
- },
- "PageElementProperties": {
- "description": "Common properties for a page element.\n\nNote: When you initially create a\nPageElement, the API may modify\nthe values of both `size` and `transform`, but the\nvisual size will be unchanged.",
- "type": "object",
- "properties": {
- "transform": {
- "$ref": "AffineTransform",
- "description": "The transform for the element."
- },
- "pageObjectId": {
- "type": "string",
- "description": "The object ID of the page where the element is located."
- },
- "size": {
- "$ref": "Size",
- "description": "The size of the element."
- }
- },
- "id": "PageElementProperties"
- },
- "SheetsChartProperties": {
- "description": "The properties of the SheetsChart.",
- "type": "object",
- "properties": {
- "chartImageProperties": {
- "$ref": "ImageProperties",
- "description": "The properties of the embedded chart image."
- }
- },
- "id": "SheetsChartProperties"
- },
- "StretchedPictureFill": {
- "type": "object",
- "properties": {
- "contentUrl": {
- "description": "Reading the content_url:\n\nAn URL to a picture with a default lifetime of 30 minutes.\nThis URL is tagged with the account of the requester. Anyone with the URL\neffectively accesses the picture as the original requester. Access to the\npicture may be lost if the presentation's sharing settings change.\n\nWriting the content_url:\n\nThe picture is fetched once at insertion time and a copy is stored for\ndisplay inside the presentation. Pictures must be less than 50MB in size,\ncannot exceed 25 megapixels, and must be in either in PNG, JPEG, or GIF\nformat.\n\nThe provided URL can be at maximum 2K bytes large.",
- "type": "string"
- },
- "size": {
- "$ref": "Size",
- "description": "The original size of the picture fill. This field is read-only."
- }
- },
- "id": "StretchedPictureFill",
- "description": "The stretched picture fill. The page or page element is filled entirely with\nthe specified picture. The picture is stretched to fit its container."
- },
- "UpdateTextStyleRequest": {
- "type": "object",
- "properties": {
- "fields": {
- "type": "string",
- "format": "google-fieldmask",
- "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `style` is implied and\nshould not be specified. A single `\"*\"` can be used as short-hand for\nlisting every field.\n\nFor example, to update the text style to bold, set `fields` to `\"bold\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset."
- },
- "textRange": {
- "$ref": "Range",
- "description": "The range of text to style.\n\nThe range may be extended to include adjacent newlines.\n\nIf the range fully contains a paragraph belonging to a list, the\nparagraph's bullet is also updated with the matching text style."
- },
- "objectId": {
- "type": "string",
- "description": "The object ID of the shape or table with the text to be styled."
- },
- "style": {
- "$ref": "TextStyle",
- "description": "The style(s) to set on the text.\n\nIf the value for a particular style matches that of the parent, that style\nwill be set to inherit.\n\nCertain text style changes may cause other changes meant to mirror the\nbehavior of the Slides editor. See the documentation of\nTextStyle for more information."
- },
- "cellLocation": {
- "$ref": "TableCellLocation",
- "description": "The location of the cell in the table containing the text to style. If\n`object_id` refers to a table, `cell_location` must have a value.\nOtherwise, it must not."
- }
- },
- "id": "UpdateTextStyleRequest",
- "description": "Update the styling of text in a Shape or\nTable."
- },
- "DeleteTableColumnRequest": {
- "description": "Deletes a column from a table.",
- "type": "object",
- "properties": {
- "cellLocation": {
- "$ref": "TableCellLocation",
- "description": "The reference table cell location from which a column will be deleted.\n\nThe column this cell spans will be deleted. If this is a merged cell,\nmultiple columns will be deleted. If no columns remain in the table after\nthis deletion, the whole table is deleted."
- },
- "tableObjectId": {
- "type": "string",
- "description": "The table to delete columns from."
- }
- },
- "id": "DeleteTableColumnRequest"
- },
- "List": {
- "description": "A List describes the look and feel of bullets belonging to paragraphs\nassociated with a list. A paragraph that is part of a list has an implicit\nreference to that list's ID.",
- "type": "object",
- "properties": {
- "nestingLevel": {
- "additionalProperties": {
- "$ref": "NestingLevel"
- },
- "description": "A map of nesting levels to the properties of bullets at the associated\nlevel. A list has at most nine levels of nesting, so the possible values\nfor the keys of this map are 0 through 8, inclusive.",
- "type": "object"
- },
- "listId": {
- "description": "The ID of the list.",
- "type": "string"
- }
- },
- "id": "List"
- },
- "WeightedFontFamily": {
- "type": "object",
- "properties": {
- "weight": {
- "type": "integer",
- "format": "int32",
- "description": "The rendered weight of the text. This field can have any value that is a\nmultiple of `100` between `100` and `900`, inclusive. This range\ncorresponds to the numerical values described in the CSS 2.1\nSpecification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness),\nwith non-numerical values disallowed. Weights greater than or equal to\n`700` are considered bold, and weights less than `700`are not bold. The\ndefault value is `400` (\"normal\")."
- },
- "fontFamily": {
- "type": "string",
- "description": "The font family of the text.\n\nThe font family can be any font from the Font menu in Slides or from\n[Google Fonts] (https://fonts.google.com/). If the font name is\nunrecognized, the text is rendered in `Arial`."
- }
- },
- "id": "WeightedFontFamily",
- "description": "Represents a font family and weight used to style a TextRun."
- },
- "PageElement": {
- "type": "object",
- "properties": {
- "wordArt": {
- "$ref": "WordArt",
- "description": "A word art page element."
- },
- "table": {
- "$ref": "Table",
- "description": "A table page element."
- },
- "transform": {
- "$ref": "AffineTransform",
- "description": "The transform of the page element.\n\nThe visual appearance of the page element is determined by its absolute\ntransform. To compute the absolute transform, preconcatenate a page\nelement's transform with the transforms of all of its parent groups. If the\npage element is not in a group, its absolute transform is the same as the\nvalue in this field.\n\nThe initial transform for the newly created Group is always the identity transform."
- },
- "objectId": {
- "type": "string",
- "description": "The object ID for this page element. Object IDs used by\ngoogle.apps.slides.v1.Page and\ngoogle.apps.slides.v1.PageElement share the same namespace."
- },
- "shape": {
- "$ref": "Shape",
- "description": "A generic shape."
- },
- "line": {
- "$ref": "Line",
- "description": "A line page element."
- },
- "description": {
- "type": "string",
- "description": "The description of the page element. Combined with title to display alt\ntext."
- },
- "elementGroup": {
- "$ref": "Group",
- "description": "A collection of page elements joined as a single unit."
- },
- "image": {
- "$ref": "Image",
- "description": "An image page element."
- },
- "size": {
- "$ref": "Size",
- "description": "The size of the page element."
- },
- "sheetsChart": {
- "$ref": "SheetsChart",
- "description": "A linked chart embedded from Google Sheets. Unlinked charts are\nrepresented as images."
- },
- "title": {
- "description": "The title of the page element. Combined with description to display alt\ntext.",
- "type": "string"
- },
- "video": {
- "$ref": "Video",
- "description": "A video page element."
- }
- },
- "id": "PageElement",
- "description": "A visual element rendered on a page."
- },
- "CreateImageRequest": {
- "description": "Creates an image.",
- "type": "object",
- "properties": {
- "objectId": {
- "type": "string",
- "description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated."
- },
- "elementProperties": {
- "$ref": "PageElementProperties",
- "description": "The element properties for the image.\n\nWhen the aspect ratio of the provided size does not match the image aspect\nratio, the image is scaled and centered with respect to the size in order\nto maintain aspect ratio. The provided transform is applied after this\noperation."
- },
- "url": {
- "description": "The image URL.\n\nThe image is fetched once at insertion time and a copy is stored for\ndisplay inside the presentation. Images must be less than 50MB in size,\ncannot exceed 25 megapixels, and must be in either in PNG, JPEG, or GIF\nformat.\n\nThe provided URL can be at maximum 2K bytes large.",
- "type": "string"
- }
- },
- "id": "CreateImageRequest"
- },
- "CreateParagraphBulletsRequest": {
- "description": "Creates bullets for all of the paragraphs that overlap with the given\ntext index range.\n\nThe nesting level of each paragraph will be determined by counting leading\ntabs in front of each paragraph. To avoid excess space between the bullet and\nthe corresponding paragraph, these leading tabs are removed by this request.\nThis may change the indices of parts of the text.\n\nIf the paragraph immediately before paragraphs being updated is in a list\nwith a matching preset, the paragraphs being updated are added to that\npreceding list.",
- "type": "object",
- "properties": {
- "textRange": {
- "$ref": "Range",
- "description": "The range of text to apply the bullet presets to, based on TextElement indexes."
- },
- "objectId": {
- "type": "string",
- "description": "The object ID of the shape or table containing the text to add bullets to."
- },
- "bulletPreset": {
- "type": "string",
- "enumDescriptions": [
- "A bulleted list with a `DISC`, `CIRCLE` and `SQUARE` bullet glyph for the\nfirst 3 list nesting levels.",
- "A bulleted list with a `DIAMONDX`, `ARROW3D` and `SQUARE` bullet glyph for\nthe first 3 list nesting levels.",
- "A bulleted list with `CHECKBOX` bullet glyphs for all list nesting levels.",
- "A bulleted list with a `ARROW`, `DIAMOND` and `DISC` bullet glyph for\nthe first 3 list nesting levels.",
- "A bulleted list with a `STAR`, `CIRCLE` and `SQUARE` bullet glyph for\nthe first 3 list nesting levels.",
- "A bulleted list with a `ARROW3D`, `CIRCLE` and `SQUARE` bullet glyph for\nthe first 3 list nesting levels.",
- "A bulleted list with a `LEFTTRIANGLE`, `DIAMOND` and `DISC` bullet glyph\nfor the first 3 list nesting levels.",
- "A bulleted list with a `DIAMONDX`, `HOLLOWDIAMOND` and `SQUARE` bullet\nglyph for the first 3 list nesting levels.",
- "A bulleted list with a `DIAMOND`, `CIRCLE` and `SQUARE` bullet glyph\nfor the first 3 list nesting levels.",
- "A numbered list with `DIGIT`, `ALPHA` and `ROMAN` numeric glyphs for\nthe first 3 list nesting levels, followed by periods.",
- "A numbered list with `DIGIT`, `ALPHA` and `ROMAN` numeric glyphs for\nthe first 3 list nesting levels, followed by parenthesis.",
- "A numbered list with `DIGIT` numeric glyphs separated by periods, where\neach nesting level uses the previous nesting level's glyph as a prefix.\nFor example: '1.', '1.1.', '2.', '2.2.'.",
- "A numbered list with `UPPERALPHA`, `ALPHA` and `ROMAN` numeric glyphs for\nthe first 3 list nesting levels, followed by periods.",
- "A numbered list with `UPPERROMAN`, `UPPERALPHA` and `DIGIT` numeric glyphs\nfor the first 3 list nesting levels, followed by periods.",
- "A numbered list with `ZERODIGIT`, `ALPHA` and `ROMAN` numeric glyphs for\nthe first 3 list nesting levels, followed by periods."
- ],
- "enum": [
- "BULLET_DISC_CIRCLE_SQUARE",
- "BULLET_DIAMONDX_ARROW3D_SQUARE",
- "BULLET_CHECKBOX",
- "BULLET_ARROW_DIAMOND_DISC",
- "BULLET_STAR_CIRCLE_SQUARE",
- "BULLET_ARROW3D_CIRCLE_SQUARE",
- "BULLET_LEFTTRIANGLE_DIAMOND_DISC",
- "BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE",
- "BULLET_DIAMOND_CIRCLE_SQUARE",
- "NUMBERED_DIGIT_ALPHA_ROMAN",
- "NUMBERED_DIGIT_ALPHA_ROMAN_PARENS",
- "NUMBERED_DIGIT_NESTED",
- "NUMBERED_UPPERALPHA_ALPHA_ROMAN",
- "NUMBERED_UPPERROMAN_UPPERALPHA_DIGIT",
- "NUMBERED_ZERODIGIT_ALPHA_ROMAN"
- ],
- "description": "The kinds of bullet glyphs to be used. Defaults to the\n`BULLET_DISC_CIRCLE_SQUARE` preset."
- },
- "cellLocation": {
- "$ref": "TableCellLocation",
- "description": "The optional table cell location if the text to be modified is in a table\ncell. If present, the object_id must refer to a table."
- }
- },
- "id": "CreateParagraphBulletsRequest"
- },
- "Size": {
- "description": "A width and height.",
- "type": "object",
- "properties": {
- "height": {
- "$ref": "Dimension",
- "description": "The height of the object."
- },
- "width": {
- "$ref": "Dimension",
- "description": "The width of the object."
- }
- },
- "id": "Size"
- },
- "TextStyle": {
- "type": "object",
- "properties": {
- "fontFamily": {
- "description": "The font family of the text.\n\nThe font family can be any font from the Font menu in Slides or from\n[Google Fonts] (https://fonts.google.com/). If the font name is\nunrecognized, the text is rendered in `Arial`.\n\nSome fonts can affect the weight of the text. If an update request\nspecifies values for both `font_family` and `bold`, the explicitly-set\n`bold` value is used.",
- "type": "string"
- },
- "strikethrough": {
- "description": "Whether or not the text is struck through.",
- "type": "boolean"
- },
- "italic": {
- "type": "boolean",
- "description": "Whether or not the text is italicized."
- },
- "fontSize": {
- "$ref": "Dimension",
- "description": "The size of the text's font. When read, the `font_size` will specified in\npoints."
- },
- "baselineOffset": {
- "type": "string",
- "enumDescriptions": [
- "The text's baseline offset is inherited from the parent.",
- "The text is not vertically offset.",
- "The text is vertically offset upwards (superscript).",
- "The text is vertically offset downwards (subscript)."
- ],
- "enum": [
- "BASELINE_OFFSET_UNSPECIFIED",
- "NONE",
- "SUPERSCRIPT",
- "SUBSCRIPT"
- ],
- "description": "The text's vertical offset from its normal position.\n\nText with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically\nrendered in a smaller font size, computed based on the `font_size` field.\nThe `font_size` itself is not affected by changes in this field."
- },
- "weightedFontFamily": {
- "$ref": "WeightedFontFamily",
- "description": "The font family and rendered weight of the text.\n\nThis field is an extension of `font_family` meant to support explicit font\nweights without breaking backwards compatibility. As such, when reading the\nstyle of a range of text, the value of `weighted_font_family#font_family`\nwill always be equal to that of `font_family`. However, when writing, if\nboth fields are included in the field mask (either explicitly or through\nthe wildcard `\"*\"`), their values are reconciled as follows:\n\n* If `font_family` is set and `weighted_font_family` is not, the value of\n `font_family` is applied with weight `400` (\"normal\").\n* If both fields are set, the value of `font_family` must match that of\n `weighted_font_family#font_family`. If so, the font family and weight of\n `weighted_font_family` is applied. Otherwise, a 400 bad request error is\n returned.\n* If `weighted_font_family` is set and `font_family` is not, the font\n family and weight of `weighted_font_family` is applied.\n* If neither field is set, the font family and weight of the text inherit\n from the parent. Note that these properties cannot inherit separately\n from each other.\n\nIf an update request specifies values for both `weighted_font_family` and\n`bold`, the `weighted_font_family` is applied first, then `bold`.\n\nIf `weighted_font_family#weight` is not set, it defaults to `400`.\n\nIf `weighted_font_family` is set, then `weighted_font_family#font_family`\nmust also be set with a non-empty value. Otherwise, a 400 bad request error\nis returned."
- },
- "smallCaps": {
- "type": "boolean",
- "description": "Whether or not the text is in small capital letters."
- },
- "backgroundColor": {
- "$ref": "OptionalColor",
- "description": "The background color of the text. If set, the color is either opaque or\ntransparent, depending on if the `opaque_color` field in it is set."
- },
- "underline": {
- "type": "boolean",
- "description": "Whether or not the text is underlined."
- },
- "link": {
- "$ref": "Link",
- "description": "The hyperlink destination of the text. If unset, there is no link. Links\nare not inherited from parent text.\n\nChanging the link in an update request causes some other changes to the\ntext style of the range:\n\n* When setting a link, the text foreground color will be set to\n ThemeColorType.HYPERLINK and the text will\n be underlined. If these fields are modified in the same\n request, those values will be used instead of the link defaults.\n* Setting a link on a text range that overlaps with an existing link will\n also update the existing link to point to the new URL.\n* Links are not settable on newline characters. As a result, setting a link\n on a text range that crosses a paragraph boundary, such as `\"ABC\\n123\"`,\n will separate the newline character(s) into their own text runs. The\n link will be applied separately to the runs before and after the newline.\n* Removing a link will update the text style of the range to match the\n style of the preceding text (or the default text styles if the preceding\n text is another link) unless different styles are being set in the same\n request."
- },
- "bold": {
- "type": "boolean",
- "description": "Whether or not the text is rendered as bold."
- },
- "foregroundColor": {
- "$ref": "OptionalColor",
- "description": "The color of the text itself. If set, the color is either opaque or\ntransparent, depending on if the `opaque_color` field in it is set."
- }
- },
- "id": "TextStyle",
- "description": "Represents the styling that can be applied to a TextRun.\n\nIf this text is contained in a shape with a parent placeholder, then these text styles may be\ninherited from the parent. Which text styles are inherited depend on the\nnesting level of lists:\n\n* A text run in a paragraph that is not in a list will inherit its text style\n from the the newline character in the paragraph at the 0 nesting level of\n the list inside the parent placeholder.\n* A text run in a paragraph that is in a list will inherit its text style\n from the newline character in the paragraph at its corresponding nesting\n level of the list inside the parent placeholder.\n\nInherited text styles are represented as unset fields in this message. If\ntext is contained in a shape without a parent placeholder, unsetting these\nfields will revert the style to a value matching the defaults in the Slides\neditor."
- },
- "UpdateVideoPropertiesRequest": {
- "description": "Update the properties of a Video.",
- "type": "object",
- "properties": {
- "fields": {
- "type": "string",
- "format": "google-fieldmask",
- "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `videoProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the video outline color, set `fields` to\n`\"outline.outlineFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset."
- },
- "objectId": {
- "type": "string",
- "description": "The object ID of the video the updates are applied to."
- },
- "videoProperties": {
- "$ref": "VideoProperties",
- "description": "The video properties to update."
- }
- },
- "id": "UpdateVideoPropertiesRequest"
- },
- "Request": {
- "type": "object",
- "properties": {
- "mergeTableCells": {
- "$ref": "MergeTableCellsRequest",
- "description": "Merges cells in a Table."
- },
- "refreshSheetsChart": {
- "$ref": "RefreshSheetsChartRequest",
- "description": "Refreshes a Google Sheets chart."
- },
- "createTable": {
- "$ref": "CreateTableRequest",
- "description": "Creates a new table."
- },
- "updateTableCellProperties": {
- "$ref": "UpdateTableCellPropertiesRequest",
- "description": "Updates the properties of a TableCell."
- },
- "deleteObject": {
- "$ref": "DeleteObjectRequest",
- "description": "Deletes a page or page element from the presentation."
- },
- "updateParagraphStyle": {
- "$ref": "UpdateParagraphStyleRequest",
- "description": "Updates the styling of paragraphs within a Shape or Table."
- },
- "duplicateObject": {
- "$ref": "DuplicateObjectRequest",
- "description": "Duplicates a slide or page element."
- },
- "deleteTableColumn": {
- "$ref": "DeleteTableColumnRequest",
- "description": "Deletes a column from a table."
- },
- "createLine": {
- "$ref": "CreateLineRequest",
- "description": "Creates a line."
- },
- "updateVideoProperties": {
- "$ref": "UpdateVideoPropertiesRequest",
- "description": "Updates the properties of a Video."
- },
- "createImage": {
- "$ref": "CreateImageRequest",
- "description": "Creates an image."
- },
- "createParagraphBullets": {
- "$ref": "CreateParagraphBulletsRequest",
- "description": "Creates bullets for paragraphs."
- },
- "createVideo": {
- "$ref": "CreateVideoRequest",
- "description": "Creates a video."
- },
- "createSheetsChart": {
- "$ref": "CreateSheetsChartRequest",
- "description": "Creates an embedded Google Sheets chart."
- },
- "replaceAllShapesWithSheetsChart": {
- "$ref": "ReplaceAllShapesWithSheetsChartRequest",
- "description": "Replaces all shapes matching some criteria with a Google Sheets chart."
- },
- "unmergeTableCells": {
- "$ref": "UnmergeTableCellsRequest",
- "description": "Unmerges cells in a Table."
- },
- "updatePageElementTransform": {
- "$ref": "UpdatePageElementTransformRequest",
- "description": "Updates the transform of a page element."
- },
- "updateTextStyle": {
- "$ref": "UpdateTextStyleRequest",
- "description": "Updates the styling of text within a Shape or Table."
- },
- "updateTableRowProperties": {
- "$ref": "UpdateTableRowPropertiesRequest",
- "description": "Updates the properties of a Table row."
- },
- "replaceAllShapesWithImage": {
- "$ref": "ReplaceAllShapesWithImageRequest",
- "description": "Replaces all shapes matching some criteria with an image."
- },
- "replaceAllText": {
- "$ref": "ReplaceAllTextRequest",
- "description": "Replaces all instances of specified text."
- },
- "updateImageProperties": {
- "$ref": "UpdateImagePropertiesRequest",
- "description": "Updates the properties of an Image."
- },
- "insertTableRows": {
- "$ref": "InsertTableRowsRequest",
- "description": "Inserts rows into a table."
- },
- "createSlide": {
- "$ref": "CreateSlideRequest",
- "description": "Creates a new slide."
- },
- "updateLineProperties": {
- "$ref": "UpdateLinePropertiesRequest",
- "description": "Updates the properties of a Line."
- },
- "updateSlidesPosition": {
- "$ref": "UpdateSlidesPositionRequest",
- "description": "Updates the position of a set of slides in the presentation."
- },
- "deleteTableRow": {
- "$ref": "DeleteTableRowRequest",
- "description": "Deletes a row from a table."
- },
- "updateShapeProperties": {
- "$ref": "UpdateShapePropertiesRequest",
- "description": "Updates the properties of a Shape."
- },
- "ungroupObjects": {
- "$ref": "UngroupObjectsRequest",
- "description": "Ungroups objects, such as groups."
- },
- "groupObjects": {
- "$ref": "GroupObjectsRequest",
- "description": "Groups objects, such as page elements."
- },
- "insertText": {
- "$ref": "InsertTextRequest",
- "description": "Inserts text into a shape or table cell."
- },
- "updateTableColumnProperties": {
- "$ref": "UpdateTableColumnPropertiesRequest",
- "description": "Updates the properties of a Table\ncolumn."
- },
- "deleteText": {
- "$ref": "DeleteTextRequest",
- "description": "Deletes text from a shape or a table cell."
- },
- "updatePageProperties": {
- "$ref": "UpdatePagePropertiesRequest",
- "description": "Updates the properties of a Page."
- },
- "createShape": {
- "$ref": "CreateShapeRequest",
- "description": "Creates a new shape."
- },
- "deleteParagraphBullets": {
- "$ref": "DeleteParagraphBulletsRequest",
- "description": "Deletes bullets from paragraphs."
- },
- "updateTableBorderProperties": {
- "$ref": "UpdateTableBorderPropertiesRequest",
- "description": "Updates the properties of the table borders in a Table."
- },
- "insertTableColumns": {
- "$ref": "InsertTableColumnsRequest",
- "description": "Inserts columns into a table."
- }
- },
- "id": "Request",
- "description": "A single kind of update to apply to a presentation."
- },
- "UpdateImagePropertiesRequest": {
- "description": "Update the properties of an Image.",
- "type": "object",
- "properties": {
- "fields": {
- "format": "google-fieldmask",
- "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `imageProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the image outline color, set `fields` to\n`\"outline.outlineFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
- "type": "string"
- },
- "imageProperties": {
- "$ref": "ImageProperties",
- "description": "The image properties to update."
- },
- "objectId": {
- "description": "The object ID of the image the updates are applied to.",
- "type": "string"
- }
- },
- "id": "UpdateImagePropertiesRequest"
- },
- "ParagraphStyle": {
- "type": "object",
- "properties": {
- "spaceBelow": {
- "$ref": "Dimension",
- "description": "The amount of extra space above the paragraph. If unset, the value is\ninherited from the parent."
- },
- "direction": {
- "type": "string",
- "enumDescriptions": [
- "The text direction is inherited from the parent.",
- "The text goes from left to right.",
- "The text goes from right to left."
- ],
- "enum": [
- "TEXT_DIRECTION_UNSPECIFIED",
- "LEFT_TO_RIGHT",
- "RIGHT_TO_LEFT"
- ],
- "description": "The text direction of this paragraph. If unset, the value defaults to\nLEFT_TO_RIGHT since\ntext direction is not inherited."
- },
- "spacingMode": {
- "type": "string",
- "enumDescriptions": [
- "The spacing mode is inherited from the parent.",
- "Paragraph spacing is always rendered.",
- "Paragraph spacing is skipped between list elements."
- ],
- "enum": [
- "SPACING_MODE_UNSPECIFIED",
- "NEVER_COLLAPSE",
- "COLLAPSE_LISTS"
- ],
- "description": "The spacing mode for the paragraph."
- },
- "indentEnd": {
- "$ref": "Dimension",
- "description": "The amount indentation for the paragraph on the side that corresponds to\nthe end of the text, based on the current text direction. If unset, the\nvalue is inherited from the parent."
- },
- "indentStart": {
- "$ref": "Dimension",
- "description": "The amount indentation for the paragraph on the side that corresponds to\nthe start of the text, based on the current text direction. If unset, the\nvalue is inherited from the parent."
- },
- "spaceAbove": {
- "$ref": "Dimension",
- "description": "The amount of extra space above the paragraph. If unset, the value is\ninherited from the parent."
- },
- "indentFirstLine": {
- "$ref": "Dimension",
- "description": "The amount of indentation for the start of the first line of the paragraph.\nIf unset, the value is inherited from the parent."
- },
- "lineSpacing": {
- "type": "number",
- "format": "float",
- "description": "The amount of space between lines, as a percentage of normal, where normal\nis represented as 100.0. If unset, the value is inherited from the parent."
- },
- "alignment": {
- "enum": [
- "ALIGNMENT_UNSPECIFIED",
- "START",
- "CENTER",
- "END",
- "JUSTIFIED"
- ],
- "description": "The text alignment for this paragraph.",
- "type": "string",
- "enumDescriptions": [
- "The paragraph alignment is inherited from the parent.",
- "The paragraph is aligned to the start of the line. Left-aligned for\nLTR text, right-aligned otherwise.",
- "The paragraph is centered.",
- "The paragraph is aligned to the end of the line. Right-aligned for\nLTR text, left-aligned otherwise.",
- "The paragraph is justified."
- ]
- }
- },
- "id": "ParagraphStyle",
- "description": "Styles that apply to a whole paragraph.\n\nIf this text is contained in a shape with a parent placeholder, then these paragraph styles may be\ninherited from the parent. Which paragraph styles are inherited depend on the\nnesting level of lists:\n\n* A paragraph not in a list will inherit its paragraph style from the\n paragraph at the 0 nesting level of the list inside the parent placeholder.\n* A paragraph in a list will inherit its paragraph style from the paragraph\n at its corresponding nesting level of the list inside the parent\n placeholder.\n\nInherited paragraph styles are represented as unset fields in this message."
- },
- "UpdateTableRowPropertiesRequest": {
- "description": "Updates the properties of a Table row.",
- "type": "object",
- "properties": {
- "fields": {
- "format": "google-fieldmask",
- "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `tableRowProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the minimum row height, set `fields` to\n`\"min_row_height\"`.\n\nIf '\"min_row_height\"' is included in the field mask but the property is\nleft unset, the minimum row height will default to 0.",
- "type": "string"
- },
- "tableRowProperties": {
- "$ref": "TableRowProperties",
- "description": "The table row properties to update."
- },
- "objectId": {
- "description": "The object ID of the table.",
- "type": "string"
- },
- "rowIndices": {
- "items": {
- "type": "integer",
- "format": "int32"
- },
- "type": "array",
- "description": "The list of zero-based indices specifying which rows to update. If no\nindices are provided, all rows in the table will be updated."
- }
- },
- "id": "UpdateTableRowPropertiesRequest"
- },
- "ReplaceAllShapesWithSheetsChartResponse": {
- "type": "object",
- "properties": {
- "occurrencesChanged": {
- "format": "int32",
- "description": "The number of shapes replaced with charts.",
- "type": "integer"
- }
- },
- "id": "ReplaceAllShapesWithSheetsChartResponse",
- "description": "The result of replacing shapes with a Google Sheets chart."
- },
- "TableCellProperties": {
- "description": "The properties of the TableCell.",
- "type": "object",
- "properties": {
- "tableCellBackgroundFill": {
- "$ref": "TableCellBackgroundFill",
- "description": "The background fill of the table cell. The default fill matches the fill\nfor newly created table cells in the Slides editor."
- }
- },
- "id": "TableCellProperties"
- },
- "RefreshSheetsChartRequest": {
- "description": "Refreshes an embedded Google Sheets chart by replacing it with the latest\nversion of the chart from Google Sheets.\n\nNOTE: Refreshing charts requires at least one of the spreadsheets.readonly,\nspreadsheets, drive.readonly, or drive OAuth scopes.",
- "type": "object",
- "properties": {
- "objectId": {
- "type": "string",
- "description": "The object ID of the chart to refresh."
- }
- },
- "id": "RefreshSheetsChartRequest"
- },
- "Outline": {
- "description": "The outline of a PageElement.\n\nIf these fields are unset, they may be inherited from a parent placeholder\nif it exists. If there is no parent, the fields will default to the value\nused for new page elements created in the Slides editor, which may depend on\nthe page element kind.",
- "type": "object",
- "properties": {
- "outlineFill": {
- "$ref": "OutlineFill",
- "description": "The fill of the outline."
- },
- "weight": {
- "$ref": "Dimension",
- "description": "The thickness of the outline."
- },
- "dashStyle": {
- "enum": [
- "DASH_STYLE_UNSPECIFIED",
- "SOLID",
- "DOT",
- "DASH",
- "DASH_DOT",
- "LONG_DASH",
- "LONG_DASH_DOT"
- ],
- "description": "The dash style of the outline.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified dash style.",
- "Solid line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'solid'.\nThis is the default dash style.",
- "Dotted line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dot'.",
- "Dashed line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dash'.",
- "Alternating dashes and dots. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'dashDot'.",
- "Line with large dashes. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'lgDash'.",
- "Alternating large dashes and dots. Corresponds to ECMA-376\nST_PresetLineDashVal value 'lgDashDot'."
- ]
- },
- "propertyState": {
- "enum": [
- "RENDERED",
- "NOT_RENDERED",
- "INHERIT"
- ],
- "description": "The outline property state.\n\nUpdating the the outline on a page element will implicitly update this\nfield to`RENDERED`, unless another value is specified in the same request.\nTo have no outline on a page element, set this field to `NOT_RENDERED`. In\nthis case, any other outline fields set in the same request will be\nignored.",
- "type": "string",
- "enumDescriptions": [
- "If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.",
- "If a property's state is NOT_RENDERED, then the element does not have the\ncorresponding property when rendered on a page. However, the field may\nstill be set so it can be inherited by child shapes. To remove a property\nfrom a rendered element, set its property_state to NOT_RENDERED.",
- "If a property's state is INHERIT, then the property state uses the value of\ncorresponding `property_state` field on the parent shape. Elements that do\nnot inherit will never have an INHERIT property state."
- ]
- }
- },
- "id": "Outline"
- },
- "ShapeProperties": {
- "description": "The properties of a Shape.\n\nIf the shape is a placeholder shape as determined by the\nplaceholder field, then these\nproperties may be inherited from a parent placeholder shape.\nDetermining the rendered value of the property depends on the corresponding\nproperty_state field value.",
- "type": "object",
- "properties": {
- "shadow": {
- "$ref": "Shadow",
- "description": "The shadow properties of the shape. If unset, the shadow is inherited from\na parent placeholder if it exists. If the shape has no parent, then the\ndefault shadow matches the defaults for new shapes created in the Slides\neditor. This property is read-only."
- },
- "shapeBackgroundFill": {
- "$ref": "ShapeBackgroundFill",
- "description": "The background fill of the shape. If unset, the background fill is\ninherited from a parent placeholder if it exists. If the shape has no\nparent, then the default background fill depends on the shape type,\nmatching the defaults for new shapes created in the Slides editor."
- },
- "link": {
- "$ref": "Link",
- "description": "The hyperlink destination of the shape. If unset, there is no link. Links\nare not inherited from parent placeholders."
- },
- "outline": {
- "$ref": "Outline",
- "description": "The outline of the shape. If unset, the outline is inherited from a\nparent placeholder if it exists. If the shape has no parent, then the\ndefault outline depends on the shape type, matching the defaults for\nnew shapes created in the Slides editor."
- }
- },
- "id": "ShapeProperties"
- },
- "TableColumnProperties": {
- "type": "object",
- "properties": {
- "columnWidth": {
- "$ref": "Dimension",
- "description": "Width of a column."
- }
- },
- "id": "TableColumnProperties",
- "description": "Properties of each column in a table."
- },
- "NotesProperties": {
- "description": "The properties of Page that are only\nrelevant for pages with page_type NOTES.",
- "type": "object",
- "properties": {
- "speakerNotesObjectId": {
- "type": "string",
- "description": "The object ID of the shape on this notes page that contains the speaker\nnotes for the corresponding slide.\nThe actual shape may not always exist on the notes page. Inserting text\nusing this object ID will automatically create the shape. In this case, the\nactual shape may have different object ID. The `GetPresentation` or\n`GetPage` action will always return the latest object ID."
- }
- },
- "id": "NotesProperties"
- },
- "TableRow": {
- "description": "Properties and contents of each row in a table.",
- "type": "object",
- "properties": {
- "tableRowProperties": {
- "$ref": "TableRowProperties",
- "description": "Properties of the row."
- },
- "tableCells": {
- "items": {
- "$ref": "TableCell"
- },
- "type": "array",
- "description": "Properties and contents of each cell.\n\nCells that span multiple columns are represented only once with a\ncolumn_span greater\nthan 1. As a result, the length of this collection does not always match\nthe number of columns of the entire table."
- },
- "rowHeight": {
- "$ref": "Dimension",
- "description": "Height of a row."
- }
- },
- "id": "TableRow"
- },
- "UpdateTableCellPropertiesRequest": {
- "type": "object",
- "properties": {
- "fields": {
- "type": "string",
- "format": "google-fieldmask",
- "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `tableCellProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the table cell background solid fill color, set\n`fields` to `\"tableCellBackgroundFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset."
- },
- "tableRange": {
- "$ref": "TableRange",
- "description": "The table range representing the subset of the table to which the updates\nare applied. If a table range is not specified, the updates will apply to\nthe entire table."
- },
- "objectId": {
- "description": "The object ID of the table.",
- "type": "string"
- },
- "tableCellProperties": {
- "$ref": "TableCellProperties",
- "description": "The table cell properties to update."
- }
- },
- "id": "UpdateTableCellPropertiesRequest",
- "description": "Update the properties of a TableCell."
- },
- "CreateSlideRequest": {
- "type": "object",
- "properties": {
- "slideLayoutReference": {
- "$ref": "LayoutReference",
- "description": "Layout reference of the slide to be inserted, based on the *current\nmaster*, which is one of the following:\n\n- The master of the previous slide index.\n- The master of the first slide, if the insertion_index is zero.\n- The first master in the presentation, if there are no slides.\n\nIf the LayoutReference is not found in the current master, a 400 bad\nrequest error is returned.\n\nIf you don't specify a layout reference, then the new slide will use the\npredefined layout `BLANK`."
- },
- "objectId": {
- "description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated.",
- "type": "string"
- },
- "insertionIndex": {
- "type": "integer",
- "format": "int32",
- "description": "The optional zero-based index indicating where to insert the slides.\n\nIf you don't specify an index, the new slide is created at the end."
- },
- "placeholderIdMappings": {
- "items": {
- "$ref": "LayoutPlaceholderIdMapping"
- },
- "type": "array",
- "description": "An optional list of object ID mappings from the placeholder(s) on the layout to the placeholder(s)\nthat will be created on the new slide from that specified layout. Can only\nbe used when `slide_layout_reference` is specified."
- }
- },
- "id": "CreateSlideRequest",
- "description": "Creates a new slide."
- },
- "TableRowProperties": {
- "description": "Properties of each row in a table.",
- "type": "object",
- "properties": {
- "minRowHeight": {
- "$ref": "Dimension",
- "description": "Minimum height of the row. The row will be rendered in the Slides editor at\na height equal to or greater than this value in order to show all the text\nin the row's cell(s)."
- }
- },
- "id": "TableRowProperties"
- },
- "BatchUpdatePresentationRequest": {
- "description": "Request message for PresentationsService.BatchUpdatePresentation.",
- "type": "object",
- "properties": {
- "requests": {
- "description": "A list of updates to apply to the presentation.",
- "items": {
- "$ref": "Request"
- },
- "type": "array"
- },
- "writeControl": {
- "$ref": "WriteControl",
- "description": "Provides control over how write requests are executed."
- }
- },
- "id": "BatchUpdatePresentationRequest"
- },
- "GroupObjectsResponse": {
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the created group.",
- "type": "string"
- }
- },
- "id": "GroupObjectsResponse",
- "description": "The result of grouping objects."
- },
- "TableBorderProperties": {
- "type": "object",
- "properties": {
- "weight": {
- "$ref": "Dimension",
- "description": "The thickness of the border."
- },
- "dashStyle": {
- "enum": [
- "DASH_STYLE_UNSPECIFIED",
- "SOLID",
- "DOT",
- "DASH",
- "DASH_DOT",
- "LONG_DASH",
- "LONG_DASH_DOT"
- ],
- "description": "The dash style of the border.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified dash style.",
- "Solid line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'solid'.\nThis is the default dash style.",
- "Dotted line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dot'.",
- "Dashed line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dash'.",
- "Alternating dashes and dots. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'dashDot'.",
- "Line with large dashes. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'lgDash'.",
- "Alternating large dashes and dots. Corresponds to ECMA-376\nST_PresetLineDashVal value 'lgDashDot'."
- ]
- },
- "tableBorderFill": {
- "$ref": "TableBorderFill",
- "description": "The fill of the table border."
- }
- },
- "id": "TableBorderProperties",
- "description": "The border styling properties of the\nTableBorderCell."
- },
- "TableBorderCell": {
- "type": "object",
- "properties": {
- "tableBorderProperties": {
- "$ref": "TableBorderProperties",
- "description": "The border properties."
- },
- "location": {
- "$ref": "TableCellLocation",
- "description": "The location of the border within the border table."
- }
- },
- "id": "TableBorderCell",
- "description": "The properties of each border cell."
- },
- "TextContent": {
- "type": "object",
- "properties": {
- "textElements": {
- "description": "The text contents broken down into its component parts, including styling\ninformation. This property is read-only.",
- "items": {
- "$ref": "TextElement"
- },
- "type": "array"
- },
- "lists": {
- "type": "object",
- "additionalProperties": {
- "$ref": "List"
- },
- "description": "The bulleted lists contained in this text, keyed by list ID."
- }
- },
- "id": "TextContent",
- "description": "The general text content. The text must reside in a compatible shape (e.g.\ntext box or rectangle) or a table cell in a page."
- },
- "CreateSheetsChartResponse": {
- "description": "The result of creating an embedded Google Sheets chart.",
- "type": "object",
- "properties": {
- "objectId": {
- "type": "string",
- "description": "The object ID of the created chart."
- }
- },
- "id": "CreateSheetsChartResponse"
- },
"WriteControl": {
"description": "Provides control over how write requests are executed.",
"type": "object",
"properties": {
"requiredRevisionId": {
- "type": "string",
- "description": "The revision ID of the presentation required for the write request. If\nspecified and the `required_revision_id` doesn't exactly match the\npresentation's current `revision_id`, the request will not be processed and\nwill return a 400 bad request error."
+ "description": "The revision ID of the presentation required for the write request. If\nspecified and the `required_revision_id` doesn't exactly match the\npresentation's current `revision_id`, the request will not be processed and\nwill return a 400 bad request error.",
+ "type": "string"
}
},
"id": "WriteControl"
},
"DeleteParagraphBulletsRequest": {
+ "id": "DeleteParagraphBulletsRequest",
"description": "Deletes bullets from all of the paragraphs that overlap with the given text\nindex range.\n\nThe nesting level of each paragraph will be visually preserved by adding\nindent to the start of the corresponding paragraph.",
"type": "object",
"properties": {
@@ -3820,56 +295,41 @@
"description": "The range of text to delete bullets from, based on TextElement indexes."
},
"objectId": {
- "type": "string",
- "description": "The object ID of the shape or table containing the text to delete bullets\nfrom."
+ "description": "The object ID of the shape or table containing the text to delete bullets\nfrom.",
+ "type": "string"
},
"cellLocation": {
- "$ref": "TableCellLocation",
- "description": "The optional table cell location if the text to be modified is in a table\ncell. If present, the object_id must refer to a table."
+ "description": "The optional table cell location if the text to be modified is in a table\ncell. If present, the object_id must refer to a table.",
+ "$ref": "TableCellLocation"
}
- },
- "id": "DeleteParagraphBulletsRequest"
+ }
},
"ParagraphMarker": {
+ "id": "ParagraphMarker",
"description": "A TextElement kind that represents the beginning of a new paragraph.",
"type": "object",
"properties": {
- "bullet": {
- "$ref": "Bullet",
- "description": "The bullet for this paragraph. If not present, the paragraph does not\nbelong to a list."
- },
"style": {
"$ref": "ParagraphStyle",
"description": "The paragraph's style"
- }
- },
- "id": "ParagraphMarker"
- },
- "Thumbnail": {
- "type": "object",
- "properties": {
- "contentUrl": {
- "description": "The content URL of the thumbnail image.\n\nThe URL to the image has a default lifetime of 30 minutes.\nThis URL is tagged with the account of the requester. Anyone with the URL\neffectively accesses the image as the original requester. Access to the\nimage may be lost if the presentation's sharing settings change.\nThe mime type of the thumbnail image is the same as specified in the\n`GetPageThumbnailRequest`.",
- "type": "string"
},
- "width": {
- "type": "integer",
- "format": "int32",
- "description": "The positive width in pixels of the thumbnail image."
- },
- "height": {
- "type": "integer",
- "format": "int32",
- "description": "The positive height in pixels of the thumbnail image."
+ "bullet": {
+ "$ref": "Bullet",
+ "description": "The bullet for this paragraph. If not present, the paragraph does not\nbelong to a list."
}
- },
- "id": "Thumbnail",
- "description": "The thumbnail of a page."
+ }
},
"InsertTableColumnsRequest": {
- "description": "Inserts columns into a table.\n\nOther columns in the table will be resized to fit the new column.",
- "type": "object",
"properties": {
+ "number": {
+ "format": "int32",
+ "description": "The number of columns to be inserted. Maximum 20 per request.",
+ "type": "integer"
+ },
+ "cellLocation": {
+ "$ref": "TableCellLocation",
+ "description": "The reference table cell location from which columns will be inserted.\n\nA new column will be inserted to the left (or right) of the column where\nthe reference cell is. If the reference cell is a merged cell, a new\ncolumn will be inserted to the left (or right) of the merged cell."
+ },
"insertRight": {
"type": "boolean",
"description": "Whether to insert new columns to the right of the reference cell location.\n\n- `True`: insert to the right.\n- `False`: insert to the left."
@@ -3877,47 +337,75 @@
"tableObjectId": {
"description": "The table to insert columns into.",
"type": "string"
- },
- "number": {
- "type": "integer",
- "format": "int32",
- "description": "The number of columns to be inserted. Maximum 20 per request."
- },
- "cellLocation": {
- "$ref": "TableCellLocation",
- "description": "The reference table cell location from which columns will be inserted.\n\nA new column will be inserted to the left (or right) of the column where\nthe reference cell is. If the reference cell is a merged cell, a new\ncolumn will be inserted to the left (or right) of the merged cell."
}
},
- "id": "InsertTableColumnsRequest"
+ "id": "InsertTableColumnsRequest",
+ "description": "Inserts columns into a table.\n\nOther columns in the table will be resized to fit the new column.",
+ "type": "object"
},
- "LayoutPlaceholderIdMapping": {
+ "Thumbnail": {
+ "description": "The thumbnail of a page.",
"type": "object",
"properties": {
- "objectId": {
- "description": "A user-supplied object ID for the placeholder identified above that to be\ncreated onto a slide.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated.",
+ "height": {
+ "format": "int32",
+ "description": "The positive height in pixels of the thumbnail image.",
+ "type": "integer"
+ },
+ "contentUrl": {
+ "description": "The content URL of the thumbnail image.\n\nThe URL to the image has a default lifetime of 30 minutes.\nThis URL is tagged with the account of the requester. Anyone with the URL\neffectively accesses the image as the original requester. Access to the\nimage may be lost if the presentation's sharing settings change.\nThe mime type of the thumbnail image is the same as specified in the\n`GetPageThumbnailRequest`.",
"type": "string"
},
+ "width": {
+ "format": "int32",
+ "description": "The positive width in pixels of the thumbnail image.",
+ "type": "integer"
+ }
+ },
+ "id": "Thumbnail"
+ },
+ "LayoutPlaceholderIdMapping": {
+ "description": "The user-specified ID mapping for a placeholder that will be created on a\nslide from a specified layout.",
+ "type": "object",
+ "properties": {
"layoutPlaceholder": {
"$ref": "Placeholder",
"description": "The placeholder on a layout that will be applied to a slide. Only type and index are needed. For example, a\npredefined `TITLE_AND_BODY` layout may usually have a TITLE placeholder\nwith index 0 and a BODY placeholder with index 0."
},
"layoutPlaceholderObjectId": {
- "description": "The object ID of the placeholder on a layout that will be applied\nto a slide.",
+ "type": "string",
+ "description": "The object ID of the placeholder on a layout that will be applied\nto a slide."
+ },
+ "objectId": {
+ "description": "A user-supplied object ID for the placeholder identified above that to be\ncreated onto a slide.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated.",
"type": "string"
}
},
- "id": "LayoutPlaceholderIdMapping",
- "description": "The user-specified ID mapping for a placeholder that will be created on a\nslide from a specified layout."
+ "id": "LayoutPlaceholderIdMapping"
},
"UpdateTableBorderPropertiesRequest": {
+ "description": "Updates the properties of the table borders in a Table.",
"type": "object",
"properties": {
+ "tableRange": {
+ "description": "The table range representing the subset of the table to which the updates\nare applied. If a table range is not specified, the updates will apply to\nthe entire table.",
+ "$ref": "TableRange"
+ },
+ "objectId": {
+ "description": "The object ID of the table.",
+ "type": "string"
+ },
+ "tableBorderProperties": {
+ "$ref": "TableBorderProperties",
+ "description": "The table border properties to update."
+ },
"fields": {
- "type": "string",
"format": "google-fieldmask",
- "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `tableBorderProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the table border solid fill color, set\n`fields` to `\"tableBorderFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset."
+ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `tableBorderProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the table border solid fill color, set\n`fields` to `\"tableBorderFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
+ "type": "string"
},
"borderPosition": {
+ "description": "The border position in the table range the updates should apply to. If a\nborder position is not specified, the updates will apply to all borders in\nthe table range.",
"type": "string",
"enumDescriptions": [
"All borders in the range.",
@@ -3940,52 +428,38 @@
"OUTER",
"RIGHT",
"TOP"
- ],
- "description": "The border position in the table range the updates should apply to. If a\nborder position is not specified, the updates will apply to all borders in\nthe table range."
- },
- "tableRange": {
- "$ref": "TableRange",
- "description": "The table range representing the subset of the table to which the updates\nare applied. If a table range is not specified, the updates will apply to\nthe entire table."
- },
- "objectId": {
- "type": "string",
- "description": "The object ID of the table."
- },
- "tableBorderProperties": {
- "$ref": "TableBorderProperties",
- "description": "The table border properties to update."
+ ]
}
},
- "id": "UpdateTableBorderPropertiesRequest",
- "description": "Updates the properties of the table borders in a Table."
+ "id": "UpdateTableBorderPropertiesRequest"
},
"UpdateShapePropertiesRequest": {
+ "description": "Update the properties of a Shape.",
"type": "object",
"properties": {
"objectId": {
- "description": "The object ID of the shape the updates are applied to.",
- "type": "string"
+ "type": "string",
+ "description": "The object ID of the shape the updates are applied to."
},
"shapeProperties": {
- "$ref": "ShapeProperties",
- "description": "The shape properties to update."
+ "description": "The shape properties to update.",
+ "$ref": "ShapeProperties"
},
"fields": {
- "type": "string",
"format": "google-fieldmask",
- "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `shapeProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the shape background solid fill color, set `fields`\nto `\"shapeBackgroundFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset."
+ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `shapeProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the shape background solid fill color, set `fields`\nto `\"shapeBackgroundFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
+ "type": "string"
}
},
- "id": "UpdateShapePropertiesRequest",
- "description": "Update the properties of a Shape."
+ "id": "UpdateShapePropertiesRequest"
},
"WordArt": {
"description": "A PageElement kind representing\nword art.",
"type": "object",
"properties": {
"renderedText": {
- "type": "string",
- "description": "The text rendered as word art."
+ "description": "The text rendered as word art.",
+ "type": "string"
}
},
"id": "WordArt"
@@ -3993,10 +467,6 @@
"UpdateTableColumnPropertiesRequest": {
"type": "object",
"properties": {
- "objectId": {
- "description": "The object ID of the table.",
- "type": "string"
- },
"tableColumnProperties": {
"$ref": "TableColumnProperties",
"description": "The table column properties to update.\n\nIf the value of `table_column_properties#column_width` in the request is\nless than 406,400 EMU (32 points), a 400 bad request error is returned."
@@ -4010,8 +480,12 @@
"description": "The list of zero-based indices specifying which columns to update. If no\nindices are provided, all columns in the table will be updated."
},
"fields": {
+ "type": "string",
"format": "google-fieldmask",
- "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `tableColumnProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the column width, set `fields` to `\"column_width\"`.\n\nIf '\"column_width\"' is included in the field mask but the property is left\nunset, the column width will default to 406,400 EMU (32 points).",
+ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `tableColumnProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the column width, set `fields` to `\"column_width\"`.\n\nIf '\"column_width\"' is included in the field mask but the property is left\nunset, the column width will default to 406,400 EMU (32 points)."
+ },
+ "objectId": {
+ "description": "The object ID of the table.",
"type": "string"
}
},
@@ -4019,17 +493,17 @@
"description": "Updates the properties of a Table column."
},
"Recolor": {
+ "description": "A recolor effect applied on an image.",
"type": "object",
"properties": {
"recolorStops": {
+ "description": "The recolor effect is represented by a gradient, which is a list of color\nstops.\n\nThe colors in the gradient will replace the corresponding colors at\nthe same position in the color palette and apply to the image. This\nproperty is read-only.",
"items": {
"$ref": "ColorStop"
},
- "type": "array",
- "description": "The recolor effect is represented by a gradient, which is a list of color\nstops.\n\nThe colors in the gradient will replace the corresponding colors at\nthe same position in the color palette and apply to the image. This\nproperty is read-only."
+ "type": "array"
},
"name": {
- "type": "string",
"enumDescriptions": [
"No recolor effect. The default value.",
"A recolor effect that lightens the image using the page's first available\ncolor from its color scheme.",
@@ -4084,25 +558,23 @@
"SEPIA",
"CUSTOM"
],
- "description": "The name of the recolor effect.\n\nThe name is determined from the `recolor_stops` by matching the gradient\nagainst the colors in the page's current color scheme. This property is\nread-only."
+ "description": "The name of the recolor effect.\n\nThe name is determined from the `recolor_stops` by matching the gradient\nagainst the colors in the page's current color scheme. This property is\nread-only.",
+ "type": "string"
}
},
- "id": "Recolor",
- "description": "A recolor effect applied on an image."
+ "id": "Recolor"
},
"Link": {
+ "description": "A hypertext link.",
"type": "object",
"properties": {
- "pageObjectId": {
- "type": "string",
- "description": "If set, indicates this is a link to the specific page in this\npresentation with this ID. A page with this ID may not exist."
- },
"slideIndex": {
"format": "int32",
"description": "If set, indicates this is a link to the slide at this zero-based index\nin the presentation. There may not be a slide at this index.",
"type": "integer"
},
"relativeLink": {
+ "description": "If set, indicates this is a link to a slide in this presentation,\naddressed by its position.",
"type": "string",
"enumDescriptions": [
"An unspecified relative slide link.",
@@ -4117,18 +589,21 @@
"PREVIOUS_SLIDE",
"FIRST_SLIDE",
"LAST_SLIDE"
- ],
- "description": "If set, indicates this is a link to a slide in this presentation,\naddressed by its position."
+ ]
},
"url": {
"description": "If set, indicates this is a link to the external web page at this URL.",
"type": "string"
+ },
+ "pageObjectId": {
+ "description": "If set, indicates this is a link to the specific page in this\npresentation with this ID. A page with this ID may not exist.",
+ "type": "string"
}
},
- "id": "Link",
- "description": "A hypertext link."
+ "id": "Link"
},
"RgbColor": {
+ "description": "An RGB color.",
"type": "object",
"properties": {
"red": {
@@ -4137,9 +612,9 @@
"description": "The red component of the color, from 0.0 to 1.0."
},
"blue": {
+ "type": "number",
"format": "float",
- "description": "The blue component of the color, from 0.0 to 1.0.",
- "type": "number"
+ "description": "The blue component of the color, from 0.0 to 1.0."
},
"green": {
"format": "float",
@@ -4147,22 +622,20 @@
"type": "number"
}
},
- "id": "RgbColor",
- "description": "An RGB color."
+ "id": "RgbColor"
},
"CreateShapeResponse": {
+ "description": "The result of creating a shape.",
"type": "object",
"properties": {
"objectId": {
- "type": "string",
- "description": "The object ID of the created shape."
+ "description": "The object ID of the created shape.",
+ "type": "string"
}
},
- "id": "CreateShapeResponse",
- "description": "The result of creating a shape."
+ "id": "CreateShapeResponse"
},
"CreateLineRequest": {
- "type": "object",
"properties": {
"objectId": {
"description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated.",
@@ -4173,47 +646,3571 @@
"description": "The element properties for the line."
},
"lineCategory": {
+ "enumDescriptions": [
+ "Straight connectors, including straight connector 1. The is the default\ncategory when one is not specified.",
+ "Bent connectors, including bent connector 2 to 5.",
+ "Curved connectors, including curved connector 2 to 5."
+ ],
"enum": [
"STRAIGHT",
"BENT",
"CURVED"
],
"description": "The category of line to be created.",
- "type": "string",
- "enumDescriptions": [
- "Straight connectors, including straight connector 1. The is the default\ncategory when one is not specified.",
- "Bent connectors, including bent connector 2 to 5.",
- "Curved connectors, including curved connector 2 to 5."
- ]
+ "type": "string"
}
},
"id": "CreateLineRequest",
- "description": "Creates a line."
+ "description": "Creates a line.",
+ "type": "object"
},
"CreateSlideResponse": {
- "description": "The result of creating a slide.",
- "type": "object",
"properties": {
"objectId": {
"description": "The object ID of the created slide.",
"type": "string"
}
},
- "id": "CreateSlideResponse"
+ "id": "CreateSlideResponse",
+ "description": "The result of creating a slide.",
+ "type": "object"
+ },
+ "CreateShapeRequest": {
+ "description": "Creates a new shape.",
+ "type": "object",
+ "properties": {
+ "shapeType": {
+ "enumDescriptions": [
+ "The shape type that is not predefined.",
+ "Text box shape.",
+ "Rectangle shape. Corresponds to ECMA-376 ST_ShapeType 'rect'.",
+ "Round corner rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'roundRect'",
+ "Ellipse shape. Corresponds to ECMA-376 ST_ShapeType 'ellipse'",
+ "Curved arc shape. Corresponds to ECMA-376 ST_ShapeType 'arc'",
+ "Bent arrow shape. Corresponds to ECMA-376 ST_ShapeType 'bentArrow'",
+ "Bent up arrow shape. Corresponds to ECMA-376 ST_ShapeType 'bentUpArrow'",
+ "Bevel shape. Corresponds to ECMA-376 ST_ShapeType 'bevel'",
+ "Block arc shape. Corresponds to ECMA-376 ST_ShapeType 'blockArc'",
+ "Brace pair shape. Corresponds to ECMA-376 ST_ShapeType 'bracePair'",
+ "Bracket pair shape. Corresponds to ECMA-376 ST_ShapeType 'bracketPair'",
+ "Can shape. Corresponds to ECMA-376 ST_ShapeType 'can'",
+ "Chevron shape. Corresponds to ECMA-376 ST_ShapeType 'chevron'",
+ "Chord shape. Corresponds to ECMA-376 ST_ShapeType 'chord'",
+ "Cloud shape. Corresponds to ECMA-376 ST_ShapeType 'cloud'",
+ "Corner shape. Corresponds to ECMA-376 ST_ShapeType 'corner'",
+ "Cube shape. Corresponds to ECMA-376 ST_ShapeType 'cube'",
+ "Curved down arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'curvedDownArrow'",
+ "Curved left arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'curvedLeftArrow'",
+ "Curved right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'curvedRightArrow'",
+ "Curved up arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'curvedUpArrow'",
+ "Decagon shape. Corresponds to ECMA-376 ST_ShapeType 'decagon'",
+ "Diagonal stripe shape. Corresponds to ECMA-376 ST_ShapeType 'diagStripe'",
+ "Diamond shape. Corresponds to ECMA-376 ST_ShapeType 'diamond'",
+ "Dodecagon shape. Corresponds to ECMA-376 ST_ShapeType 'dodecagon'",
+ "Donut shape. Corresponds to ECMA-376 ST_ShapeType 'donut'",
+ "Double wave shape. Corresponds to ECMA-376 ST_ShapeType 'doubleWave'",
+ "Down arrow shape. Corresponds to ECMA-376 ST_ShapeType 'downArrow'",
+ "Callout down arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'downArrowCallout'",
+ "Folded corner shape. Corresponds to ECMA-376 ST_ShapeType 'foldedCorner'",
+ "Frame shape. Corresponds to ECMA-376 ST_ShapeType 'frame'",
+ "Half frame shape. Corresponds to ECMA-376 ST_ShapeType 'halfFrame'",
+ "Heart shape. Corresponds to ECMA-376 ST_ShapeType 'heart'",
+ "Heptagon shape. Corresponds to ECMA-376 ST_ShapeType 'heptagon'",
+ "Hexagon shape. Corresponds to ECMA-376 ST_ShapeType 'hexagon'",
+ "Home plate shape. Corresponds to ECMA-376 ST_ShapeType 'homePlate'",
+ "Horizontal scroll shape. Corresponds to ECMA-376 ST_ShapeType\n'horizontalScroll'",
+ "Irregular seal 1 shape. Corresponds to ECMA-376 ST_ShapeType\n'irregularSeal1'",
+ "Irregular seal 2 shape. Corresponds to ECMA-376 ST_ShapeType\n'irregularSeal2'",
+ "Left arrow shape. Corresponds to ECMA-376 ST_ShapeType 'leftArrow'",
+ "Callout left arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'leftArrowCallout'",
+ "Left brace shape. Corresponds to ECMA-376 ST_ShapeType 'leftBrace'",
+ "Left bracket shape. Corresponds to ECMA-376 ST_ShapeType 'leftBracket'",
+ "Left right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'leftRightArrow'",
+ "Callout left right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'leftRightArrowCallout'",
+ "Left right up arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'leftRightUpArrow'",
+ "Left up arrow shape. Corresponds to ECMA-376 ST_ShapeType 'leftUpArrow'",
+ "Lightning bolt shape. Corresponds to ECMA-376 ST_ShapeType\n'lightningBolt'",
+ "Divide math shape. Corresponds to ECMA-376 ST_ShapeType 'mathDivide'",
+ "Equal math shape. Corresponds to ECMA-376 ST_ShapeType 'mathEqual'",
+ "Minus math shape. Corresponds to ECMA-376 ST_ShapeType 'mathMinus'",
+ "Multiply math shape. Corresponds to ECMA-376 ST_ShapeType 'mathMultiply'",
+ "Not equal math shape. Corresponds to ECMA-376 ST_ShapeType 'mathNotEqual'",
+ "Plus math shape. Corresponds to ECMA-376 ST_ShapeType 'mathPlus'",
+ "Moon shape. Corresponds to ECMA-376 ST_ShapeType 'moon'",
+ "No smoking shape. Corresponds to ECMA-376 ST_ShapeType 'noSmoking'",
+ "Notched right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'notchedRightArrow'",
+ "Octagon shape. Corresponds to ECMA-376 ST_ShapeType 'octagon'",
+ "Parallelogram shape. Corresponds to ECMA-376 ST_ShapeType 'parallelogram'",
+ "Pentagon shape. Corresponds to ECMA-376 ST_ShapeType 'pentagon'",
+ "Pie shape. Corresponds to ECMA-376 ST_ShapeType 'pie'",
+ "Plaque shape. Corresponds to ECMA-376 ST_ShapeType 'plaque'",
+ "Plus shape. Corresponds to ECMA-376 ST_ShapeType 'plus'",
+ "Quad-arrow shape. Corresponds to ECMA-376 ST_ShapeType 'quadArrow'",
+ "Callout quad-arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'quadArrowCallout'",
+ "Ribbon shape. Corresponds to ECMA-376 ST_ShapeType 'ribbon'",
+ "Ribbon 2 shape. Corresponds to ECMA-376 ST_ShapeType 'ribbon2'",
+ "Right arrow shape. Corresponds to ECMA-376 ST_ShapeType 'rightArrow'",
+ "Callout right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'rightArrowCallout'",
+ "Right brace shape. Corresponds to ECMA-376 ST_ShapeType 'rightBrace'",
+ "Right bracket shape. Corresponds to ECMA-376 ST_ShapeType 'rightBracket'",
+ "One round corner rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'round1Rect'",
+ "Two diagonal round corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'round2DiagRect'",
+ "Two same-side round corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'round2SameRect'",
+ "Right triangle shape. Corresponds to ECMA-376 ST_ShapeType 'rtTriangle'",
+ "Smiley face shape. Corresponds to ECMA-376 ST_ShapeType 'smileyFace'",
+ "One snip corner rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'snip1Rect'",
+ "Two diagonal snip corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'snip2DiagRect'",
+ "Two same-side snip corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'snip2SameRect'",
+ "One snip one round corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'snipRoundRect'",
+ "Ten pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star10'",
+ "Twelve pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star12'",
+ "Sixteen pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star16'",
+ "Twenty four pointed star shape. Corresponds to ECMA-376 ST_ShapeType\n'star24'",
+ "Thirty two pointed star shape. Corresponds to ECMA-376 ST_ShapeType\n'star32'",
+ "Four pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star4'",
+ "Five pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star5'",
+ "Six pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star6'",
+ "Seven pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star7'",
+ "Eight pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star8'",
+ "Striped right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'stripedRightArrow'",
+ "Sun shape. Corresponds to ECMA-376 ST_ShapeType 'sun'",
+ "Trapezoid shape. Corresponds to ECMA-376 ST_ShapeType 'trapezoid'",
+ "Triangle shape. Corresponds to ECMA-376 ST_ShapeType 'triangle'",
+ "Up arrow shape. Corresponds to ECMA-376 ST_ShapeType 'upArrow'",
+ "Callout up arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'upArrowCallout'",
+ "Up down arrow shape. Corresponds to ECMA-376 ST_ShapeType 'upDownArrow'",
+ "U-turn arrow shape. Corresponds to ECMA-376 ST_ShapeType 'uturnArrow'",
+ "Vertical scroll shape. Corresponds to ECMA-376 ST_ShapeType\n'verticalScroll'",
+ "Wave shape. Corresponds to ECMA-376 ST_ShapeType 'wave'",
+ "Callout wedge ellipse shape. Corresponds to ECMA-376 ST_ShapeType\n'wedgeEllipseCallout'",
+ "Callout wedge rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'wedgeRectCallout'",
+ "Callout wedge round rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'wedgeRoundRectCallout'",
+ "Alternate process flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartAlternateProcess'",
+ "Collate flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartCollate'",
+ "Connector flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartConnector'",
+ "Decision flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartDecision'",
+ "Delay flow shape. Corresponds to ECMA-376 ST_ShapeType 'flowChartDelay'",
+ "Display flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartDisplay'",
+ "Document flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartDocument'",
+ "Extract flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartExtract'",
+ "Input output flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartInputOutput'",
+ "Internal storage flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartInternalStorage'",
+ "Magnetic disk flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartMagneticDisk'",
+ "Magnetic drum flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartMagneticDrum'",
+ "Magnetic tape flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartMagneticTape'",
+ "Manual input flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartManualInput'",
+ "Manual operation flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartManualOperation'",
+ "Merge flow shape. Corresponds to ECMA-376 ST_ShapeType 'flowChartMerge'",
+ "Multi-document flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartMultidocument'",
+ "Offline storage flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartOfflineStorage'",
+ "Off-page connector flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartOffpageConnector'",
+ "Online storage flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartOnlineStorage'",
+ "Or flow shape. Corresponds to ECMA-376 ST_ShapeType 'flowChartOr'",
+ "Predefined process flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartPredefinedProcess'",
+ "Preparation flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartPreparation'",
+ "Process flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartProcess'",
+ "Punched card flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartPunchedCard'",
+ "Punched tape flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartPunchedTape'",
+ "Sort flow shape. Corresponds to ECMA-376 ST_ShapeType 'flowChartSort'",
+ "Summing junction flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartSummingJunction'",
+ "Terminator flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartTerminator'",
+ "East arrow shape.",
+ "Northeast arrow shape.",
+ "North arrow shape.",
+ "Speech shape.",
+ "Star burst shape.",
+ "Teardrop shape. Corresponds to ECMA-376 ST_ShapeType 'teardrop'",
+ "Ellipse ribbon shape. Corresponds to ECMA-376 ST_ShapeType\n'ellipseRibbon'",
+ "Ellipse ribbon 2 shape. Corresponds to ECMA-376 ST_ShapeType\n'ellipseRibbon2'",
+ "Callout cloud shape. Corresponds to ECMA-376 ST_ShapeType 'cloudCallout'",
+ "Custom shape."
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "TEXT_BOX",
+ "RECTANGLE",
+ "ROUND_RECTANGLE",
+ "ELLIPSE",
+ "ARC",
+ "BENT_ARROW",
+ "BENT_UP_ARROW",
+ "BEVEL",
+ "BLOCK_ARC",
+ "BRACE_PAIR",
+ "BRACKET_PAIR",
+ "CAN",
+ "CHEVRON",
+ "CHORD",
+ "CLOUD",
+ "CORNER",
+ "CUBE",
+ "CURVED_DOWN_ARROW",
+ "CURVED_LEFT_ARROW",
+ "CURVED_RIGHT_ARROW",
+ "CURVED_UP_ARROW",
+ "DECAGON",
+ "DIAGONAL_STRIPE",
+ "DIAMOND",
+ "DODECAGON",
+ "DONUT",
+ "DOUBLE_WAVE",
+ "DOWN_ARROW",
+ "DOWN_ARROW_CALLOUT",
+ "FOLDED_CORNER",
+ "FRAME",
+ "HALF_FRAME",
+ "HEART",
+ "HEPTAGON",
+ "HEXAGON",
+ "HOME_PLATE",
+ "HORIZONTAL_SCROLL",
+ "IRREGULAR_SEAL_1",
+ "IRREGULAR_SEAL_2",
+ "LEFT_ARROW",
+ "LEFT_ARROW_CALLOUT",
+ "LEFT_BRACE",
+ "LEFT_BRACKET",
+ "LEFT_RIGHT_ARROW",
+ "LEFT_RIGHT_ARROW_CALLOUT",
+ "LEFT_RIGHT_UP_ARROW",
+ "LEFT_UP_ARROW",
+ "LIGHTNING_BOLT",
+ "MATH_DIVIDE",
+ "MATH_EQUAL",
+ "MATH_MINUS",
+ "MATH_MULTIPLY",
+ "MATH_NOT_EQUAL",
+ "MATH_PLUS",
+ "MOON",
+ "NO_SMOKING",
+ "NOTCHED_RIGHT_ARROW",
+ "OCTAGON",
+ "PARALLELOGRAM",
+ "PENTAGON",
+ "PIE",
+ "PLAQUE",
+ "PLUS",
+ "QUAD_ARROW",
+ "QUAD_ARROW_CALLOUT",
+ "RIBBON",
+ "RIBBON_2",
+ "RIGHT_ARROW",
+ "RIGHT_ARROW_CALLOUT",
+ "RIGHT_BRACE",
+ "RIGHT_BRACKET",
+ "ROUND_1_RECTANGLE",
+ "ROUND_2_DIAGONAL_RECTANGLE",
+ "ROUND_2_SAME_RECTANGLE",
+ "RIGHT_TRIANGLE",
+ "SMILEY_FACE",
+ "SNIP_1_RECTANGLE",
+ "SNIP_2_DIAGONAL_RECTANGLE",
+ "SNIP_2_SAME_RECTANGLE",
+ "SNIP_ROUND_RECTANGLE",
+ "STAR_10",
+ "STAR_12",
+ "STAR_16",
+ "STAR_24",
+ "STAR_32",
+ "STAR_4",
+ "STAR_5",
+ "STAR_6",
+ "STAR_7",
+ "STAR_8",
+ "STRIPED_RIGHT_ARROW",
+ "SUN",
+ "TRAPEZOID",
+ "TRIANGLE",
+ "UP_ARROW",
+ "UP_ARROW_CALLOUT",
+ "UP_DOWN_ARROW",
+ "UTURN_ARROW",
+ "VERTICAL_SCROLL",
+ "WAVE",
+ "WEDGE_ELLIPSE_CALLOUT",
+ "WEDGE_RECTANGLE_CALLOUT",
+ "WEDGE_ROUND_RECTANGLE_CALLOUT",
+ "FLOW_CHART_ALTERNATE_PROCESS",
+ "FLOW_CHART_COLLATE",
+ "FLOW_CHART_CONNECTOR",
+ "FLOW_CHART_DECISION",
+ "FLOW_CHART_DELAY",
+ "FLOW_CHART_DISPLAY",
+ "FLOW_CHART_DOCUMENT",
+ "FLOW_CHART_EXTRACT",
+ "FLOW_CHART_INPUT_OUTPUT",
+ "FLOW_CHART_INTERNAL_STORAGE",
+ "FLOW_CHART_MAGNETIC_DISK",
+ "FLOW_CHART_MAGNETIC_DRUM",
+ "FLOW_CHART_MAGNETIC_TAPE",
+ "FLOW_CHART_MANUAL_INPUT",
+ "FLOW_CHART_MANUAL_OPERATION",
+ "FLOW_CHART_MERGE",
+ "FLOW_CHART_MULTIDOCUMENT",
+ "FLOW_CHART_OFFLINE_STORAGE",
+ "FLOW_CHART_OFFPAGE_CONNECTOR",
+ "FLOW_CHART_ONLINE_STORAGE",
+ "FLOW_CHART_OR",
+ "FLOW_CHART_PREDEFINED_PROCESS",
+ "FLOW_CHART_PREPARATION",
+ "FLOW_CHART_PROCESS",
+ "FLOW_CHART_PUNCHED_CARD",
+ "FLOW_CHART_PUNCHED_TAPE",
+ "FLOW_CHART_SORT",
+ "FLOW_CHART_SUMMING_JUNCTION",
+ "FLOW_CHART_TERMINATOR",
+ "ARROW_EAST",
+ "ARROW_NORTH_EAST",
+ "ARROW_NORTH",
+ "SPEECH",
+ "STARBURST",
+ "TEARDROP",
+ "ELLIPSE_RIBBON",
+ "ELLIPSE_RIBBON_2",
+ "CLOUD_CALLOUT",
+ "CUSTOM"
+ ],
+ "description": "The shape type.",
+ "type": "string"
+ },
+ "objectId": {
+ "description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\nIf empty, a unique identifier will be generated.",
+ "type": "string"
+ },
+ "elementProperties": {
+ "$ref": "PageElementProperties",
+ "description": "The element properties for the shape."
+ }
+ },
+ "id": "CreateShapeRequest"
+ },
+ "Video": {
+ "description": "A PageElement kind representing a\nvideo.",
+ "type": "object",
+ "properties": {
+ "videoProperties": {
+ "$ref": "VideoProperties",
+ "description": "The properties of the video."
+ },
+ "source": {
+ "enumDescriptions": [
+ "The video source is unspecified.",
+ "The video source is YouTube."
+ ],
+ "enum": [
+ "SOURCE_UNSPECIFIED",
+ "YOUTUBE"
+ ],
+ "description": "The video source.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The video source's unique identifier for this video.",
+ "type": "string"
+ },
+ "url": {
+ "description": "An URL to a video. The URL is valid as long as the source video\nexists and sharing settings do not change.",
+ "type": "string"
+ }
+ },
+ "id": "Video"
+ },
+ "PageProperties": {
+ "description": "The properties of the Page.\n\nThe page will inherit properties from the parent page. Depending on the page\ntype the hierarchy is defined in either\nSlideProperties or\nLayoutProperties.",
+ "type": "object",
+ "properties": {
+ "pageBackgroundFill": {
+ "description": "The background fill of the page. If unset, the background fill is inherited\nfrom a parent page if it exists. If the page has no parent, then the\nbackground fill defaults to the corresponding fill in the Slides editor.",
+ "$ref": "PageBackgroundFill"
+ },
+ "colorScheme": {
+ "$ref": "ColorScheme",
+ "description": "The color scheme of the page. If unset, the color scheme is inherited from\na parent page. If the page has no parent, the color scheme uses a default\nSlides color scheme. This field is read-only."
+ }
+ },
+ "id": "PageProperties"
+ },
+ "TableCell": {
+ "type": "object",
+ "properties": {
+ "rowSpan": {
+ "format": "int32",
+ "description": "Row span of the cell.",
+ "type": "integer"
+ },
+ "location": {
+ "$ref": "TableCellLocation",
+ "description": "The location of the cell within the table."
+ },
+ "columnSpan": {
+ "format": "int32",
+ "description": "Column span of the cell.",
+ "type": "integer"
+ },
+ "text": {
+ "description": "The text content of the cell.",
+ "$ref": "TextContent"
+ },
+ "tableCellProperties": {
+ "$ref": "TableCellProperties",
+ "description": "The properties of the table cell."
+ }
+ },
+ "id": "TableCell",
+ "description": "Properties and contents of each table cell."
+ },
+ "NestingLevel": {
+ "properties": {
+ "bulletStyle": {
+ "$ref": "TextStyle",
+ "description": "The style of a bullet at this level of nesting."
+ }
+ },
+ "id": "NestingLevel",
+ "description": "Contains properties describing the look and feel of a list bullet at a given\nlevel of nesting.",
+ "type": "object"
+ },
+ "UpdateLinePropertiesRequest": {
+ "description": "Updates the properties of a Line.",
+ "type": "object",
+ "properties": {
+ "lineProperties": {
+ "$ref": "LineProperties",
+ "description": "The line properties to update."
+ },
+ "fields": {
+ "format": "google-fieldmask",
+ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `lineProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the line solid fill color, set `fields` to\n`\"lineFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
+ "type": "string"
+ },
+ "objectId": {
+ "description": "The object ID of the line the update is applied to.",
+ "type": "string"
+ }
+ },
+ "id": "UpdateLinePropertiesRequest"
+ },
+ "TableCellBackgroundFill": {
+ "description": "The table cell background fill.",
+ "type": "object",
+ "properties": {
+ "propertyState": {
+ "description": "The background fill property state.\n\nUpdating the the fill on a table cell will implicitly update this field\nto `RENDERED`, unless another value is specified in the same request. To\nhave no fill on a table cell, set this field to `NOT_RENDERED`. In this\ncase, any other fill fields set in the same request will be ignored.",
+ "type": "string",
+ "enumDescriptions": [
+ "If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.",
+ "If a property's state is NOT_RENDERED, then the element does not have the\ncorresponding property when rendered on a page. However, the field may\nstill be set so it can be inherited by child shapes. To remove a property\nfrom a rendered element, set its property_state to NOT_RENDERED.",
+ "If a property's state is INHERIT, then the property state uses the value of\ncorresponding `property_state` field on the parent shape. Elements that do\nnot inherit will never have an INHERIT property state."
+ ],
+ "enum": [
+ "RENDERED",
+ "NOT_RENDERED",
+ "INHERIT"
+ ]
+ },
+ "solidFill": {
+ "description": "Solid color fill.",
+ "$ref": "SolidFill"
+ }
+ },
+ "id": "TableCellBackgroundFill"
+ },
+ "UpdateSlidesPositionRequest": {
+ "description": "Updates the position of slides in the presentation.",
+ "type": "object",
+ "properties": {
+ "insertionIndex": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The index where the slides should be inserted, based on the slide\narrangement before the move takes place. Must be between zero and the\nnumber of slides in the presentation, inclusive."
+ },
+ "slideObjectIds": {
+ "description": "The IDs of the slides in the presentation that should be moved.\nThe slides in this list must be in existing presentation order, without\nduplicates.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "UpdateSlidesPositionRequest"
+ },
+ "UpdatePagePropertiesRequest": {
+ "id": "UpdatePagePropertiesRequest",
+ "description": "Updates the properties of a Page.",
+ "type": "object",
+ "properties": {
+ "fields": {
+ "format": "google-fieldmask",
+ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `pageProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the page background solid fill color, set `fields`\nto `\"pageBackgroundFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
+ "type": "string"
+ },
+ "pageProperties": {
+ "description": "The page properties to update.",
+ "$ref": "PageProperties"
+ },
+ "objectId": {
+ "description": "The object ID of the page the update is applied to.",
+ "type": "string"
+ }
+ }
+ },
+ "Group": {
+ "description": "A PageElement kind representing a\njoined collection of PageElements.",
+ "type": "object",
+ "properties": {
+ "children": {
+ "description": "The collection of elements in the group. The minimum size of a group is 2.",
+ "items": {
+ "$ref": "PageElement"
+ },
+ "type": "array"
+ }
+ },
+ "id": "Group"
+ },
+ "Placeholder": {
+ "properties": {
+ "type": {
+ "enumDescriptions": [
+ "Default value, signifies it is not a placeholder.",
+ "Body text.",
+ "Chart or graph.",
+ "Clip art image.",
+ "Title centered.",
+ "Diagram.",
+ "Date and time.",
+ "Footer text.",
+ "Header text.",
+ "Multimedia.",
+ "Any content type.",
+ "Picture.",
+ "Number of a slide.",
+ "Subtitle.",
+ "Table.",
+ "Slide title.",
+ "Slide image."
+ ],
+ "enum": [
+ "NONE",
+ "BODY",
+ "CHART",
+ "CLIP_ART",
+ "CENTERED_TITLE",
+ "DIAGRAM",
+ "DATE_AND_TIME",
+ "FOOTER",
+ "HEADER",
+ "MEDIA",
+ "OBJECT",
+ "PICTURE",
+ "SLIDE_NUMBER",
+ "SUBTITLE",
+ "TABLE",
+ "TITLE",
+ "SLIDE_IMAGE"
+ ],
+ "description": "The type of the placeholder.",
+ "type": "string"
+ },
+ "parentObjectId": {
+ "description": "The object ID of this shape's parent placeholder.\nIf unset, the parent placeholder shape does not exist, so the shape does\nnot inherit properties from any other shape.",
+ "type": "string"
+ },
+ "index": {
+ "format": "int32",
+ "description": "The index of the placeholder. If the same placeholder types are present in\nthe same page, they would have different index values.",
+ "type": "integer"
+ }
+ },
+ "id": "Placeholder",
+ "description": "The placeholder information that uniquely identifies a placeholder shape.",
+ "type": "object"
+ },
+ "DuplicateObjectRequest": {
+ "type": "object",
+ "properties": {
+ "objectIds": {
+ "description": "The object being duplicated may contain other objects, for example when\nduplicating a slide or a group page element. This map defines how the IDs\nof duplicated objects are generated: the keys are the IDs of the original\nobjects and its values are the IDs that will be assigned to the\ncorresponding duplicate object. The ID of the source object's duplicate\nmay be specified in this map as well, using the same value of the\n`object_id` field as a key and the newly desired ID as the value.\n\nAll keys must correspond to existing IDs in the presentation. All values\nmust be unique in the presentation and must start with an alphanumeric\ncharacter or an underscore (matches regex `[a-zA-Z0-9_]`); remaining\ncharacters may include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`). The length of the new ID must not be less than 5 or\ngreater than 50.\n\nIf any IDs of source objects are omitted from the map, a new random ID will\nbe assigned. If the map is empty or unset, all duplicate objects will\nreceive a new random ID.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "objectId": {
+ "description": "The ID of the object to duplicate.",
+ "type": "string"
+ }
+ },
+ "id": "DuplicateObjectRequest",
+ "description": "Duplicates a slide or page element.\n\nWhen duplicating a slide, the duplicate slide will be created immediately\nfollowing the specified slide. When duplicating a page element, the duplicate\nwill be placed on the same page at the same position as the original."
+ },
+ "ReplaceAllTextRequest": {
+ "type": "object",
+ "properties": {
+ "containsText": {
+ "description": "Finds text in a shape matching this substring.",
+ "$ref": "SubstringMatchCriteria"
+ },
+ "pageObjectIds": {
+ "description": "If non-empty, limits the matches to page elements only on the given pages.\n\nReturns a 400 bad request error if given the page object ID of a\nnotes master,\nor if a page with that object ID doesn't exist in the presentation.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "replaceText": {
+ "type": "string",
+ "description": "The text that will replace the matched text."
+ }
+ },
+ "id": "ReplaceAllTextRequest",
+ "description": "Replaces all instances of text matching a criteria with replace text."
+ },
+ "UnmergeTableCellsRequest": {
+ "description": "Unmerges cells in a Table.",
+ "type": "object",
+ "properties": {
+ "tableRange": {
+ "description": "The table range specifying which cells of the table to unmerge.\n\nAll merged cells in this range will be unmerged, and cells that are already\nunmerged will not be affected. If the range has no merged cells, the\nrequest will do nothing. If there is text in any of the merged cells, the\ntext will remain in the upper-left (\"head\") cell of the resulting block of\nunmerged cells.",
+ "$ref": "TableRange"
+ },
+ "objectId": {
+ "description": "The object ID of the table.",
+ "type": "string"
+ }
+ },
+ "id": "UnmergeTableCellsRequest"
+ },
+ "Page": {
+ "description": "A page in a presentation.",
+ "type": "object",
+ "properties": {
+ "masterProperties": {
+ "description": "Master specific properties. Only set if page_type = MASTER.",
+ "$ref": "MasterProperties"
+ },
+ "objectId": {
+ "description": "The object ID for this page. Object IDs used by\nPage and\nPageElement share the same namespace.",
+ "type": "string"
+ },
+ "revisionId": {
+ "description": "The revision ID of the presentation containing this page. Can be used in\nupdate requests to assert that the presentation revision hasn't changed\nsince the last read operation. Only populated if the user has edit access\nto the presentation.\n\nThe format of the revision ID may change over time, so it should be treated\nopaquely. A returned revision ID is only guaranteed to be valid for 24\nhours after it has been returned and cannot be shared across users. If the\nrevision ID is unchanged between calls, then the presentation has not\nchanged. Conversely, a changed ID (for the same presentation and user)\nusually means the presentation has been updated; however, a changed ID can\nalso be due to internal factors such as ID format changes.",
+ "type": "string"
+ },
+ "layoutProperties": {
+ "description": "Layout specific properties. Only set if page_type = LAYOUT.",
+ "$ref": "LayoutProperties"
+ },
+ "pageElements": {
+ "description": "The page elements rendered on the page.",
+ "items": {
+ "$ref": "PageElement"
+ },
+ "type": "array"
+ },
+ "pageType": {
+ "description": "The type of the page.",
+ "type": "string",
+ "enumDescriptions": [
+ "A slide page.",
+ "A master slide page.",
+ "A layout page.",
+ "A notes page.",
+ "A notes master page."
+ ],
+ "enum": [
+ "SLIDE",
+ "MASTER",
+ "LAYOUT",
+ "NOTES",
+ "NOTES_MASTER"
+ ]
+ },
+ "notesProperties": {
+ "$ref": "NotesProperties",
+ "description": "Notes specific properties. Only set if page_type = NOTES."
+ },
+ "pageProperties": {
+ "description": "The properties of the page.",
+ "$ref": "PageProperties"
+ },
+ "slideProperties": {
+ "description": "Slide specific properties. Only set if page_type = SLIDE.",
+ "$ref": "SlideProperties"
+ }
+ },
+ "id": "Page"
+ },
+ "ShapeBackgroundFill": {
+ "description": "The shape background fill.",
+ "type": "object",
+ "properties": {
+ "propertyState": {
+ "enum": [
+ "RENDERED",
+ "NOT_RENDERED",
+ "INHERIT"
+ ],
+ "description": "The background fill property state.\n\nUpdating the the fill on a shape will implicitly update this field to\n`RENDERED`, unless another value is specified in the same request. To\nhave no fill on a shape, set this field to `NOT_RENDERED`. In this case,\nany other fill fields set in the same request will be ignored.",
+ "type": "string",
+ "enumDescriptions": [
+ "If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.",
+ "If a property's state is NOT_RENDERED, then the element does not have the\ncorresponding property when rendered on a page. However, the field may\nstill be set so it can be inherited by child shapes. To remove a property\nfrom a rendered element, set its property_state to NOT_RENDERED.",
+ "If a property's state is INHERIT, then the property state uses the value of\ncorresponding `property_state` field on the parent shape. Elements that do\nnot inherit will never have an INHERIT property state."
+ ]
+ },
+ "solidFill": {
+ "description": "Solid color fill.",
+ "$ref": "SolidFill"
+ }
+ },
+ "id": "ShapeBackgroundFill"
+ },
+ "CropProperties": {
+ "type": "object",
+ "properties": {
+ "angle": {
+ "format": "float",
+ "description": "The rotation angle of the crop window around its center, in radians.\nRotation angle is applied after the offset.",
+ "type": "number"
+ },
+ "topOffset": {
+ "format": "float",
+ "description": "The offset specifies the top edge of the crop rectangle that is located\nbelow the original bounding rectangle top edge, relative to the object's\noriginal height.",
+ "type": "number"
+ },
+ "leftOffset": {
+ "format": "float",
+ "description": "The offset specifies the left edge of the crop rectangle that is located to\nthe right of the original bounding rectangle left edge, relative to the\nobject's original width.",
+ "type": "number"
+ },
+ "rightOffset": {
+ "format": "float",
+ "description": "The offset specifies the right edge of the crop rectangle that is located\nto the left of the original bounding rectangle right edge, relative to the\nobject's original width.",
+ "type": "number"
+ },
+ "bottomOffset": {
+ "format": "float",
+ "description": "The offset specifies the bottom edge of the crop rectangle that is located\nabove the original bounding rectangle bottom edge, relative to the object's\noriginal height.",
+ "type": "number"
+ }
+ },
+ "id": "CropProperties",
+ "description": "The crop properties of an object enclosed in a container. For example, an\nImage.\n\nThe crop properties is represented by the offsets of four edges which define\na crop rectangle. The offsets are measured in percentage from the\ncorresponding edges of the object's original bounding rectangle towards\ninside, relative to the object's original dimensions.\n\n- If the offset is in the interval (0, 1), the corresponding edge of crop\nrectangle is positioned inside of the object's original bounding rectangle.\n- If the offset is negative or greater than 1, the corresponding edge of crop\nrectangle is positioned outside of the object's original bounding rectangle.\n- If the left edge of the crop rectangle is on the right side of its right\nedge, the object will be flipped horizontally.\n- If the top edge of the crop rectangle is below its bottom edge, the object\nwill be flipped vertically.\n- If all offsets and rotation angle is 0, the object is not cropped.\n\nAfter cropping, the content in the crop rectangle will be stretched to fit\nits container."
+ },
+ "ReplaceAllShapesWithSheetsChartRequest": {
+ "description": "Replaces all shapes that match the given criteria with the provided Google\nSheets chart. The chart will be scaled and centered to fit within the bounds\nof the original shape.\n\nNOTE: Replacing shapes with a chart requires at least one of the\nspreadsheets.readonly, spreadsheets, drive.readonly, or drive OAuth scopes.",
+ "type": "object",
+ "properties": {
+ "linkingMode": {
+ "type": "string",
+ "enumDescriptions": [
+ "The chart is not associated with the source spreadsheet and cannot be\nupdated. A chart that is not linked will be inserted as an image.",
+ "Linking the chart allows it to be updated, and other collaborators will\nsee a link to the spreadsheet."
+ ],
+ "enum": [
+ "NOT_LINKED_IMAGE",
+ "LINKED"
+ ],
+ "description": "The mode with which the chart is linked to the source spreadsheet. When\nnot specified, the chart will be an image that is not linked."
+ },
+ "spreadsheetId": {
+ "description": "The ID of the Google Sheets spreadsheet that contains the chart.",
+ "type": "string"
+ },
+ "pageObjectIds": {
+ "description": "If non-empty, limits the matches to page elements only on the given pages.\n\nReturns a 400 bad request error if given the page object ID of a\nnotes page or a\nnotes master, or if a\npage with that object ID doesn't exist in the presentation.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "chartId": {
+ "format": "int32",
+ "description": "The ID of the specific chart in the Google Sheets spreadsheet.",
+ "type": "integer"
+ },
+ "containsText": {
+ "$ref": "SubstringMatchCriteria",
+ "description": "The criteria that the shapes must match in order to be replaced. The\nrequest will replace all of the shapes that contain the given text."
+ }
+ },
+ "id": "ReplaceAllShapesWithSheetsChartRequest"
+ },
+ "ColorStop": {
+ "description": "A color and position in a gradient band.",
+ "type": "object",
+ "properties": {
+ "color": {
+ "$ref": "OpaqueColor",
+ "description": "The color of the gradient stop."
+ },
+ "position": {
+ "format": "float",
+ "description": "The relative position of the color stop in the gradient band measured\nin percentage. The value should be in the interval [0.0, 1.0].",
+ "type": "number"
+ },
+ "alpha": {
+ "format": "float",
+ "description": "The alpha value of this color in the gradient band. Defaults to 1.0,\nfully opaque.",
+ "type": "number"
+ }
+ },
+ "id": "ColorStop"
+ },
+ "Range": {
+ "id": "Range",
+ "description": "Specifies a contiguous range of an indexed collection, such as characters in\ntext.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "enumDescriptions": [
+ "Unspecified range type. This value must not be used.",
+ "A fixed range. Both the `start_index` and\n`end_index` must be specified.",
+ "Starts the range at `start_index` and continues until the\nend of the collection. The `end_index` must not be specified.",
+ "Sets the range to be the whole length of the collection. Both the\n`start_index` and the `end_index` must not be\nspecified."
+ ],
+ "enum": [
+ "RANGE_TYPE_UNSPECIFIED",
+ "FIXED_RANGE",
+ "FROM_START_INDEX",
+ "ALL"
+ ],
+ "description": "The type of range.",
+ "type": "string"
+ },
+ "endIndex": {
+ "format": "int32",
+ "description": "The optional zero-based index of the end of the collection.\nRequired for `FIXED_RANGE` ranges.",
+ "type": "integer"
+ },
+ "startIndex": {
+ "format": "int32",
+ "description": "The optional zero-based index of the beginning of the collection.\nRequired for `FIXED_RANGE` and `FROM_START_INDEX` ranges.",
+ "type": "integer"
+ }
+ }
+ },
+ "CreateVideoRequest": {
+ "description": "Creates a video.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The video source's unique identifier for this video.\n\ne.g. For YouTube video https://www.youtube.com/watch?v=7U3axjORYZ0,\nthe ID is 7U3axjORYZ0.",
+ "type": "string"
+ },
+ "source": {
+ "description": "The video source.",
+ "type": "string",
+ "enumDescriptions": [
+ "The video source is unspecified.",
+ "The video source is YouTube."
+ ],
+ "enum": [
+ "SOURCE_UNSPECIFIED",
+ "YOUTUBE"
+ ]
+ },
+ "objectId": {
+ "description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated.",
+ "type": "string"
+ },
+ "elementProperties": {
+ "description": "The element properties for the video.",
+ "$ref": "PageElementProperties"
+ }
+ },
+ "id": "CreateVideoRequest"
+ },
+ "DuplicateObjectResponse": {
+ "description": "The response of duplicating an object.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "type": "string",
+ "description": "The ID of the new duplicate object."
+ }
+ },
+ "id": "DuplicateObjectResponse"
+ },
+ "ReplaceAllShapesWithImageRequest": {
+ "description": "Replaces all shapes that match the given criteria with the provided image.",
+ "type": "object",
+ "properties": {
+ "pageObjectIds": {
+ "description": "If non-empty, limits the matches to page elements only on the given pages.\n\nReturns a 400 bad request error if given the page object ID of a\nnotes page or a\nnotes master, or if a\npage with that object ID doesn't exist in the presentation.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "containsText": {
+ "$ref": "SubstringMatchCriteria",
+ "description": "If set, this request will replace all of the shapes that contain the\ngiven text."
+ },
+ "imageUrl": {
+ "description": "The image URL.\n\nThe image is fetched once at insertion time and a copy is stored for\ndisplay inside the presentation. Images must be less than 50MB in size,\ncannot exceed 25 megapixels, and must be in either in PNG, JPEG, or GIF\nformat.\n\nThe provided URL can be at maximum 2K bytes large.",
+ "type": "string"
+ },
+ "replaceMethod": {
+ "enum": [
+ "CENTER_INSIDE",
+ "CENTER_CROP"
+ ],
+ "description": "The replace method.",
+ "type": "string",
+ "enumDescriptions": [
+ "Scales and centers the image to fit within the bounds of the original\nshape and maintains the image's aspect ratio. The rendered size of the\nimage may be smaller than the size of the shape. This is the default\nmethod when one is not specified.",
+ "Scales and centers the image to fill the bounds of the original shape.\nThe image may be cropped in order to fill the shape. The rendered size of\nthe image will be the same as that of the original shape."
+ ]
+ }
+ },
+ "id": "ReplaceAllShapesWithImageRequest"
+ },
+ "MergeTableCellsRequest": {
+ "description": "Merges cells in a Table.",
+ "type": "object",
+ "properties": {
+ "tableRange": {
+ "$ref": "TableRange",
+ "description": "The table range specifying which cells of the table to merge.\n\nAny text in the cells being merged will be concatenated and stored in the\nupper-left (\"head\") cell of the range. If the range is non-rectangular\n(which can occur in some cases where the range covers cells that are\nalready merged), a 400 bad request error is returned."
+ },
+ "objectId": {
+ "description": "The object ID of the table.",
+ "type": "string"
+ }
+ },
+ "id": "MergeTableCellsRequest"
+ },
+ "Shadow": {
+ "description": "The shadow properties of a page element.\n\nIf these fields are unset, they may be inherited from a parent placeholder\nif it exists. If there is no parent, the fields will default to the value\nused for new page elements created in the Slides editor, which may depend on\nthe page element kind.",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "The shadow color value.",
+ "$ref": "OpaqueColor"
+ },
+ "rotateWithShape": {
+ "description": "Whether the shadow should rotate with the shape.",
+ "type": "boolean"
+ },
+ "propertyState": {
+ "enum": [
+ "RENDERED",
+ "NOT_RENDERED",
+ "INHERIT"
+ ],
+ "description": "The shadow property state.\n\nUpdating the the shadow on a page element will implicitly update this field\nto `RENDERED`, unless another value is specified in the same request. To\nhave no shadow on a page element, set this field to `NOT_RENDERED`. In this\ncase, any other shadow fields set in the same request will be ignored.",
+ "type": "string",
+ "enumDescriptions": [
+ "If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.",
+ "If a property's state is NOT_RENDERED, then the element does not have the\ncorresponding property when rendered on a page. However, the field may\nstill be set so it can be inherited by child shapes. To remove a property\nfrom a rendered element, set its property_state to NOT_RENDERED.",
+ "If a property's state is INHERIT, then the property state uses the value of\ncorresponding `property_state` field on the parent shape. Elements that do\nnot inherit will never have an INHERIT property state."
+ ]
+ },
+ "blurRadius": {
+ "$ref": "Dimension",
+ "description": "The radius of the shadow blur. The larger the radius, the more diffuse the\nshadow becomes."
+ },
+ "type": {
+ "enumDescriptions": [
+ "Unspecified shadow type.",
+ "Outer shadow."
+ ],
+ "enum": [
+ "SHADOW_TYPE_UNSPECIFIED",
+ "OUTER"
+ ],
+ "description": "The type of the shadow.",
+ "type": "string"
+ },
+ "transform": {
+ "$ref": "AffineTransform",
+ "description": "Transform that encodes the translate, scale, and skew of the shadow,\nrelative to the alignment position."
+ },
+ "alignment": {
+ "enumDescriptions": [
+ "Unspecified.",
+ "Top left.",
+ "Top center.",
+ "Top right.",
+ "Left center.",
+ "Center.",
+ "Right center.",
+ "Bottom left.",
+ "Bottom center.",
+ "Bottom right."
+ ],
+ "enum": [
+ "RECTANGLE_POSITION_UNSPECIFIED",
+ "TOP_LEFT",
+ "TOP_CENTER",
+ "TOP_RIGHT",
+ "LEFT_CENTER",
+ "CENTER",
+ "RIGHT_CENTER",
+ "BOTTOM_LEFT",
+ "BOTTOM_CENTER",
+ "BOTTOM_RIGHT"
+ ],
+ "description": "The alignment point of the shadow, that sets the origin for translate,\nscale and skew of the shadow.",
+ "type": "string"
+ },
+ "alpha": {
+ "format": "float",
+ "description": "The alpha of the shadow's color, from 0.0 to 1.0.",
+ "type": "number"
+ }
+ },
+ "id": "Shadow"
+ },
+ "UngroupObjectsRequest": {
+ "description": "Ungroups objects, such as groups.",
+ "type": "object",
+ "properties": {
+ "objectIds": {
+ "description": "The object IDs of the objects to ungroup.\n\nOnly groups that are not inside other\ngroups can be ungrouped. All the groups\nshould be on the same page. The group itself is deleted. The visual sizes\nand positions of all the children are preserved.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "UngroupObjectsRequest"
+ },
+ "DeleteTableRowRequest": {
+ "properties": {
+ "cellLocation": {
+ "$ref": "TableCellLocation",
+ "description": "The reference table cell location from which a row will be deleted.\n\nThe row this cell spans will be deleted. If this is a merged cell, multiple\nrows will be deleted. If no rows remain in the table after this deletion,\nthe whole table is deleted."
+ },
+ "tableObjectId": {
+ "description": "The table to delete rows from.",
+ "type": "string"
+ }
+ },
+ "id": "DeleteTableRowRequest",
+ "description": "Deletes a row from a table.",
+ "type": "object"
+ },
+ "Bullet": {
+ "description": "Describes the bullet of a paragraph.",
+ "type": "object",
+ "properties": {
+ "glyph": {
+ "description": "The rendered bullet glyph for this paragraph.",
+ "type": "string"
+ },
+ "nestingLevel": {
+ "format": "int32",
+ "description": "The nesting level of this paragraph in the list.",
+ "type": "integer"
+ },
+ "bulletStyle": {
+ "description": "The paragraph specific text style applied to this bullet.",
+ "$ref": "TextStyle"
+ },
+ "listId": {
+ "description": "The ID of the list this paragraph belongs to.",
+ "type": "string"
+ }
+ },
+ "id": "Bullet"
+ },
+ "OutlineFill": {
+ "properties": {
+ "solidFill": {
+ "$ref": "SolidFill",
+ "description": "Solid color fill."
+ }
+ },
+ "id": "OutlineFill",
+ "description": "The fill of the outline.",
+ "type": "object"
+ },
+ "TableCellLocation": {
+ "description": "A location of a single table cell within a table.",
+ "type": "object",
+ "properties": {
+ "columnIndex": {
+ "format": "int32",
+ "description": "The 0-based column index.",
+ "type": "integer"
+ },
+ "rowIndex": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The 0-based row index."
+ }
+ },
+ "id": "TableCellLocation"
+ },
+ "CreateLineResponse": {
+ "description": "The result of creating a line.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the created line.",
+ "type": "string"
+ }
+ },
+ "id": "CreateLineResponse"
+ },
+ "ReplaceAllTextResponse": {
+ "description": "The result of replacing text.",
+ "type": "object",
+ "properties": {
+ "occurrencesChanged": {
+ "format": "int32",
+ "description": "The number of occurrences changed by replacing all text.",
+ "type": "integer"
+ }
+ },
+ "id": "ReplaceAllTextResponse"
+ },
+ "TableBorderFill": {
+ "description": "The fill of the border.",
+ "type": "object",
+ "properties": {
+ "solidFill": {
+ "description": "Solid fill.",
+ "$ref": "SolidFill"
+ }
+ },
+ "id": "TableBorderFill"
+ },
+ "UpdateParagraphStyleRequest": {
+ "description": "Updates the styling for all of the paragraphs within a Shape or Table that\noverlap with the given text index range.",
+ "type": "object",
+ "properties": {
+ "style": {
+ "description": "The paragraph's style.",
+ "$ref": "ParagraphStyle"
+ },
+ "cellLocation": {
+ "$ref": "TableCellLocation",
+ "description": "The location of the cell in the table containing the paragraph(s) to\nstyle. If `object_id` refers to a table, `cell_location` must have a value.\nOtherwise, it must not."
+ },
+ "fields": {
+ "format": "google-fieldmask",
+ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `style` is implied and\nshould not be specified. A single `\"*\"` can be used as short-hand for\nlisting every field.\n\nFor example, to update the paragraph alignment, set `fields` to\n`\"alignment\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
+ "type": "string"
+ },
+ "textRange": {
+ "description": "The range of text containing the paragraph(s) to style.",
+ "$ref": "Range"
+ },
+ "objectId": {
+ "description": "The object ID of the shape or table with the text to be styled.",
+ "type": "string"
+ }
+ },
+ "id": "UpdateParagraphStyleRequest"
+ },
+ "ColorScheme": {
+ "description": "The palette of predefined colors for a page.",
+ "type": "object",
+ "properties": {
+ "colors": {
+ "items": {
+ "$ref": "ThemeColorPair"
+ },
+ "type": "array",
+ "description": "The ThemeColorType and corresponding concrete color pairs."
+ }
+ },
+ "id": "ColorScheme"
+ },
+ "Shape": {
+ "description": "A PageElement kind representing a\ngeneric shape that does not have a more specific classification.",
+ "type": "object",
+ "properties": {
+ "placeholder": {
+ "$ref": "Placeholder",
+ "description": "Placeholders are shapes that are inherit from corresponding placeholders on\nlayouts and masters.\n\nIf set, the shape is a placeholder shape and any inherited properties\ncan be resolved by looking at the parent placeholder identified by the\nPlaceholder.parent_object_id field."
+ },
+ "text": {
+ "description": "The text content of the shape.",
+ "$ref": "TextContent"
+ },
+ "shapeType": {
+ "description": "The type of the shape.",
+ "type": "string",
+ "enumDescriptions": [
+ "The shape type that is not predefined.",
+ "Text box shape.",
+ "Rectangle shape. Corresponds to ECMA-376 ST_ShapeType 'rect'.",
+ "Round corner rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'roundRect'",
+ "Ellipse shape. Corresponds to ECMA-376 ST_ShapeType 'ellipse'",
+ "Curved arc shape. Corresponds to ECMA-376 ST_ShapeType 'arc'",
+ "Bent arrow shape. Corresponds to ECMA-376 ST_ShapeType 'bentArrow'",
+ "Bent up arrow shape. Corresponds to ECMA-376 ST_ShapeType 'bentUpArrow'",
+ "Bevel shape. Corresponds to ECMA-376 ST_ShapeType 'bevel'",
+ "Block arc shape. Corresponds to ECMA-376 ST_ShapeType 'blockArc'",
+ "Brace pair shape. Corresponds to ECMA-376 ST_ShapeType 'bracePair'",
+ "Bracket pair shape. Corresponds to ECMA-376 ST_ShapeType 'bracketPair'",
+ "Can shape. Corresponds to ECMA-376 ST_ShapeType 'can'",
+ "Chevron shape. Corresponds to ECMA-376 ST_ShapeType 'chevron'",
+ "Chord shape. Corresponds to ECMA-376 ST_ShapeType 'chord'",
+ "Cloud shape. Corresponds to ECMA-376 ST_ShapeType 'cloud'",
+ "Corner shape. Corresponds to ECMA-376 ST_ShapeType 'corner'",
+ "Cube shape. Corresponds to ECMA-376 ST_ShapeType 'cube'",
+ "Curved down arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'curvedDownArrow'",
+ "Curved left arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'curvedLeftArrow'",
+ "Curved right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'curvedRightArrow'",
+ "Curved up arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'curvedUpArrow'",
+ "Decagon shape. Corresponds to ECMA-376 ST_ShapeType 'decagon'",
+ "Diagonal stripe shape. Corresponds to ECMA-376 ST_ShapeType 'diagStripe'",
+ "Diamond shape. Corresponds to ECMA-376 ST_ShapeType 'diamond'",
+ "Dodecagon shape. Corresponds to ECMA-376 ST_ShapeType 'dodecagon'",
+ "Donut shape. Corresponds to ECMA-376 ST_ShapeType 'donut'",
+ "Double wave shape. Corresponds to ECMA-376 ST_ShapeType 'doubleWave'",
+ "Down arrow shape. Corresponds to ECMA-376 ST_ShapeType 'downArrow'",
+ "Callout down arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'downArrowCallout'",
+ "Folded corner shape. Corresponds to ECMA-376 ST_ShapeType 'foldedCorner'",
+ "Frame shape. Corresponds to ECMA-376 ST_ShapeType 'frame'",
+ "Half frame shape. Corresponds to ECMA-376 ST_ShapeType 'halfFrame'",
+ "Heart shape. Corresponds to ECMA-376 ST_ShapeType 'heart'",
+ "Heptagon shape. Corresponds to ECMA-376 ST_ShapeType 'heptagon'",
+ "Hexagon shape. Corresponds to ECMA-376 ST_ShapeType 'hexagon'",
+ "Home plate shape. Corresponds to ECMA-376 ST_ShapeType 'homePlate'",
+ "Horizontal scroll shape. Corresponds to ECMA-376 ST_ShapeType\n'horizontalScroll'",
+ "Irregular seal 1 shape. Corresponds to ECMA-376 ST_ShapeType\n'irregularSeal1'",
+ "Irregular seal 2 shape. Corresponds to ECMA-376 ST_ShapeType\n'irregularSeal2'",
+ "Left arrow shape. Corresponds to ECMA-376 ST_ShapeType 'leftArrow'",
+ "Callout left arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'leftArrowCallout'",
+ "Left brace shape. Corresponds to ECMA-376 ST_ShapeType 'leftBrace'",
+ "Left bracket shape. Corresponds to ECMA-376 ST_ShapeType 'leftBracket'",
+ "Left right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'leftRightArrow'",
+ "Callout left right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'leftRightArrowCallout'",
+ "Left right up arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'leftRightUpArrow'",
+ "Left up arrow shape. Corresponds to ECMA-376 ST_ShapeType 'leftUpArrow'",
+ "Lightning bolt shape. Corresponds to ECMA-376 ST_ShapeType\n'lightningBolt'",
+ "Divide math shape. Corresponds to ECMA-376 ST_ShapeType 'mathDivide'",
+ "Equal math shape. Corresponds to ECMA-376 ST_ShapeType 'mathEqual'",
+ "Minus math shape. Corresponds to ECMA-376 ST_ShapeType 'mathMinus'",
+ "Multiply math shape. Corresponds to ECMA-376 ST_ShapeType 'mathMultiply'",
+ "Not equal math shape. Corresponds to ECMA-376 ST_ShapeType 'mathNotEqual'",
+ "Plus math shape. Corresponds to ECMA-376 ST_ShapeType 'mathPlus'",
+ "Moon shape. Corresponds to ECMA-376 ST_ShapeType 'moon'",
+ "No smoking shape. Corresponds to ECMA-376 ST_ShapeType 'noSmoking'",
+ "Notched right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'notchedRightArrow'",
+ "Octagon shape. Corresponds to ECMA-376 ST_ShapeType 'octagon'",
+ "Parallelogram shape. Corresponds to ECMA-376 ST_ShapeType 'parallelogram'",
+ "Pentagon shape. Corresponds to ECMA-376 ST_ShapeType 'pentagon'",
+ "Pie shape. Corresponds to ECMA-376 ST_ShapeType 'pie'",
+ "Plaque shape. Corresponds to ECMA-376 ST_ShapeType 'plaque'",
+ "Plus shape. Corresponds to ECMA-376 ST_ShapeType 'plus'",
+ "Quad-arrow shape. Corresponds to ECMA-376 ST_ShapeType 'quadArrow'",
+ "Callout quad-arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'quadArrowCallout'",
+ "Ribbon shape. Corresponds to ECMA-376 ST_ShapeType 'ribbon'",
+ "Ribbon 2 shape. Corresponds to ECMA-376 ST_ShapeType 'ribbon2'",
+ "Right arrow shape. Corresponds to ECMA-376 ST_ShapeType 'rightArrow'",
+ "Callout right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'rightArrowCallout'",
+ "Right brace shape. Corresponds to ECMA-376 ST_ShapeType 'rightBrace'",
+ "Right bracket shape. Corresponds to ECMA-376 ST_ShapeType 'rightBracket'",
+ "One round corner rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'round1Rect'",
+ "Two diagonal round corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'round2DiagRect'",
+ "Two same-side round corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'round2SameRect'",
+ "Right triangle shape. Corresponds to ECMA-376 ST_ShapeType 'rtTriangle'",
+ "Smiley face shape. Corresponds to ECMA-376 ST_ShapeType 'smileyFace'",
+ "One snip corner rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'snip1Rect'",
+ "Two diagonal snip corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'snip2DiagRect'",
+ "Two same-side snip corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'snip2SameRect'",
+ "One snip one round corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'snipRoundRect'",
+ "Ten pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star10'",
+ "Twelve pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star12'",
+ "Sixteen pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star16'",
+ "Twenty four pointed star shape. Corresponds to ECMA-376 ST_ShapeType\n'star24'",
+ "Thirty two pointed star shape. Corresponds to ECMA-376 ST_ShapeType\n'star32'",
+ "Four pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star4'",
+ "Five pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star5'",
+ "Six pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star6'",
+ "Seven pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star7'",
+ "Eight pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star8'",
+ "Striped right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'stripedRightArrow'",
+ "Sun shape. Corresponds to ECMA-376 ST_ShapeType 'sun'",
+ "Trapezoid shape. Corresponds to ECMA-376 ST_ShapeType 'trapezoid'",
+ "Triangle shape. Corresponds to ECMA-376 ST_ShapeType 'triangle'",
+ "Up arrow shape. Corresponds to ECMA-376 ST_ShapeType 'upArrow'",
+ "Callout up arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'upArrowCallout'",
+ "Up down arrow shape. Corresponds to ECMA-376 ST_ShapeType 'upDownArrow'",
+ "U-turn arrow shape. Corresponds to ECMA-376 ST_ShapeType 'uturnArrow'",
+ "Vertical scroll shape. Corresponds to ECMA-376 ST_ShapeType\n'verticalScroll'",
+ "Wave shape. Corresponds to ECMA-376 ST_ShapeType 'wave'",
+ "Callout wedge ellipse shape. Corresponds to ECMA-376 ST_ShapeType\n'wedgeEllipseCallout'",
+ "Callout wedge rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'wedgeRectCallout'",
+ "Callout wedge round rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'wedgeRoundRectCallout'",
+ "Alternate process flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartAlternateProcess'",
+ "Collate flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartCollate'",
+ "Connector flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartConnector'",
+ "Decision flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartDecision'",
+ "Delay flow shape. Corresponds to ECMA-376 ST_ShapeType 'flowChartDelay'",
+ "Display flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartDisplay'",
+ "Document flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartDocument'",
+ "Extract flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartExtract'",
+ "Input output flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartInputOutput'",
+ "Internal storage flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartInternalStorage'",
+ "Magnetic disk flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartMagneticDisk'",
+ "Magnetic drum flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartMagneticDrum'",
+ "Magnetic tape flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartMagneticTape'",
+ "Manual input flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartManualInput'",
+ "Manual operation flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartManualOperation'",
+ "Merge flow shape. Corresponds to ECMA-376 ST_ShapeType 'flowChartMerge'",
+ "Multi-document flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartMultidocument'",
+ "Offline storage flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartOfflineStorage'",
+ "Off-page connector flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartOffpageConnector'",
+ "Online storage flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartOnlineStorage'",
+ "Or flow shape. Corresponds to ECMA-376 ST_ShapeType 'flowChartOr'",
+ "Predefined process flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartPredefinedProcess'",
+ "Preparation flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartPreparation'",
+ "Process flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartProcess'",
+ "Punched card flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartPunchedCard'",
+ "Punched tape flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartPunchedTape'",
+ "Sort flow shape. Corresponds to ECMA-376 ST_ShapeType 'flowChartSort'",
+ "Summing junction flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartSummingJunction'",
+ "Terminator flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartTerminator'",
+ "East arrow shape.",
+ "Northeast arrow shape.",
+ "North arrow shape.",
+ "Speech shape.",
+ "Star burst shape.",
+ "Teardrop shape. Corresponds to ECMA-376 ST_ShapeType 'teardrop'",
+ "Ellipse ribbon shape. Corresponds to ECMA-376 ST_ShapeType\n'ellipseRibbon'",
+ "Ellipse ribbon 2 shape. Corresponds to ECMA-376 ST_ShapeType\n'ellipseRibbon2'",
+ "Callout cloud shape. Corresponds to ECMA-376 ST_ShapeType 'cloudCallout'",
+ "Custom shape."
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "TEXT_BOX",
+ "RECTANGLE",
+ "ROUND_RECTANGLE",
+ "ELLIPSE",
+ "ARC",
+ "BENT_ARROW",
+ "BENT_UP_ARROW",
+ "BEVEL",
+ "BLOCK_ARC",
+ "BRACE_PAIR",
+ "BRACKET_PAIR",
+ "CAN",
+ "CHEVRON",
+ "CHORD",
+ "CLOUD",
+ "CORNER",
+ "CUBE",
+ "CURVED_DOWN_ARROW",
+ "CURVED_LEFT_ARROW",
+ "CURVED_RIGHT_ARROW",
+ "CURVED_UP_ARROW",
+ "DECAGON",
+ "DIAGONAL_STRIPE",
+ "DIAMOND",
+ "DODECAGON",
+ "DONUT",
+ "DOUBLE_WAVE",
+ "DOWN_ARROW",
+ "DOWN_ARROW_CALLOUT",
+ "FOLDED_CORNER",
+ "FRAME",
+ "HALF_FRAME",
+ "HEART",
+ "HEPTAGON",
+ "HEXAGON",
+ "HOME_PLATE",
+ "HORIZONTAL_SCROLL",
+ "IRREGULAR_SEAL_1",
+ "IRREGULAR_SEAL_2",
+ "LEFT_ARROW",
+ "LEFT_ARROW_CALLOUT",
+ "LEFT_BRACE",
+ "LEFT_BRACKET",
+ "LEFT_RIGHT_ARROW",
+ "LEFT_RIGHT_ARROW_CALLOUT",
+ "LEFT_RIGHT_UP_ARROW",
+ "LEFT_UP_ARROW",
+ "LIGHTNING_BOLT",
+ "MATH_DIVIDE",
+ "MATH_EQUAL",
+ "MATH_MINUS",
+ "MATH_MULTIPLY",
+ "MATH_NOT_EQUAL",
+ "MATH_PLUS",
+ "MOON",
+ "NO_SMOKING",
+ "NOTCHED_RIGHT_ARROW",
+ "OCTAGON",
+ "PARALLELOGRAM",
+ "PENTAGON",
+ "PIE",
+ "PLAQUE",
+ "PLUS",
+ "QUAD_ARROW",
+ "QUAD_ARROW_CALLOUT",
+ "RIBBON",
+ "RIBBON_2",
+ "RIGHT_ARROW",
+ "RIGHT_ARROW_CALLOUT",
+ "RIGHT_BRACE",
+ "RIGHT_BRACKET",
+ "ROUND_1_RECTANGLE",
+ "ROUND_2_DIAGONAL_RECTANGLE",
+ "ROUND_2_SAME_RECTANGLE",
+ "RIGHT_TRIANGLE",
+ "SMILEY_FACE",
+ "SNIP_1_RECTANGLE",
+ "SNIP_2_DIAGONAL_RECTANGLE",
+ "SNIP_2_SAME_RECTANGLE",
+ "SNIP_ROUND_RECTANGLE",
+ "STAR_10",
+ "STAR_12",
+ "STAR_16",
+ "STAR_24",
+ "STAR_32",
+ "STAR_4",
+ "STAR_5",
+ "STAR_6",
+ "STAR_7",
+ "STAR_8",
+ "STRIPED_RIGHT_ARROW",
+ "SUN",
+ "TRAPEZOID",
+ "TRIANGLE",
+ "UP_ARROW",
+ "UP_ARROW_CALLOUT",
+ "UP_DOWN_ARROW",
+ "UTURN_ARROW",
+ "VERTICAL_SCROLL",
+ "WAVE",
+ "WEDGE_ELLIPSE_CALLOUT",
+ "WEDGE_RECTANGLE_CALLOUT",
+ "WEDGE_ROUND_RECTANGLE_CALLOUT",
+ "FLOW_CHART_ALTERNATE_PROCESS",
+ "FLOW_CHART_COLLATE",
+ "FLOW_CHART_CONNECTOR",
+ "FLOW_CHART_DECISION",
+ "FLOW_CHART_DELAY",
+ "FLOW_CHART_DISPLAY",
+ "FLOW_CHART_DOCUMENT",
+ "FLOW_CHART_EXTRACT",
+ "FLOW_CHART_INPUT_OUTPUT",
+ "FLOW_CHART_INTERNAL_STORAGE",
+ "FLOW_CHART_MAGNETIC_DISK",
+ "FLOW_CHART_MAGNETIC_DRUM",
+ "FLOW_CHART_MAGNETIC_TAPE",
+ "FLOW_CHART_MANUAL_INPUT",
+ "FLOW_CHART_MANUAL_OPERATION",
+ "FLOW_CHART_MERGE",
+ "FLOW_CHART_MULTIDOCUMENT",
+ "FLOW_CHART_OFFLINE_STORAGE",
+ "FLOW_CHART_OFFPAGE_CONNECTOR",
+ "FLOW_CHART_ONLINE_STORAGE",
+ "FLOW_CHART_OR",
+ "FLOW_CHART_PREDEFINED_PROCESS",
+ "FLOW_CHART_PREPARATION",
+ "FLOW_CHART_PROCESS",
+ "FLOW_CHART_PUNCHED_CARD",
+ "FLOW_CHART_PUNCHED_TAPE",
+ "FLOW_CHART_SORT",
+ "FLOW_CHART_SUMMING_JUNCTION",
+ "FLOW_CHART_TERMINATOR",
+ "ARROW_EAST",
+ "ARROW_NORTH_EAST",
+ "ARROW_NORTH",
+ "SPEECH",
+ "STARBURST",
+ "TEARDROP",
+ "ELLIPSE_RIBBON",
+ "ELLIPSE_RIBBON_2",
+ "CLOUD_CALLOUT",
+ "CUSTOM"
+ ]
+ },
+ "shapeProperties": {
+ "description": "The properties of the shape.",
+ "$ref": "ShapeProperties"
+ }
+ },
+ "id": "Shape"
+ },
+ "Image": {
+ "type": "object",
+ "properties": {
+ "imageProperties": {
+ "$ref": "ImageProperties",
+ "description": "The properties of the image."
+ },
+ "contentUrl": {
+ "description": "An URL to an image with a default lifetime of 30 minutes.\nThis URL is tagged with the account of the requester. Anyone with the URL\neffectively accesses the image as the original requester. Access to the\nimage may be lost if the presentation's sharing settings change.",
+ "type": "string"
+ }
+ },
+ "id": "Image",
+ "description": "A PageElement kind representing an\nimage."
+ },
+ "InsertTextRequest": {
+ "properties": {
+ "text": {
+ "description": "The text to be inserted.\n\nInserting a newline character will implicitly create a new\nParagraphMarker at that index.\nThe paragraph style of the new paragraph will be copied from the paragraph\nat the current insertion index, including lists and bullets.\n\nText styles for inserted text will be determined automatically, generally\npreserving the styling of neighboring text. In most cases, the text will be\nadded to the TextRun that exists at the\ninsertion index.\n\nSome control characters (U+0000-U+0008, U+000C-U+001F) and characters\nfrom the Unicode Basic Multilingual Plane Private Use Area (U+E000-U+F8FF)\nwill be stripped out of the inserted text.",
+ "type": "string"
+ },
+ "objectId": {
+ "description": "The object ID of the shape or table where the text will be inserted.",
+ "type": "string"
+ },
+ "insertionIndex": {
+ "format": "int32",
+ "description": "The index where the text will be inserted, in Unicode code units, based\non TextElement indexes.\n\nThe index is zero-based and is computed from the start of the string.\nThe index may be adjusted to prevent insertions inside Unicode grapheme\nclusters. In these cases, the text will be inserted immediately after the\ngrapheme cluster.",
+ "type": "integer"
+ },
+ "cellLocation": {
+ "description": "The optional table cell location if the text is to be inserted into a table\ncell. If present, the object_id must refer to a table.",
+ "$ref": "TableCellLocation"
+ }
+ },
+ "id": "InsertTextRequest",
+ "description": "Inserts text into a shape or a table cell.",
+ "type": "object"
+ },
+ "AffineTransform": {
+ "description": "AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ]\nto transform source coordinates (x,y) into destination coordinates (x', y')\naccording to:\n\n x' x = shear_y scale_y translate_y \n 1 [ 1 ]\n\nAfter transformation,\n\n x' = scale_x * x + shear_x * y + translate_x;\n y' = scale_y * y + shear_y * x + translate_y;\n\nThis message is therefore composed of these six matrix elements.",
+ "type": "object",
+ "properties": {
+ "unit": {
+ "enum": [
+ "UNIT_UNSPECIFIED",
+ "EMU",
+ "PT"
+ ],
+ "description": "The units for translate elements.",
+ "type": "string",
+ "enumDescriptions": [
+ "The units are unknown.",
+ "An English Metric Unit (EMU) is defined as 1/360,000 of a centimeter\nand thus there are 914,400 EMUs per inch, and 12,700 EMUs per point.",
+ "A point, 1/72 of an inch."
+ ]
+ },
+ "scaleX": {
+ "format": "double",
+ "description": "The X coordinate scaling element.",
+ "type": "number"
+ },
+ "shearX": {
+ "format": "double",
+ "description": "The X coordinate shearing element.",
+ "type": "number"
+ },
+ "scaleY": {
+ "format": "double",
+ "description": "The Y coordinate scaling element.",
+ "type": "number"
+ },
+ "translateY": {
+ "format": "double",
+ "description": "The Y coordinate translation element.",
+ "type": "number"
+ },
+ "translateX": {
+ "format": "double",
+ "description": "The X coordinate translation element.",
+ "type": "number"
+ },
+ "shearY": {
+ "format": "double",
+ "description": "The Y coordinate shearing element.",
+ "type": "number"
+ }
+ },
+ "id": "AffineTransform"
+ },
+ "AutoText": {
+ "id": "AutoText",
+ "description": "A TextElement kind that represents auto text.",
+ "type": "object",
+ "properties": {
+ "style": {
+ "description": "The styling applied to this auto text.",
+ "$ref": "TextStyle"
+ },
+ "content": {
+ "description": "The rendered content of this auto text, if available.",
+ "type": "string"
+ },
+ "type": {
+ "enumDescriptions": [
+ "An unspecified autotext type.",
+ "Type for autotext that represents the current slide number."
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "SLIDE_NUMBER"
+ ],
+ "description": "The type of this auto text.",
+ "type": "string"
+ }
+ }
+ },
+ "CreateVideoResponse": {
+ "description": "The result of creating a video.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the created video.",
+ "type": "string"
+ }
+ },
+ "id": "CreateVideoResponse"
+ },
+ "DeleteTextRequest": {
+ "description": "Deletes text from a shape or a table cell.",
+ "type": "object",
+ "properties": {
+ "cellLocation": {
+ "$ref": "TableCellLocation",
+ "description": "The optional table cell location if the text is to be deleted from a table\ncell. If present, the object_id must refer to a table."
+ },
+ "textRange": {
+ "description": "The range of text to delete, based on TextElement indexes.\n\nThere is always an implicit newline character at the end of a shape's or\ntable cell's text that cannot be deleted. `Range.Type.ALL` will use the\ncorrect bounds, but care must be taken when specifying explicit bounds for\nrange types `FROM_START_INDEX` and `FIXED_RANGE`. For example, if the text\nis \"ABC\", followed by an implicit newline, then the maximum value is 2 for\n`text_range.start_index` and 3 for `text_range.end_index`.\n\nDeleting text that crosses a paragraph boundary may result in changes\nto paragraph styles and lists as the two paragraphs are merged.\n\nRanges that include only one code unit of a surrogate pair are expanded to\ninclude both code units.",
+ "$ref": "Range"
+ },
+ "objectId": {
+ "type": "string",
+ "description": "The object ID of the shape or table from which the text will be deleted."
+ }
+ },
+ "id": "DeleteTextRequest"
+ },
+ "UpdatePageElementTransformRequest": {
+ "description": "Updates the transform of a page element.\n\nUpdating the transform of a group will change the absolute transform of the\npage elements in that group, which can change their visual appearance. See\nthe documentation for PageElement.transform for more details.",
+ "type": "object",
+ "properties": {
+ "transform": {
+ "$ref": "AffineTransform",
+ "description": "The input transform matrix used to update the page element."
+ },
+ "objectId": {
+ "description": "The object ID of the page element to update.",
+ "type": "string"
+ },
+ "applyMode": {
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified mode.",
+ "Applies the new AffineTransform matrix to the existing one, and\nreplaces the existing one with the resulting concatenation.",
+ "Replaces the existing AffineTransform matrix with the new one."
+ ],
+ "enum": [
+ "APPLY_MODE_UNSPECIFIED",
+ "RELATIVE",
+ "ABSOLUTE"
+ ],
+ "description": "The apply mode of the transform update."
+ }
+ },
+ "id": "UpdatePageElementTransformRequest"
+ },
+ "DeleteObjectRequest": {
+ "description": "Deletes an object, either pages or\npage elements, from the\npresentation.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the page or page element to delete.\n\nIf after a delete operation a group contains\nonly 1 or no page elements, the group is also deleted.\n\nIf a placeholder is deleted on a layout, any empty inheriting shapes are\nalso deleted.",
+ "type": "string"
+ }
+ },
+ "id": "DeleteObjectRequest"
+ },
+ "Dimension": {
+ "description": "A magnitude in a single direction in the specified units.",
+ "type": "object",
+ "properties": {
+ "magnitude": {
+ "format": "double",
+ "description": "The magnitude.",
+ "type": "number"
+ },
+ "unit": {
+ "description": "The units for magnitude.",
+ "type": "string",
+ "enumDescriptions": [
+ "The units are unknown.",
+ "An English Metric Unit (EMU) is defined as 1/360,000 of a centimeter\nand thus there are 914,400 EMUs per inch, and 12,700 EMUs per point.",
+ "A point, 1/72 of an inch."
+ ],
+ "enum": [
+ "UNIT_UNSPECIFIED",
+ "EMU",
+ "PT"
+ ]
+ }
+ },
+ "id": "Dimension"
+ },
+ "TextElement": {
+ "type": "object",
+ "properties": {
+ "textRun": {
+ "$ref": "TextRun",
+ "description": "A TextElement representing a run of text where all of the characters\nin the run have the same TextStyle.\n\nThe `start_index` and `end_index` of TextRuns will always be fully\ncontained in the index range of a single `paragraph_marker` TextElement.\nIn other words, a TextRun will never span multiple paragraphs."
+ },
+ "autoText": {
+ "description": "A TextElement representing a spot in the text that is dynamically\nreplaced with content that can change over time.",
+ "$ref": "AutoText"
+ },
+ "paragraphMarker": {
+ "description": "A marker representing the beginning of a new paragraph.\n\nThe `start_index` and `end_index` of this TextElement represent the\nrange of the paragraph. Other TextElements with an index range contained\ninside this paragraph's range are considered to be part of this\nparagraph. The range of indices of two separate paragraphs will never\noverlap.",
+ "$ref": "ParagraphMarker"
+ },
+ "endIndex": {
+ "format": "int32",
+ "description": "The zero-based end index of this text element, exclusive, in Unicode code\nunits.",
+ "type": "integer"
+ },
+ "startIndex": {
+ "format": "int32",
+ "description": "The zero-based start index of this text element, in Unicode code units.",
+ "type": "integer"
+ }
+ },
+ "id": "TextElement",
+ "description": "A TextElement describes the content of a range of indices in the text content\nof a Shape or TableCell."
+ },
+ "LineFill": {
+ "description": "The fill of the line.",
+ "type": "object",
+ "properties": {
+ "solidFill": {
+ "$ref": "SolidFill",
+ "description": "Solid color fill."
+ }
+ },
+ "id": "LineFill"
+ },
+ "VideoProperties": {
+ "id": "VideoProperties",
+ "description": "The properties of the Video.",
+ "type": "object",
+ "properties": {
+ "outline": {
+ "description": "The outline of the video. The default outline matches the defaults for new\nvideos created in the Slides editor.",
+ "$ref": "Outline"
+ }
+ }
+ },
+ "InsertTableRowsRequest": {
+ "description": "Inserts rows into a table.",
+ "type": "object",
+ "properties": {
+ "number": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of rows to be inserted. Maximum 20 per request."
+ },
+ "cellLocation": {
+ "$ref": "TableCellLocation",
+ "description": "The reference table cell location from which rows will be inserted.\n\nA new row will be inserted above (or below) the row where the reference\ncell is. If the reference cell is a merged cell, a new row will be\ninserted above (or below) the merged cell."
+ },
+ "tableObjectId": {
+ "description": "The table to insert rows into.",
+ "type": "string"
+ },
+ "insertBelow": {
+ "description": "Whether to insert new rows below the reference cell location.\n\n- `True`: insert below the cell.\n- `False`: insert above the cell.",
+ "type": "boolean"
+ }
+ },
+ "id": "InsertTableRowsRequest"
+ },
+ "LayoutProperties": {
+ "description": "The properties of Page are only\nrelevant for pages with page_type LAYOUT.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the layout.",
+ "type": "string"
+ },
+ "displayName": {
+ "type": "string",
+ "description": "The human-readable name of the layout."
+ },
+ "masterObjectId": {
+ "description": "The object ID of the master that this layout is based on.",
+ "type": "string"
+ }
+ },
+ "id": "LayoutProperties"
+ },
+ "LineProperties": {
+ "type": "object",
+ "properties": {
+ "weight": {
+ "$ref": "Dimension",
+ "description": "The thickness of the line."
+ },
+ "lineFill": {
+ "$ref": "LineFill",
+ "description": "The fill of the line. The default line fill matches the defaults for new\nlines created in the Slides editor."
+ },
+ "link": {
+ "$ref": "Link",
+ "description": "The hyperlink destination of the line. If unset, there is no link."
+ },
+ "dashStyle": {
+ "enum": [
+ "DASH_STYLE_UNSPECIFIED",
+ "SOLID",
+ "DOT",
+ "DASH",
+ "DASH_DOT",
+ "LONG_DASH",
+ "LONG_DASH_DOT"
+ ],
+ "description": "The dash style of the line.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified dash style.",
+ "Solid line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'solid'.\nThis is the default dash style.",
+ "Dotted line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dot'.",
+ "Dashed line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dash'.",
+ "Alternating dashes and dots. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'dashDot'.",
+ "Line with large dashes. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'lgDash'.",
+ "Alternating large dashes and dots. Corresponds to ECMA-376\nST_PresetLineDashVal value 'lgDashDot'."
+ ]
+ },
+ "startArrow": {
+ "enumDescriptions": [
+ "An unspecified arrow style.",
+ "No arrow.",
+ "Arrow with notched back. Corresponds to ECMA-376 ST_LineEndType value\n'stealth'.",
+ "Filled arrow. Corresponds to ECMA-376 ST_LineEndType value 'triangle'.",
+ "Filled circle. Corresponds to ECMA-376 ST_LineEndType value 'oval'.",
+ "Filled square.",
+ "Filled diamond. Corresponds to ECMA-376 ST_LineEndType value 'diamond'.",
+ "Hollow arrow.",
+ "Hollow circle.",
+ "Hollow square.",
+ "Hollow diamond."
+ ],
+ "enum": [
+ "ARROW_STYLE_UNSPECIFIED",
+ "NONE",
+ "STEALTH_ARROW",
+ "FILL_ARROW",
+ "FILL_CIRCLE",
+ "FILL_SQUARE",
+ "FILL_DIAMOND",
+ "OPEN_ARROW",
+ "OPEN_CIRCLE",
+ "OPEN_SQUARE",
+ "OPEN_DIAMOND"
+ ],
+ "description": "The style of the arrow at the beginning of the line.",
+ "type": "string"
+ },
+ "endArrow": {
+ "enum": [
+ "ARROW_STYLE_UNSPECIFIED",
+ "NONE",
+ "STEALTH_ARROW",
+ "FILL_ARROW",
+ "FILL_CIRCLE",
+ "FILL_SQUARE",
+ "FILL_DIAMOND",
+ "OPEN_ARROW",
+ "OPEN_CIRCLE",
+ "OPEN_SQUARE",
+ "OPEN_DIAMOND"
+ ],
+ "description": "The style of the arrow at the end of the line.",
+ "type": "string",
+ "enumDescriptions": [
+ "An unspecified arrow style.",
+ "No arrow.",
+ "Arrow with notched back. Corresponds to ECMA-376 ST_LineEndType value\n'stealth'.",
+ "Filled arrow. Corresponds to ECMA-376 ST_LineEndType value 'triangle'.",
+ "Filled circle. Corresponds to ECMA-376 ST_LineEndType value 'oval'.",
+ "Filled square.",
+ "Filled diamond. Corresponds to ECMA-376 ST_LineEndType value 'diamond'.",
+ "Hollow arrow.",
+ "Hollow circle.",
+ "Hollow square.",
+ "Hollow diamond."
+ ]
+ }
+ },
+ "id": "LineProperties",
+ "description": "The properties of the Line.\n\nWhen unset, these fields default to values that match the appearance of\nnew lines created in the Slides editor."
+ },
+ "Presentation": {
+ "type": "object",
+ "properties": {
+ "presentationId": {
+ "description": "The ID of the presentation.",
+ "type": "string"
+ },
+ "slides": {
+ "description": "The slides in the presentation.\nA slide inherits properties from a slide layout.",
+ "items": {
+ "$ref": "Page"
+ },
+ "type": "array"
+ },
+ "revisionId": {
+ "description": "The revision ID of the presentation. Can be used in update requests\nto assert that the presentation revision hasn't changed since the last\nread operation. Only populated if the user has edit access to the\npresentation.\n\nThe format of the revision ID may change over time, so it should be treated\nopaquely. A returned revision ID is only guaranteed to be valid for 24\nhours after it has been returned and cannot be shared across users. If the\nrevision ID is unchanged between calls, then the presentation has not\nchanged. Conversely, a changed ID (for the same presentation and user)\nusually means the presentation has been updated; however, a changed ID can\nalso be due to internal factors such as ID format changes.",
+ "type": "string"
+ },
+ "notesMaster": {
+ "$ref": "Page",
+ "description": "The notes master in the presentation. It serves three purposes:\n\n- Placeholder shapes on a notes master contain the default text styles and\n shape properties of all placeholder shapes on notes pages. Specifically,\n a `SLIDE_IMAGE` placeholder shape contains the slide thumbnail, and a\n `BODY` placeholder shape contains the speaker notes.\n- The notes master page properties define the common page properties\n inherited by all notes pages.\n- Any other shapes on the notes master will appear on all notes pages.\n\nThe notes master is read-only."
+ },
+ "title": {
+ "description": "The title of the presentation.",
+ "type": "string"
+ },
+ "layouts": {
+ "description": "The layouts in the presentation. A layout is a template that determines\nhow content is arranged and styled on the slides that inherit from that\nlayout.",
+ "items": {
+ "$ref": "Page"
+ },
+ "type": "array"
+ },
+ "locale": {
+ "description": "The locale of the presentation, as an IETF BCP 47 language tag.",
+ "type": "string"
+ },
+ "masters": {
+ "items": {
+ "$ref": "Page"
+ },
+ "type": "array",
+ "description": "The slide masters in the presentation. A slide master contains all common\npage elements and the common properties for a set of layouts. They serve\nthree purposes:\n\n- Placeholder shapes on a master contain the default text styles and shape\n properties of all placeholder shapes on pages that use that master.\n- The master page properties define the common page properties inherited by\n its layouts.\n- Any other shapes on the master slide will appear on all slides using that\n master, regardless of their layout."
+ },
+ "pageSize": {
+ "description": "The size of pages in the presentation.",
+ "$ref": "Size"
+ }
+ },
+ "id": "Presentation",
+ "description": "A Google Slides presentation."
+ },
+ "OpaqueColor": {
+ "description": "A themeable solid color value.",
+ "type": "object",
+ "properties": {
+ "rgbColor": {
+ "description": "An opaque RGB color.",
+ "$ref": "RgbColor"
+ },
+ "themeColor": {
+ "enumDescriptions": [
+ "Unspecified theme color. This value should not be used.",
+ "Represents the first dark color.",
+ "Represents the first light color.",
+ "Represents the second dark color.",
+ "Represents the second light color.",
+ "Represents the first accent color.",
+ "Represents the second accent color.",
+ "Represents the third accent color.",
+ "Represents the fourth accent color.",
+ "Represents the fifth accent color.",
+ "Represents the sixth accent color.",
+ "Represents the color to use for hyperlinks.",
+ "Represents the color to use for visited hyperlinks.",
+ "Represents the first text color.",
+ "Represents the first background color.",
+ "Represents the second text color.",
+ "Represents the second background color."
+ ],
+ "enum": [
+ "THEME_COLOR_TYPE_UNSPECIFIED",
+ "DARK1",
+ "LIGHT1",
+ "DARK2",
+ "LIGHT2",
+ "ACCENT1",
+ "ACCENT2",
+ "ACCENT3",
+ "ACCENT4",
+ "ACCENT5",
+ "ACCENT6",
+ "HYPERLINK",
+ "FOLLOWED_HYPERLINK",
+ "TEXT1",
+ "BACKGROUND1",
+ "TEXT2",
+ "BACKGROUND2"
+ ],
+ "description": "An opaque theme color.",
+ "type": "string"
+ }
+ },
+ "id": "OpaqueColor"
+ },
+ "ImageProperties": {
+ "description": "The properties of the Image.",
+ "type": "object",
+ "properties": {
+ "outline": {
+ "description": "The outline of the image. If not set, the the image has no outline.",
+ "$ref": "Outline"
+ },
+ "brightness": {
+ "format": "float",
+ "description": "The brightness effect of the image. The value should be in the interval\n[-1.0, 1.0], where 0 means no effect. This property is read-only.",
+ "type": "number"
+ },
+ "transparency": {
+ "format": "float",
+ "description": "The transparency effect of the image. The value should be in the interval\n[0.0, 1.0], where 0 means no effect and 1 means completely transparent.\nThis property is read-only.",
+ "type": "number"
+ },
+ "shadow": {
+ "description": "The shadow of the image. If not set, the image has no shadow. This property\nis read-only.",
+ "$ref": "Shadow"
+ },
+ "contrast": {
+ "format": "float",
+ "description": "The contrast effect of the image. The value should be in the interval\n[-1.0, 1.0], where 0 means no effect. This property is read-only.",
+ "type": "number"
+ },
+ "link": {
+ "$ref": "Link",
+ "description": "The hyperlink destination of the image. If unset, there is no link."
+ },
+ "cropProperties": {
+ "$ref": "CropProperties",
+ "description": "The crop properties of the image. If not set, the image is not cropped.\nThis property is read-only."
+ },
+ "recolor": {
+ "$ref": "Recolor",
+ "description": "The recolor effect of the image. If not set, the image is not recolored.\nThis property is read-only."
+ }
+ },
+ "id": "ImageProperties"
+ },
+ "ReplaceAllShapesWithImageResponse": {
+ "description": "The result of replacing shapes with an image.",
+ "type": "object",
+ "properties": {
+ "occurrencesChanged": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of shapes replaced with images."
+ }
+ },
+ "id": "ReplaceAllShapesWithImageResponse"
+ },
+ "Line": {
+ "type": "object",
+ "properties": {
+ "lineType": {
+ "description": "The type of the line.",
+ "type": "string",
+ "enumDescriptions": [
+ "An unspecified line type.",
+ "Straight connector 1 form. Corresponds to ECMA-376 ST_ShapeType\n'straightConnector1'.",
+ "Bent connector 2 form. Corresponds to ECMA-376 ST_ShapeType\n'bentConnector2'.",
+ "Bent connector 3 form. Corresponds to ECMA-376 ST_ShapeType\n'bentConnector3'.",
+ "Bent connector 4 form. Corresponds to ECMA-376 ST_ShapeType\n'bentConnector4'.",
+ "Bent connector 5 form. Corresponds to ECMA-376 ST_ShapeType\n'bentConnector5'.",
+ "Curved connector 2 form. Corresponds to ECMA-376 ST_ShapeType\n'curvedConnector2'.",
+ "Curved connector 3 form. Corresponds to ECMA-376 ST_ShapeType\n'curvedConnector3'.",
+ "Curved connector 4 form. Corresponds to ECMA-376 ST_ShapeType\n'curvedConnector4'.",
+ "Curved connector 5 form. Corresponds to ECMA-376 ST_ShapeType\n'curvedConnector5'."
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "STRAIGHT_CONNECTOR_1",
+ "BENT_CONNECTOR_2",
+ "BENT_CONNECTOR_3",
+ "BENT_CONNECTOR_4",
+ "BENT_CONNECTOR_5",
+ "CURVED_CONNECTOR_2",
+ "CURVED_CONNECTOR_3",
+ "CURVED_CONNECTOR_4",
+ "CURVED_CONNECTOR_5"
+ ]
+ },
+ "lineProperties": {
+ "description": "The properties of the line.",
+ "$ref": "LineProperties"
+ }
+ },
+ "id": "Line",
+ "description": "A PageElement kind representing a\nline, curved connector, or bent connector."
+ },
+ "CreateSheetsChartRequest": {
+ "properties": {
+ "objectId": {
+ "description": "A user-supplied object ID.\n\nIf specified, the ID must be unique among all pages and page elements in\nthe presentation. The ID should start with a word character [a-zA-Z0-9_]\nand then followed by any number of the following characters [a-zA-Z0-9_-:].\nThe length of the ID should not be less than 5 or greater than 50.\nIf empty, a unique identifier will be generated.",
+ "type": "string"
+ },
+ "elementProperties": {
+ "$ref": "PageElementProperties",
+ "description": "The element properties for the chart.\n\nWhen the aspect ratio of the provided size does not match the chart aspect\nratio, the chart is scaled and centered with respect to the size in order\nto maintain aspect ratio. The provided transform is applied after this\noperation."
+ },
+ "linkingMode": {
+ "enum": [
+ "NOT_LINKED_IMAGE",
+ "LINKED"
+ ],
+ "description": "The mode with which the chart is linked to the source spreadsheet. When\nnot specified, the chart will be an image that is not linked.",
+ "type": "string",
+ "enumDescriptions": [
+ "The chart is not associated with the source spreadsheet and cannot be\nupdated. A chart that is not linked will be inserted as an image.",
+ "Linking the chart allows it to be updated, and other collaborators will\nsee a link to the spreadsheet."
+ ]
+ },
+ "spreadsheetId": {
+ "description": "The ID of the Google Sheets spreadsheet that contains the chart.",
+ "type": "string"
+ },
+ "chartId": {
+ "format": "int32",
+ "description": "The ID of the specific chart in the Google Sheets spreadsheet.",
+ "type": "integer"
+ }
+ },
+ "id": "CreateSheetsChartRequest",
+ "description": "Creates an embedded Google Sheets chart.\n\nNOTE: Chart creation requires at least one of the spreadsheets.readonly,\nspreadsheets, drive.readonly, or drive OAuth scopes.",
+ "type": "object"
+ },
+ "BatchUpdatePresentationResponse": {
+ "id": "BatchUpdatePresentationResponse",
+ "description": "Response message from a batch update.",
+ "type": "object",
+ "properties": {
+ "replies": {
+ "description": "The reply of the updates. This maps 1:1 with the updates, although\nreplies to some requests may be empty.",
+ "items": {
+ "$ref": "Response"
+ },
+ "type": "array"
+ },
+ "presentationId": {
+ "description": "The presentation the updates were applied to.",
+ "type": "string"
+ }
+ }
+ },
+ "CreateImageResponse": {
+ "description": "The result of creating an image.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the created image.",
+ "type": "string"
+ }
+ },
+ "id": "CreateImageResponse"
+ },
+ "SlideProperties": {
+ "description": "The properties of Page that are only\nrelevant for pages with page_type SLIDE.",
+ "type": "object",
+ "properties": {
+ "masterObjectId": {
+ "description": "The object ID of the master that this slide is based on.",
+ "type": "string"
+ },
+ "layoutObjectId": {
+ "description": "The object ID of the layout that this slide is based on.",
+ "type": "string"
+ },
+ "notesPage": {
+ "$ref": "Page",
+ "description": "The notes page that this slide is associated with. It defines the visual\nappearance of a notes page when printing or exporting slides with speaker\nnotes. A notes page inherits properties from the\nnotes master.\nThe placeholder shape with type BODY on the notes page contains the speaker\nnotes for this slide. The ID of this shape is identified by the\nspeakerNotesObjectId field.\nThe notes page is read-only except for the text content and styles of the\nspeaker notes shape."
+ }
+ },
+ "id": "SlideProperties"
+ },
+ "Response": {
+ "type": "object",
+ "properties": {
+ "createShape": {
+ "description": "The result of creating a shape.",
+ "$ref": "CreateShapeResponse"
+ },
+ "replaceAllShapesWithImage": {
+ "description": "The result of replacing all shapes matching some criteria with an\nimage.",
+ "$ref": "ReplaceAllShapesWithImageResponse"
+ },
+ "createTable": {
+ "$ref": "CreateTableResponse",
+ "description": "The result of creating a table."
+ },
+ "replaceAllText": {
+ "$ref": "ReplaceAllTextResponse",
+ "description": "The result of replacing text."
+ },
+ "createSlide": {
+ "description": "The result of creating a slide.",
+ "$ref": "CreateSlideResponse"
+ },
+ "duplicateObject": {
+ "description": "The result of duplicating an object.",
+ "$ref": "DuplicateObjectResponse"
+ },
+ "createLine": {
+ "description": "The result of creating a line.",
+ "$ref": "CreateLineResponse"
+ },
+ "createImage": {
+ "$ref": "CreateImageResponse",
+ "description": "The result of creating an image."
+ },
+ "createVideo": {
+ "$ref": "CreateVideoResponse",
+ "description": "The result of creating a video."
+ },
+ "createSheetsChart": {
+ "$ref": "CreateSheetsChartResponse",
+ "description": "The result of creating a Google Sheets chart."
+ },
+ "replaceAllShapesWithSheetsChart": {
+ "$ref": "ReplaceAllShapesWithSheetsChartResponse",
+ "description": "The result of replacing all shapes matching some criteria with a Google\nSheets chart."
+ },
+ "groupObjects": {
+ "$ref": "GroupObjectsResponse",
+ "description": "The result of grouping objects."
+ }
+ },
+ "id": "Response",
+ "description": "A single response from an update."
+ },
+ "MasterProperties": {
+ "type": "object",
+ "properties": {
+ "displayName": {
+ "description": "The human-readable name of the master.",
+ "type": "string"
+ }
+ },
+ "id": "MasterProperties",
+ "description": "The properties of Page that are only\nrelevant for pages with page_type MASTER."
+ },
+ "TextRun": {
+ "description": "A TextElement kind that represents a run of text that all has the same\nstyling.",
+ "type": "object",
+ "properties": {
+ "content": {
+ "type": "string",
+ "description": "The text of this run."
+ },
+ "style": {
+ "$ref": "TextStyle",
+ "description": "The styling applied to this run."
+ }
+ },
+ "id": "TextRun"
+ },
+ "LayoutReference": {
+ "description": "Slide layout reference. This may reference either:\n\n- A predefined layout\n- One of the layouts in the presentation.",
+ "type": "object",
+ "properties": {
+ "layoutId": {
+ "description": "Layout ID: the object ID of one of the layouts in the presentation.",
+ "type": "string"
+ },
+ "predefinedLayout": {
+ "enum": [
+ "PREDEFINED_LAYOUT_UNSPECIFIED",
+ "BLANK",
+ "CAPTION_ONLY",
+ "TITLE",
+ "TITLE_AND_BODY",
+ "TITLE_AND_TWO_COLUMNS",
+ "TITLE_ONLY",
+ "SECTION_HEADER",
+ "SECTION_TITLE_AND_DESCRIPTION",
+ "ONE_COLUMN_TEXT",
+ "MAIN_POINT",
+ "BIG_NUMBER"
+ ],
+ "description": "Predefined layout.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified layout.",
+ "Blank layout, with no placeholders.",
+ "Layout with a caption at the bottom.",
+ "Layout with a title and a subtitle.",
+ "Layout with a title and body.",
+ "Layout with a title and two columns.",
+ "Layout with only a title.",
+ "Layout with a section title.",
+ "Layout with a title and subtitle on one side and description on the other.",
+ "Layout with one title and one body, arranged in a single column.",
+ "Layout with a main point.",
+ "Layout with a big number heading."
+ ]
+ }
+ },
+ "id": "LayoutReference"
+ },
+ "SubstringMatchCriteria": {
+ "properties": {
+ "text": {
+ "description": "The text to search for in the shape or table.",
+ "type": "string"
+ },
+ "matchCase": {
+ "description": "Indicates whether the search should respect case:\n\n- `True`: the search is case sensitive.\n- `False`: the search is case insensitive.",
+ "type": "boolean"
+ }
+ },
+ "id": "SubstringMatchCriteria",
+ "description": "A criteria that matches a specific string of text in a shape or table.",
+ "type": "object"
+ },
+ "TableRange": {
+ "type": "object",
+ "properties": {
+ "rowSpan": {
+ "format": "int32",
+ "description": "The row span of the table range.",
+ "type": "integer"
+ },
+ "location": {
+ "$ref": "TableCellLocation",
+ "description": "The starting location of the table range."
+ },
+ "columnSpan": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The column span of the table range."
+ }
+ },
+ "id": "TableRange",
+ "description": "A table range represents a reference to a subset of a table.\n\nIt's important to note that the cells specified by a table range do not\nnecessarily form a rectangle. For example, let's say we have a 3 x 3 table\nwhere all the cells of the last row are merged together. The table looks\nlike this:\n\n \n [ ]\n\nA table range with location = (0, 0), row span = 3 and column span = 2\nspecifies the following cells:\n\n x x \n [ x ]"
+ },
+ "CreateTableRequest": {
+ "description": "Creates a new table.",
+ "type": "object",
+ "properties": {
+ "columns": {
+ "format": "int32",
+ "description": "Number of columns in the table.",
+ "type": "integer"
+ },
+ "objectId": {
+ "description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated.",
+ "type": "string"
+ },
+ "elementProperties": {
+ "description": "The element properties for the table.\n\nThe table will be created at the provided size, subject to a minimum size.\nIf no size is provided, the table will be automatically sized.\n\nTable transforms must have a scale of 1 and no shear components. If no\ntransform is provided, the table will be centered on the page.",
+ "$ref": "PageElementProperties"
+ },
+ "rows": {
+ "format": "int32",
+ "description": "Number of rows in the table.",
+ "type": "integer"
+ }
+ },
+ "id": "CreateTableRequest"
+ },
+ "CreateTableResponse": {
+ "description": "The result of creating a table.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the created table.",
+ "type": "string"
+ }
+ },
+ "id": "CreateTableResponse"
+ },
+ "Table": {
+ "description": "A PageElement kind representing a\ntable.",
+ "type": "object",
+ "properties": {
+ "horizontalBorderRows": {
+ "description": "Properties of horizontal cell borders.\n\nA table's horizontal cell borders are represented as a grid. The grid has\none more row than the number of rows in the table and the same number of\ncolumns as the table. For example, if the table is 3 x 3, its horizontal\nborders will be represented as a grid with 4 rows and 3 columns.",
+ "items": {
+ "$ref": "TableBorderRow"
+ },
+ "type": "array"
+ },
+ "verticalBorderRows": {
+ "description": "Properties of vertical cell borders.\n\nA table's vertical cell borders are represented as a grid. The grid has the\nsame number of rows as the table and one more column than the number of\ncolumns in the table. For example, if the table is 3 x 3, its vertical\nborders will be represented as a grid with 3 rows and 4 columns.",
+ "items": {
+ "$ref": "TableBorderRow"
+ },
+ "type": "array"
+ },
+ "rows": {
+ "format": "int32",
+ "description": "Number of rows in the table.",
+ "type": "integer"
+ },
+ "tableColumns": {
+ "description": "Properties of each column.",
+ "items": {
+ "$ref": "TableColumnProperties"
+ },
+ "type": "array"
+ },
+ "columns": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Number of columns in the table."
+ },
+ "tableRows": {
+ "description": "Properties and contents of each row.\n\nCells that span multiple rows are contained in only one of these rows and\nhave a row_span greater\nthan 1.",
+ "items": {
+ "$ref": "TableRow"
+ },
+ "type": "array"
+ }
+ },
+ "id": "Table"
+ },
+ "GroupObjectsRequest": {
+ "properties": {
+ "childrenObjectIds": {
+ "description": "The object IDs of the objects to group.\n\nOnly page elements can be grouped. There should be at least two page\nelements on the same page that are not already in another group. Some page\nelements, such as videos, tables and placeholder shapes cannot be grouped.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "groupObjectId": {
+ "description": "A user-supplied object ID for the group to be created.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated.",
+ "type": "string"
+ }
+ },
+ "id": "GroupObjectsRequest",
+ "description": "Groups objects to create an object group. For example, groups PageElements to create a Group on the same page as all the children.",
+ "type": "object"
+ },
+ "TableBorderRow": {
+ "description": "Contents of each border row in a table.",
+ "type": "object",
+ "properties": {
+ "tableBorderCells": {
+ "description": "Properties of each border cell. When a border's adjacent table cells are\nmerged, it is not included in the response.",
+ "items": {
+ "$ref": "TableBorderCell"
+ },
+ "type": "array"
+ }
+ },
+ "id": "TableBorderRow"
+ },
+ "PageBackgroundFill": {
+ "description": "The page background fill.",
+ "type": "object",
+ "properties": {
+ "propertyState": {
+ "enum": [
+ "RENDERED",
+ "NOT_RENDERED",
+ "INHERIT"
+ ],
+ "description": "The background fill property state.\n\nUpdating the fill on a page will implicitly update this field to\n`RENDERED`, unless another value is specified in the same request. To\nhave no fill on a page, set this field to `NOT_RENDERED`. In this case,\nany other fill fields set in the same request will be ignored.",
+ "type": "string",
+ "enumDescriptions": [
+ "If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.",
+ "If a property's state is NOT_RENDERED, then the element does not have the\ncorresponding property when rendered on a page. However, the field may\nstill be set so it can be inherited by child shapes. To remove a property\nfrom a rendered element, set its property_state to NOT_RENDERED.",
+ "If a property's state is INHERIT, then the property state uses the value of\ncorresponding `property_state` field on the parent shape. Elements that do\nnot inherit will never have an INHERIT property state."
+ ]
+ },
+ "stretchedPictureFill": {
+ "$ref": "StretchedPictureFill",
+ "description": "Stretched picture fill."
+ },
+ "solidFill": {
+ "$ref": "SolidFill",
+ "description": "Solid color fill."
+ }
+ },
+ "id": "PageBackgroundFill"
+ },
+ "SheetsChart": {
+ "description": "A PageElement kind representing\na linked chart embedded from Google Sheets.",
+ "type": "object",
+ "properties": {
+ "contentUrl": {
+ "description": "The URL of an image of the embedded chart, with a default lifetime of 30\nminutes. This URL is tagged with the account of the requester. Anyone with\nthe URL effectively accesses the image as the original requester. Access to\nthe image may be lost if the presentation's sharing settings change.",
+ "type": "string"
+ },
+ "spreadsheetId": {
+ "description": "The ID of the Google Sheets spreadsheet that contains the source chart.",
+ "type": "string"
+ },
+ "chartId": {
+ "format": "int32",
+ "description": "The ID of the specific chart in the Google Sheets spreadsheet that is\nembedded.",
+ "type": "integer"
+ },
+ "sheetsChartProperties": {
+ "$ref": "SheetsChartProperties",
+ "description": "The properties of the Sheets chart."
+ }
+ },
+ "id": "SheetsChart"
+ },
+ "SolidFill": {
+ "description": "A solid color fill. The page or page element is filled entirely with the\nspecified color value.\n\nIf any field is unset, its value may be inherited from a parent placeholder\nif it exists.",
+ "type": "object",
+ "properties": {
+ "alpha": {
+ "format": "float",
+ "description": "The fraction of this `color` that should be applied to the pixel.\nThat is, the final pixel color is defined by the equation:\n\n pixel color = alpha * (color) + (1.0 - alpha) * (background color)\n\nThis means that a value of 1.0 corresponds to a solid color, whereas\na value of 0.0 corresponds to a completely transparent color.",
+ "type": "number"
+ },
+ "color": {
+ "$ref": "OpaqueColor",
+ "description": "The color value of the solid fill."
+ }
+ },
+ "id": "SolidFill"
+ },
+ "ThemeColorPair": {
+ "description": "A pair mapping a theme color type to the concrete color it represents.",
+ "type": "object",
+ "properties": {
+ "color": {
+ "$ref": "RgbColor",
+ "description": "The concrete color corresponding to the theme color type above."
+ },
+ "type": {
+ "description": "The type of the theme color.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified theme color. This value should not be used.",
+ "Represents the first dark color.",
+ "Represents the first light color.",
+ "Represents the second dark color.",
+ "Represents the second light color.",
+ "Represents the first accent color.",
+ "Represents the second accent color.",
+ "Represents the third accent color.",
+ "Represents the fourth accent color.",
+ "Represents the fifth accent color.",
+ "Represents the sixth accent color.",
+ "Represents the color to use for hyperlinks.",
+ "Represents the color to use for visited hyperlinks.",
+ "Represents the first text color.",
+ "Represents the first background color.",
+ "Represents the second text color.",
+ "Represents the second background color."
+ ],
+ "enum": [
+ "THEME_COLOR_TYPE_UNSPECIFIED",
+ "DARK1",
+ "LIGHT1",
+ "DARK2",
+ "LIGHT2",
+ "ACCENT1",
+ "ACCENT2",
+ "ACCENT3",
+ "ACCENT4",
+ "ACCENT5",
+ "ACCENT6",
+ "HYPERLINK",
+ "FOLLOWED_HYPERLINK",
+ "TEXT1",
+ "BACKGROUND1",
+ "TEXT2",
+ "BACKGROUND2"
+ ]
+ }
+ },
+ "id": "ThemeColorPair"
+ },
+ "OptionalColor": {
+ "properties": {
+ "opaqueColor": {
+ "description": "If set, this will be used as an opaque color. If unset, this represents\na transparent color.",
+ "$ref": "OpaqueColor"
+ }
+ },
+ "id": "OptionalColor",
+ "description": "A color that can either be fully opaque or fully transparent.",
+ "type": "object"
+ },
+ "PageElementProperties": {
+ "description": "Common properties for a page element.\n\nNote: When you initially create a\nPageElement, the API may modify\nthe values of both `size` and `transform`, but the\nvisual size will be unchanged.",
+ "type": "object",
+ "properties": {
+ "transform": {
+ "description": "The transform for the element.",
+ "$ref": "AffineTransform"
+ },
+ "pageObjectId": {
+ "description": "The object ID of the page where the element is located.",
+ "type": "string"
+ },
+ "size": {
+ "description": "The size of the element.",
+ "$ref": "Size"
+ }
+ },
+ "id": "PageElementProperties"
+ },
+ "SheetsChartProperties": {
+ "description": "The properties of the SheetsChart.",
+ "type": "object",
+ "properties": {
+ "chartImageProperties": {
+ "description": "The properties of the embedded chart image.",
+ "$ref": "ImageProperties"
+ }
+ },
+ "id": "SheetsChartProperties"
+ },
+ "StretchedPictureFill": {
+ "description": "The stretched picture fill. The page or page element is filled entirely with\nthe specified picture. The picture is stretched to fit its container.",
+ "type": "object",
+ "properties": {
+ "size": {
+ "$ref": "Size",
+ "description": "The original size of the picture fill. This field is read-only."
+ },
+ "contentUrl": {
+ "description": "Reading the content_url:\n\nAn URL to a picture with a default lifetime of 30 minutes.\nThis URL is tagged with the account of the requester. Anyone with the URL\neffectively accesses the picture as the original requester. Access to the\npicture may be lost if the presentation's sharing settings change.\n\nWriting the content_url:\n\nThe picture is fetched once at insertion time and a copy is stored for\ndisplay inside the presentation. Pictures must be less than 50MB in size,\ncannot exceed 25 megapixels, and must be in either in PNG, JPEG, or GIF\nformat.\n\nThe provided URL can be at maximum 2K bytes large.",
+ "type": "string"
+ }
+ },
+ "id": "StretchedPictureFill"
+ },
+ "UpdateTextStyleRequest": {
+ "description": "Update the styling of text in a Shape or\nTable.",
+ "type": "object",
+ "properties": {
+ "fields": {
+ "format": "google-fieldmask",
+ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `style` is implied and\nshould not be specified. A single `\"*\"` can be used as short-hand for\nlisting every field.\n\nFor example, to update the text style to bold, set `fields` to `\"bold\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
+ "type": "string"
+ },
+ "textRange": {
+ "$ref": "Range",
+ "description": "The range of text to style.\n\nThe range may be extended to include adjacent newlines.\n\nIf the range fully contains a paragraph belonging to a list, the\nparagraph's bullet is also updated with the matching text style."
+ },
+ "objectId": {
+ "description": "The object ID of the shape or table with the text to be styled.",
+ "type": "string"
+ },
+ "style": {
+ "$ref": "TextStyle",
+ "description": "The style(s) to set on the text.\n\nIf the value for a particular style matches that of the parent, that style\nwill be set to inherit.\n\nCertain text style changes may cause other changes meant to mirror the\nbehavior of the Slides editor. See the documentation of\nTextStyle for more information."
+ },
+ "cellLocation": {
+ "description": "The location of the cell in the table containing the text to style. If\n`object_id` refers to a table, `cell_location` must have a value.\nOtherwise, it must not.",
+ "$ref": "TableCellLocation"
+ }
+ },
+ "id": "UpdateTextStyleRequest"
+ },
+ "DeleteTableColumnRequest": {
+ "properties": {
+ "cellLocation": {
+ "description": "The reference table cell location from which a column will be deleted.\n\nThe column this cell spans will be deleted. If this is a merged cell,\nmultiple columns will be deleted. If no columns remain in the table after\nthis deletion, the whole table is deleted.",
+ "$ref": "TableCellLocation"
+ },
+ "tableObjectId": {
+ "description": "The table to delete columns from.",
+ "type": "string"
+ }
+ },
+ "id": "DeleteTableColumnRequest",
+ "description": "Deletes a column from a table.",
+ "type": "object"
+ },
+ "List": {
+ "description": "A List describes the look and feel of bullets belonging to paragraphs\nassociated with a list. A paragraph that is part of a list has an implicit\nreference to that list's ID.",
+ "type": "object",
+ "properties": {
+ "listId": {
+ "description": "The ID of the list.",
+ "type": "string"
+ },
+ "nestingLevel": {
+ "additionalProperties": {
+ "$ref": "NestingLevel"
+ },
+ "description": "A map of nesting levels to the properties of bullets at the associated\nlevel. A list has at most nine levels of nesting, so the possible values\nfor the keys of this map are 0 through 8, inclusive.",
+ "type": "object"
+ }
+ },
+ "id": "List"
+ },
+ "WeightedFontFamily": {
+ "description": "Represents a font family and weight used to style a TextRun.",
+ "type": "object",
+ "properties": {
+ "weight": {
+ "format": "int32",
+ "description": "The rendered weight of the text. This field can have any value that is a\nmultiple of `100` between `100` and `900`, inclusive. This range\ncorresponds to the numerical values described in the CSS 2.1\nSpecification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness),\nwith non-numerical values disallowed. Weights greater than or equal to\n`700` are considered bold, and weights less than `700`are not bold. The\ndefault value is `400` (\"normal\").",
+ "type": "integer"
+ },
+ "fontFamily": {
+ "description": "The font family of the text.\n\nThe font family can be any font from the Font menu in Slides or from\n[Google Fonts] (https://fonts.google.com/). If the font name is\nunrecognized, the text is rendered in `Arial`.",
+ "type": "string"
+ }
+ },
+ "id": "WeightedFontFamily"
+ },
+ "PageElement": {
+ "description": "A visual element rendered on a page.",
+ "type": "object",
+ "properties": {
+ "table": {
+ "$ref": "Table",
+ "description": "A table page element."
+ },
+ "objectId": {
+ "description": "The object ID for this page element. Object IDs used by\ngoogle.apps.slides.v1.Page and\ngoogle.apps.slides.v1.PageElement share the same namespace.",
+ "type": "string"
+ },
+ "transform": {
+ "description": "The transform of the page element.\n\nThe visual appearance of the page element is determined by its absolute\ntransform. To compute the absolute transform, preconcatenate a page\nelement's transform with the transforms of all of its parent groups. If the\npage element is not in a group, its absolute transform is the same as the\nvalue in this field.\n\nThe initial transform for the newly created Group is always the identity transform.",
+ "$ref": "AffineTransform"
+ },
+ "shape": {
+ "description": "A generic shape.",
+ "$ref": "Shape"
+ },
+ "line": {
+ "description": "A line page element.",
+ "$ref": "Line"
+ },
+ "description": {
+ "description": "The description of the page element. Combined with title to display alt\ntext.",
+ "type": "string"
+ },
+ "elementGroup": {
+ "$ref": "Group",
+ "description": "A collection of page elements joined as a single unit."
+ },
+ "image": {
+ "$ref": "Image",
+ "description": "An image page element."
+ },
+ "size": {
+ "$ref": "Size",
+ "description": "The size of the page element."
+ },
+ "title": {
+ "description": "The title of the page element. Combined with description to display alt\ntext.",
+ "type": "string"
+ },
+ "sheetsChart": {
+ "$ref": "SheetsChart",
+ "description": "A linked chart embedded from Google Sheets. Unlinked charts are\nrepresented as images."
+ },
+ "video": {
+ "$ref": "Video",
+ "description": "A video page element."
+ },
+ "wordArt": {
+ "$ref": "WordArt",
+ "description": "A word art page element."
+ }
+ },
+ "id": "PageElement"
+ },
+ "CreateImageRequest": {
+ "description": "Creates an image.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated.",
+ "type": "string"
+ },
+ "elementProperties": {
+ "description": "The element properties for the image.\n\nWhen the aspect ratio of the provided size does not match the image aspect\nratio, the image is scaled and centered with respect to the size in order\nto maintain aspect ratio. The provided transform is applied after this\noperation.",
+ "$ref": "PageElementProperties"
+ },
+ "url": {
+ "description": "The image URL.\n\nThe image is fetched once at insertion time and a copy is stored for\ndisplay inside the presentation. Images must be less than 50MB in size,\ncannot exceed 25 megapixels, and must be in either in PNG, JPEG, or GIF\nformat.\n\nThe provided URL can be at maximum 2K bytes large.",
+ "type": "string"
+ }
+ },
+ "id": "CreateImageRequest"
+ },
+ "CreateParagraphBulletsRequest": {
+ "description": "Creates bullets for all of the paragraphs that overlap with the given\ntext index range.\n\nThe nesting level of each paragraph will be determined by counting leading\ntabs in front of each paragraph. To avoid excess space between the bullet and\nthe corresponding paragraph, these leading tabs are removed by this request.\nThis may change the indices of parts of the text.\n\nIf the paragraph immediately before paragraphs being updated is in a list\nwith a matching preset, the paragraphs being updated are added to that\npreceding list.",
+ "type": "object",
+ "properties": {
+ "bulletPreset": {
+ "description": "The kinds of bullet glyphs to be used. Defaults to the\n`BULLET_DISC_CIRCLE_SQUARE` preset.",
+ "type": "string",
+ "enumDescriptions": [
+ "A bulleted list with a `DISC`, `CIRCLE` and `SQUARE` bullet glyph for the\nfirst 3 list nesting levels.",
+ "A bulleted list with a `DIAMONDX`, `ARROW3D` and `SQUARE` bullet glyph for\nthe first 3 list nesting levels.",
+ "A bulleted list with `CHECKBOX` bullet glyphs for all list nesting levels.",
+ "A bulleted list with a `ARROW`, `DIAMOND` and `DISC` bullet glyph for\nthe first 3 list nesting levels.",
+ "A bulleted list with a `STAR`, `CIRCLE` and `SQUARE` bullet glyph for\nthe first 3 list nesting levels.",
+ "A bulleted list with a `ARROW3D`, `CIRCLE` and `SQUARE` bullet glyph for\nthe first 3 list nesting levels.",
+ "A bulleted list with a `LEFTTRIANGLE`, `DIAMOND` and `DISC` bullet glyph\nfor the first 3 list nesting levels.",
+ "A bulleted list with a `DIAMONDX`, `HOLLOWDIAMOND` and `SQUARE` bullet\nglyph for the first 3 list nesting levels.",
+ "A bulleted list with a `DIAMOND`, `CIRCLE` and `SQUARE` bullet glyph\nfor the first 3 list nesting levels.",
+ "A numbered list with `DIGIT`, `ALPHA` and `ROMAN` numeric glyphs for\nthe first 3 list nesting levels, followed by periods.",
+ "A numbered list with `DIGIT`, `ALPHA` and `ROMAN` numeric glyphs for\nthe first 3 list nesting levels, followed by parenthesis.",
+ "A numbered list with `DIGIT` numeric glyphs separated by periods, where\neach nesting level uses the previous nesting level's glyph as a prefix.\nFor example: '1.', '1.1.', '2.', '2.2.'.",
+ "A numbered list with `UPPERALPHA`, `ALPHA` and `ROMAN` numeric glyphs for\nthe first 3 list nesting levels, followed by periods.",
+ "A numbered list with `UPPERROMAN`, `UPPERALPHA` and `DIGIT` numeric glyphs\nfor the first 3 list nesting levels, followed by periods.",
+ "A numbered list with `ZERODIGIT`, `ALPHA` and `ROMAN` numeric glyphs for\nthe first 3 list nesting levels, followed by periods."
+ ],
+ "enum": [
+ "BULLET_DISC_CIRCLE_SQUARE",
+ "BULLET_DIAMONDX_ARROW3D_SQUARE",
+ "BULLET_CHECKBOX",
+ "BULLET_ARROW_DIAMOND_DISC",
+ "BULLET_STAR_CIRCLE_SQUARE",
+ "BULLET_ARROW3D_CIRCLE_SQUARE",
+ "BULLET_LEFTTRIANGLE_DIAMOND_DISC",
+ "BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE",
+ "BULLET_DIAMOND_CIRCLE_SQUARE",
+ "NUMBERED_DIGIT_ALPHA_ROMAN",
+ "NUMBERED_DIGIT_ALPHA_ROMAN_PARENS",
+ "NUMBERED_DIGIT_NESTED",
+ "NUMBERED_UPPERALPHA_ALPHA_ROMAN",
+ "NUMBERED_UPPERROMAN_UPPERALPHA_DIGIT",
+ "NUMBERED_ZERODIGIT_ALPHA_ROMAN"
+ ]
+ },
+ "cellLocation": {
+ "description": "The optional table cell location if the text to be modified is in a table\ncell. If present, the object_id must refer to a table.",
+ "$ref": "TableCellLocation"
+ },
+ "textRange": {
+ "description": "The range of text to apply the bullet presets to, based on TextElement indexes.",
+ "$ref": "Range"
+ },
+ "objectId": {
+ "description": "The object ID of the shape or table containing the text to add bullets to.",
+ "type": "string"
+ }
+ },
+ "id": "CreateParagraphBulletsRequest"
+ },
+ "Size": {
+ "description": "A width and height.",
+ "type": "object",
+ "properties": {
+ "height": {
+ "$ref": "Dimension",
+ "description": "The height of the object."
+ },
+ "width": {
+ "description": "The width of the object.",
+ "$ref": "Dimension"
+ }
+ },
+ "id": "Size"
+ },
+ "TextStyle": {
+ "description": "Represents the styling that can be applied to a TextRun.\n\nIf this text is contained in a shape with a parent placeholder, then these text styles may be\ninherited from the parent. Which text styles are inherited depend on the\nnesting level of lists:\n\n* A text run in a paragraph that is not in a list will inherit its text style\n from the the newline character in the paragraph at the 0 nesting level of\n the list inside the parent placeholder.\n* A text run in a paragraph that is in a list will inherit its text style\n from the newline character in the paragraph at its corresponding nesting\n level of the list inside the parent placeholder.\n\nInherited text styles are represented as unset fields in this message. If\ntext is contained in a shape without a parent placeholder, unsetting these\nfields will revert the style to a value matching the defaults in the Slides\neditor.",
+ "type": "object",
+ "properties": {
+ "smallCaps": {
+ "type": "boolean",
+ "description": "Whether or not the text is in small capital letters."
+ },
+ "backgroundColor": {
+ "$ref": "OptionalColor",
+ "description": "The background color of the text. If set, the color is either opaque or\ntransparent, depending on if the `opaque_color` field in it is set."
+ },
+ "link": {
+ "$ref": "Link",
+ "description": "The hyperlink destination of the text. If unset, there is no link. Links\nare not inherited from parent text.\n\nChanging the link in an update request causes some other changes to the\ntext style of the range:\n\n* When setting a link, the text foreground color will be set to\n ThemeColorType.HYPERLINK and the text will\n be underlined. If these fields are modified in the same\n request, those values will be used instead of the link defaults.\n* Setting a link on a text range that overlaps with an existing link will\n also update the existing link to point to the new URL.\n* Links are not settable on newline characters. As a result, setting a link\n on a text range that crosses a paragraph boundary, such as `\"ABC\\n123\"`,\n will separate the newline character(s) into their own text runs. The\n link will be applied separately to the runs before and after the newline.\n* Removing a link will update the text style of the range to match the\n style of the preceding text (or the default text styles if the preceding\n text is another link) unless different styles are being set in the same\n request."
+ },
+ "underline": {
+ "description": "Whether or not the text is underlined.",
+ "type": "boolean"
+ },
+ "bold": {
+ "description": "Whether or not the text is rendered as bold.",
+ "type": "boolean"
+ },
+ "foregroundColor": {
+ "$ref": "OptionalColor",
+ "description": "The color of the text itself. If set, the color is either opaque or\ntransparent, depending on if the `opaque_color` field in it is set."
+ },
+ "fontFamily": {
+ "description": "The font family of the text.\n\nThe font family can be any font from the Font menu in Slides or from\n[Google Fonts] (https://fonts.google.com/). If the font name is\nunrecognized, the text is rendered in `Arial`.\n\nSome fonts can affect the weight of the text. If an update request\nspecifies values for both `font_family` and `bold`, the explicitly-set\n`bold` value is used.",
+ "type": "string"
+ },
+ "italic": {
+ "description": "Whether or not the text is italicized.",
+ "type": "boolean"
+ },
+ "strikethrough": {
+ "description": "Whether or not the text is struck through.",
+ "type": "boolean"
+ },
+ "fontSize": {
+ "$ref": "Dimension",
+ "description": "The size of the text's font. When read, the `font_size` will specified in\npoints."
+ },
+ "baselineOffset": {
+ "enum": [
+ "BASELINE_OFFSET_UNSPECIFIED",
+ "NONE",
+ "SUPERSCRIPT",
+ "SUBSCRIPT"
+ ],
+ "description": "The text's vertical offset from its normal position.\n\nText with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically\nrendered in a smaller font size, computed based on the `font_size` field.\nThe `font_size` itself is not affected by changes in this field.",
+ "type": "string",
+ "enumDescriptions": [
+ "The text's baseline offset is inherited from the parent.",
+ "The text is not vertically offset.",
+ "The text is vertically offset upwards (superscript).",
+ "The text is vertically offset downwards (subscript)."
+ ]
+ },
+ "weightedFontFamily": {
+ "$ref": "WeightedFontFamily",
+ "description": "The font family and rendered weight of the text.\n\nThis field is an extension of `font_family` meant to support explicit font\nweights without breaking backwards compatibility. As such, when reading the\nstyle of a range of text, the value of `weighted_font_family#font_family`\nwill always be equal to that of `font_family`. However, when writing, if\nboth fields are included in the field mask (either explicitly or through\nthe wildcard `\"*\"`), their values are reconciled as follows:\n\n* If `font_family` is set and `weighted_font_family` is not, the value of\n `font_family` is applied with weight `400` (\"normal\").\n* If both fields are set, the value of `font_family` must match that of\n `weighted_font_family#font_family`. If so, the font family and weight of\n `weighted_font_family` is applied. Otherwise, a 400 bad request error is\n returned.\n* If `weighted_font_family` is set and `font_family` is not, the font\n family and weight of `weighted_font_family` is applied.\n* If neither field is set, the font family and weight of the text inherit\n from the parent. Note that these properties cannot inherit separately\n from each other.\n\nIf an update request specifies values for both `weighted_font_family` and\n`bold`, the `weighted_font_family` is applied first, then `bold`.\n\nIf `weighted_font_family#weight` is not set, it defaults to `400`.\n\nIf `weighted_font_family` is set, then `weighted_font_family#font_family`\nmust also be set with a non-empty value. Otherwise, a 400 bad request error\nis returned."
+ }
+ },
+ "id": "TextStyle"
+ },
+ "UpdateVideoPropertiesRequest": {
+ "description": "Update the properties of a Video.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the video the updates are applied to.",
+ "type": "string"
+ },
+ "videoProperties": {
+ "description": "The video properties to update.",
+ "$ref": "VideoProperties"
+ },
+ "fields": {
+ "format": "google-fieldmask",
+ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `videoProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the video outline color, set `fields` to\n`\"outline.outlineFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
+ "type": "string"
+ }
+ },
+ "id": "UpdateVideoPropertiesRequest"
+ },
+ "Request": {
+ "description": "A single kind of update to apply to a presentation.",
+ "type": "object",
+ "properties": {
+ "updateImageProperties": {
+ "description": "Updates the properties of an Image.",
+ "$ref": "UpdateImagePropertiesRequest"
+ },
+ "insertTableRows": {
+ "description": "Inserts rows into a table.",
+ "$ref": "InsertTableRowsRequest"
+ },
+ "createSlide": {
+ "description": "Creates a new slide.",
+ "$ref": "CreateSlideRequest"
+ },
+ "updateLineProperties": {
+ "$ref": "UpdateLinePropertiesRequest",
+ "description": "Updates the properties of a Line."
+ },
+ "updateSlidesPosition": {
+ "$ref": "UpdateSlidesPositionRequest",
+ "description": "Updates the position of a set of slides in the presentation."
+ },
+ "deleteTableRow": {
+ "$ref": "DeleteTableRowRequest",
+ "description": "Deletes a row from a table."
+ },
+ "updateShapeProperties": {
+ "$ref": "UpdateShapePropertiesRequest",
+ "description": "Updates the properties of a Shape."
+ },
+ "ungroupObjects": {
+ "$ref": "UngroupObjectsRequest",
+ "description": "Ungroups objects, such as groups."
+ },
+ "groupObjects": {
+ "description": "Groups objects, such as page elements.",
+ "$ref": "GroupObjectsRequest"
+ },
+ "insertText": {
+ "$ref": "InsertTextRequest",
+ "description": "Inserts text into a shape or table cell."
+ },
+ "updateTableColumnProperties": {
+ "description": "Updates the properties of a Table\ncolumn.",
+ "$ref": "UpdateTableColumnPropertiesRequest"
+ },
+ "deleteText": {
+ "$ref": "DeleteTextRequest",
+ "description": "Deletes text from a shape or a table cell."
+ },
+ "updatePageProperties": {
+ "$ref": "UpdatePagePropertiesRequest",
+ "description": "Updates the properties of a Page."
+ },
+ "createShape": {
+ "$ref": "CreateShapeRequest",
+ "description": "Creates a new shape."
+ },
+ "deleteParagraphBullets": {
+ "$ref": "DeleteParagraphBulletsRequest",
+ "description": "Deletes bullets from paragraphs."
+ },
+ "updateTableBorderProperties": {
+ "$ref": "UpdateTableBorderPropertiesRequest",
+ "description": "Updates the properties of the table borders in a Table."
+ },
+ "insertTableColumns": {
+ "description": "Inserts columns into a table.",
+ "$ref": "InsertTableColumnsRequest"
+ },
+ "mergeTableCells": {
+ "$ref": "MergeTableCellsRequest",
+ "description": "Merges cells in a Table."
+ },
+ "refreshSheetsChart": {
+ "$ref": "RefreshSheetsChartRequest",
+ "description": "Refreshes a Google Sheets chart."
+ },
+ "createTable": {
+ "description": "Creates a new table.",
+ "$ref": "CreateTableRequest"
+ },
+ "updateTableCellProperties": {
+ "$ref": "UpdateTableCellPropertiesRequest",
+ "description": "Updates the properties of a TableCell."
+ },
+ "deleteObject": {
+ "$ref": "DeleteObjectRequest",
+ "description": "Deletes a page or page element from the presentation."
+ },
+ "updateParagraphStyle": {
+ "description": "Updates the styling of paragraphs within a Shape or Table.",
+ "$ref": "UpdateParagraphStyleRequest"
+ },
+ "duplicateObject": {
+ "description": "Duplicates a slide or page element.",
+ "$ref": "DuplicateObjectRequest"
+ },
+ "deleteTableColumn": {
+ "$ref": "DeleteTableColumnRequest",
+ "description": "Deletes a column from a table."
+ },
+ "createLine": {
+ "$ref": "CreateLineRequest",
+ "description": "Creates a line."
+ },
+ "updateVideoProperties": {
+ "$ref": "UpdateVideoPropertiesRequest",
+ "description": "Updates the properties of a Video."
+ },
+ "createImage": {
+ "$ref": "CreateImageRequest",
+ "description": "Creates an image."
+ },
+ "createParagraphBullets": {
+ "$ref": "CreateParagraphBulletsRequest",
+ "description": "Creates bullets for paragraphs."
+ },
+ "createVideo": {
+ "description": "Creates a video.",
+ "$ref": "CreateVideoRequest"
+ },
+ "createSheetsChart": {
+ "description": "Creates an embedded Google Sheets chart.",
+ "$ref": "CreateSheetsChartRequest"
+ },
+ "replaceAllShapesWithSheetsChart": {
+ "description": "Replaces all shapes matching some criteria with a Google Sheets chart.",
+ "$ref": "ReplaceAllShapesWithSheetsChartRequest"
+ },
+ "unmergeTableCells": {
+ "$ref": "UnmergeTableCellsRequest",
+ "description": "Unmerges cells in a Table."
+ },
+ "updatePageElementTransform": {
+ "$ref": "UpdatePageElementTransformRequest",
+ "description": "Updates the transform of a page element."
+ },
+ "updateTextStyle": {
+ "description": "Updates the styling of text within a Shape or Table.",
+ "$ref": "UpdateTextStyleRequest"
+ },
+ "updateTableRowProperties": {
+ "description": "Updates the properties of a Table row.",
+ "$ref": "UpdateTableRowPropertiesRequest"
+ },
+ "replaceAllShapesWithImage": {
+ "$ref": "ReplaceAllShapesWithImageRequest",
+ "description": "Replaces all shapes matching some criteria with an image."
+ },
+ "replaceAllText": {
+ "$ref": "ReplaceAllTextRequest",
+ "description": "Replaces all instances of specified text."
+ }
+ },
+ "id": "Request"
+ },
+ "UpdateImagePropertiesRequest": {
+ "id": "UpdateImagePropertiesRequest",
+ "description": "Update the properties of an Image.",
+ "type": "object",
+ "properties": {
+ "fields": {
+ "format": "google-fieldmask",
+ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `imageProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the image outline color, set `fields` to\n`\"outline.outlineFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
+ "type": "string"
+ },
+ "imageProperties": {
+ "$ref": "ImageProperties",
+ "description": "The image properties to update."
+ },
+ "objectId": {
+ "description": "The object ID of the image the updates are applied to.",
+ "type": "string"
+ }
+ }
+ },
+ "ParagraphStyle": {
+ "description": "Styles that apply to a whole paragraph.\n\nIf this text is contained in a shape with a parent placeholder, then these paragraph styles may be\ninherited from the parent. Which paragraph styles are inherited depend on the\nnesting level of lists:\n\n* A paragraph not in a list will inherit its paragraph style from the\n paragraph at the 0 nesting level of the list inside the parent placeholder.\n* A paragraph in a list will inherit its paragraph style from the paragraph\n at its corresponding nesting level of the list inside the parent\n placeholder.\n\nInherited paragraph styles are represented as unset fields in this message.",
+ "type": "object",
+ "properties": {
+ "indentEnd": {
+ "$ref": "Dimension",
+ "description": "The amount indentation for the paragraph on the side that corresponds to\nthe end of the text, based on the current text direction. If unset, the\nvalue is inherited from the parent."
+ },
+ "spacingMode": {
+ "type": "string",
+ "enumDescriptions": [
+ "The spacing mode is inherited from the parent.",
+ "Paragraph spacing is always rendered.",
+ "Paragraph spacing is skipped between list elements."
+ ],
+ "enum": [
+ "SPACING_MODE_UNSPECIFIED",
+ "NEVER_COLLAPSE",
+ "COLLAPSE_LISTS"
+ ],
+ "description": "The spacing mode for the paragraph."
+ },
+ "indentStart": {
+ "$ref": "Dimension",
+ "description": "The amount indentation for the paragraph on the side that corresponds to\nthe start of the text, based on the current text direction. If unset, the\nvalue is inherited from the parent."
+ },
+ "spaceAbove": {
+ "$ref": "Dimension",
+ "description": "The amount of extra space above the paragraph. If unset, the value is\ninherited from the parent."
+ },
+ "alignment": {
+ "enum": [
+ "ALIGNMENT_UNSPECIFIED",
+ "START",
+ "CENTER",
+ "END",
+ "JUSTIFIED"
+ ],
+ "description": "The text alignment for this paragraph.",
+ "type": "string",
+ "enumDescriptions": [
+ "The paragraph alignment is inherited from the parent.",
+ "The paragraph is aligned to the start of the line. Left-aligned for\nLTR text, right-aligned otherwise.",
+ "The paragraph is centered.",
+ "The paragraph is aligned to the end of the line. Right-aligned for\nLTR text, left-aligned otherwise.",
+ "The paragraph is justified."
+ ]
+ },
+ "lineSpacing": {
+ "format": "float",
+ "description": "The amount of space between lines, as a percentage of normal, where normal\nis represented as 100.0. If unset, the value is inherited from the parent.",
+ "type": "number"
+ },
+ "indentFirstLine": {
+ "$ref": "Dimension",
+ "description": "The amount of indentation for the start of the first line of the paragraph.\nIf unset, the value is inherited from the parent."
+ },
+ "spaceBelow": {
+ "$ref": "Dimension",
+ "description": "The amount of extra space above the paragraph. If unset, the value is\ninherited from the parent."
+ },
+ "direction": {
+ "description": "The text direction of this paragraph. If unset, the value defaults to\nLEFT_TO_RIGHT since\ntext direction is not inherited.",
+ "type": "string",
+ "enumDescriptions": [
+ "The text direction is inherited from the parent.",
+ "The text goes from left to right.",
+ "The text goes from right to left."
+ ],
+ "enum": [
+ "TEXT_DIRECTION_UNSPECIFIED",
+ "LEFT_TO_RIGHT",
+ "RIGHT_TO_LEFT"
+ ]
+ }
+ },
+ "id": "ParagraphStyle"
+ },
+ "UpdateTableRowPropertiesRequest": {
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the table.",
+ "type": "string"
+ },
+ "rowIndices": {
+ "description": "The list of zero-based indices specifying which rows to update. If no\nindices are provided, all rows in the table will be updated.",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "fields": {
+ "format": "google-fieldmask",
+ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `tableRowProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the minimum row height, set `fields` to\n`\"min_row_height\"`.\n\nIf '\"min_row_height\"' is included in the field mask but the property is\nleft unset, the minimum row height will default to 0.",
+ "type": "string"
+ },
+ "tableRowProperties": {
+ "$ref": "TableRowProperties",
+ "description": "The table row properties to update."
+ }
+ },
+ "id": "UpdateTableRowPropertiesRequest",
+ "description": "Updates the properties of a Table row.",
+ "type": "object"
+ },
+ "ReplaceAllShapesWithSheetsChartResponse": {
+ "description": "The result of replacing shapes with a Google Sheets chart.",
+ "type": "object",
+ "properties": {
+ "occurrencesChanged": {
+ "format": "int32",
+ "description": "The number of shapes replaced with charts.",
+ "type": "integer"
+ }
+ },
+ "id": "ReplaceAllShapesWithSheetsChartResponse"
+ },
+ "TableCellProperties": {
+ "description": "The properties of the TableCell.",
+ "type": "object",
+ "properties": {
+ "tableCellBackgroundFill": {
+ "description": "The background fill of the table cell. The default fill matches the fill\nfor newly created table cells in the Slides editor.",
+ "$ref": "TableCellBackgroundFill"
+ }
+ },
+ "id": "TableCellProperties"
+ },
+ "RefreshSheetsChartRequest": {
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the chart to refresh.",
+ "type": "string"
+ }
+ },
+ "id": "RefreshSheetsChartRequest",
+ "description": "Refreshes an embedded Google Sheets chart by replacing it with the latest\nversion of the chart from Google Sheets.\n\nNOTE: Refreshing charts requires at least one of the spreadsheets.readonly,\nspreadsheets, drive.readonly, or drive OAuth scopes."
+ },
+ "Outline": {
+ "description": "The outline of a PageElement.\n\nIf these fields are unset, they may be inherited from a parent placeholder\nif it exists. If there is no parent, the fields will default to the value\nused for new page elements created in the Slides editor, which may depend on\nthe page element kind.",
+ "type": "object",
+ "properties": {
+ "weight": {
+ "description": "The thickness of the outline.",
+ "$ref": "Dimension"
+ },
+ "dashStyle": {
+ "enum": [
+ "DASH_STYLE_UNSPECIFIED",
+ "SOLID",
+ "DOT",
+ "DASH",
+ "DASH_DOT",
+ "LONG_DASH",
+ "LONG_DASH_DOT"
+ ],
+ "description": "The dash style of the outline.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified dash style.",
+ "Solid line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'solid'.\nThis is the default dash style.",
+ "Dotted line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dot'.",
+ "Dashed line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dash'.",
+ "Alternating dashes and dots. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'dashDot'.",
+ "Line with large dashes. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'lgDash'.",
+ "Alternating large dashes and dots. Corresponds to ECMA-376\nST_PresetLineDashVal value 'lgDashDot'."
+ ]
+ },
+ "propertyState": {
+ "enumDescriptions": [
+ "If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.",
+ "If a property's state is NOT_RENDERED, then the element does not have the\ncorresponding property when rendered on a page. However, the field may\nstill be set so it can be inherited by child shapes. To remove a property\nfrom a rendered element, set its property_state to NOT_RENDERED.",
+ "If a property's state is INHERIT, then the property state uses the value of\ncorresponding `property_state` field on the parent shape. Elements that do\nnot inherit will never have an INHERIT property state."
+ ],
+ "enum": [
+ "RENDERED",
+ "NOT_RENDERED",
+ "INHERIT"
+ ],
+ "description": "The outline property state.\n\nUpdating the the outline on a page element will implicitly update this\nfield to`RENDERED`, unless another value is specified in the same request.\nTo have no outline on a page element, set this field to `NOT_RENDERED`. In\nthis case, any other outline fields set in the same request will be\nignored.",
+ "type": "string"
+ },
+ "outlineFill": {
+ "$ref": "OutlineFill",
+ "description": "The fill of the outline."
+ }
+ },
+ "id": "Outline"
+ },
+ "NotesProperties": {
+ "properties": {
+ "speakerNotesObjectId": {
+ "description": "The object ID of the shape on this notes page that contains the speaker\nnotes for the corresponding slide.\nThe actual shape may not always exist on the notes page. Inserting text\nusing this object ID will automatically create the shape. In this case, the\nactual shape may have different object ID. The `GetPresentation` or\n`GetPage` action will always return the latest object ID.",
+ "type": "string"
+ }
+ },
+ "id": "NotesProperties",
+ "description": "The properties of Page that are only\nrelevant for pages with page_type NOTES.",
+ "type": "object"
+ },
+ "TableColumnProperties": {
+ "properties": {
+ "columnWidth": {
+ "description": "Width of a column.",
+ "$ref": "Dimension"
+ }
+ },
+ "id": "TableColumnProperties",
+ "description": "Properties of each column in a table.",
+ "type": "object"
+ },
+ "ShapeProperties": {
+ "description": "The properties of a Shape.\n\nIf the shape is a placeholder shape as determined by the\nplaceholder field, then these\nproperties may be inherited from a parent placeholder shape.\nDetermining the rendered value of the property depends on the corresponding\nproperty_state field value.",
+ "type": "object",
+ "properties": {
+ "outline": {
+ "$ref": "Outline",
+ "description": "The outline of the shape. If unset, the outline is inherited from a\nparent placeholder if it exists. If the shape has no parent, then the\ndefault outline depends on the shape type, matching the defaults for\nnew shapes created in the Slides editor."
+ },
+ "shadow": {
+ "$ref": "Shadow",
+ "description": "The shadow properties of the shape. If unset, the shadow is inherited from\na parent placeholder if it exists. If the shape has no parent, then the\ndefault shadow matches the defaults for new shapes created in the Slides\neditor. This property is read-only."
+ },
+ "shapeBackgroundFill": {
+ "$ref": "ShapeBackgroundFill",
+ "description": "The background fill of the shape. If unset, the background fill is\ninherited from a parent placeholder if it exists. If the shape has no\nparent, then the default background fill depends on the shape type,\nmatching the defaults for new shapes created in the Slides editor."
+ },
+ "link": {
+ "$ref": "Link",
+ "description": "The hyperlink destination of the shape. If unset, there is no link. Links\nare not inherited from parent placeholders."
+ }
+ },
+ "id": "ShapeProperties"
+ },
+ "TableRow": {
+ "description": "Properties and contents of each row in a table.",
+ "type": "object",
+ "properties": {
+ "tableRowProperties": {
+ "$ref": "TableRowProperties",
+ "description": "Properties of the row."
+ },
+ "tableCells": {
+ "description": "Properties and contents of each cell.\n\nCells that span multiple columns are represented only once with a\ncolumn_span greater\nthan 1. As a result, the length of this collection does not always match\nthe number of columns of the entire table.",
+ "items": {
+ "$ref": "TableCell"
+ },
+ "type": "array"
+ },
+ "rowHeight": {
+ "$ref": "Dimension",
+ "description": "Height of a row."
+ }
+ },
+ "id": "TableRow"
+ },
+ "UpdateTableCellPropertiesRequest": {
+ "description": "Update the properties of a TableCell.",
+ "type": "object",
+ "properties": {
+ "fields": {
+ "type": "string",
+ "format": "google-fieldmask",
+ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `tableCellProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the table cell background solid fill color, set\n`fields` to `\"tableCellBackgroundFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset."
+ },
+ "tableRange": {
+ "$ref": "TableRange",
+ "description": "The table range representing the subset of the table to which the updates\nare applied. If a table range is not specified, the updates will apply to\nthe entire table."
+ },
+ "objectId": {
+ "description": "The object ID of the table.",
+ "type": "string"
+ },
+ "tableCellProperties": {
+ "$ref": "TableCellProperties",
+ "description": "The table cell properties to update."
+ }
+ },
+ "id": "UpdateTableCellPropertiesRequest"
+ },
+ "CreateSlideRequest": {
+ "type": "object",
+ "properties": {
+ "slideLayoutReference": {
+ "description": "Layout reference of the slide to be inserted, based on the *current\nmaster*, which is one of the following:\n\n- The master of the previous slide index.\n- The master of the first slide, if the insertion_index is zero.\n- The first master in the presentation, if there are no slides.\n\nIf the LayoutReference is not found in the current master, a 400 bad\nrequest error is returned.\n\nIf you don't specify a layout reference, then the new slide will use the\npredefined layout `BLANK`.",
+ "$ref": "LayoutReference"
+ },
+ "objectId": {
+ "description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated.",
+ "type": "string"
+ },
+ "insertionIndex": {
+ "format": "int32",
+ "description": "The optional zero-based index indicating where to insert the slides.\n\nIf you don't specify an index, the new slide is created at the end.",
+ "type": "integer"
+ },
+ "placeholderIdMappings": {
+ "description": "An optional list of object ID mappings from the placeholder(s) on the layout to the placeholder(s)\nthat will be created on the new slide from that specified layout. Can only\nbe used when `slide_layout_reference` is specified.",
+ "items": {
+ "$ref": "LayoutPlaceholderIdMapping"
+ },
+ "type": "array"
+ }
+ },
+ "id": "CreateSlideRequest",
+ "description": "Creates a new slide."
+ },
+ "TableRowProperties": {
+ "id": "TableRowProperties",
+ "description": "Properties of each row in a table.",
+ "type": "object",
+ "properties": {
+ "minRowHeight": {
+ "$ref": "Dimension",
+ "description": "Minimum height of the row. The row will be rendered in the Slides editor at\na height equal to or greater than this value in order to show all the text\nin the row's cell(s)."
+ }
+ }
+ },
+ "BatchUpdatePresentationRequest": {
+ "description": "Request message for PresentationsService.BatchUpdatePresentation.",
+ "type": "object",
+ "properties": {
+ "requests": {
+ "description": "A list of updates to apply to the presentation.",
+ "items": {
+ "$ref": "Request"
+ },
+ "type": "array"
+ },
+ "writeControl": {
+ "$ref": "WriteControl",
+ "description": "Provides control over how write requests are executed."
+ }
+ },
+ "id": "BatchUpdatePresentationRequest"
+ },
+ "GroupObjectsResponse": {
+ "description": "The result of grouping objects.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the created group.",
+ "type": "string"
+ }
+ },
+ "id": "GroupObjectsResponse"
+ },
+ "TableBorderProperties": {
+ "type": "object",
+ "properties": {
+ "weight": {
+ "$ref": "Dimension",
+ "description": "The thickness of the border."
+ },
+ "dashStyle": {
+ "enumDescriptions": [
+ "Unspecified dash style.",
+ "Solid line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'solid'.\nThis is the default dash style.",
+ "Dotted line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dot'.",
+ "Dashed line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dash'.",
+ "Alternating dashes and dots. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'dashDot'.",
+ "Line with large dashes. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'lgDash'.",
+ "Alternating large dashes and dots. Corresponds to ECMA-376\nST_PresetLineDashVal value 'lgDashDot'."
+ ],
+ "enum": [
+ "DASH_STYLE_UNSPECIFIED",
+ "SOLID",
+ "DOT",
+ "DASH",
+ "DASH_DOT",
+ "LONG_DASH",
+ "LONG_DASH_DOT"
+ ],
+ "description": "The dash style of the border.",
+ "type": "string"
+ },
+ "tableBorderFill": {
+ "description": "The fill of the table border.",
+ "$ref": "TableBorderFill"
+ }
+ },
+ "id": "TableBorderProperties",
+ "description": "The border styling properties of the\nTableBorderCell."
+ },
+ "TableBorderCell": {
+ "description": "The properties of each border cell.",
+ "type": "object",
+ "properties": {
+ "location": {
+ "description": "The location of the border within the border table.",
+ "$ref": "TableCellLocation"
+ },
+ "tableBorderProperties": {
+ "$ref": "TableBorderProperties",
+ "description": "The border properties."
+ }
+ },
+ "id": "TableBorderCell"
+ },
+ "TextContent": {
+ "id": "TextContent",
+ "description": "The general text content. The text must reside in a compatible shape (e.g.\ntext box or rectangle) or a table cell in a page.",
+ "type": "object",
+ "properties": {
+ "lists": {
+ "additionalProperties": {
+ "$ref": "List"
+ },
+ "description": "The bulleted lists contained in this text, keyed by list ID.",
+ "type": "object"
+ },
+ "textElements": {
+ "items": {
+ "$ref": "TextElement"
+ },
+ "type": "array",
+ "description": "The text contents broken down into its component parts, including styling\ninformation. This property is read-only."
+ }
+ }
+ },
+ "CreateSheetsChartResponse": {
+ "description": "The result of creating an embedded Google Sheets chart.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the created chart.",
+ "type": "string"
+ }
+ },
+ "id": "CreateSheetsChartResponse"
}
},
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"protocol": "rest",
"canonicalName": "Slides",
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/presentations": {
- "description": "View and manage your Google Slides presentations"
- },
"https://www.googleapis.com/auth/presentations.readonly": {
"description": "View your Google Slides presentations"
},
@@ -4228,6 +4225,9 @@
},
"https://www.googleapis.com/auth/spreadsheets": {
"description": "View and manage your spreadsheets in Google Drive"
+ },
+ "https://www.googleapis.com/auth/presentations": {
+ "description": "View and manage your Google Slides presentations"
}
}
}
diff --git a/sourcerepo/v1/sourcerepo-api.json b/sourcerepo/v1/sourcerepo-api.json
index 5b77862..6aa670a 100644
--- a/sourcerepo/v1/sourcerepo-api.json
+++ b/sourcerepo/v1/sourcerepo-api.json
@@ -1,145 +1,355 @@
{
+ "canonicalName": "Cloud Source Repositories",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/source.read_write": {
+ "description": "Manage the contents of your source code repositories"
+ },
+ "https://www.googleapis.com/auth/source.full_control": {
+ "description": "Manage your source code repositories"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/source.read_only": {
+ "description": "View the contents of your source code repositories"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://sourcerepo.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "sourcerepo",
+ "batchPath": "batch",
+ "title": "Cloud Source Repositories API",
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "resources": {
+ "repos": {
+ "methods": {
+ "get": {
+ "description": "Returns information about a repo.",
+ "response": {
+ "$ref": "Repo"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "description": "The name of the requested repository. Values are of the form\n`projects/\u003cproject\u003e/repos/\u003crepo\u003e`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/repos/.+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/source.full_control",
+ "https://www.googleapis.com/auth/source.read_only",
+ "https://www.googleapis.com/auth/source.read_write"
+ ],
+ "flatPath": "v1/projects/{projectsId}/repos/{reposId}",
+ "id": "sourcerepo.projects.repos.get",
+ "path": "v1/{+name}"
+ },
+ "testIamPermissions": {
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/repos/.+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/source.full_control",
+ "https://www.googleapis.com/auth/source.read_only",
+ "https://www.googleapis.com/auth/source.read_write"
+ ],
+ "flatPath": "v1/projects/{projectsId}/repos/{reposId}:testIamPermissions",
+ "id": "sourcerepo.projects.repos.testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions"
+ },
+ "delete": {
+ "description": "Deletes a repo.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/source.full_control",
+ "https://www.googleapis.com/auth/source.read_only",
+ "https://www.googleapis.com/auth/source.read_write"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the repo to delete. Values are of the form\n`projects/\u003cproject\u003e/repos/\u003crepo\u003e`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/repos/.+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/repos/{reposId}",
+ "path": "v1/{+name}",
+ "id": "sourcerepo.projects.repos.delete"
+ },
+ "list": {
+ "flatPath": "v1/projects/{projectsId}/repos",
+ "path": "v1/{+name}/repos",
+ "id": "sourcerepo.projects.repos.list",
+ "description": "Returns all repos belonging to a project. The sizes of the repos are\nnot set by ListRepos. To get the size of a repo, use GetRepo.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "ListReposResponse"
+ },
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Resume listing repositories where a prior ListReposResponse\nleft off. This is an opaque token that must be obtained from\na recent, prior ListReposResponse's next_page_token field.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The project ID whose repos should be listed. Values are of the form\n`projects/\u003cproject\u003e`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Maximum number of repositories to return; between 1 and 500.\nIf not set or zero, defaults to 100 at the server.",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/source.full_control",
+ "https://www.googleapis.com/auth/source.read_only",
+ "https://www.googleapis.com/auth/source.read_write"
+ ]
+ },
+ "setIamPolicy": {
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/source.full_control",
+ "https://www.googleapis.com/auth/source.read_only",
+ "https://www.googleapis.com/auth/source.read_write"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/repos/.+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/repos/{reposId}:setIamPolicy",
+ "id": "sourcerepo.projects.repos.setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy."
+ },
+ "create": {
+ "flatPath": "v1/projects/{projectsId}/repos",
+ "id": "sourcerepo.projects.repos.create",
+ "path": "v1/{+parent}/repos",
+ "request": {
+ "$ref": "Repo"
+ },
+ "description": "Creates a repo in the given project with the given name.\n\nIf the named repository already exists, `CreateRepo` returns\n`ALREADY_EXISTS`.",
+ "response": {
+ "$ref": "Repo"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/source.full_control",
+ "https://www.googleapis.com/auth/source.read_only",
+ "https://www.googleapis.com/auth/source.read_write"
+ ],
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "description": "The project in which to create the repo. Values are of the form\n`projects/\u003cproject\u003e`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+$"
+ }
+ }
+ },
+ "getIamPolicy": {
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/source.full_control",
+ "https://www.googleapis.com/auth/source.read_only",
+ "https://www.googleapis.com/auth/source.read_write"
+ ],
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "type": "string",
+ "required": true,
+ "pattern": "^projects/[^/]+/repos/.+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/repos/{reposId}:getIamPolicy",
+ "id": "sourcerepo.projects.repos.getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "alt": {
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://sourcerepo.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Access source code repositories hosted by Google.",
+ "servicePath": "",
"basePath": "",
- "documentationLink": "https://cloud.google.com/source-repositories/docs/apis",
- "revision": "20170908",
"id": "sourcerepo:v1",
+ "revision": "20170908",
+ "documentationLink": "https://cloud.google.com/source-repositories/docs/apis",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "Expr": {
- "description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"",
- "type": "object",
- "properties": {
- "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"
- },
- "description": {
- "description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
- "type": "string"
- },
- "expression": {
- "description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
- "type": "string"
- }
- },
- "id": "Expr"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "MirrorConfig": {
- "description": "Configuration to automatically mirror a repository from another\nhosting service, for example GitHub or BitBucket.",
- "type": "object",
- "properties": {
- "deployKeyId": {
- "description": "ID of the SSH deploy key at the other hosting service.\nRemoving this key from the other service would deauthorize\nGoogle Cloud Source Repositories from mirroring.",
- "type": "string"
- },
- "url": {
- "description": "URL of the main repository at the other hosting service.",
- "type": "string"
- },
- "webhookId": {
- "description": "ID of the webhook listening to updates to trigger mirroring.\nRemoving this webook from the other hosting service will stop\nGoogle Cloud Source Repositories from receiving notifications,\nand thereby disabling mirroring.",
- "type": "string"
- }
- },
- "id": "MirrorConfig"
- },
- "Repo": {
- "description": "A repository (or repo) is a Git repository storing versioned source content.",
- "type": "object",
- "properties": {
- "size": {
- "format": "int64",
- "description": "The disk usage of the repo, in bytes.\nOnly returned by GetRepo.",
- "type": "string"
- },
- "name": {
- "description": "Resource name of the repository, of the form\n`projects/\u003cproject\u003e/repos/\u003crepo\u003e`. The repo name may contain slashes.\neg, `projects/myproject/repos/name/with/slash`",
- "type": "string"
- },
- "mirrorConfig": {
- "$ref": "MirrorConfig",
- "description": "How this repository mirrors a repository managed by another service."
- },
- "url": {
- "description": "URL to clone the repository from Google Cloud Source Repositories.",
- "type": "string"
- }
- },
- "id": "Repo"
- },
- "TestIamPermissionsResponse": {
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "TestIamPermissionsResponse"
- },
- "ListReposResponse": {
- "description": "Response for ListRepos. The size is not set in the returned repositories.",
- "type": "object",
- "properties": {
- "repos": {
- "description": "The listed repos.",
- "items": {
- "$ref": "Repo"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "If non-empty, additional repositories exist within the project. These\ncan be retrieved by including this value in the next ListReposRequest's\npage_token field.",
- "type": "string"
- }
- },
- "id": "ListReposResponse"
- },
- "AuditLogConfig": {
- "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
- "type": "object",
- "properties": {
- "exemptedMembers": {
- "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "logType": {
- "enumDescriptions": [
- "Default case. Should never be this.",
- "Admin reads. Example: CloudIAM getIamPolicy",
- "Data writes. Example: CloudSQL Users create",
- "Data reads. Example: CloudSQL Users list"
- ],
- "enum": [
- "LOG_TYPE_UNSPECIFIED",
- "ADMIN_READ",
- "DATA_WRITE",
- "DATA_READ"
- ],
- "description": "The log type that this config enables.",
- "type": "string"
- }
- },
- "id": "AuditLogConfig"
- },
"TestIamPermissionsRequest": {
"description": "Request message for `TestIamPermissions` method.",
"type": "object",
@@ -158,6 +368,16 @@
"description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
"type": "object",
"properties": {
+ "etag": {
+ "format": "byte",
+ "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.",
+ "type": "string"
+ },
+ "version": {
+ "format": "int32",
+ "description": "Version of the `Policy`. The default version is 0.",
+ "type": "integer"
+ },
"auditConfigs": {
"description": "Specifies cloud audit logging configuration for this policy.",
"items": {
@@ -174,16 +394,6 @@
},
"iamOwned": {
"type": "boolean"
- },
- "etag": {
- "format": "byte",
- "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.",
- "type": "string"
- },
- "version": {
- "format": "int32",
- "description": "Version of the `Policy`. The default version is 0.",
- "type": "integer"
}
},
"id": "Policy"
@@ -222,8 +432,8 @@
"type": "string"
},
"policy": {
- "$ref": "Policy",
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.",
+ "$ref": "Policy"
}
},
"id": "SetIamPolicyRequest"
@@ -232,6 +442,10 @@
"description": "Associates `members` with a `role`.",
"type": "object",
"properties": {
+ "condition": {
+ "$ref": "Expr",
+ "description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently.\nThis field is GOOGLE_INTERNAL."
+ },
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
"items": {
@@ -242,362 +456,148 @@
"role": {
"description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
"type": "string"
- },
- "condition": {
- "$ref": "Expr",
- "description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently.\nThis field is GOOGLE_INTERNAL."
}
},
"id": "Binding"
+ },
+ "Expr": {
+ "description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "description": {
+ "description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
+ "type": "string"
+ },
+ "expression": {
+ "description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
+ "type": "string"
+ }
+ },
+ "id": "Expr"
+ },
+ "MirrorConfig": {
+ "description": "Configuration to automatically mirror a repository from another\nhosting service, for example GitHub or BitBucket.",
+ "type": "object",
+ "properties": {
+ "deployKeyId": {
+ "description": "ID of the SSH deploy key at the other hosting service.\nRemoving this key from the other service would deauthorize\nGoogle Cloud Source Repositories from mirroring.",
+ "type": "string"
+ },
+ "url": {
+ "description": "URL of the main repository at the other hosting service.",
+ "type": "string"
+ },
+ "webhookId": {
+ "description": "ID of the webhook listening to updates to trigger mirroring.\nRemoving this webook from the other hosting service will stop\nGoogle Cloud Source Repositories from receiving notifications,\nand thereby disabling mirroring.",
+ "type": "string"
+ }
+ },
+ "id": "MirrorConfig"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
+ },
+ "Repo": {
+ "description": "A repository (or repo) is a Git repository storing versioned source content.",
+ "type": "object",
+ "properties": {
+ "size": {
+ "format": "int64",
+ "description": "The disk usage of the repo, in bytes.\nOnly returned by GetRepo.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Resource name of the repository, of the form\n`projects/\u003cproject\u003e/repos/\u003crepo\u003e`. The repo name may contain slashes.\neg, `projects/myproject/repos/name/with/slash`",
+ "type": "string"
+ },
+ "mirrorConfig": {
+ "$ref": "MirrorConfig",
+ "description": "How this repository mirrors a repository managed by another service."
+ },
+ "url": {
+ "description": "URL to clone the repository from Google Cloud Source Repositories.",
+ "type": "string"
+ }
+ },
+ "id": "Repo"
+ },
+ "ListReposResponse": {
+ "description": "Response for ListRepos. The size is not set in the returned repositories.",
+ "type": "object",
+ "properties": {
+ "repos": {
+ "description": "The listed repos.",
+ "items": {
+ "$ref": "Repo"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "If non-empty, additional repositories exist within the project. These\ncan be retrieved by including this value in the next ListReposRequest's\npage_token field.",
+ "type": "string"
+ }
+ },
+ "id": "ListReposResponse"
+ },
+ "TestIamPermissionsResponse": {
+ "description": "Response message for `TestIamPermissions` method.",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "TestIamPermissionsResponse"
+ },
+ "AuditLogConfig": {
+ "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
+ "type": "object",
+ "properties": {
+ "logType": {
+ "description": "The log type that this config enables.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default case. Should never be this.",
+ "Admin reads. Example: CloudIAM getIamPolicy",
+ "Data writes. Example: CloudSQL Users create",
+ "Data reads. Example: CloudSQL Users list"
+ ],
+ "enum": [
+ "LOG_TYPE_UNSPECIFIED",
+ "ADMIN_READ",
+ "DATA_WRITE",
+ "DATA_READ"
+ ]
+ },
+ "exemptedMembers": {
+ "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "AuditLogConfig"
}
},
+ "protocol": "rest",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "protocol": "rest",
- "canonicalName": "Cloud Source Repositories",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/source.read_write": {
- "description": "Manage the contents of your source code repositories"
- },
- "https://www.googleapis.com/auth/source.full_control": {
- "description": "Manage your source code repositories"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/source.read_only": {
- "description": "View the contents of your source code repositories"
- }
- }
- }
- },
- "rootUrl": "https://sourcerepo.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "sourcerepo",
- "batchPath": "batch",
- "title": "Cloud Source Repositories API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "repos": {
- "methods": {
- "testIamPermissions": {
- "flatPath": "v1/projects/{projectsId}/repos/{reposId}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "id": "sourcerepo.projects.repos.testIamPermissions",
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/repos/.+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/source.full_control",
- "https://www.googleapis.com/auth/source.read_only",
- "https://www.googleapis.com/auth/source.read_write"
- ]
- },
- "delete": {
- "description": "Deletes a repo.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/source.full_control",
- "https://www.googleapis.com/auth/source.read_only",
- "https://www.googleapis.com/auth/source.read_write"
- ],
- "parameters": {
- "name": {
- "description": "The name of the repo to delete. Values are of the form\n`projects/\u003cproject\u003e/repos/\u003crepo\u003e`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/repos/.+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/repos/{reposId}",
- "path": "v1/{+name}",
- "id": "sourcerepo.projects.repos.delete"
- },
- "list": {
- "description": "Returns all repos belonging to a project. The sizes of the repos are\nnot set by ListRepos. To get the size of a repo, use GetRepo.",
- "response": {
- "$ref": "ListReposResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/source.full_control",
- "https://www.googleapis.com/auth/source.read_only",
- "https://www.googleapis.com/auth/source.read_write"
- ],
- "parameters": {
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "Maximum number of repositories to return; between 1 and 500.\nIf not set or zero, defaults to 100 at the server.",
- "type": "integer"
- },
- "pageToken": {
- "location": "query",
- "description": "Resume listing repositories where a prior ListReposResponse\nleft off. This is an opaque token that must be obtained from\na recent, prior ListReposResponse's next_page_token field.",
- "type": "string"
- },
- "name": {
- "description": "The project ID whose repos should be listed. Values are of the form\n`projects/\u003cproject\u003e`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/repos",
- "id": "sourcerepo.projects.repos.list",
- "path": "v1/{+name}/repos"
- },
- "create": {
- "description": "Creates a repo in the given project with the given name.\n\nIf the named repository already exists, `CreateRepo` returns\n`ALREADY_EXISTS`.",
- "request": {
- "$ref": "Repo"
- },
- "response": {
- "$ref": "Repo"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "location": "path",
- "description": "The project in which to create the repo. Values are of the form\n`projects/\u003cproject\u003e`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/source.full_control",
- "https://www.googleapis.com/auth/source.read_only",
- "https://www.googleapis.com/auth/source.read_write"
- ],
- "flatPath": "v1/projects/{projectsId}/repos",
- "id": "sourcerepo.projects.repos.create",
- "path": "v1/{+parent}/repos"
- },
- "setIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/repos/.+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/source.full_control",
- "https://www.googleapis.com/auth/source.read_only",
- "https://www.googleapis.com/auth/source.read_write"
- ],
- "flatPath": "v1/projects/{projectsId}/repos/{reposId}:setIamPolicy",
- "id": "sourcerepo.projects.repos.setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "request": {
- "$ref": "SetIamPolicyRequest"
- }
- },
- "getIamPolicy": {
- "httpMethod": "GET",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/source.full_control",
- "https://www.googleapis.com/auth/source.read_only",
- "https://www.googleapis.com/auth/source.read_write"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/repos/.+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/repos/{reposId}:getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "id": "sourcerepo.projects.repos.getIamPolicy",
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset."
- },
- "get": {
- "description": "Returns information about a repo.",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Repo"
- },
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/source.full_control",
- "https://www.googleapis.com/auth/source.read_only",
- "https://www.googleapis.com/auth/source.read_write"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the requested repository. Values are of the form\n`projects/\u003cproject\u003e/repos/\u003crepo\u003e`.",
- "type": "string",
- "required": true,
- "pattern": "^projects/[^/]+/repos/.+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/repos/{reposId}",
- "id": "sourcerepo.projects.repos.get",
- "path": "v1/{+name}"
- }
- }
- }
- }
- }
- },
- "parameters": {
- "pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "alt": {
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- }
- },
- "version": "v1",
- "baseUrl": "https://sourcerepo.googleapis.com/",
- "servicePath": "",
- "description": "Access source code repositories hosted by Google.",
- "kind": "discovery#restDescription"
+ }
}
diff --git a/spanner/v1/spanner-api.json b/spanner/v1/spanner-api.json
index d0d6b3d..af88bb8 100644
--- a/spanner/v1/spanner-api.json
+++ b/spanner/v1/spanner-api.json
@@ -3,12 +3,751 @@
"description": "Cloud Spanner is a managed, mission-critical, globally consistent and scalable relational database service.",
"servicePath": "",
"basePath": "",
- "revision": "20170914",
- "documentationLink": "https://cloud.google.com/spanner/",
"id": "spanner:v1",
+ "documentationLink": "https://cloud.google.com/spanner/",
+ "revision": "20170914",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "ResultSet": {
+ "description": "Results from Read or\nExecuteSql.",
+ "type": "object",
+ "properties": {
+ "metadata": {
+ "description": "Metadata about the result set, such as row type information.",
+ "$ref": "ResultSetMetadata"
+ },
+ "stats": {
+ "description": "Query plan and execution statistics for the query that produced this\nresult set. These can be requested by setting\nExecuteSqlRequest.query_mode.",
+ "$ref": "ResultSetStats"
+ },
+ "rows": {
+ "description": "Each element in `rows` is a row whose format is defined by\nmetadata.row_type. The ith element\nin each row matches the ith field in\nmetadata.row_type. Elements are\nencoded based on type as described\nhere.",
+ "type": "array",
+ "items": {
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ }
+ }
+ },
+ "id": "ResultSet"
+ },
+ "Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
+ "properties": {
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "type": "array",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ }
+ },
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "Status"
+ },
+ "CreateSessionRequest": {
+ "description": "The request for CreateSession.",
+ "type": "object",
+ "properties": {
+ "session": {
+ "$ref": "Session",
+ "description": "The session to create."
+ }
+ },
+ "id": "CreateSessionRequest"
+ },
+ "UpdateDatabaseDdlRequest": {
+ "description": "Enqueues the given DDL statements to be applied, in order but not\nnecessarily all at once, to the database schema at some point (or\npoints) in the future. The server checks that the statements\nare executable (syntactically valid, name tables that exist, etc.)\nbefore enqueueing them, but they may still fail upon\nlater execution (e.g., if a statement from another batch of\nstatements is applied first and it conflicts in some way, or if\nthere is some data-related problem like a `NULL` value in a column to\nwhich `NOT NULL` would be added). If a statement fails, all\nsubsequent statements in the batch are automatically cancelled.\n\nEach batch of statements is assigned a name which can be used with\nthe Operations API to monitor\nprogress. See the\noperation_id field for more\ndetails.",
+ "type": "object",
+ "properties": {
+ "statements": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "DDL statements to be applied to the database."
+ },
+ "operationId": {
+ "description": "If empty, the new update request is assigned an\nautomatically-generated operation ID. Otherwise, `operation_id`\nis used to construct the name of the resulting\nOperation.\n\nSpecifying an explicit operation ID simplifies determining\nwhether the statements were executed in the event that the\nUpdateDatabaseDdl call is replayed,\nor the return value is otherwise lost: the database and\n`operation_id` fields can be combined to form the\nname of the resulting\nlongrunning.Operation: `\u003cdatabase\u003e/operations/\u003coperation_id\u003e`.\n\n`operation_id` should be unique within the database, and must be\na valid identifier: `a-z*`. Note that\nautomatically-generated operation IDs always begin with an\nunderscore. If the named operation already exists,\nUpdateDatabaseDdl returns\n`ALREADY_EXISTS`.",
+ "type": "string"
+ }
+ },
+ "id": "UpdateDatabaseDdlRequest"
+ },
+ "Binding": {
+ "description": "Associates `members` with a `role`.",
+ "type": "object",
+ "properties": {
+ "members": {
+ "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "role": {
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
+ "type": "string"
+ }
+ },
+ "id": "Binding"
+ },
+ "PartialResultSet": {
+ "properties": {
+ "chunkedValue": {
+ "description": "If true, then the final value in values is chunked, and must\nbe combined with more values from subsequent `PartialResultSet`s\nto obtain a complete field value.",
+ "type": "boolean"
+ },
+ "metadata": {
+ "description": "Metadata about the result set, such as row type information.\nOnly present in the first response.",
+ "$ref": "ResultSetMetadata"
+ },
+ "values": {
+ "description": "A streamed result set consists of a stream of values, which might\nbe split into many `PartialResultSet` messages to accommodate\nlarge rows and/or large values. Every N complete values defines a\nrow, where N is equal to the number of entries in\nmetadata.row_type.fields.\n\nMost values are encoded based on type as described\nhere.\n\nIt is possible that the last value in values is \"chunked\",\nmeaning that the rest of the value is sent in subsequent\n`PartialResultSet`(s). This is denoted by the chunked_value\nfield. Two or more chunked values can be merged to form a\ncomplete value as follows:\n\n * `bool/number/null`: cannot be chunked\n * `string`: concatenate the strings\n * `list`: concatenate the lists. If the last element in a list is a\n `string`, `list`, or `object`, merge it with the first element in\n the next list by applying these rules recursively.\n * `object`: concatenate the (field name, field value) pairs. If a\n field name is duplicated, then apply these rules recursively\n to merge the field values.\n\nSome examples of merging:\n\n # Strings are concatenated.\n \"foo\", \"bar\" =\u003e \"foobar\"\n\n # Lists of non-strings are concatenated.\n [2, 3], [4] =\u003e [2, 3, 4]\n\n # Lists are concatenated, but the last and first elements are merged\n # because they are strings.\n [\"a\", \"b\"], [\"c\", \"d\"] =\u003e [\"a\", \"bc\", \"d\"]\n\n # Lists are concatenated, but the last and first elements are merged\n # because they are lists. Recursively, the last and first elements\n # of the inner lists are merged because they are strings.\n [\"a\", [\"b\", \"c\"]], [[\"d\"], \"e\"] =\u003e [\"a\", [\"b\", \"cd\"], \"e\"]\n\n # Non-overlapping object fields are combined.\n {\"a\": \"1\"}, {\"b\": \"2\"} =\u003e {\"a\": \"1\", \"b\": 2\"}\n\n # Overlapping object fields are merged.\n {\"a\": \"1\"}, {\"a\": \"2\"} =\u003e {\"a\": \"12\"}\n\n # Examples of merging objects containing lists of strings.\n {\"a\": [\"1\"]}, {\"a\": [\"2\"]} =\u003e {\"a\": [\"12\"]}\n\nFor a more complete example, suppose a streaming SQL query is\nyielding a result set whose rows contain a single string\nfield. The following `PartialResultSet`s might be yielded:\n\n {\n \"metadata\": { ... }\n \"values\": [\"Hello\", \"W\"]\n \"chunked_value\": true\n \"resume_token\": \"Af65...\"\n }\n {\n \"values\": [\"orl\"]\n \"chunked_value\": true\n \"resume_token\": \"Bqp2...\"\n }\n {\n \"values\": [\"d\"]\n \"resume_token\": \"Zx1B...\"\n }\n\nThis sequence of `PartialResultSet`s encodes two rows, one\ncontaining the field value `\"Hello\"`, and a second containing the\nfield value `\"World\" = \"W\" + \"orl\" + \"d\"`.",
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ },
+ "resumeToken": {
+ "description": "Streaming calls might be interrupted for a variety of reasons, such\nas TCP connection loss. If this occurs, the stream of results can\nbe resumed by re-sending the original request and including\n`resume_token`. Note that executing any other transaction in the\nsame session invalidates the token.",
+ "format": "byte",
+ "type": "string"
+ },
+ "stats": {
+ "$ref": "ResultSetStats",
+ "description": "Query plan and execution statistics for the query that produced this\nstreaming result set. These can be requested by setting\nExecuteSqlRequest.query_mode and are sent\nonly once with the last response in the stream."
+ }
+ },
+ "id": "PartialResultSet",
+ "description": "Partial results from a streaming read or SQL query. Streaming reads and\nSQL queries better tolerate large result sets, large rows, and large\nvalues, but are a little trickier to consume.",
+ "type": "object"
+ },
+ "ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Operation"
+ }
+ }
+ },
+ "id": "ListOperationsResponse"
+ },
+ "UpdateInstanceMetadata": {
+ "properties": {
+ "cancelTime": {
+ "description": "The time at which this operation was cancelled. If set, this operation is\nin the process of undoing itself (which is guaranteed to succeed) and\ncannot be cancelled again.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "The time at which this operation failed or was completed successfully.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "instance": {
+ "description": "The desired end state of the update.",
+ "$ref": "Instance"
+ },
+ "startTime": {
+ "description": "The time at which UpdateInstance\nrequest was received.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "UpdateInstanceMetadata",
+ "description": "Metadata type for the operation returned by\nUpdateInstance.",
+ "type": "object"
+ },
+ "ResultSetMetadata": {
+ "description": "Metadata about a ResultSet or PartialResultSet.",
+ "type": "object",
+ "properties": {
+ "transaction": {
+ "$ref": "Transaction",
+ "description": "If the read or SQL query began a transaction as a side-effect, the\ninformation about the new transaction is yielded here."
+ },
+ "rowType": {
+ "description": "Indicates the field names and types for the rows in the result\nset. For example, a SQL query like `\"SELECT UserId, UserName FROM\nUsers\"` could return a `row_type` value like:\n\n \"fields\": [\n { \"name\": \"UserId\", \"type\": { \"code\": \"INT64\" } },\n { \"name\": \"UserName\", \"type\": { \"code\": \"STRING\" } },\n ]",
+ "$ref": "StructType"
+ }
+ },
+ "id": "ResultSetMetadata"
+ },
+ "TransactionSelector": {
+ "description": "This message is used to select the transaction in which a\nRead or\nExecuteSql call runs.\n\nSee TransactionOptions for more information about transactions.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Execute the read or SQL query in a previously-started transaction.",
+ "format": "byte"
+ },
+ "singleUse": {
+ "description": "Execute the read or SQL query in a temporary transaction.\nThis is the most efficient way to execute a transaction that\nconsists of a single SQL query.",
+ "$ref": "TransactionOptions"
+ },
+ "begin": {
+ "description": "Begin a new transaction and execute this read or SQL query in\nit. The transaction ID of the new transaction is returned in\nResultSetMetadata.transaction, which is a Transaction.",
+ "$ref": "TransactionOptions"
+ }
+ },
+ "id": "TransactionSelector"
+ },
+ "KeySet": {
+ "id": "KeySet",
+ "description": "`KeySet` defines a collection of Cloud Spanner keys and/or key ranges. All\nthe keys are expected to be in the same table or index. The keys need\nnot be sorted in any particular way.\n\nIf the same key is specified multiple times in the set (for example\nif two ranges, two keys, or a key and a range overlap), Cloud Spanner\nbehaves as if the key were only specified once.",
+ "type": "object",
+ "properties": {
+ "ranges": {
+ "description": "A list of key ranges. See KeyRange for more information about\nkey range specifications.",
+ "type": "array",
+ "items": {
+ "$ref": "KeyRange"
+ }
+ },
+ "keys": {
+ "description": "A list of specific keys. Entries in `keys` should have exactly as\nmany elements as there are columns in the primary or index key\nwith which this `KeySet` is used. Individual key values are\nencoded as described here.",
+ "type": "array",
+ "items": {
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ }
+ },
+ "all": {
+ "description": "For convenience `all` can be set to `true` to indicate that this\n`KeySet` matches all keys in the table or index. Note that any keys\nspecified in `keys` or `ranges` are only yielded once.",
+ "type": "boolean"
+ }
+ }
+ },
+ "Mutation": {
+ "description": "A modification to one or more Cloud Spanner rows. Mutations can be\napplied to a Cloud Spanner database by sending them in a\nCommit call.",
+ "type": "object",
+ "properties": {
+ "update": {
+ "$ref": "Write",
+ "description": "Update existing rows in a table. If any of the rows does not\nalready exist, the transaction fails with error `NOT_FOUND`."
+ },
+ "replace": {
+ "$ref": "Write",
+ "description": "Like insert, except that if the row already exists, it is\ndeleted, and the column values provided are inserted\ninstead. Unlike insert_or_update, this means any values not\nexplicitly written become `NULL`."
+ },
+ "delete": {
+ "description": "Delete rows from a table. Succeeds whether or not the named\nrows were present.",
+ "$ref": "Delete"
+ },
+ "insert": {
+ "$ref": "Write",
+ "description": "Insert new rows in a table. If any of the rows already exist,\nthe write or transaction fails with error `ALREADY_EXISTS`."
+ },
+ "insertOrUpdate": {
+ "$ref": "Write",
+ "description": "Like insert, except that if the row already exists, then\nits column values are overwritten with the ones provided. Any\ncolumn values not explicitly written are preserved."
+ }
+ },
+ "id": "Mutation"
+ },
+ "GetDatabaseDdlResponse": {
+ "description": "The response for GetDatabaseDdl.",
+ "type": "object",
+ "properties": {
+ "statements": {
+ "description": "A list of formatted DDL statements defining the schema of the database\nspecified in the request.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "GetDatabaseDdlResponse"
+ },
+ "Database": {
+ "description": "A Cloud Spanner database.",
+ "type": "object",
+ "properties": {
+ "state": {
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified.",
+ "The database is still being created. Operations on the database may fail\nwith `FAILED_PRECONDITION` in this state.",
+ "The database is fully created and ready for use."
+ ],
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "CREATING",
+ "READY"
+ ],
+ "description": "Output only. The current database state."
+ },
+ "name": {
+ "description": "Required. The name of the database. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/databases/\u003cdatabase\u003e`,\nwhere `\u003cdatabase\u003e` is as specified in the `CREATE DATABASE`\nstatement. This name can be passed to other API methods to\nidentify the database.",
+ "type": "string"
+ }
+ },
+ "id": "Database"
+ },
+ "Instance": {
+ "type": "object",
+ "properties": {
+ "displayName": {
+ "description": "Required. The descriptive name for this instance as it appears in UIs.\nMust be unique per project and between 4 and 30 characters in length.",
+ "type": "string"
+ },
+ "nodeCount": {
+ "description": "Required. The number of nodes allocated to this instance. This may be zero\nin API responses for instances that are not yet in state `READY`.\n\nEach Spanner node can provide up to 10,000 QPS of reads or 2000 QPS of\nwrites (writing single rows at 1KB data per row), and 2 TiB storage.\n\nFor optimal performance, we recommend provisioning enough nodes to keep\noverall CPU utilization under 75%.\n\nA minimum of 3 nodes is recommended for production environments. This\nminimum is required for SLAs to apply to your instance.\n\nNote that Cloud Spanner performance is highly dependent on workload, schema\ndesign, and dataset characteristics. The performance numbers above are\nestimates, and assume [best practices](https://cloud.google.com/spanner/docs/bulk-loading)\nare followed.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Cloud Labels are a flexible and lightweight mechanism for organizing cloud\nresources into groups that reflect a customer's organizational needs and\ndeployment strategies. Cloud Labels can be used to filter collections of\nresources. They can be used to control how resource metrics are aggregated.\nAnd they can be used as arguments to policy management rules (e.g. route,\nfirewall, load balancing, etc.).\n\n * Label keys must be between 1 and 63 characters long and must conform to\n the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.\n * Label values must be between 0 and 63 characters long and must conform\n to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.\n * No more than 64 labels can be associated with a given resource.\n\nSee https://goo.gl/xmQnxf for more information on and examples of labels.\n\nIf you plan to use labels in your own code, please note that additional\ncharacters may be allowed in the future. And so you are advised to use an\ninternal label representation, such as JSON, which doesn't rely upon\nspecific characters being disallowed. For example, representing labels\nas the string: name + \"_\" + value would prove problematic if we were to\nallow \"_\" in a future release.",
+ "type": "object"
+ },
+ "config": {
+ "description": "Required. The name of the instance's configuration. Values are of the form\n`projects/\u003cproject\u003e/instanceConfigs/\u003cconfiguration\u003e`. See\nalso InstanceConfig and\nListInstanceConfigs.",
+ "type": "string"
+ },
+ "state": {
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "CREATING",
+ "READY"
+ ],
+ "description": "Output only. The current instance state. For\nCreateInstance, the state must be\neither omitted or set to `CREATING`. For\nUpdateInstance, the state must be\neither omitted or set to `READY`.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified.",
+ "The instance is still being created. Resources may not be\navailable yet, and operations such as database creation may not\nwork.",
+ "The instance is fully created and ready to do work such as\ncreating databases."
+ ]
+ },
+ "name": {
+ "description": "Required. A unique identifier for the instance, which cannot be changed\nafter the instance is created. Values are of the form\n`projects/\u003cproject\u003e/instances/a-z*[a-z0-9]`. The final\nsegment of the name must be between 6 and 30 characters in length.",
+ "type": "string"
+ }
+ },
+ "id": "Instance",
+ "description": "An isolated set of Cloud Spanner resources on which databases can be hosted."
+ },
+ "ListDatabasesResponse": {
+ "description": "The response for ListDatabases.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "`next_page_token` can be sent in a subsequent\nListDatabases call to fetch more\nof the matching databases.",
+ "type": "string"
+ },
+ "databases": {
+ "description": "Databases that matched the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Database"
+ }
+ }
+ },
+ "id": "ListDatabasesResponse"
+ },
+ "SetIamPolicyRequest": {
+ "description": "Request message for `SetIamPolicy` method.",
+ "type": "object",
+ "properties": {
+ "policy": {
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.",
+ "$ref": "Policy"
+ }
+ },
+ "id": "SetIamPolicyRequest"
+ },
+ "RollbackRequest": {
+ "description": "The request for Rollback.",
+ "type": "object",
+ "properties": {
+ "transactionId": {
+ "description": "Required. The transaction to roll back.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "RollbackRequest"
+ },
+ "Transaction": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "`id` may be used to identify the transaction in subsequent\nRead,\nExecuteSql,\nCommit, or\nRollback calls.\n\nSingle-use read-only transactions do not have IDs, because\nsingle-use transactions do not support multiple requests.",
+ "format": "byte",
+ "type": "string"
+ },
+ "readTimestamp": {
+ "description": "For snapshot read-only transactions, the read timestamp chosen\nfor the transaction. Not returned by default: see\nTransactionOptions.ReadOnly.return_read_timestamp.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "Transaction",
+ "description": "A transaction."
+ },
+ "UpdateDatabaseDdlMetadata": {
+ "description": "Metadata type for the operation returned by\nUpdateDatabaseDdl.",
+ "type": "object",
+ "properties": {
+ "statements": {
+ "description": "For an update this list contains all the statements. For an\nindividual statement, this list contains only that statement.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "commitTimestamps": {
+ "description": "Reports the commit timestamps of all statements that have\nsucceeded so far, where `commit_timestamps[i]` is the commit\ntimestamp for the statement `statements[i]`.",
+ "type": "array",
+ "items": {
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "database": {
+ "description": "The database being modified.",
+ "type": "string"
+ }
+ },
+ "id": "UpdateDatabaseDdlMetadata"
+ },
+ "StructType": {
+ "description": "`StructType` defines the fields of a STRUCT type.",
+ "type": "object",
+ "properties": {
+ "fields": {
+ "description": "The list of fields that make up this struct. Order is\nsignificant, because values of this struct type are represented as\nlists, where the order of field values matches the order of\nfields in the StructType. In turn, the order of fields\nmatches the order of columns in a read request, or the order of\nfields in the `SELECT` clause of a query.",
+ "type": "array",
+ "items": {
+ "$ref": "Field"
+ }
+ }
+ },
+ "id": "StructType"
+ },
+ "QueryPlan": {
+ "description": "Contains an ordered list of nodes appearing in the query plan.",
+ "type": "object",
+ "properties": {
+ "planNodes": {
+ "description": "The nodes in the query plan. Plan nodes are returned in pre-order starting\nwith the plan root. Each PlanNode's `id` corresponds to its index in\n`plan_nodes`.",
+ "type": "array",
+ "items": {
+ "$ref": "PlanNode"
+ }
+ }
+ },
+ "id": "QueryPlan"
+ },
+ "Field": {
+ "description": "Message representing a single field of a struct.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the field. For reads, this is the column name. For\nSQL queries, it is the column alias (e.g., `\"Word\"` in the\nquery `\"SELECT 'hello' AS Word\"`), or the column name (e.g.,\n`\"ColName\"` in the query `\"SELECT ColName FROM Table\"`). Some\ncolumns might have an empty name (e.g., !\"SELECT\nUPPER(ColName)\"`). Note that a query result can contain\nmultiple fields with the same name.",
+ "type": "string"
+ },
+ "type": {
+ "$ref": "Type",
+ "description": "The type of the field."
+ }
+ },
+ "id": "Field"
+ },
+ "TestIamPermissionsRequest": {
+ "description": "Request message for `TestIamPermissions` method.",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "description": "REQUIRED: The set of permissions to check for 'resource'.\nPermissions with wildcards (such as '*', 'spanner.*', 'spanner.instances.*') are not allowed.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "TestIamPermissionsRequest"
+ },
+ "ResultSetStats": {
+ "properties": {
+ "queryStats": {
+ "description": "Aggregated statistics from the execution of the query. Only present when\nthe query is profiled. For example, a query could return the statistics as\nfollows:\n\n {\n \"rows_returned\": \"3\",\n \"elapsed_time\": \"1.22 secs\",\n \"cpu_time\": \"1.19 secs\"\n }",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ }
+ },
+ "queryPlan": {
+ "$ref": "QueryPlan",
+ "description": "QueryPlan for the query associated with this result."
+ }
+ },
+ "id": "ResultSetStats",
+ "description": "Additional statistics about a ResultSet or PartialResultSet.",
+ "type": "object"
+ },
+ "CommitResponse": {
+ "type": "object",
+ "properties": {
+ "commitTimestamp": {
+ "description": "The Cloud Spanner timestamp at which the transaction committed.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "CommitResponse",
+ "description": "The response for Commit."
+ },
+ "Type": {
+ "properties": {
+ "arrayElementType": {
+ "$ref": "Type",
+ "description": "If code == ARRAY, then `array_element_type`\nis the type of the array elements."
+ },
+ "code": {
+ "enum": [
+ "TYPE_CODE_UNSPECIFIED",
+ "BOOL",
+ "INT64",
+ "FLOAT64",
+ "TIMESTAMP",
+ "DATE",
+ "STRING",
+ "BYTES",
+ "ARRAY",
+ "STRUCT"
+ ],
+ "description": "Required. The TypeCode for this type.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified.",
+ "Encoded as JSON `true` or `false`.",
+ "Encoded as `string`, in decimal format.",
+ "Encoded as `number`, or the strings `\"NaN\"`, `\"Infinity\"`, or\n`\"-Infinity\"`.",
+ "Encoded as `string` in RFC 3339 timestamp format. The time zone\nmust be present, and must be `\"Z\"`.",
+ "Encoded as `string` in RFC 3339 date format.",
+ "Encoded as `string`.",
+ "Encoded as a base64-encoded `string`, as described in RFC 4648,\nsection 4.",
+ "Encoded as `list`, where the list elements are represented\naccording to array_element_type.",
+ "Encoded as `list`, where list element `i` is represented according\nto [struct_type.fields[i]][google.spanner.v1.StructType.fields]."
+ ]
+ },
+ "structType": {
+ "$ref": "StructType",
+ "description": "If code == STRUCT, then `struct_type`\nprovides type information for the struct's fields."
+ }
+ },
+ "id": "Type",
+ "description": "`Type` indicates the type of a Cloud Spanner value, as might be stored in a\ntable cell or returned from an SQL query.",
+ "type": "object"
+ },
+ "PlanNode": {
+ "description": "Node information for nodes appearing in a QueryPlan.plan_nodes.",
+ "type": "object",
+ "properties": {
+ "index": {
+ "description": "The `PlanNode`'s index in node list.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "displayName": {
+ "description": "The display name for the node.",
+ "type": "string"
+ },
+ "kind": {
+ "enum": [
+ "KIND_UNSPECIFIED",
+ "RELATIONAL",
+ "SCALAR"
+ ],
+ "description": "Used to determine the type of node. May be needed for visualizing\ndifferent kinds of nodes differently. For example, If the node is a\nSCALAR node, it will have a condensed representation\nwhich can be used to directly embed a description of the node in its\nparent.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified.",
+ "Denotes a Relational operator node in the expression tree. Relational\noperators represent iterative processing of rows during query execution.\nFor example, a `TableScan` operation that reads rows from a table.",
+ "Denotes a Scalar node in the expression tree. Scalar nodes represent\nnon-iterable entities in the query plan. For example, constants or\narithmetic operators appearing inside predicate expressions or references\nto column names."
+ ]
+ },
+ "childLinks": {
+ "description": "List of child node `index`es and their relationship to this parent.",
+ "type": "array",
+ "items": {
+ "$ref": "ChildLink"
+ }
+ },
+ "metadata": {
+ "description": "Attributes relevant to the node contained in a group of key-value pairs.\nFor example, a Parameter Reference node could have the following\ninformation in its metadata:\n\n {\n \"parameter_reference\": \"param1\",\n \"parameter_type\": \"array\"\n }",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ }
+ },
+ "executionStats": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "The execution statistics associated with the node, contained in a group of\nkey-value pairs. Only present if the plan was returned as a result of a\nprofile query. For example, number of executions, number of rows/time per\nexecution etc.",
+ "type": "object"
+ },
+ "shortRepresentation": {
+ "$ref": "ShortRepresentation",
+ "description": "Condensed representation for SCALAR nodes."
+ }
+ },
+ "id": "PlanNode"
+ },
+ "CreateInstanceMetadata": {
+ "description": "Metadata type for the operation returned by\nCreateInstance.",
+ "type": "object",
+ "properties": {
+ "cancelTime": {
+ "description": "The time at which this operation was cancelled. If set, this operation is\nin the process of undoing itself (which is guaranteed to succeed) and\ncannot be cancelled again.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "endTime": {
+ "type": "string",
+ "description": "The time at which this operation failed or was completed successfully.",
+ "format": "google-datetime"
+ },
+ "instance": {
+ "$ref": "Instance",
+ "description": "The instance being created."
+ },
+ "startTime": {
+ "description": "The time at which the\nCreateInstance request was\nreceived.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "CreateInstanceMetadata"
+ },
+ "ChildLink": {
+ "properties": {
+ "type": {
+ "description": "The type of the link. For example, in Hash Joins this could be used to\ndistinguish between the build child and the probe child, or in the case\nof the child being an output variable, to represent the tag associated\nwith the output variable.",
+ "type": "string"
+ },
+ "childIndex": {
+ "description": "The node to which the link points.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "variable": {
+ "description": "Only present if the child node is SCALAR and corresponds\nto an output variable of the parent node. The field carries the name of\nthe output variable.\nFor example, a `TableScan` operator that reads rows from a table will\nhave child links to the `SCALAR` nodes representing the output variables\ncreated for each column that is read by the operator. The corresponding\n`variable` fields will be set to the variable names assigned to the\ncolumns.",
+ "type": "string"
+ }
+ },
+ "id": "ChildLink",
+ "description": "Metadata associated with a parent-child relationship appearing in a\nPlanNode.",
+ "type": "object"
+ },
+ "Delete": {
+ "description": "Arguments to delete operations.",
+ "type": "object",
+ "properties": {
+ "table": {
+ "description": "Required. The table whose rows will be deleted.",
+ "type": "string"
+ },
+ "keySet": {
+ "$ref": "KeySet",
+ "description": "Required. The primary keys of the rows within table to delete."
+ }
+ },
+ "id": "Delete"
+ },
+ "ListInstanceConfigsResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "`next_page_token` can be sent in a subsequent\nListInstanceConfigs call to\nfetch more of the matching instance configurations.",
+ "type": "string"
+ },
+ "instanceConfigs": {
+ "description": "The list of requested instance configurations.",
+ "type": "array",
+ "items": {
+ "$ref": "InstanceConfig"
+ }
+ }
+ },
+ "id": "ListInstanceConfigsResponse",
+ "description": "The response for ListInstanceConfigs.",
+ "type": "object"
+ },
+ "BeginTransactionRequest": {
+ "description": "The request for BeginTransaction.",
+ "type": "object",
+ "properties": {
+ "options": {
+ "description": "Required. Options for the new transaction.",
+ "$ref": "TransactionOptions"
+ }
+ },
+ "id": "BeginTransactionRequest"
+ },
+ "CommitRequest": {
+ "properties": {
+ "singleUseTransaction": {
+ "description": "Execute mutations in a temporary transaction. Note that unlike\ncommit of a previously-started transaction, commit with a\ntemporary transaction is non-idempotent. That is, if the\n`CommitRequest` is sent to Cloud Spanner more than once (for\ninstance, due to retries in the application, or in the\ntransport library), it is possible that the mutations are\nexecuted more than once. If this is undesirable, use\nBeginTransaction and\nCommit instead.",
+ "$ref": "TransactionOptions"
+ },
+ "mutations": {
+ "description": "The mutations to be executed when this transaction commits. All\nmutations are applied atomically, in the order they appear in\nthis list.",
+ "type": "array",
+ "items": {
+ "$ref": "Mutation"
+ }
+ },
+ "transactionId": {
+ "type": "string",
+ "description": "Commit a previously-started transaction.",
+ "format": "byte"
+ }
+ },
+ "id": "CommitRequest",
+ "description": "The request for Commit.",
+ "type": "object"
+ },
+ "GetIamPolicyRequest": {
+ "description": "Request message for `GetIamPolicy` method.",
+ "type": "object",
+ "properties": {},
+ "id": "GetIamPolicyRequest"
+ },
"TestIamPermissionsResponse": {
"description": "Response message for `TestIamPermissions` method.",
"type": "object",
@@ -23,12 +762,6 @@
},
"id": "TestIamPermissionsResponse"
},
- "GetIamPolicyRequest": {
- "properties": {},
- "id": "GetIamPolicyRequest",
- "description": "Request message for `GetIamPolicy` method.",
- "type": "object"
- },
"CreateDatabaseMetadata": {
"description": "Metadata type for the operation returned by\nCreateDatabase.",
"type": "object",
@@ -41,24 +774,27 @@
"id": "CreateDatabaseMetadata"
},
"ListSessionsResponse": {
+ "id": "ListSessionsResponse",
+ "description": "The response for ListSessions.",
+ "type": "object",
"properties": {
- "nextPageToken": {
- "description": "`next_page_token` can be sent in a subsequent\nListSessions call to fetch more of the matching\nsessions.",
- "type": "string"
- },
"sessions": {
"description": "The list of requested sessions.",
"type": "array",
"items": {
"$ref": "Session"
}
+ },
+ "nextPageToken": {
+ "description": "`next_page_token` can be sent in a subsequent\nListSessions call to fetch more of the matching\nsessions.",
+ "type": "string"
}
- },
- "id": "ListSessionsResponse",
- "description": "The response for ListSessions.",
- "type": "object"
+ }
},
"Session": {
+ "id": "Session",
+ "description": "A session in the Cloud Spanner API.",
+ "type": "object",
"properties": {
"name": {
"description": "The name of the session.",
@@ -70,39 +806,18 @@
"type": "string"
},
"labels": {
+ "type": "object",
"additionalProperties": {
"type": "string"
},
- "description": "The labels for the session.\n\n * Label keys must be between 1 and 63 characters long and must conform to\n the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.\n * Label values must be between 0 and 63 characters long and must conform\n to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.\n * No more than 20 labels can be associated with a given session.",
- "type": "object"
+ "description": "The labels for the session.\n\n * Label keys must be between 1 and 63 characters long and must conform to\n the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.\n * Label values must be between 0 and 63 characters long and must conform\n to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.\n * No more than 20 labels can be associated with a given session."
},
"createTime": {
"description": "Output only. The timestamp when the session is created.",
"format": "google-datetime",
"type": "string"
}
- },
- "id": "Session",
- "description": "A session in the Cloud Spanner API.",
- "type": "object"
- },
- "ListInstancesResponse": {
- "properties": {
- "instances": {
- "description": "The list of requested instances.",
- "type": "array",
- "items": {
- "$ref": "Instance"
- }
- },
- "nextPageToken": {
- "description": "`next_page_token` can be sent in a subsequent\nListInstances call to fetch more\nof the matching instances.",
- "type": "string"
- }
- },
- "id": "ListInstancesResponse",
- "description": "The response for ListInstances.",
- "type": "object"
+ }
},
"KeyRange": {
"description": "KeyRange represents a range of rows in a table or index.\n\nA range has a start key and an end key. These keys can be open or\nclosed, indicating if the range includes rows with that key.\n\nKeys are represented by lists, where the ith value in the list\ncorresponds to the ith component of the table or index primary key.\nIndividual values are encoded as described here.\n\nFor example, consider the following table definition:\n\n CREATE TABLE UserEvents (\n UserName STRING(MAX),\n EventDate STRING(10)\n ) PRIMARY KEY(UserName, EventDate);\n\nThe following keys name rows in this table:\n\n \"Bob\", \"2014-09-23\"\n\nSince the `UserEvents` table's `PRIMARY KEY` clause names two\ncolumns, each `UserEvents` key has two elements; the first is the\n`UserName`, and the second is the `EventDate`.\n\nKey ranges with multiple components are interpreted\nlexicographically by component using the table or index key's declared\nsort order. For example, the following range returns all events for\nuser `\"Bob\"` that occurred in the year 2015:\n\n \"start_closed\": [\"Bob\", \"2015-01-01\"]\n \"end_closed\": [\"Bob\", \"2015-12-31\"]\n\nStart and end keys can omit trailing key components. This affects the\ninclusion and exclusion of rows that exactly match the provided key\ncomponents: if the key is closed, then rows that exactly match the\nprovided components are included; if the key is open, then rows\nthat exactly match are not included.\n\nFor example, the following range includes all events for `\"Bob\"` that\noccurred during and after the year 2000:\n\n \"start_closed\": [\"Bob\", \"2000-01-01\"]\n \"end_closed\": [\"Bob\"]\n\nThe next example retrieves all events for `\"Bob\"`:\n\n \"start_closed\": [\"Bob\"]\n \"end_closed\": [\"Bob\"]\n\nTo retrieve events before the year 2000:\n\n \"start_closed\": [\"Bob\"]\n \"end_open\": [\"Bob\", \"2000-01-01\"]\n\nThe following range includes all rows in the table:\n\n \"start_closed\": []\n \"end_closed\": []\n\nThis range returns all users whose `UserName` begins with any\ncharacter from A to C:\n\n \"start_closed\": [\"A\"]\n \"end_open\": [\"D\"]\n\nThis range returns all users whose `UserName` begins with B:\n\n \"start_closed\": [\"B\"]\n \"end_open\": [\"C\"]\n\nKey ranges honor column sort order. For example, suppose a table is\ndefined as follows:\n\n CREATE TABLE DescendingSortedTable {\n Key INT64,\n ...\n ) PRIMARY KEY(Key DESC);\n\nThe following range retrieves all rows with key values between 1\nand 100 inclusive:\n\n \"start_closed\": [\"100\"]\n \"end_closed\": [\"1\"]\n\nNote that 100 is passed as the start, and 1 is passed as the end,\nbecause `Key` is a descending column in the schema.",
@@ -130,23 +845,37 @@
}
},
"endClosed": {
- "description": "If the end is closed, then the range includes all rows whose\nfirst `len(end_closed)` key columns exactly match `end_closed`.",
"type": "array",
"items": {
"type": "any"
- }
+ },
+ "description": "If the end is closed, then the range includes all rows whose\nfirst `len(end_closed)` key columns exactly match `end_closed`."
}
},
"id": "KeyRange"
},
+ "ListInstancesResponse": {
+ "type": "object",
+ "properties": {
+ "instances": {
+ "type": "array",
+ "items": {
+ "$ref": "Instance"
+ },
+ "description": "The list of requested instances."
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "`next_page_token` can be sent in a subsequent\nListInstances call to fetch more\nof the matching instances."
+ }
+ },
+ "id": "ListInstancesResponse",
+ "description": "The response for ListInstances."
+ },
"ShortRepresentation": {
"description": "Condensed representation of a node and its subtree. Only present for\n`SCALAR` PlanNode(s).",
"type": "object",
"properties": {
- "description": {
- "description": "A string representation of the expression subtree rooted at this node.",
- "type": "string"
- },
"subqueries": {
"additionalProperties": {
"format": "int32",
@@ -154,6 +883,10 @@
},
"description": "A mapping of (subquery variable name) -\u003e (subquery node id) for cases\nwhere the `description` string of this node references a `SCALAR`\nsubquery contained in the expression subtree rooted at this node. The\nreferenced `SCALAR` subquery may not necessarily be a direct child of\nthis node.",
"type": "object"
+ },
+ "description": {
+ "description": "A string representation of the expression subtree rooted at this node.",
+ "type": "string"
}
},
"id": "ShortRepresentation"
@@ -190,27 +923,30 @@
"id": "UpdateInstanceRequest"
},
"Empty": {
+ "type": "object",
"properties": {},
"id": "Empty",
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object"
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`."
},
"TransactionOptions": {
- "description": "# Transactions\n\n\nEach session can have at most one active transaction at a time. After the\nactive transaction is completed, the session can immediately be\nre-used for the next transaction. It is not necessary to create a\nnew session for each transaction.\n\n# Transaction Modes\n\nCloud Spanner supports two transaction modes:\n\n 1. Locking read-write. This type of transaction is the only way\n to write data into Cloud Spanner. These transactions rely on\n pessimistic locking and, if necessary, two-phase commit.\n Locking read-write transactions may abort, requiring the\n application to retry.\n\n 2. Snapshot read-only. This transaction type provides guaranteed\n consistency across several reads, but does not allow\n writes. Snapshot read-only transactions can be configured to\n read at timestamps in the past. Snapshot read-only\n transactions do not need to be committed.\n\nFor transactions that only read, snapshot read-only transactions\nprovide simpler semantics and are almost always faster. In\nparticular, read-only transactions do not take locks, so they do\nnot conflict with read-write transactions. As a consequence of not\ntaking locks, they also do not abort, so retry loops are not needed.\n\nTransactions may only read/write data in a single database. They\nmay, however, read/write data in different tables within that\ndatabase.\n\n## Locking Read-Write Transactions\n\nLocking transactions may be used to atomically read-modify-write\ndata anywhere in a database. This type of transaction is externally\nconsistent.\n\nClients should attempt to minimize the amount of time a transaction\nis active. Faster transactions commit with higher probability\nand cause less contention. Cloud Spanner attempts to keep read locks\nactive as long as the transaction continues to do reads, and the\ntransaction has not been terminated by\nCommit or\nRollback. Long periods of\ninactivity at the client may cause Cloud Spanner to release a\ntransaction's locks and abort it.\n\nReads performed within a transaction acquire locks on the data\nbeing read. Writes can only be done at commit time, after all reads\nhave been completed.\nConceptually, a read-write transaction consists of zero or more\nreads or SQL queries followed by\nCommit. At any time before\nCommit, the client can send a\nRollback request to abort the\ntransaction.\n\n### Semantics\n\nCloud Spanner can commit the transaction if all read locks it acquired\nare still valid at commit time, and it is able to acquire write\nlocks for all writes. Cloud Spanner can abort the transaction for any\nreason. If a commit attempt returns `ABORTED`, Cloud Spanner guarantees\nthat the transaction has not modified any user data in Cloud Spanner.\n\nUnless the transaction commits, Cloud Spanner makes no guarantees about\nhow long the transaction's locks were held for. It is an error to\nuse Cloud Spanner locks for any sort of mutual exclusion other than\nbetween Cloud Spanner transactions themselves.\n\n### Retrying Aborted Transactions\n\nWhen a transaction aborts, the application can choose to retry the\nwhole transaction again. To maximize the chances of successfully\ncommitting the retry, the client should execute the retry in the\nsame session as the original attempt. The original session's lock\npriority increases with each consecutive abort, meaning that each\nattempt has a slightly better chance of success than the previous.\n\nUnder some circumstances (e.g., many transactions attempting to\nmodify the same row(s)), a transaction can abort many times in a\nshort period before successfully committing. Thus, it is not a good\nidea to cap the number of retries a transaction can attempt;\ninstead, it is better to limit the total amount of wall time spent\nretrying.\n\n### Idle Transactions\n\nA transaction is considered idle if it has no outstanding reads or\nSQL queries and has not started a read or SQL query within the last 10\nseconds. Idle transactions can be aborted by Cloud Spanner so that they\ndon't hold on to locks indefinitely. In that case, the commit will\nfail with error `ABORTED`.\n\nIf this behavior is undesirable, periodically executing a simple\nSQL query in the transaction (e.g., `SELECT 1`) prevents the\ntransaction from becoming idle.\n\n## Snapshot Read-Only Transactions\n\nSnapshot read-only transactions provides a simpler method than\nlocking read-write transactions for doing several consistent\nreads. However, this type of transaction does not support writes.\n\nSnapshot transactions do not take locks. Instead, they work by\nchoosing a Cloud Spanner timestamp, then executing all reads at that\ntimestamp. Since they do not acquire locks, they do not block\nconcurrent read-write transactions.\n\nUnlike locking read-write transactions, snapshot read-only\ntransactions never abort. They can fail if the chosen read\ntimestamp is garbage collected; however, the default garbage\ncollection policy is generous enough that most applications do not\nneed to worry about this in practice.\n\nSnapshot read-only transactions do not need to call\nCommit or\nRollback (and in fact are not\npermitted to do so).\n\nTo execute a snapshot transaction, the client specifies a timestamp\nbound, which tells Cloud Spanner how to choose a read timestamp.\n\nThe types of timestamp bound are:\n\n - Strong (the default).\n - Bounded staleness.\n - Exact staleness.\n\nIf the Cloud Spanner database to be read is geographically distributed,\nstale read-only transactions can execute more quickly than strong\nor read-write transaction, because they are able to execute far\nfrom the leader replica.\n\nEach type of timestamp bound is discussed in detail below.\n\n### Strong\n\nStrong reads are guaranteed to see the effects of all transactions\nthat have committed before the start of the read. Furthermore, all\nrows yielded by a single read are consistent with each other -- if\nany part of the read observes a transaction, all parts of the read\nsee the transaction.\n\nStrong reads are not repeatable: two consecutive strong read-only\ntransactions might return inconsistent results if there are\nconcurrent writes. If consistency across reads is required, the\nreads should be executed within a transaction or at an exact read\ntimestamp.\n\nSee TransactionOptions.ReadOnly.strong.\n\n### Exact Staleness\n\nThese timestamp bounds execute reads at a user-specified\ntimestamp. Reads at a timestamp are guaranteed to see a consistent\nprefix of the global transaction history: they observe\nmodifications done by all transactions with a commit timestamp \u003c=\nthe read timestamp, and observe none of the modifications done by\ntransactions with a larger commit timestamp. They will block until\nall conflicting transactions that may be assigned commit timestamps\n\u003c= the read timestamp have finished.\n\nThe timestamp can either be expressed as an absolute Cloud Spanner commit\ntimestamp or a staleness relative to the current time.\n\nThese modes do not require a \"negotiation phase\" to pick a\ntimestamp. As a result, they execute slightly faster than the\nequivalent boundedly stale concurrency modes. On the other hand,\nboundedly stale reads usually return fresher results.\n\nSee TransactionOptions.ReadOnly.read_timestamp and\nTransactionOptions.ReadOnly.exact_staleness.\n\n### Bounded Staleness\n\nBounded staleness modes allow Cloud Spanner to pick the read timestamp,\nsubject to a user-provided staleness bound. Cloud Spanner chooses the\nnewest timestamp within the staleness bound that allows execution\nof the reads at the closest available replica without blocking.\n\nAll rows yielded are consistent with each other -- if any part of\nthe read observes a transaction, all parts of the read see the\ntransaction. Boundedly stale reads are not repeatable: two stale\nreads, even if they use the same staleness bound, can execute at\ndifferent timestamps and thus return inconsistent results.\n\nBoundedly stale reads execute in two phases: the first phase\nnegotiates a timestamp among all replicas needed to serve the\nread. In the second phase, reads are executed at the negotiated\ntimestamp.\n\nAs a result of the two phase execution, bounded staleness reads are\nusually a little slower than comparable exact staleness\nreads. However, they are typically able to return fresher\nresults, and are more likely to execute at the closest replica.\n\nBecause the timestamp negotiation requires up-front knowledge of\nwhich rows will be read, it can only be used with single-use\nread-only transactions.\n\nSee TransactionOptions.ReadOnly.max_staleness and\nTransactionOptions.ReadOnly.min_read_timestamp.\n\n### Old Read Timestamps and Garbage Collection\n\nCloud Spanner continuously garbage collects deleted and overwritten data\nin the background to reclaim storage space. This process is known\nas \"version GC\". By default, version GC reclaims versions after they\nare one hour old. Because of this, Cloud Spanner cannot perform reads\nat read timestamps more than one hour in the past. This\nrestriction also applies to in-progress reads and/or SQL queries whose\ntimestamp become too old while executing. Reads and SQL queries with\ntoo-old read timestamps fail with the error `FAILED_PRECONDITION`.",
"type": "object",
"properties": {
"readWrite": {
- "$ref": "ReadWrite",
- "description": "Transaction may write.\n\nAuthorization to begin a read-write transaction requires\n`spanner.databases.beginOrRollbackReadWriteTransaction` permission\non the `session` resource."
+ "description": "Transaction may write.\n\nAuthorization to begin a read-write transaction requires\n`spanner.databases.beginOrRollbackReadWriteTransaction` permission\non the `session` resource.",
+ "$ref": "ReadWrite"
},
"readOnly": {
"$ref": "ReadOnly",
"description": "Transaction will not write.\n\nAuthorization to begin a read-only transaction requires\n`spanner.databases.beginReadOnlyTransaction` permission\non the `session` resource."
}
},
- "id": "TransactionOptions"
+ "id": "TransactionOptions",
+ "description": "# Transactions\n\n\nEach session can have at most one active transaction at a time. After the\nactive transaction is completed, the session can immediately be\nre-used for the next transaction. It is not necessary to create a\nnew session for each transaction.\n\n# Transaction Modes\n\nCloud Spanner supports two transaction modes:\n\n 1. Locking read-write. This type of transaction is the only way\n to write data into Cloud Spanner. These transactions rely on\n pessimistic locking and, if necessary, two-phase commit.\n Locking read-write transactions may abort, requiring the\n application to retry.\n\n 2. Snapshot read-only. This transaction type provides guaranteed\n consistency across several reads, but does not allow\n writes. Snapshot read-only transactions can be configured to\n read at timestamps in the past. Snapshot read-only\n transactions do not need to be committed.\n\nFor transactions that only read, snapshot read-only transactions\nprovide simpler semantics and are almost always faster. In\nparticular, read-only transactions do not take locks, so they do\nnot conflict with read-write transactions. As a consequence of not\ntaking locks, they also do not abort, so retry loops are not needed.\n\nTransactions may only read/write data in a single database. They\nmay, however, read/write data in different tables within that\ndatabase.\n\n## Locking Read-Write Transactions\n\nLocking transactions may be used to atomically read-modify-write\ndata anywhere in a database. This type of transaction is externally\nconsistent.\n\nClients should attempt to minimize the amount of time a transaction\nis active. Faster transactions commit with higher probability\nand cause less contention. Cloud Spanner attempts to keep read locks\nactive as long as the transaction continues to do reads, and the\ntransaction has not been terminated by\nCommit or\nRollback. Long periods of\ninactivity at the client may cause Cloud Spanner to release a\ntransaction's locks and abort it.\n\nReads performed within a transaction acquire locks on the data\nbeing read. Writes can only be done at commit time, after all reads\nhave been completed.\nConceptually, a read-write transaction consists of zero or more\nreads or SQL queries followed by\nCommit. At any time before\nCommit, the client can send a\nRollback request to abort the\ntransaction.\n\n### Semantics\n\nCloud Spanner can commit the transaction if all read locks it acquired\nare still valid at commit time, and it is able to acquire write\nlocks for all writes. Cloud Spanner can abort the transaction for any\nreason. If a commit attempt returns `ABORTED`, Cloud Spanner guarantees\nthat the transaction has not modified any user data in Cloud Spanner.\n\nUnless the transaction commits, Cloud Spanner makes no guarantees about\nhow long the transaction's locks were held for. It is an error to\nuse Cloud Spanner locks for any sort of mutual exclusion other than\nbetween Cloud Spanner transactions themselves.\n\n### Retrying Aborted Transactions\n\nWhen a transaction aborts, the application can choose to retry the\nwhole transaction again. To maximize the chances of successfully\ncommitting the retry, the client should execute the retry in the\nsame session as the original attempt. The original session's lock\npriority increases with each consecutive abort, meaning that each\nattempt has a slightly better chance of success than the previous.\n\nUnder some circumstances (e.g., many transactions attempting to\nmodify the same row(s)), a transaction can abort many times in a\nshort period before successfully committing. Thus, it is not a good\nidea to cap the number of retries a transaction can attempt;\ninstead, it is better to limit the total amount of wall time spent\nretrying.\n\n### Idle Transactions\n\nA transaction is considered idle if it has no outstanding reads or\nSQL queries and has not started a read or SQL query within the last 10\nseconds. Idle transactions can be aborted by Cloud Spanner so that they\ndon't hold on to locks indefinitely. In that case, the commit will\nfail with error `ABORTED`.\n\nIf this behavior is undesirable, periodically executing a simple\nSQL query in the transaction (e.g., `SELECT 1`) prevents the\ntransaction from becoming idle.\n\n## Snapshot Read-Only Transactions\n\nSnapshot read-only transactions provides a simpler method than\nlocking read-write transactions for doing several consistent\nreads. However, this type of transaction does not support writes.\n\nSnapshot transactions do not take locks. Instead, they work by\nchoosing a Cloud Spanner timestamp, then executing all reads at that\ntimestamp. Since they do not acquire locks, they do not block\nconcurrent read-write transactions.\n\nUnlike locking read-write transactions, snapshot read-only\ntransactions never abort. They can fail if the chosen read\ntimestamp is garbage collected; however, the default garbage\ncollection policy is generous enough that most applications do not\nneed to worry about this in practice.\n\nSnapshot read-only transactions do not need to call\nCommit or\nRollback (and in fact are not\npermitted to do so).\n\nTo execute a snapshot transaction, the client specifies a timestamp\nbound, which tells Cloud Spanner how to choose a read timestamp.\n\nThe types of timestamp bound are:\n\n - Strong (the default).\n - Bounded staleness.\n - Exact staleness.\n\nIf the Cloud Spanner database to be read is geographically distributed,\nstale read-only transactions can execute more quickly than strong\nor read-write transaction, because they are able to execute far\nfrom the leader replica.\n\nEach type of timestamp bound is discussed in detail below.\n\n### Strong\n\nStrong reads are guaranteed to see the effects of all transactions\nthat have committed before the start of the read. Furthermore, all\nrows yielded by a single read are consistent with each other -- if\nany part of the read observes a transaction, all parts of the read\nsee the transaction.\n\nStrong reads are not repeatable: two consecutive strong read-only\ntransactions might return inconsistent results if there are\nconcurrent writes. If consistency across reads is required, the\nreads should be executed within a transaction or at an exact read\ntimestamp.\n\nSee TransactionOptions.ReadOnly.strong.\n\n### Exact Staleness\n\nThese timestamp bounds execute reads at a user-specified\ntimestamp. Reads at a timestamp are guaranteed to see a consistent\nprefix of the global transaction history: they observe\nmodifications done by all transactions with a commit timestamp \u003c=\nthe read timestamp, and observe none of the modifications done by\ntransactions with a larger commit timestamp. They will block until\nall conflicting transactions that may be assigned commit timestamps\n\u003c= the read timestamp have finished.\n\nThe timestamp can either be expressed as an absolute Cloud Spanner commit\ntimestamp or a staleness relative to the current time.\n\nThese modes do not require a \"negotiation phase\" to pick a\ntimestamp. As a result, they execute slightly faster than the\nequivalent boundedly stale concurrency modes. On the other hand,\nboundedly stale reads usually return fresher results.\n\nSee TransactionOptions.ReadOnly.read_timestamp and\nTransactionOptions.ReadOnly.exact_staleness.\n\n### Bounded Staleness\n\nBounded staleness modes allow Cloud Spanner to pick the read timestamp,\nsubject to a user-provided staleness bound. Cloud Spanner chooses the\nnewest timestamp within the staleness bound that allows execution\nof the reads at the closest available replica without blocking.\n\nAll rows yielded are consistent with each other -- if any part of\nthe read observes a transaction, all parts of the read see the\ntransaction. Boundedly stale reads are not repeatable: two stale\nreads, even if they use the same staleness bound, can execute at\ndifferent timestamps and thus return inconsistent results.\n\nBoundedly stale reads execute in two phases: the first phase\nnegotiates a timestamp among all replicas needed to serve the\nread. In the second phase, reads are executed at the negotiated\ntimestamp.\n\nAs a result of the two phase execution, bounded staleness reads are\nusually a little slower than comparable exact staleness\nreads. However, they are typically able to return fresher\nresults, and are more likely to execute at the closest replica.\n\nBecause the timestamp negotiation requires up-front knowledge of\nwhich rows will be read, it can only be used with single-use\nread-only transactions.\n\nSee TransactionOptions.ReadOnly.max_staleness and\nTransactionOptions.ReadOnly.min_read_timestamp.\n\n### Old Read Timestamps and Garbage Collection\n\nCloud Spanner continuously garbage collects deleted and overwritten data\nin the background to reclaim storage space. This process is known\nas \"version GC\". By default, version GC reclaims versions after they\nare one hour old. Because of this, Cloud Spanner cannot perform reads\nat read timestamps more than one hour in the past. This\nrestriction also applies to in-progress reads and/or SQL queries whose\ntimestamp become too old while executing. Reads and SQL queries with\ntoo-old read timestamps fail with the error `FAILED_PRECONDITION`."
},
"CreateDatabaseRequest": {
+ "id": "CreateDatabaseRequest",
+ "description": "The request for CreateDatabase.",
+ "type": "object",
"properties": {
"extraStatements": {
"description": "An optional list of DDL statements to run inside the newly created\ndatabase. Statements can create tables, indexes, etc. These\nstatements execute atomically with the creation of the database:\nif there is an error in any statement, the database is not created.",
@@ -223,37 +959,45 @@
"description": "Required. A `CREATE DATABASE` statement, which specifies the ID of the\nnew database. The database ID must conform to the regular expression\n`a-z*[a-z0-9]` and be between 2 and 30 characters in length.\nIf the database ID is a reserved word or if it contains a hyphen, the\ndatabase ID must be enclosed in backticks (`` ` ``).",
"type": "string"
}
- },
- "id": "CreateDatabaseRequest",
- "description": "The request for CreateDatabase.",
- "type": "object"
+ }
},
"CreateInstanceRequest": {
"description": "The request for CreateInstance.",
"type": "object",
"properties": {
"instance": {
- "$ref": "Instance",
- "description": "Required. The instance to create. The name may be omitted, but if\nspecified must be `\u003cparent\u003e/instances/\u003cinstance_id\u003e`."
+ "description": "Required. The instance to create. The name may be omitted, but if\nspecified must be `\u003cparent\u003e/instances/\u003cinstance_id\u003e`.",
+ "$ref": "Instance"
},
"instanceId": {
- "description": "Required. The ID of the instance to create. Valid identifiers are of the\nform `a-z*[a-z0-9]` and must be between 6 and 30 characters in\nlength.",
- "type": "string"
+ "type": "string",
+ "description": "Required. The ID of the instance to create. Valid identifiers are of the\nform `a-z*[a-z0-9]` and must be between 6 and 30 characters in\nlength."
}
},
"id": "CreateInstanceRequest"
},
"ReadOnly": {
+ "description": "Message type to initiate a read-only transaction.",
+ "type": "object",
"properties": {
+ "strong": {
+ "description": "Read at a timestamp where all previously committed transactions\nare visible.",
+ "type": "boolean"
+ },
+ "minReadTimestamp": {
+ "description": "Executes all reads at a timestamp \u003e= `min_read_timestamp`.\n\nThis is useful for requesting fresher data than some previous\nread, or data that is fresh enough to observe the effects of some\npreviously committed transaction whose timestamp is known.\n\nNote that this option can only be used in single-use transactions.",
+ "format": "google-datetime",
+ "type": "string"
+ },
"maxStaleness": {
"description": "Read data at a timestamp \u003e= `NOW - max_staleness`\nseconds. Guarantees that all writes that have committed more\nthan the specified number of seconds ago are visible. Because\nCloud Spanner chooses the exact timestamp, this mode works even if\nthe client's local clock is substantially skewed from Cloud Spanner\ncommit timestamps.\n\nUseful for reading the freshest data available at a nearby\nreplica, while bounding the possible staleness if the local\nreplica has fallen behind.\n\nNote that this option can only be used in single-use\ntransactions.",
"format": "google-duration",
"type": "string"
},
"readTimestamp": {
+ "type": "string",
"description": "Executes all reads at the given timestamp. Unlike other modes,\nreads at a specific timestamp are repeatable; the same read at\nthe same timestamp always returns the same data. If the\ntimestamp is in the future, the read will block until the\nspecified timestamp, modulo the read's deadline.\n\nUseful for large scale consistent reads such as mapreduces, or\nfor coordinating many reads against a consistent snapshot of the\ndata.",
- "format": "google-datetime",
- "type": "string"
+ "format": "google-datetime"
},
"returnReadTimestamp": {
"description": "If true, the Cloud Spanner-selected read timestamp is included in\nthe Transaction message that describes the transaction.",
@@ -263,25 +1007,25 @@
"description": "Executes all reads at a timestamp that is `exact_staleness`\nold. The timestamp is chosen soon after the read is started.\n\nGuarantees that all writes that have committed more than the\nspecified number of seconds ago are visible. Because Cloud Spanner\nchooses the exact timestamp, this mode works even if the client's\nlocal clock is substantially skewed from Cloud Spanner commit\ntimestamps.\n\nUseful for reading at nearby replicas without the distributed\ntimestamp negotiation overhead of `max_staleness`.",
"format": "google-duration",
"type": "string"
- },
- "strong": {
- "description": "Read at a timestamp where all previously committed transactions\nare visible.",
- "type": "boolean"
- },
- "minReadTimestamp": {
- "description": "Executes all reads at a timestamp \u003e= `min_read_timestamp`.\n\nThis is useful for requesting fresher data than some previous\nread, or data that is fresh enough to observe the effects of some\npreviously committed transaction whose timestamp is known.\n\nNote that this option can only be used in single-use transactions.",
- "format": "google-datetime",
- "type": "string"
}
},
- "id": "ReadOnly",
- "description": "Message type to initiate a read-only transaction.",
- "type": "object"
+ "id": "ReadOnly"
},
"ExecuteSqlRequest": {
"description": "The request for ExecuteSql and\nExecuteStreamingSql.",
"type": "object",
"properties": {
+ "paramTypes": {
+ "description": "It is not always possible for Cloud Spanner to infer the right SQL type\nfrom a JSON value. For example, values of type `BYTES` and values\nof type `STRING` both appear in params as JSON strings.\n\nIn these cases, `param_types` can be used to specify the exact\nSQL type for some or all of the SQL query parameters. See the\ndefinition of Type for more information\nabout SQL types.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "Type"
+ }
+ },
+ "sql": {
+ "description": "Required. The SQL query string.",
+ "type": "string"
+ },
"params": {
"additionalProperties": {
"description": "Properties of the object.",
@@ -291,43 +1035,34 @@
"type": "object"
},
"queryMode": {
+ "enumDescriptions": [
+ "The default mode where only the query result, without any information\nabout the query plan is returned.",
+ "This mode returns only the query plan, without any result rows or\nexecution statistics information.",
+ "This mode returns both the query plan and the execution statistics along\nwith the result rows."
+ ],
"enum": [
"NORMAL",
"PLAN",
"PROFILE"
],
"description": "Used to control the amount of debugging information returned in\nResultSetStats.",
- "type": "string",
- "enumDescriptions": [
- "The default mode where only the query result, without any information\nabout the query plan is returned.",
- "This mode returns only the query plan, without any result rows or\nexecution statistics information.",
- "This mode returns both the query plan and the execution statistics along\nwith the result rows."
- ]
+ "type": "string"
},
"transaction": {
- "description": "The transaction to use. If none is provided, the default is a\ntemporary read-only transaction with strong concurrency.",
- "$ref": "TransactionSelector"
+ "$ref": "TransactionSelector",
+ "description": "The transaction to use. If none is provided, the default is a\ntemporary read-only transaction with strong concurrency."
},
"resumeToken": {
"description": "If this request is resuming a previously interrupted SQL query\nexecution, `resume_token` should be copied from the last\nPartialResultSet yielded before the interruption. Doing this\nenables the new SQL query execution to resume where the last one left\noff. The rest of the request parameters must exactly match the\nrequest that yielded this token.",
"format": "byte",
"type": "string"
- },
- "paramTypes": {
- "additionalProperties": {
- "$ref": "Type"
- },
- "description": "It is not always possible for Cloud Spanner to infer the right SQL type\nfrom a JSON value. For example, values of type `BYTES` and values\nof type `STRING` both appear in params as JSON strings.\n\nIn these cases, `param_types` can be used to specify the exact\nSQL type for some or all of the SQL query parameters. See the\ndefinition of Type for more information\nabout SQL types.",
- "type": "object"
- },
- "sql": {
- "description": "Required. The SQL query string.",
- "type": "string"
}
},
"id": "ExecuteSqlRequest"
},
"Policy": {
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
+ "type": "object",
"properties": {
"etag": {
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
@@ -347,9 +1082,7 @@
}
}
},
- "id": "Policy",
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
- "type": "object"
+ "id": "Policy"
},
"ReadRequest": {
"properties": {
@@ -363,8 +1096,8 @@
"type": "string"
},
"keySet": {
- "description": "Required. `key_set` identifies the rows to be yielded. `key_set` names the\nprimary keys of the rows in table to be yielded, unless index\nis present. If index is present, then key_set instead names\nindex keys in index.\n\nRows are yielded in table primary key order (if index is empty)\nor index key order (if index is non-empty).\n\nIt is not an error for the `key_set` to name rows that do not\nexist in the database. Read yields nothing for nonexistent rows.",
- "$ref": "KeySet"
+ "$ref": "KeySet",
+ "description": "Required. `key_set` identifies the rows to be yielded. `key_set` names the\nprimary keys of the rows in table to be yielded, unless index\nis present. If index is present, then key_set instead names\nindex keys in index.\n\nRows are yielded in table primary key order (if index is empty)\nor index key order (if index is non-empty).\n\nIt is not an error for the `key_set` to name rows that do not\nexist in the database. Read yields nothing for nonexistent rows."
},
"columns": {
"description": "The columns of table to be returned for each row matching\nthis request.",
@@ -374,8 +1107,8 @@
}
},
"transaction": {
- "$ref": "TransactionSelector",
- "description": "The transaction to use. If none is provided, the default is a\ntemporary read-only transaction with strong concurrency."
+ "description": "The transaction to use. If none is provided, the default is a\ntemporary read-only transaction with strong concurrency.",
+ "$ref": "TransactionSelector"
},
"resumeToken": {
"description": "If this request is resuming a previously interrupted read,\n`resume_token` should be copied from the last\nPartialResultSet yielded before the interruption. Doing this\nenables the new read to resume where the last read left off. The\nrest of the request parameters must exactly match the request\nthat yielded this token.",
@@ -383,8 +1116,8 @@
"type": "string"
},
"table": {
- "description": "Required. The name of the table in the database to be read.",
- "type": "string"
+ "type": "string",
+ "description": "Required. The name of the table in the database to be read."
}
},
"id": "ReadRequest",
@@ -392,6 +1125,9 @@
"type": "object"
},
"Write": {
+ "id": "Write",
+ "description": "Arguments to insert, update, insert_or_update, and\nreplace operations.",
+ "type": "object",
"properties": {
"table": {
"description": "Required. The table whose rows will be written.",
@@ -414,30 +1150,29 @@
}
}
}
- },
- "id": "Write",
- "description": "Arguments to insert, update, insert_or_update, and\nreplace operations.",
- "type": "object"
+ }
},
"ReadWrite": {
- "properties": {},
"id": "ReadWrite",
"description": "Message type to initiate a read-write transaction. Currently this\ntransaction type has no options.",
- "type": "object"
+ "type": "object",
+ "properties": {}
},
"Operation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object",
"properties": {
"done": {
"description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
"type": "boolean"
},
"response": {
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
- "type": "object"
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`."
},
"name": {
"description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
@@ -456,761 +1191,26 @@
"type": "object"
}
},
- "id": "Operation",
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object"
- },
- "ResultSet": {
- "description": "Results from Read or\nExecuteSql.",
- "type": "object",
- "properties": {
- "stats": {
- "description": "Query plan and execution statistics for the query that produced this\nresult set. These can be requested by setting\nExecuteSqlRequest.query_mode.",
- "$ref": "ResultSetStats"
- },
- "rows": {
- "description": "Each element in `rows` is a row whose format is defined by\nmetadata.row_type. The ith element\nin each row matches the ith field in\nmetadata.row_type. Elements are\nencoded based on type as described\nhere.",
- "type": "array",
- "items": {
- "type": "array",
- "items": {
- "type": "any"
- }
- }
- },
- "metadata": {
- "$ref": "ResultSetMetadata",
- "description": "Metadata about the result set, such as row type information."
- }
- },
- "id": "ResultSet"
- },
- "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"
- },
- "CreateSessionRequest": {
- "description": "The request for CreateSession.",
- "type": "object",
- "properties": {
- "session": {
- "description": "The session to create.",
- "$ref": "Session"
- }
- },
- "id": "CreateSessionRequest"
- },
- "UpdateDatabaseDdlRequest": {
- "description": "Enqueues the given DDL statements to be applied, in order but not\nnecessarily all at once, to the database schema at some point (or\npoints) in the future. The server checks that the statements\nare executable (syntactically valid, name tables that exist, etc.)\nbefore enqueueing them, but they may still fail upon\nlater execution (e.g., if a statement from another batch of\nstatements is applied first and it conflicts in some way, or if\nthere is some data-related problem like a `NULL` value in a column to\nwhich `NOT NULL` would be added). If a statement fails, all\nsubsequent statements in the batch are automatically cancelled.\n\nEach batch of statements is assigned a name which can be used with\nthe Operations API to monitor\nprogress. See the\noperation_id field for more\ndetails.",
- "type": "object",
- "properties": {
- "statements": {
- "description": "DDL statements to be applied to the database.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "operationId": {
- "description": "If empty, the new update request is assigned an\nautomatically-generated operation ID. Otherwise, `operation_id`\nis used to construct the name of the resulting\nOperation.\n\nSpecifying an explicit operation ID simplifies determining\nwhether the statements were executed in the event that the\nUpdateDatabaseDdl call is replayed,\nor the return value is otherwise lost: the database and\n`operation_id` fields can be combined to form the\nname of the resulting\nlongrunning.Operation: `\u003cdatabase\u003e/operations/\u003coperation_id\u003e`.\n\n`operation_id` should be unique within the database, and must be\na valid identifier: `a-z*`. Note that\nautomatically-generated operation IDs always begin with an\nunderscore. If the named operation already exists,\nUpdateDatabaseDdl returns\n`ALREADY_EXISTS`.",
- "type": "string"
- }
- },
- "id": "UpdateDatabaseDdlRequest"
- },
- "Binding": {
- "properties": {
- "members": {
- "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "role": {
- "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
- "type": "string"
- }
- },
- "id": "Binding",
- "description": "Associates `members` with a `role`.",
- "type": "object"
- },
- "PartialResultSet": {
- "description": "Partial results from a streaming read or SQL query. Streaming reads and\nSQL queries better tolerate large result sets, large rows, and large\nvalues, but are a little trickier to consume.",
- "type": "object",
- "properties": {
- "chunkedValue": {
- "description": "If true, then the final value in values is chunked, and must\nbe combined with more values from subsequent `PartialResultSet`s\nto obtain a complete field value.",
- "type": "boolean"
- },
- "metadata": {
- "description": "Metadata about the result set, such as row type information.\nOnly present in the first response.",
- "$ref": "ResultSetMetadata"
- },
- "values": {
- "description": "A streamed result set consists of a stream of values, which might\nbe split into many `PartialResultSet` messages to accommodate\nlarge rows and/or large values. Every N complete values defines a\nrow, where N is equal to the number of entries in\nmetadata.row_type.fields.\n\nMost values are encoded based on type as described\nhere.\n\nIt is possible that the last value in values is \"chunked\",\nmeaning that the rest of the value is sent in subsequent\n`PartialResultSet`(s). This is denoted by the chunked_value\nfield. Two or more chunked values can be merged to form a\ncomplete value as follows:\n\n * `bool/number/null`: cannot be chunked\n * `string`: concatenate the strings\n * `list`: concatenate the lists. If the last element in a list is a\n `string`, `list`, or `object`, merge it with the first element in\n the next list by applying these rules recursively.\n * `object`: concatenate the (field name, field value) pairs. If a\n field name is duplicated, then apply these rules recursively\n to merge the field values.\n\nSome examples of merging:\n\n # Strings are concatenated.\n \"foo\", \"bar\" =\u003e \"foobar\"\n\n # Lists of non-strings are concatenated.\n [2, 3], [4] =\u003e [2, 3, 4]\n\n # Lists are concatenated, but the last and first elements are merged\n # because they are strings.\n [\"a\", \"b\"], [\"c\", \"d\"] =\u003e [\"a\", \"bc\", \"d\"]\n\n # Lists are concatenated, but the last and first elements are merged\n # because they are lists. Recursively, the last and first elements\n # of the inner lists are merged because they are strings.\n [\"a\", [\"b\", \"c\"]], [[\"d\"], \"e\"] =\u003e [\"a\", [\"b\", \"cd\"], \"e\"]\n\n # Non-overlapping object fields are combined.\n {\"a\": \"1\"}, {\"b\": \"2\"} =\u003e {\"a\": \"1\", \"b\": 2\"}\n\n # Overlapping object fields are merged.\n {\"a\": \"1\"}, {\"a\": \"2\"} =\u003e {\"a\": \"12\"}\n\n # Examples of merging objects containing lists of strings.\n {\"a\": [\"1\"]}, {\"a\": [\"2\"]} =\u003e {\"a\": [\"12\"]}\n\nFor a more complete example, suppose a streaming SQL query is\nyielding a result set whose rows contain a single string\nfield. The following `PartialResultSet`s might be yielded:\n\n {\n \"metadata\": { ... }\n \"values\": [\"Hello\", \"W\"]\n \"chunked_value\": true\n \"resume_token\": \"Af65...\"\n }\n {\n \"values\": [\"orl\"]\n \"chunked_value\": true\n \"resume_token\": \"Bqp2...\"\n }\n {\n \"values\": [\"d\"]\n \"resume_token\": \"Zx1B...\"\n }\n\nThis sequence of `PartialResultSet`s encodes two rows, one\ncontaining the field value `\"Hello\"`, and a second containing the\nfield value `\"World\" = \"W\" + \"orl\" + \"d\"`.",
- "type": "array",
- "items": {
- "type": "any"
- }
- },
- "resumeToken": {
- "description": "Streaming calls might be interrupted for a variety of reasons, such\nas TCP connection loss. If this occurs, the stream of results can\nbe resumed by re-sending the original request and including\n`resume_token`. Note that executing any other transaction in the\nsame session invalidates the token.",
- "format": "byte",
- "type": "string"
- },
- "stats": {
- "description": "Query plan and execution statistics for the query that produced this\nstreaming result set. These can be requested by setting\nExecuteSqlRequest.query_mode and are sent\nonly once with the last response in the stream.",
- "$ref": "ResultSetStats"
- }
- },
- "id": "PartialResultSet"
- },
- "UpdateInstanceMetadata": {
- "properties": {
- "cancelTime": {
- "description": "The time at which this operation was cancelled. If set, this operation is\nin the process of undoing itself (which is guaranteed to succeed) and\ncannot be cancelled again.",
- "format": "google-datetime",
- "type": "string"
- },
- "endTime": {
- "description": "The time at which this operation failed or was completed successfully.",
- "format": "google-datetime",
- "type": "string"
- },
- "instance": {
- "$ref": "Instance",
- "description": "The desired end state of the update."
- },
- "startTime": {
- "description": "The time at which UpdateInstance\nrequest was received.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "UpdateInstanceMetadata",
- "description": "Metadata type for the operation returned by\nUpdateInstance.",
- "type": "object"
- },
- "ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Operation"
- }
- }
- },
- "id": "ListOperationsResponse"
- },
- "ResultSetMetadata": {
- "description": "Metadata about a ResultSet or PartialResultSet.",
- "type": "object",
- "properties": {
- "transaction": {
- "description": "If the read or SQL query began a transaction as a side-effect, the\ninformation about the new transaction is yielded here.",
- "$ref": "Transaction"
- },
- "rowType": {
- "$ref": "StructType",
- "description": "Indicates the field names and types for the rows in the result\nset. For example, a SQL query like `\"SELECT UserId, UserName FROM\nUsers\"` could return a `row_type` value like:\n\n \"fields\": [\n { \"name\": \"UserId\", \"type\": { \"code\": \"INT64\" } },\n { \"name\": \"UserName\", \"type\": { \"code\": \"STRING\" } },\n ]"
- }
- },
- "id": "ResultSetMetadata"
- },
- "TransactionSelector": {
- "properties": {
- "id": {
- "description": "Execute the read or SQL query in a previously-started transaction.",
- "format": "byte",
- "type": "string"
- },
- "singleUse": {
- "description": "Execute the read or SQL query in a temporary transaction.\nThis is the most efficient way to execute a transaction that\nconsists of a single SQL query.",
- "$ref": "TransactionOptions"
- },
- "begin": {
- "$ref": "TransactionOptions",
- "description": "Begin a new transaction and execute this read or SQL query in\nit. The transaction ID of the new transaction is returned in\nResultSetMetadata.transaction, which is a Transaction."
- }
- },
- "id": "TransactionSelector",
- "description": "This message is used to select the transaction in which a\nRead or\nExecuteSql call runs.\n\nSee TransactionOptions for more information about transactions.",
- "type": "object"
- },
- "Mutation": {
- "description": "A modification to one or more Cloud Spanner rows. Mutations can be\napplied to a Cloud Spanner database by sending them in a\nCommit call.",
- "type": "object",
- "properties": {
- "delete": {
- "$ref": "Delete",
- "description": "Delete rows from a table. Succeeds whether or not the named\nrows were present."
- },
- "insert": {
- "description": "Insert new rows in a table. If any of the rows already exist,\nthe write or transaction fails with error `ALREADY_EXISTS`.",
- "$ref": "Write"
- },
- "insertOrUpdate": {
- "$ref": "Write",
- "description": "Like insert, except that if the row already exists, then\nits column values are overwritten with the ones provided. Any\ncolumn values not explicitly written are preserved."
- },
- "update": {
- "$ref": "Write",
- "description": "Update existing rows in a table. If any of the rows does not\nalready exist, the transaction fails with error `NOT_FOUND`."
- },
- "replace": {
- "$ref": "Write",
- "description": "Like insert, except that if the row already exists, it is\ndeleted, and the column values provided are inserted\ninstead. Unlike insert_or_update, this means any values not\nexplicitly written become `NULL`."
- }
- },
- "id": "Mutation"
- },
- "KeySet": {
- "properties": {
- "keys": {
- "description": "A list of specific keys. Entries in `keys` should have exactly as\nmany elements as there are columns in the primary or index key\nwith which this `KeySet` is used. Individual key values are\nencoded as described here.",
- "type": "array",
- "items": {
- "type": "array",
- "items": {
- "type": "any"
- }
- }
- },
- "all": {
- "description": "For convenience `all` can be set to `true` to indicate that this\n`KeySet` matches all keys in the table or index. Note that any keys\nspecified in `keys` or `ranges` are only yielded once.",
- "type": "boolean"
- },
- "ranges": {
- "description": "A list of key ranges. See KeyRange for more information about\nkey range specifications.",
- "type": "array",
- "items": {
- "$ref": "KeyRange"
- }
- }
- },
- "id": "KeySet",
- "description": "`KeySet` defines a collection of Cloud Spanner keys and/or key ranges. All\nthe keys are expected to be in the same table or index. The keys need\nnot be sorted in any particular way.\n\nIf the same key is specified multiple times in the set (for example\nif two ranges, two keys, or a key and a range overlap), Cloud Spanner\nbehaves as if the key were only specified once.",
- "type": "object"
- },
- "GetDatabaseDdlResponse": {
- "properties": {
- "statements": {
- "description": "A list of formatted DDL statements defining the schema of the database\nspecified in the request.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "GetDatabaseDdlResponse",
- "description": "The response for GetDatabaseDdl.",
- "type": "object"
- },
- "Database": {
- "description": "A Cloud Spanner database.",
- "type": "object",
- "properties": {
- "state": {
- "enumDescriptions": [
- "Not specified.",
- "The database is still being created. Operations on the database may fail\nwith `FAILED_PRECONDITION` in this state.",
- "The database is fully created and ready for use."
- ],
- "enum": [
- "STATE_UNSPECIFIED",
- "CREATING",
- "READY"
- ],
- "description": "Output only. The current database state.",
- "type": "string"
- },
- "name": {
- "description": "Required. The name of the database. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/databases/\u003cdatabase\u003e`,\nwhere `\u003cdatabase\u003e` is as specified in the `CREATE DATABASE`\nstatement. This name can be passed to other API methods to\nidentify the database.",
- "type": "string"
- }
- },
- "id": "Database"
- },
- "SetIamPolicyRequest": {
- "properties": {
- "policy": {
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.",
- "$ref": "Policy"
- }
- },
- "id": "SetIamPolicyRequest",
- "description": "Request message for `SetIamPolicy` method.",
- "type": "object"
- },
- "ListDatabasesResponse": {
- "properties": {
- "nextPageToken": {
- "description": "`next_page_token` can be sent in a subsequent\nListDatabases call to fetch more\nof the matching databases.",
- "type": "string"
- },
- "databases": {
- "description": "Databases that matched the request.",
- "type": "array",
- "items": {
- "$ref": "Database"
- }
- }
- },
- "id": "ListDatabasesResponse",
- "description": "The response for ListDatabases.",
- "type": "object"
- },
- "Instance": {
- "description": "An isolated set of Cloud Spanner resources on which databases can be hosted.",
- "type": "object",
- "properties": {
- "nodeCount": {
- "description": "Required. The number of nodes allocated to this instance. This may be zero\nin API responses for instances that are not yet in state `READY`.\n\nEach Spanner node can provide up to 10,000 QPS of reads or 2000 QPS of\nwrites (writing single rows at 1KB data per row), and 2 TiB storage.\n\nFor optimal performance, we recommend provisioning enough nodes to keep\noverall CPU utilization under 75%.\n\nA minimum of 3 nodes is recommended for production environments. This\nminimum is required for SLAs to apply to your instance.\n\nNote that Cloud Spanner performance is highly dependent on workload, schema\ndesign, and dataset characteristics. The performance numbers above are\nestimates, and assume [best practices](https://cloud.google.com/spanner/docs/bulk-loading)\nare followed.",
- "format": "int32",
- "type": "integer"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Cloud Labels are a flexible and lightweight mechanism for organizing cloud\nresources into groups that reflect a customer's organizational needs and\ndeployment strategies. Cloud Labels can be used to filter collections of\nresources. They can be used to control how resource metrics are aggregated.\nAnd they can be used as arguments to policy management rules (e.g. route,\nfirewall, load balancing, etc.).\n\n * Label keys must be between 1 and 63 characters long and must conform to\n the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.\n * Label values must be between 0 and 63 characters long and must conform\n to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.\n * No more than 64 labels can be associated with a given resource.\n\nSee https://goo.gl/xmQnxf for more information on and examples of labels.\n\nIf you plan to use labels in your own code, please note that additional\ncharacters may be allowed in the future. And so you are advised to use an\ninternal label representation, such as JSON, which doesn't rely upon\nspecific characters being disallowed. For example, representing labels\nas the string: name + \"_\" + value would prove problematic if we were to\nallow \"_\" in a future release.",
- "type": "object"
- },
- "config": {
- "description": "Required. The name of the instance's configuration. Values are of the form\n`projects/\u003cproject\u003e/instanceConfigs/\u003cconfiguration\u003e`. See\nalso InstanceConfig and\nListInstanceConfigs.",
- "type": "string"
- },
- "state": {
- "enumDescriptions": [
- "Not specified.",
- "The instance is still being created. Resources may not be\navailable yet, and operations such as database creation may not\nwork.",
- "The instance is fully created and ready to do work such as\ncreating databases."
- ],
- "enum": [
- "STATE_UNSPECIFIED",
- "CREATING",
- "READY"
- ],
- "description": "Output only. The current instance state. For\nCreateInstance, the state must be\neither omitted or set to `CREATING`. For\nUpdateInstance, the state must be\neither omitted or set to `READY`.",
- "type": "string"
- },
- "name": {
- "description": "Required. A unique identifier for the instance, which cannot be changed\nafter the instance is created. Values are of the form\n`projects/\u003cproject\u003e/instances/a-z*[a-z0-9]`. The final\nsegment of the name must be between 6 and 30 characters in length.",
- "type": "string"
- },
- "displayName": {
- "description": "Required. The descriptive name for this instance as it appears in UIs.\nMust be unique per project and between 4 and 30 characters in length.",
- "type": "string"
- }
- },
- "id": "Instance"
- },
- "RollbackRequest": {
- "description": "The request for Rollback.",
- "type": "object",
- "properties": {
- "transactionId": {
- "description": "Required. The transaction to roll back.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "RollbackRequest"
- },
- "Transaction": {
- "description": "A transaction.",
- "type": "object",
- "properties": {
- "id": {
- "description": "`id` may be used to identify the transaction in subsequent\nRead,\nExecuteSql,\nCommit, or\nRollback calls.\n\nSingle-use read-only transactions do not have IDs, because\nsingle-use transactions do not support multiple requests.",
- "format": "byte",
- "type": "string"
- },
- "readTimestamp": {
- "description": "For snapshot read-only transactions, the read timestamp chosen\nfor the transaction. Not returned by default: see\nTransactionOptions.ReadOnly.return_read_timestamp.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "Transaction"
- },
- "UpdateDatabaseDdlMetadata": {
- "description": "Metadata type for the operation returned by\nUpdateDatabaseDdl.",
- "type": "object",
- "properties": {
- "statements": {
- "description": "For an update this list contains all the statements. For an\nindividual statement, this list contains only that statement.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "commitTimestamps": {
- "description": "Reports the commit timestamps of all statements that have\nsucceeded so far, where `commit_timestamps[i]` is the commit\ntimestamp for the statement `statements[i]`.",
- "type": "array",
- "items": {
- "format": "google-datetime",
- "type": "string"
- }
- },
- "database": {
- "description": "The database being modified.",
- "type": "string"
- }
- },
- "id": "UpdateDatabaseDdlMetadata"
- },
- "QueryPlan": {
- "properties": {
- "planNodes": {
- "description": "The nodes in the query plan. Plan nodes are returned in pre-order starting\nwith the plan root. Each PlanNode's `id` corresponds to its index in\n`plan_nodes`.",
- "type": "array",
- "items": {
- "$ref": "PlanNode"
- }
- }
- },
- "id": "QueryPlan",
- "description": "Contains an ordered list of nodes appearing in the query plan.",
- "type": "object"
- },
- "StructType": {
- "description": "`StructType` defines the fields of a STRUCT type.",
- "type": "object",
- "properties": {
- "fields": {
- "description": "The list of fields that make up this struct. Order is\nsignificant, because values of this struct type are represented as\nlists, where the order of field values matches the order of\nfields in the StructType. In turn, the order of fields\nmatches the order of columns in a read request, or the order of\nfields in the `SELECT` clause of a query.",
- "type": "array",
- "items": {
- "$ref": "Field"
- }
- }
- },
- "id": "StructType"
- },
- "Field": {
- "description": "Message representing a single field of a struct.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The name of the field. For reads, this is the column name. For\nSQL queries, it is the column alias (e.g., `\"Word\"` in the\nquery `\"SELECT 'hello' AS Word\"`), or the column name (e.g.,\n`\"ColName\"` in the query `\"SELECT ColName FROM Table\"`). Some\ncolumns might have an empty name (e.g., !\"SELECT\nUPPER(ColName)\"`). Note that a query result can contain\nmultiple fields with the same name.",
- "type": "string"
- },
- "type": {
- "$ref": "Type",
- "description": "The type of the field."
- }
- },
- "id": "Field"
- },
- "TestIamPermissionsRequest": {
- "properties": {
- "permissions": {
- "description": "REQUIRED: The set of permissions to check for 'resource'.\nPermissions with wildcards (such as '*', 'spanner.*', 'spanner.instances.*') are not allowed.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "TestIamPermissionsRequest",
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object"
- },
- "ResultSetStats": {
- "description": "Additional statistics about a ResultSet or PartialResultSet.",
- "type": "object",
- "properties": {
- "queryPlan": {
- "description": "QueryPlan for the query associated with this result.",
- "$ref": "QueryPlan"
- },
- "queryStats": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "Aggregated statistics from the execution of the query. Only present when\nthe query is profiled. For example, a query could return the statistics as\nfollows:\n\n {\n \"rows_returned\": \"3\",\n \"elapsed_time\": \"1.22 secs\",\n \"cpu_time\": \"1.19 secs\"\n }",
- "type": "object"
- }
- },
- "id": "ResultSetStats"
- },
- "CommitResponse": {
- "description": "The response for Commit.",
- "type": "object",
- "properties": {
- "commitTimestamp": {
- "description": "The Cloud Spanner timestamp at which the transaction committed.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "CommitResponse"
- },
- "Type": {
- "properties": {
- "structType": {
- "description": "If code == STRUCT, then `struct_type`\nprovides type information for the struct's fields.",
- "$ref": "StructType"
- },
- "arrayElementType": {
- "$ref": "Type",
- "description": "If code == ARRAY, then `array_element_type`\nis the type of the array elements."
- },
- "code": {
- "enumDescriptions": [
- "Not specified.",
- "Encoded as JSON `true` or `false`.",
- "Encoded as `string`, in decimal format.",
- "Encoded as `number`, or the strings `\"NaN\"`, `\"Infinity\"`, or\n`\"-Infinity\"`.",
- "Encoded as `string` in RFC 3339 timestamp format. The time zone\nmust be present, and must be `\"Z\"`.",
- "Encoded as `string` in RFC 3339 date format.",
- "Encoded as `string`.",
- "Encoded as a base64-encoded `string`, as described in RFC 4648,\nsection 4.",
- "Encoded as `list`, where the list elements are represented\naccording to array_element_type.",
- "Encoded as `list`, where list element `i` is represented according\nto [struct_type.fields[i]][google.spanner.v1.StructType.fields]."
- ],
- "enum": [
- "TYPE_CODE_UNSPECIFIED",
- "BOOL",
- "INT64",
- "FLOAT64",
- "TIMESTAMP",
- "DATE",
- "STRING",
- "BYTES",
- "ARRAY",
- "STRUCT"
- ],
- "description": "Required. The TypeCode for this type.",
- "type": "string"
- }
- },
- "id": "Type",
- "description": "`Type` indicates the type of a Cloud Spanner value, as might be stored in a\ntable cell or returned from an SQL query.",
- "type": "object"
- },
- "PlanNode": {
- "description": "Node information for nodes appearing in a QueryPlan.plan_nodes.",
- "type": "object",
- "properties": {
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "Attributes relevant to the node contained in a group of key-value pairs.\nFor example, a Parameter Reference node could have the following\ninformation in its metadata:\n\n {\n \"parameter_reference\": \"param1\",\n \"parameter_type\": \"array\"\n }",
- "type": "object"
- },
- "executionStats": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "The execution statistics associated with the node, contained in a group of\nkey-value pairs. Only present if the plan was returned as a result of a\nprofile query. For example, number of executions, number of rows/time per\nexecution etc.",
- "type": "object"
- },
- "shortRepresentation": {
- "description": "Condensed representation for SCALAR nodes.",
- "$ref": "ShortRepresentation"
- },
- "index": {
- "description": "The `PlanNode`'s index in node list.",
- "format": "int32",
- "type": "integer"
- },
- "kind": {
- "enumDescriptions": [
- "Not specified.",
- "Denotes a Relational operator node in the expression tree. Relational\noperators represent iterative processing of rows during query execution.\nFor example, a `TableScan` operation that reads rows from a table.",
- "Denotes a Scalar node in the expression tree. Scalar nodes represent\nnon-iterable entities in the query plan. For example, constants or\narithmetic operators appearing inside predicate expressions or references\nto column names."
- ],
- "enum": [
- "KIND_UNSPECIFIED",
- "RELATIONAL",
- "SCALAR"
- ],
- "description": "Used to determine the type of node. May be needed for visualizing\ndifferent kinds of nodes differently. For example, If the node is a\nSCALAR node, it will have a condensed representation\nwhich can be used to directly embed a description of the node in its\nparent.",
- "type": "string"
- },
- "displayName": {
- "description": "The display name for the node.",
- "type": "string"
- },
- "childLinks": {
- "description": "List of child node `index`es and their relationship to this parent.",
- "type": "array",
- "items": {
- "$ref": "ChildLink"
- }
- }
- },
- "id": "PlanNode"
- },
- "CreateInstanceMetadata": {
- "properties": {
- "instance": {
- "description": "The instance being created.",
- "$ref": "Instance"
- },
- "startTime": {
- "description": "The time at which the\nCreateInstance request was\nreceived.",
- "format": "google-datetime",
- "type": "string"
- },
- "cancelTime": {
- "description": "The time at which this operation was cancelled. If set, this operation is\nin the process of undoing itself (which is guaranteed to succeed) and\ncannot be cancelled again.",
- "format": "google-datetime",
- "type": "string"
- },
- "endTime": {
- "description": "The time at which this operation failed or was completed successfully.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "CreateInstanceMetadata",
- "description": "Metadata type for the operation returned by\nCreateInstance.",
- "type": "object"
- },
- "ChildLink": {
- "properties": {
- "type": {
- "description": "The type of the link. For example, in Hash Joins this could be used to\ndistinguish between the build child and the probe child, or in the case\nof the child being an output variable, to represent the tag associated\nwith the output variable.",
- "type": "string"
- },
- "childIndex": {
- "description": "The node to which the link points.",
- "format": "int32",
- "type": "integer"
- },
- "variable": {
- "description": "Only present if the child node is SCALAR and corresponds\nto an output variable of the parent node. The field carries the name of\nthe output variable.\nFor example, a `TableScan` operator that reads rows from a table will\nhave child links to the `SCALAR` nodes representing the output variables\ncreated for each column that is read by the operator. The corresponding\n`variable` fields will be set to the variable names assigned to the\ncolumns.",
- "type": "string"
- }
- },
- "id": "ChildLink",
- "description": "Metadata associated with a parent-child relationship appearing in a\nPlanNode.",
- "type": "object"
- },
- "Delete": {
- "description": "Arguments to delete operations.",
- "type": "object",
- "properties": {
- "keySet": {
- "description": "Required. The primary keys of the rows within table to delete.",
- "$ref": "KeySet"
- },
- "table": {
- "description": "Required. The table whose rows will be deleted.",
- "type": "string"
- }
- },
- "id": "Delete"
- },
- "ListInstanceConfigsResponse": {
- "properties": {
- "nextPageToken": {
- "description": "`next_page_token` can be sent in a subsequent\nListInstanceConfigs call to\nfetch more of the matching instance configurations.",
- "type": "string"
- },
- "instanceConfigs": {
- "description": "The list of requested instance configurations.",
- "type": "array",
- "items": {
- "$ref": "InstanceConfig"
- }
- }
- },
- "id": "ListInstanceConfigsResponse",
- "description": "The response for ListInstanceConfigs.",
- "type": "object"
- },
- "BeginTransactionRequest": {
- "description": "The request for BeginTransaction.",
- "type": "object",
- "properties": {
- "options": {
- "description": "Required. Options for the new transaction.",
- "$ref": "TransactionOptions"
- }
- },
- "id": "BeginTransactionRequest"
- },
- "CommitRequest": {
- "description": "The request for Commit.",
- "type": "object",
- "properties": {
- "singleUseTransaction": {
- "$ref": "TransactionOptions",
- "description": "Execute mutations in a temporary transaction. Note that unlike\ncommit of a previously-started transaction, commit with a\ntemporary transaction is non-idempotent. That is, if the\n`CommitRequest` is sent to Cloud Spanner more than once (for\ninstance, due to retries in the application, or in the\ntransport library), it is possible that the mutations are\nexecuted more than once. If this is undesirable, use\nBeginTransaction and\nCommit instead."
- },
- "mutations": {
- "description": "The mutations to be executed when this transaction commits. All\nmutations are applied atomically, in the order they appear in\nthis list.",
- "type": "array",
- "items": {
- "$ref": "Mutation"
- }
- },
- "transactionId": {
- "description": "Commit a previously-started transaction.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "CommitRequest"
+ "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"
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
},
+ "protocol": "rest",
"canonicalName": "Spanner",
"auth": {
"oauth2": {
"scopes": {
+ "https://www.googleapis.com/auth/spanner.data": {
+ "description": "View and manage the contents of your Spanner databases"
+ },
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
},
"https://www.googleapis.com/auth/spanner.admin": {
"description": "Administer your Spanner databases"
- },
- "https://www.googleapis.com/auth/spanner.data": {
- "description": "View and manage the contents of your Spanner databases"
}
}
}
@@ -1224,150 +1224,76 @@
"resources": {
"projects": {
"resources": {
- "instances": {
+ "instanceConfigs": {
"methods": {
- "getIamPolicy": {
- "description": "Gets the access control policy for an instance resource. Returns an empty\npolicy if an instance exists but does not have a policy set.\n\nAuthorization requires `spanner.instances.getIamPolicy` on\nresource.",
- "request": {
- "$ref": "GetIamPolicyRequest"
- },
+ "list": {
+ "description": "Lists the supported instance configurations for a given project.",
"response": {
- "$ref": "Policy"
+ "$ref": "ListInstanceConfigsResponse"
},
"parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for database resources.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "id": "spanner.projects.instances.getIamPolicy"
- },
- "patch": {
- "request": {
- "$ref": "UpdateInstanceRequest"
- },
- "description": "Updates an instance, and begins allocating or releasing resources\nas requested. The returned long-running\noperation can be used to track the\nprogress of updating the instance. If the named instance does not\nexist, returns `NOT_FOUND`.\n\nImmediately upon completion of this request:\n\n * For resource types for which a decrease in the instance's allocation\n has been requested, billing is based on the newly-requested level.\n\nUntil completion of the returned operation:\n\n * Cancelling the operation sets its metadata's\n cancel_time, and begins\n restoring resources to their pre-request values. The operation\n is guaranteed to succeed at undoing all resource changes,\n after which point it terminates with a `CANCELLED` status.\n * All other attempts to modify the instance are rejected.\n * Reading the instance via the API continues to give the pre-request\n resource levels.\n\nUpon completion of the returned operation:\n\n * Billing begins for all successfully-allocated resources (some types\n may have lower than the requested levels).\n * All newly-reserved resources are available for serving the instance's\n tables.\n * The instance's new resource levels are readable via the API.\n\nThe returned long-running operation will\nhave a name of the format `\u003cinstance_name\u003e/operations/\u003coperation_id\u003e` and\ncan be used to track the instance modification. The\nmetadata field type is\nUpdateInstanceMetadata.\nThe response field type is\nInstance, if successful.\n\nAuthorization requires `spanner.instances.update` permission on\nresource name.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/instances/[^/]+$",
- "location": "path",
- "description": "Required. A unique identifier for the instance, which cannot be changed\nafter the instance is created. Values are of the form\n`projects/\u003cproject\u003e/instances/a-z*[a-z0-9]`. The final\nsegment of the name must be between 6 and 30 characters in length.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}",
- "path": "v1/{+name}",
- "id": "spanner.projects.instances.patch"
- },
- "get": {
- "description": "Gets information about a particular instance.",
- "response": {
- "$ref": "Instance"
- },
- "parameterOrder": [
- "name"
+ "parent"
],
"httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "Required. The name of the requested instance. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+$",
- "location": "path"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/spanner.admin"
],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}",
- "path": "v1/{+name}",
- "id": "spanner.projects.instances.get"
- },
- "testIamPermissions": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
"parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/instances/[^/]+$",
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "If non-empty, `page_token` should contain a\nnext_page_token\nfrom a previous ListInstanceConfigsResponse."
+ },
+ "pageSize": {
+ "description": "Number of instance configurations to be returned in the response. If 0 or\nless, defaults to the server's maximum allowed page size.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "pattern": "^projects/[^/]+$",
"location": "path",
- "description": "REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for database resources.",
+ "description": "Required. The name of the project for which a list of supported instance\nconfigurations is requested. Values are of the form\n`projects/\u003cproject\u003e`.",
"required": true,
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:testIamPermissions",
- "id": "spanner.projects.instances.testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that the caller has on the specified instance resource.\n\nAttempting this RPC on a non-existent Cloud Spanner instance resource will\nresult in a NOT_FOUND error if the user has `spanner.instances.list`\npermission on the containing Google Cloud Project. Otherwise returns an\nempty set of permissions."
+ "flatPath": "v1/projects/{projectsId}/instanceConfigs",
+ "path": "v1/{+parent}/instanceConfigs",
+ "id": "spanner.projects.instanceConfigs.list"
},
- "delete": {
- "description": "Deletes an instance.\n\nImmediately upon completion of the request:\n\n * Billing ceases for all of the instance's reserved resources.\n\nSoon afterward:\n\n * The instance and *all of its databases* immediately and\n irrevocably disappear from the API. All data in the databases\n is permanently deleted.",
- "response": {
- "$ref": "Empty"
- },
+ "get": {
+ "description": "Gets information about a particular instance configuration.",
+ "httpMethod": "GET",
"parameterOrder": [
"name"
],
- "httpMethod": "DELETE",
+ "response": {
+ "$ref": "InstanceConfig"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/spanner.admin"
],
"parameters": {
"name": {
- "description": "Required. The name of the instance to be deleted. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e`",
+ "description": "Required. The name of the requested instance configuration. Values are of\nthe form `projects/\u003cproject\u003e/instanceConfigs/\u003cconfig\u003e`.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+$",
+ "pattern": "^projects/[^/]+/instanceConfigs/[^/]+$",
"location": "path"
}
},
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}",
- "path": "v1/{+name}",
- "id": "spanner.projects.instances.delete"
- },
+ "flatPath": "v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}",
+ "id": "spanner.projects.instanceConfigs.get",
+ "path": "v1/{+name}"
+ }
+ }
+ },
+ "instances": {
+ "methods": {
"list": {
- "path": "v1/{+parent}/instances",
- "id": "spanner.projects.instances.list",
"description": "Lists all instances in the given project.",
"response": {
"$ref": "ListInstancesResponse"
@@ -1376,80 +1302,80 @@
"parent"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
"parameters": {
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "If non-empty, `page_token` should contain a\nnext_page_token from a\nprevious ListInstancesResponse."
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "description": "Number of instances to be returned in the response. If 0 or less, defaults\nto the server's maximum allowed page size.",
+ "format": "int32"
+ },
"parent": {
+ "location": "path",
"description": "Required. The name of the project for which a list of instances is\nrequested. Values are of the form `projects/\u003cproject\u003e`.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+$"
},
"filter": {
"description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n * name\n * display_name\n * labels.key where key is the name of a label\n\nSome examples of using filters are:\n\n * name:* --\u003e The instance has a name.\n * name:Howl --\u003e The instance's name contains the string \"howl\".\n * name:HOWL --\u003e Equivalent to above.\n * NAME:howl --\u003e Equivalent to above.\n * labels.env:* --\u003e The instance has the label \"env\".\n * labels.env:dev --\u003e The instance has the label \"env\" and the value of\n the label contains the string \"dev\".\n * name:howl labels.env:dev --\u003e The instance's name contains \"howl\" and\n it has the label \"env\" with its value\n containing \"dev\".",
"type": "string",
"location": "query"
- },
- "pageToken": {
- "location": "query",
- "description": "If non-empty, `page_token` should contain a\nnext_page_token from a\nprevious ListInstancesResponse.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Number of instances to be returned in the response. If 0 or less, defaults\nto the server's maximum allowed page size.",
- "format": "int32",
- "type": "integer"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances"
- },
- "setIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for databases resources.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+$",
- "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/spanner.admin"
],
+ "flatPath": "v1/projects/{projectsId}/instances",
+ "path": "v1/{+parent}/instances",
+ "id": "spanner.projects.instances.list"
+ },
+ "setIamPolicy": {
"flatPath": "v1/projects/{projectsId}/instances/{instancesId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
"id": "spanner.projects.instances.setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "description": "Sets the access control policy on an instance resource. Replaces any\nexisting policy.\n\nAuthorization requires `spanner.instances.setIamPolicy` on\nresource.",
"request": {
"$ref": "SetIamPolicyRequest"
},
- "description": "Sets the access control policy on an instance resource. Replaces any\nexisting policy.\n\nAuthorization requires `spanner.instances.setIamPolicy` on\nresource."
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "parameters": {
+ "resource": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for databases resources."
+ }
+ }
},
"create": {
- "path": "v1/{+parent}/instances",
- "id": "spanner.projects.instances.create",
"description": "Creates an instance and begins preparing it to begin serving. The\nreturned long-running operation\ncan be used to track the progress of preparing the new\ninstance. The instance name is assigned by the caller. If the\nnamed instance already exists, `CreateInstance` returns\n`ALREADY_EXISTS`.\n\nImmediately upon completion of this request:\n\n * The instance is readable via the API, with all requested attributes\n but no allocated resources. Its state is `CREATING`.\n\nUntil completion of the returned operation:\n\n * Cancelling the operation renders the instance immediately unreadable\n via the API.\n * The instance can be deleted.\n * All other attempts to modify the instance are rejected.\n\nUpon completion of the returned operation:\n\n * Billing for all successfully-allocated resources begins (some types\n may have lower than the requested levels).\n * Databases can be created in the instance.\n * The instance's allocated resource levels are readable via the API.\n * The instance's state becomes `READY`.\n\nThe returned long-running operation will\nhave a name of the format `\u003cinstance_name\u003e/operations/\u003coperation_id\u003e` and\ncan be used to track creation of the instance. The\nmetadata field type is\nCreateInstanceMetadata.\nThe response field type is\nInstance, if successful.",
"request": {
"$ref": "CreateInstanceRequest"
},
- "response": {
- "$ref": "Operation"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"parent"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/spanner.admin"
@@ -1463,620 +1389,220 @@
"location": "path"
}
},
- "flatPath": "v1/projects/{projectsId}/instances"
+ "flatPath": "v1/projects/{projectsId}/instances",
+ "id": "spanner.projects.instances.create",
+ "path": "v1/{+parent}/instances"
+ },
+ "getIamPolicy": {
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "id": "spanner.projects.instances.getIamPolicy",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ },
+ "description": "Gets the access control policy for an instance resource. Returns an empty\npolicy if an instance exists but does not have a policy set.\n\nAuthorization requires `spanner.instances.getIamPolicy` on\nresource.",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for database resources.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ]
+ },
+ "patch": {
+ "description": "Updates an instance, and begins allocating or releasing resources\nas requested. The returned long-running\noperation can be used to track the\nprogress of updating the instance. If the named instance does not\nexist, returns `NOT_FOUND`.\n\nImmediately upon completion of this request:\n\n * For resource types for which a decrease in the instance's allocation\n has been requested, billing is based on the newly-requested level.\n\nUntil completion of the returned operation:\n\n * Cancelling the operation sets its metadata's\n cancel_time, and begins\n restoring resources to their pre-request values. The operation\n is guaranteed to succeed at undoing all resource changes,\n after which point it terminates with a `CANCELLED` status.\n * All other attempts to modify the instance are rejected.\n * Reading the instance via the API continues to give the pre-request\n resource levels.\n\nUpon completion of the returned operation:\n\n * Billing begins for all successfully-allocated resources (some types\n may have lower than the requested levels).\n * All newly-reserved resources are available for serving the instance's\n tables.\n * The instance's new resource levels are readable via the API.\n\nThe returned long-running operation will\nhave a name of the format `\u003cinstance_name\u003e/operations/\u003coperation_id\u003e` and\ncan be used to track the instance modification. The\nmetadata field type is\nUpdateInstanceMetadata.\nThe response field type is\nInstance, if successful.\n\nAuthorization requires `spanner.instances.update` permission on\nresource name.",
+ "request": {
+ "$ref": "UpdateInstanceRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Required. A unique identifier for the instance, which cannot be changed\nafter the instance is created. Values are of the form\n`projects/\u003cproject\u003e/instances/a-z*[a-z0-9]`. The final\nsegment of the name must be between 6 and 30 characters in length.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}",
+ "path": "v1/{+name}",
+ "id": "spanner.projects.instances.patch"
+ },
+ "get": {
+ "response": {
+ "$ref": "Instance"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the requested instance. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}",
+ "path": "v1/{+name}",
+ "id": "spanner.projects.instances.get",
+ "description": "Gets information about a particular instance."
+ },
+ "testIamPermissions": {
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that the caller has on the specified instance resource.\n\nAttempting this RPC on a non-existent Cloud Spanner instance resource will\nresult in a NOT_FOUND error if the user has `spanner.instances.list`\npermission on the containing Google Cloud Project. Otherwise returns an\nempty set of permissions.",
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for database resources.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "spanner.projects.instances.testIamPermissions"
+ },
+ "delete": {
+ "description": "Deletes an instance.\n\nImmediately upon completion of the request:\n\n * Billing ceases for all of the instance's reserved resources.\n\nSoon afterward:\n\n * The instance and *all of its databases* immediately and\n irrevocably disappear from the API. All data in the databases\n is permanently deleted.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Required. The name of the instance to be deleted. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}",
+ "id": "spanner.projects.instances.delete",
+ "path": "v1/{+name}"
}
},
"resources": {
"databases": {
- "resources": {
- "operations": {
- "methods": {
- "cancel": {
- "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$",
- "location": "path",
- "description": "The name of the operation resource to be cancelled.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}:cancel",
- "path": "v1/{+name}:cancel",
- "id": "spanner.projects.instances.databases.operations.cancel"
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$",
- "location": "path",
- "description": "The name of the operation resource to be deleted.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}",
- "path": "v1/{+name}",
- "id": "spanner.projects.instances.databases.operations.delete",
- "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`."
- },
- "list": {
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/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": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations",
- "path": "v1/{+name}",
- "id": "spanner.projects.instances.databases.operations.list"
- },
- "get": {
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "parameters": {
- "name": {
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}",
- "path": "v1/{+name}",
- "id": "spanner.projects.instances.databases.operations.get"
- }
- }
- },
- "sessions": {
- "methods": {
- "commit": {
- "httpMethod": "POST",
- "parameterOrder": [
- "session"
- ],
- "response": {
- "$ref": "CommitResponse"
- },
- "parameters": {
- "session": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
- "location": "path",
- "description": "Required. The session in which the transaction to be committed is running.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.data"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:commit",
- "id": "spanner.projects.instances.databases.sessions.commit",
- "path": "v1/{+session}:commit",
- "request": {
- "$ref": "CommitRequest"
- },
- "description": "Commits a transaction. The request includes the mutations to be\napplied to rows in the database.\n\n`Commit` might return an `ABORTED` error. This can occur at any time;\ncommonly, the cause is conflicts with concurrent\ntransactions. However, it can also happen for a variety of other\nreasons. If `Commit` returns `ABORTED`, the caller should re-attempt\nthe transaction from the beginning, re-using the same session."
- },
- "beginTransaction": {
- "response": {
- "$ref": "Transaction"
- },
- "parameterOrder": [
- "session"
- ],
- "httpMethod": "POST",
- "parameters": {
- "session": {
- "description": "Required. The session in which the transaction runs.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.data"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:beginTransaction",
- "path": "v1/{+session}:beginTransaction",
- "id": "spanner.projects.instances.databases.sessions.beginTransaction",
- "request": {
- "$ref": "BeginTransactionRequest"
- },
- "description": "Begins a new transaction. This step can often be skipped:\nRead, ExecuteSql and\nCommit can begin a new transaction as a\nside-effect."
- },
- "executeStreamingSql": {
- "description": "Like ExecuteSql, except returns the result\nset as a stream. Unlike ExecuteSql, there\nis no limit on the size of the returned result set. However, no\nindividual row in the result set can exceed 100 MiB, and no\ncolumn value can exceed 10 MiB.",
- "request": {
- "$ref": "ExecuteSqlRequest"
- },
- "response": {
- "$ref": "PartialResultSet"
- },
- "parameterOrder": [
- "session"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.data"
- ],
- "parameters": {
- "session": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
- "location": "path",
- "description": "Required. The session in which the SQL query should be performed.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeStreamingSql",
- "path": "v1/{+session}:executeStreamingSql",
- "id": "spanner.projects.instances.databases.sessions.executeStreamingSql"
- },
- "delete": {
- "description": "Ends a session, releasing server resources associated with it.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
- "location": "path",
- "description": "Required. The name of the session to delete.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.data"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}",
- "id": "spanner.projects.instances.databases.sessions.delete",
- "path": "v1/{+name}"
- },
- "executeSql": {
- "path": "v1/{+session}:executeSql",
- "id": "spanner.projects.instances.databases.sessions.executeSql",
- "request": {
- "$ref": "ExecuteSqlRequest"
- },
- "description": "Executes an SQL query, returning all rows in a single reply. This\nmethod cannot be used to return a result set larger than 10 MiB;\nif the query yields more data than that, the query fails with\na `FAILED_PRECONDITION` error.\n\nQueries inside read-write transactions might return `ABORTED`. If\nthis occurs, the application should restart the transaction from\nthe beginning. See Transaction for more details.\n\nLarger result sets can be fetched in streaming fashion by calling\nExecuteStreamingSql instead.",
- "response": {
- "$ref": "ResultSet"
- },
- "parameterOrder": [
- "session"
- ],
- "httpMethod": "POST",
- "parameters": {
- "session": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
- "location": "path",
- "description": "Required. The session in which the SQL query should be performed.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.data"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeSql"
- },
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListSessionsResponse"
- },
- "parameterOrder": [
- "database"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "If non-empty, `page_token` should contain a\nnext_page_token from a previous\nListSessionsResponse.",
- "type": "string"
- },
- "pageSize": {
- "description": "Number of sessions to be returned in the response. If 0 or less, defaults\nto the server's maximum allowed page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "database": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
- "location": "path",
- "description": "Required. The database in which to list sessions.",
- "required": true,
- "type": "string"
- },
- "filter": {
- "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n * labels.key where key is the name of a label\n\nSome examples of using filters are:\n\n * labels.env:* --\u003e The session has the label \"env\".\n * labels.env:dev --\u003e The session has the label \"env\" and the value of\n the label contains the string \"dev\".",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.data"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions",
- "id": "spanner.projects.instances.databases.sessions.list",
- "path": "v1/{+database}/sessions",
- "description": "Lists all sessions in a given database."
- },
- "streamingRead": {
- "request": {
- "$ref": "ReadRequest"
- },
- "description": "Like Read, except returns the result set as a\nstream. Unlike Read, there is no limit on the\nsize of the returned result set. However, no individual row in\nthe result set can exceed 100 MiB, and no column value can exceed\n10 MiB.",
- "response": {
- "$ref": "PartialResultSet"
- },
- "parameterOrder": [
- "session"
- ],
- "httpMethod": "POST",
- "parameters": {
- "session": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
- "location": "path",
- "description": "Required. The session in which the read should be performed.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.data"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:streamingRead",
- "path": "v1/{+session}:streamingRead",
- "id": "spanner.projects.instances.databases.sessions.streamingRead"
- },
- "rollback": {
- "path": "v1/{+session}:rollback",
- "id": "spanner.projects.instances.databases.sessions.rollback",
- "description": "Rolls back a transaction, releasing any locks it holds. It is a good\nidea to call this for any transaction that includes one or more\nRead or ExecuteSql requests and\nultimately decides not to commit.\n\n`Rollback` returns `OK` if it successfully aborts the transaction, the\ntransaction was already aborted, or the transaction is not\nfound. `Rollback` never returns `ABORTED`.",
- "request": {
- "$ref": "RollbackRequest"
- },
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "session"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.data"
- ],
- "parameters": {
- "session": {
- "description": "Required. The session in which the transaction to roll back is running.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:rollback"
- },
- "create": {
- "response": {
- "$ref": "Session"
- },
- "parameterOrder": [
- "database"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.data"
- ],
- "parameters": {
- "database": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
- "location": "path",
- "description": "Required. The database in which the new session is created.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions",
- "path": "v1/{+database}/sessions",
- "id": "spanner.projects.instances.databases.sessions.create",
- "description": "Creates a new session. A session can be used to perform\ntransactions that read and/or modify data in a Cloud Spanner database.\nSessions are meant to be reused for many consecutive\ntransactions.\n\nSessions can only execute one transaction at a time. To execute\nmultiple concurrent read-write/write-only transactions, create\nmultiple sessions. Note that standalone reads and queries use a\ntransaction internally, and count toward the one transaction\nlimit.\n\nCloud Spanner limits the number of sessions that can exist at any given\ntime; thus, it is a good idea to delete idle and/or unneeded sessions.\nAside from explicit deletes, Cloud Spanner can delete sessions for which no\noperations are sent for more than an hour. If a session is deleted,\nrequests to it return `NOT_FOUND`.\n\nIdle sessions can be kept alive by sending a trivial SQL query\nperiodically, e.g., `\"SELECT 1\"`.",
- "request": {
- "$ref": "CreateSessionRequest"
- }
- },
- "read": {
- "path": "v1/{+session}:read",
- "id": "spanner.projects.instances.databases.sessions.read",
- "description": "Reads rows from the database using key lookups and scans, as a\nsimple key/value style alternative to\nExecuteSql. This method cannot be used to\nreturn a result set larger than 10 MiB; if the read matches more\ndata than that, the read fails with a `FAILED_PRECONDITION`\nerror.\n\nReads inside read-write transactions might return `ABORTED`. If\nthis occurs, the application should restart the transaction from\nthe beginning. See Transaction for more details.\n\nLarger result sets can be yielded in streaming fashion by calling\nStreamingRead instead.",
- "request": {
- "$ref": "ReadRequest"
- },
- "response": {
- "$ref": "ResultSet"
- },
- "parameterOrder": [
- "session"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.data"
- ],
- "parameters": {
- "session": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
- "location": "path",
- "description": "Required. The session in which the read should be performed.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:read"
- },
- "get": {
- "response": {
- "$ref": "Session"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.data"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
- "location": "path",
- "description": "Required. The name of the session to retrieve.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}",
- "path": "v1/{+name}",
- "id": "spanner.projects.instances.databases.sessions.get",
- "description": "Gets a session. Returns `NOT_FOUND` if the session does not exist.\nThis is mainly useful for determining whether a session is still\nalive."
- }
- }
- }
- },
"methods": {
- "dropDatabase": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "database"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "database": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
- "location": "path",
- "description": "Required. The database to be dropped.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}",
- "path": "v1/{+database}",
- "id": "spanner.projects.instances.databases.dropDatabase",
- "description": "Drops (aka deletes) a Cloud Spanner database."
- },
- "updateDdl": {
- "description": "Updates the schema of a Cloud Spanner database by\ncreating/altering/dropping tables, columns, indexes, etc. The returned\nlong-running operation will have a name of\nthe format `\u003cdatabase_name\u003e/operations/\u003coperation_id\u003e` and can be used to\ntrack execution of the schema change(s). The\nmetadata field type is\nUpdateDatabaseDdlMetadata. The operation has no response.",
- "request": {
- "$ref": "UpdateDatabaseDdlRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "database"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "parameters": {
- "database": {
- "description": "Required. The database to update.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/ddl",
- "path": "v1/{+database}/ddl",
- "id": "spanner.projects.instances.databases.updateDdl"
- },
- "testIamPermissions": {
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for database resources.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "id": "spanner.projects.instances.databases.testIamPermissions",
- "description": "Returns permissions that the caller has on the specified database resource.\n\nAttempting this RPC on a non-existent Cloud Spanner database will result in\na NOT_FOUND error if the user has `spanner.databases.list` permission on\nthe containing Cloud Spanner instance. Otherwise returns an empty set of\npermissions.",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- }
- },
- "getDdl": {
- "response": {
- "$ref": "GetDatabaseDdlResponse"
- },
- "parameterOrder": [
- "database"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "parameters": {
- "database": {
- "description": "Required. The database whose schema we wish to get.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/ddl",
- "path": "v1/{+database}/ddl",
- "id": "spanner.projects.instances.databases.getDdl",
- "description": "Returns the schema of a Cloud Spanner database as a list of formatted\nDDL statements. This method does not show pending schema updates, those may\nbe queried using the Operations API."
- },
"list": {
- "path": "v1/{+parent}/databases",
- "id": "spanner.projects.instances.databases.list",
- "description": "Lists Cloud Spanner databases.",
- "response": {
- "$ref": "ListDatabasesResponse"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"parent"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
+ "response": {
+ "$ref": "ListDatabasesResponse"
+ },
"parameters": {
+ "parent": {
+ "description": "Required. The instance whose databases should be listed.\nValues are of the form `projects/\u003cproject\u003e/instances/\u003cinstance\u003e`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+$",
+ "location": "path"
+ },
"pageToken": {
- "location": "query",
"description": "If non-empty, `page_token` should contain a\nnext_page_token from a\nprevious ListDatabasesResponse.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageSize": {
"location": "query",
"description": "Number of databases to be returned in the response. If 0 or less,\ndefaults to the server's maximum allowed page size.",
"format": "int32",
"type": "integer"
- },
- "parent": {
- "pattern": "^projects/[^/]+/instances/[^/]+$",
- "location": "path",
- "description": "Required. The instance whose databases should be listed.\nValues are of the form `projects/\u003cproject\u003e/instances/\u003cinstance\u003e`.",
- "required": true,
- "type": "string"
}
},
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases",
+ "id": "spanner.projects.instances.databases.list",
+ "path": "v1/{+parent}/databases",
+ "description": "Lists Cloud Spanner databases."
+ },
+ "setIamPolicy": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for databases resources.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:setIamPolicy",
+ "id": "spanner.projects.instances.databases.setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on a database resource. Replaces any\nexisting policy.\n\nAuthorization requires `spanner.databases.setIamPolicy` permission on\nresource."
},
"create": {
- "request": {
- "$ref": "CreateDatabaseRequest"
- },
- "description": "Creates a new Cloud Spanner database and starts to prepare it for serving.\nThe returned long-running operation will\nhave a name of the format `\u003cdatabase_name\u003e/operations/\u003coperation_id\u003e` and\ncan be used to track preparation of the database. The\nmetadata field type is\nCreateDatabaseMetadata. The\nresponse field type is\nDatabase, if successful.",
"response": {
"$ref": "Operation"
},
@@ -2084,6 +1610,10 @@
"parent"
],
"httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
"parameters": {
"parent": {
"description": "Required. The name of the instance that will serve the new database.\nValues are of the form `projects/\u003cproject\u003e/instances/\u003cinstance\u003e`.",
@@ -2093,44 +1623,19 @@
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases",
"path": "v1/{+parent}/databases",
- "id": "spanner.projects.instances.databases.create"
- },
- "setIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for databases resources.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "id": "spanner.projects.instances.databases.setIamPolicy",
+ "id": "spanner.projects.instances.databases.create",
+ "description": "Creates a new Cloud Spanner database and starts to prepare it for serving.\nThe returned long-running operation will\nhave a name of the format `\u003cdatabase_name\u003e/operations/\u003coperation_id\u003e` and\ncan be used to track preparation of the database. The\nmetadata field type is\nCreateDatabaseMetadata. The\nresponse field type is\nDatabase, if successful.",
"request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on a database resource. Replaces any\nexisting policy.\n\nAuthorization requires `spanner.databases.setIamPolicy` permission on\nresource."
+ "$ref": "CreateDatabaseRequest"
+ }
},
"getIamPolicy": {
+ "description": "Gets the access control policy for a database resource. Returns an empty\npolicy if a database exists but does not have a policy set.\n\nAuthorization requires `spanner.databases.getIamPolicy` permission on\nresource.",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ },
"response": {
"$ref": "Policy"
},
@@ -2144,25 +1649,18 @@
],
"parameters": {
"resource": {
+ "location": "path",
"description": "REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for database resources.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$"
}
},
"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:getIamPolicy",
"path": "v1/{+resource}:getIamPolicy",
- "id": "spanner.projects.instances.databases.getIamPolicy",
- "description": "Gets the access control policy for a database resource. Returns an empty\npolicy if a database exists but does not have a policy set.\n\nAuthorization requires `spanner.databases.getIamPolicy` permission on\nresource.",
- "request": {
- "$ref": "GetIamPolicyRequest"
- }
+ "id": "spanner.projects.instances.databases.getIamPolicy"
},
"get": {
- "path": "v1/{+name}",
- "id": "spanner.projects.instances.databases.get",
- "description": "Gets the state of a Cloud Spanner database.",
"response": {
"$ref": "Database"
},
@@ -2183,65 +1681,583 @@
"location": "path"
}
},
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}"
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}",
+ "path": "v1/{+name}",
+ "id": "spanner.projects.instances.databases.get",
+ "description": "Gets the state of a Cloud Spanner database."
+ },
+ "dropDatabase": {
+ "description": "Drops (aka deletes) a Cloud Spanner database.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "database"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "database": {
+ "description": "Required. The database to be dropped.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}",
+ "path": "v1/{+database}",
+ "id": "spanner.projects.instances.databases.dropDatabase"
+ },
+ "updateDdl": {
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/ddl",
+ "path": "v1/{+database}/ddl",
+ "id": "spanner.projects.instances.databases.updateDdl",
+ "request": {
+ "$ref": "UpdateDatabaseDdlRequest"
+ },
+ "description": "Updates the schema of a Cloud Spanner database by\ncreating/altering/dropping tables, columns, indexes, etc. The returned\nlong-running operation will have a name of\nthe format `\u003cdatabase_name\u003e/operations/\u003coperation_id\u003e` and can be used to\ntrack execution of the schema change(s). The\nmetadata field type is\nUpdateDatabaseDdlMetadata. The operation has no response.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "database"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "database": {
+ "description": "Required. The database to update.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ]
+ },
+ "testIamPermissions": {
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that the caller has on the specified database resource.\n\nAttempting this RPC on a non-existent Cloud Spanner database will result in\na NOT_FOUND error if the user has `spanner.databases.list` permission on\nthe containing Cloud Spanner instance. Otherwise returns an empty set of\npermissions.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for database resources.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:testIamPermissions",
+ "id": "spanner.projects.instances.databases.testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions"
+ },
+ "getDdl": {
+ "response": {
+ "$ref": "GetDatabaseDdlResponse"
+ },
+ "parameterOrder": [
+ "database"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "database": {
+ "description": "Required. The database whose schema we wish to get.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/ddl",
+ "path": "v1/{+database}/ddl",
+ "id": "spanner.projects.instances.databases.getDdl",
+ "description": "Returns the schema of a Cloud Spanner database as a list of formatted\nDDL statements. This method does not show pending schema updates, those may\nbe queried using the Operations API."
+ }
+ },
+ "resources": {
+ "operations": {
+ "methods": {
+ "cancel": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be cancelled.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}:cancel",
+ "path": "v1/{+name}:cancel",
+ "id": "spanner.projects.instances.databases.operations.cancel",
+ "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`."
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be deleted.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}",
+ "path": "v1/{+name}",
+ "id": "spanner.projects.instances.databases.operations.delete",
+ "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`."
+ },
+ "list": {
+ "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": {
+ "description": "The name of the operation's parent resource.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations$",
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations",
+ "id": "spanner.projects.instances.databases.operations.list",
+ "path": "v1/{+name}"
+ },
+ "get": {
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the operation resource.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}",
+ "id": "spanner.projects.instances.databases.operations.get",
+ "path": "v1/{+name}"
+ }
+ }
+ },
+ "sessions": {
+ "methods": {
+ "commit": {
+ "description": "Commits a transaction. The request includes the mutations to be\napplied to rows in the database.\n\n`Commit` might return an `ABORTED` error. This can occur at any time;\ncommonly, the cause is conflicts with concurrent\ntransactions. However, it can also happen for a variety of other\nreasons. If `Commit` returns `ABORTED`, the caller should re-attempt\nthe transaction from the beginning, re-using the same session.",
+ "request": {
+ "$ref": "CommitRequest"
+ },
+ "response": {
+ "$ref": "CommitResponse"
+ },
+ "parameterOrder": [
+ "session"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.data"
+ ],
+ "parameters": {
+ "session": {
+ "description": "Required. The session in which the transaction to be committed is running.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:commit",
+ "path": "v1/{+session}:commit",
+ "id": "spanner.projects.instances.databases.sessions.commit"
+ },
+ "beginTransaction": {
+ "response": {
+ "$ref": "Transaction"
+ },
+ "parameterOrder": [
+ "session"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.data"
+ ],
+ "parameters": {
+ "session": {
+ "location": "path",
+ "description": "Required. The session in which the transaction runs.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:beginTransaction",
+ "path": "v1/{+session}:beginTransaction",
+ "id": "spanner.projects.instances.databases.sessions.beginTransaction",
+ "description": "Begins a new transaction. This step can often be skipped:\nRead, ExecuteSql and\nCommit can begin a new transaction as a\nside-effect.",
+ "request": {
+ "$ref": "BeginTransactionRequest"
+ }
+ },
+ "executeStreamingSql": {
+ "description": "Like ExecuteSql, except returns the result\nset as a stream. Unlike ExecuteSql, there\nis no limit on the size of the returned result set. However, no\nindividual row in the result set can exceed 100 MiB, and no\ncolumn value can exceed 10 MiB.",
+ "request": {
+ "$ref": "ExecuteSqlRequest"
+ },
+ "response": {
+ "$ref": "PartialResultSet"
+ },
+ "parameterOrder": [
+ "session"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.data"
+ ],
+ "parameters": {
+ "session": {
+ "description": "Required. The session in which the SQL query should be performed.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeStreamingSql",
+ "path": "v1/{+session}:executeStreamingSql",
+ "id": "spanner.projects.instances.databases.sessions.executeStreamingSql"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.data"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the session to delete.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}",
+ "path": "v1/{+name}",
+ "id": "spanner.projects.instances.databases.sessions.delete",
+ "description": "Ends a session, releasing server resources associated with it."
+ },
+ "executeSql": {
+ "request": {
+ "$ref": "ExecuteSqlRequest"
+ },
+ "description": "Executes an SQL query, returning all rows in a single reply. This\nmethod cannot be used to return a result set larger than 10 MiB;\nif the query yields more data than that, the query fails with\na `FAILED_PRECONDITION` error.\n\nQueries inside read-write transactions might return `ABORTED`. If\nthis occurs, the application should restart the transaction from\nthe beginning. See Transaction for more details.\n\nLarger result sets can be fetched in streaming fashion by calling\nExecuteStreamingSql instead.",
+ "response": {
+ "$ref": "ResultSet"
+ },
+ "parameterOrder": [
+ "session"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "session": {
+ "description": "Required. The session in which the SQL query should be performed.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.data"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeSql",
+ "path": "v1/{+session}:executeSql",
+ "id": "spanner.projects.instances.databases.sessions.executeSql"
+ },
+ "list": {
+ "description": "Lists all sessions in a given database.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "database"
+ ],
+ "response": {
+ "$ref": "ListSessionsResponse"
+ },
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "description": "Number of sessions to be returned in the response. If 0 or less, defaults\nto the server's maximum allowed page size.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "database": {
+ "description": "Required. The database in which to list sessions.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
+ "location": "path"
+ },
+ "filter": {
+ "location": "query",
+ "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n * labels.key where key is the name of a label\n\nSome examples of using filters are:\n\n * labels.env:* --\u003e The session has the label \"env\".\n * labels.env:dev --\u003e The session has the label \"env\" and the value of\n the label contains the string \"dev\".",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "If non-empty, `page_token` should contain a\nnext_page_token from a previous\nListSessionsResponse.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.data"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions",
+ "id": "spanner.projects.instances.databases.sessions.list",
+ "path": "v1/{+database}/sessions"
+ },
+ "streamingRead": {
+ "id": "spanner.projects.instances.databases.sessions.streamingRead",
+ "path": "v1/{+session}:streamingRead",
+ "request": {
+ "$ref": "ReadRequest"
+ },
+ "description": "Like Read, except returns the result set as a\nstream. Unlike Read, there is no limit on the\nsize of the returned result set. However, no individual row in\nthe result set can exceed 100 MiB, and no column value can exceed\n10 MiB.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "session"
+ ],
+ "response": {
+ "$ref": "PartialResultSet"
+ },
+ "parameters": {
+ "session": {
+ "location": "path",
+ "description": "Required. The session in which the read should be performed.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.data"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:streamingRead"
+ },
+ "rollback": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "session"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "session": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
+ "location": "path",
+ "description": "Required. The session in which the transaction to roll back is running."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.data"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:rollback",
+ "path": "v1/{+session}:rollback",
+ "id": "spanner.projects.instances.databases.sessions.rollback",
+ "request": {
+ "$ref": "RollbackRequest"
+ },
+ "description": "Rolls back a transaction, releasing any locks it holds. It is a good\nidea to call this for any transaction that includes one or more\nRead or ExecuteSql requests and\nultimately decides not to commit.\n\n`Rollback` returns `OK` if it successfully aborts the transaction, the\ntransaction was already aborted, or the transaction is not\nfound. `Rollback` never returns `ABORTED`."
+ },
+ "create": {
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions",
+ "id": "spanner.projects.instances.databases.sessions.create",
+ "path": "v1/{+database}/sessions",
+ "request": {
+ "$ref": "CreateSessionRequest"
+ },
+ "description": "Creates a new session. A session can be used to perform\ntransactions that read and/or modify data in a Cloud Spanner database.\nSessions are meant to be reused for many consecutive\ntransactions.\n\nSessions can only execute one transaction at a time. To execute\nmultiple concurrent read-write/write-only transactions, create\nmultiple sessions. Note that standalone reads and queries use a\ntransaction internally, and count toward the one transaction\nlimit.\n\nCloud Spanner limits the number of sessions that can exist at any given\ntime; thus, it is a good idea to delete idle and/or unneeded sessions.\nAside from explicit deletes, Cloud Spanner can delete sessions for which no\noperations are sent for more than an hour. If a session is deleted,\nrequests to it return `NOT_FOUND`.\n\nIdle sessions can be kept alive by sending a trivial SQL query\nperiodically, e.g., `\"SELECT 1\"`.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "database"
+ ],
+ "response": {
+ "$ref": "Session"
+ },
+ "parameters": {
+ "database": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
+ "location": "path",
+ "description": "Required. The database in which the new session is created.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.data"
+ ]
+ },
+ "read": {
+ "request": {
+ "$ref": "ReadRequest"
+ },
+ "description": "Reads rows from the database using key lookups and scans, as a\nsimple key/value style alternative to\nExecuteSql. This method cannot be used to\nreturn a result set larger than 10 MiB; if the read matches more\ndata than that, the read fails with a `FAILED_PRECONDITION`\nerror.\n\nReads inside read-write transactions might return `ABORTED`. If\nthis occurs, the application should restart the transaction from\nthe beginning. See Transaction for more details.\n\nLarger result sets can be yielded in streaming fashion by calling\nStreamingRead instead.",
+ "response": {
+ "$ref": "ResultSet"
+ },
+ "parameterOrder": [
+ "session"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "session": {
+ "description": "Required. The session in which the read should be performed.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.data"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:read",
+ "path": "v1/{+session}:read",
+ "id": "spanner.projects.instances.databases.sessions.read"
+ },
+ "get": {
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}",
+ "path": "v1/{+name}",
+ "id": "spanner.projects.instances.databases.sessions.get",
+ "description": "Gets a session. Returns `NOT_FOUND` if the session does not exist.\nThis is mainly useful for determining whether a session is still\nalive.",
+ "response": {
+ "$ref": "Session"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.data"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the session to retrieve.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
+ "location": "path"
+ }
+ }
+ }
+ }
}
}
},
"operations": {
"methods": {
- "cancel": {
- "httpMethod": "POST",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$",
- "location": "path",
- "description": "The name of the operation resource to be cancelled.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}:cancel",
- "id": "spanner.projects.instances.operations.cancel",
- "path": "v1/{+name}:cancel",
- "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`."
- },
- "delete": {
- "path": "v1/{+name}",
- "id": "spanner.projects.instances.operations.delete",
- "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "parameters": {
- "name": {
- "description": "The name of the operation resource to be deleted.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}"
- },
"list": {
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
"response": {
"$ref": "ListOperationsResponse"
},
@@ -2254,18 +2270,6 @@
"https://www.googleapis.com/auth/spanner.admin"
],
"parameters": {
- "name": {
- "description": "The name of the operation's parent resource.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/operations$",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
"pageSize": {
"location": "query",
"description": "The standard list page size.",
@@ -2273,15 +2277,26 @@
"type": "integer"
},
"filter": {
+ "location": "query",
"description": "The standard list filter.",
+ "type": "string"
+ },
+ "name": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/operations$",
+ "location": "path",
+ "description": "The name of the operation's parent resource.",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
"type": "string",
"location": "query"
}
},
"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations",
"path": "v1/{+name}",
- "id": "spanner.projects.instances.operations.list",
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id."
+ "id": "spanner.projects.instances.operations.list"
},
"get": {
"response": {
@@ -2297,118 +2312,113 @@
],
"parameters": {
"name": {
- "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$",
"location": "path",
"description": "The name of the operation resource.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$"
}
},
"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}",
"path": "v1/{+name}",
"id": "spanner.projects.instances.operations.get",
"description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
+ },
+ "cancel": {
+ "id": "spanner.projects.instances.operations.cancel",
+ "path": "v1/{+name}:cancel",
+ "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the operation resource to be cancelled.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}:cancel"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource to be deleted."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}",
+ "path": "v1/{+name}",
+ "id": "spanner.projects.instances.operations.delete",
+ "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`."
}
}
}
}
- },
- "instanceConfigs": {
- "methods": {
- "list": {
- "path": "v1/{+parent}/instanceConfigs",
- "id": "spanner.projects.instanceConfigs.list",
- "description": "Lists the supported instance configurations for a given project.",
- "response": {
- "$ref": "ListInstanceConfigsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "parameters": {
- "pageToken": {
- "description": "If non-empty, `page_token` should contain a\nnext_page_token\nfrom a previous ListInstanceConfigsResponse.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Number of instance configurations to be returned in the response. If 0 or\nless, defaults to the server's maximum allowed page size.",
- "format": "int32",
- "type": "integer"
- },
- "parent": {
- "description": "Required. The name of the project for which a list of supported instance\nconfigurations is requested. Values are of the form\n`projects/\u003cproject\u003e`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instanceConfigs"
- },
- "get": {
- "description": "Gets information about a particular instance configuration.",
- "response": {
- "$ref": "InstanceConfig"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "parameters": {
- "name": {
- "description": "Required. The name of the requested instance configuration. Values are of\nthe form `projects/\u003cproject\u003e/instanceConfigs/\u003cconfig\u003e`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instanceConfigs/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}",
- "path": "v1/{+name}",
- "id": "spanner.projects.instanceConfigs.get"
- }
- }
}
}
}
},
"parameters": {
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "OAuth access token."
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
},
"pp": {
+ "location": "query",
"description": "Pretty-print response.",
"type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
+ "default": "true"
},
"bearer_token": {
"location": "query",
"description": "OAuth bearer token.",
"type": "string"
},
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
"upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
},
"prettyPrint": {
"location": "query",
@@ -2416,35 +2426,41 @@
"type": "boolean",
"default": "true"
},
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
"fields": {
"location": "query",
"description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- },
"callback": {
"description": "JSONP",
"type": "string",
"location": "query"
},
+ "$.xgafv": {
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format."
+ },
"alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -2452,23 +2468,7 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
+ "default": "json"
}
},
"version": "v1",
diff --git a/speech/v1/speech-api.json b/speech/v1/speech-api.json
index 783daf5..480b179 100644
--- a/speech/v1/speech-api.json
+++ b/speech/v1/speech-api.json
@@ -1,262 +1,5 @@
{
- "title": "Google Cloud Speech API",
- "ownerName": "Google",
- "resources": {
- "operations": {
- "methods": {
- "get": {
- "path": "v1/operations/{+name}",
- "id": "speech.operations.get",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "description": "The name of the operation resource.",
- "type": "string",
- "required": true,
- "pattern": "^[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/operations/{operationsId}"
- },
- "list": {
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "name": {
- "location": "query",
- "description": "The name of the operation's parent resource.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer"
- },
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/operations",
- "id": "speech.operations.list",
- "path": "v1/operations"
- },
- "cancel": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The name of the operation resource to be cancelled.",
- "type": "string",
- "required": true,
- "pattern": "^[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/operations/{operationsId}:cancel",
- "id": "speech.operations.cancel",
- "path": "v1/operations/{+name}:cancel",
- "request": {
- "$ref": "CancelOperationRequest"
- },
- "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`."
- },
- "delete": {
- "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation resource to be deleted.",
- "type": "string",
- "required": true,
- "pattern": "^[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/operations/{operationsId}",
- "path": "v1/operations/{+name}",
- "id": "speech.operations.delete"
- }
- }
- },
- "speech": {
- "methods": {
- "longrunningrecognize": {
- "id": "speech.speech.longrunningrecognize",
- "path": "v1/speech:longrunningrecognize",
- "request": {
- "$ref": "LongRunningRecognizeRequest"
- },
- "description": "Performs asynchronous speech recognition: receive results via the\ngoogle.longrunning.Operations interface. Returns either an\n`Operation.error` or an `Operation.response` which contains\na `LongRunningRecognizeResponse` message.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v1/speech:longrunningrecognize"
- },
- "recognize": {
- "request": {
- "$ref": "RecognizeRequest"
- },
- "description": "Performs synchronous speech recognition: receive results after all audio\nhas been sent and processed.",
- "response": {
- "$ref": "RecognizeResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v1/speech:recognize",
- "id": "speech.speech.recognize",
- "path": "v1/speech:recognize"
- }
- }
- }
- },
- "parameters": {
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- }
- },
- "version": "v1",
- "baseUrl": "https://speech.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Converts audio to text by applying powerful neural network models.",
- "servicePath": "",
- "basePath": "",
- "revision": "20171003",
+ "revision": "20171010",
"documentationLink": "https://cloud.google.com/speech/",
"id": "speech:v1",
"discoveryVersion": "v1",
@@ -280,6 +23,8 @@
"type": "string"
},
"encoding": {
+ "description": "*Required* Encoding of audio data sent in all `RecognitionAudio` messages.",
+ "type": "string",
"enumDescriptions": [
"Not specified. Will return result google.rpc.Code.INVALID_ARGUMENT.",
"Uncompressed 16-bit signed little-endian samples (Linear PCM).",
@@ -299,9 +44,11 @@
"AMR_WB",
"OGG_OPUS",
"SPEEX_WITH_HEADER_BYTE"
- ],
- "description": "*Required* Encoding of audio data sent in all `RecognitionAudio` messages.",
- "type": "string"
+ ]
+ },
+ "profanityFilter": {
+ "description": "*Optional* If set to `true`, the server will attempt to filter out\nprofanities, replacing all but the initial character in each filtered word\nwith asterisks, e.g. \"f***\". If set to `false` or omitted, profanities\nwon't be filtered out.",
+ "type": "boolean"
},
"speechContexts": {
"description": "*Optional* A means to provide context to assist the speech recognition.",
@@ -310,10 +57,6 @@
},
"type": "array"
},
- "profanityFilter": {
- "description": "*Optional* If set to `true`, the server will attempt to filter out\nprofanities, replacing all but the initial character in each filtered word\nwith asterisks, e.g. \"f***\". If set to `false` or omitted, profanities\nwon't be filtered out.",
- "type": "boolean"
- },
"sampleRateHertz": {
"format": "int32",
"description": "*Required* Sample rate in Hertz of the audio data sent in all\n`RecognitionAudio` messages. Valid values are: 8000-48000.\n16000 is optimal. For best results, set the sampling rate of the audio\nsource to 16000 Hz. If that's not possible, use the native sample rate of\nthe audio source (instead of re-sampling).",
@@ -377,18 +120,36 @@
"id": "Empty"
},
"RecognizeRequest": {
+ "description": "The top-level message sent by the client for the `Recognize` method.",
+ "type": "object",
"properties": {
"audio": {
- "description": "*Required* The audio data to be recognized.",
- "$ref": "RecognitionAudio"
+ "$ref": "RecognitionAudio",
+ "description": "*Required* The audio data to be recognized."
},
"config": {
"description": "*Required* Provides information to the recognizer that specifies how to\nprocess the request.",
"$ref": "RecognitionConfig"
}
},
- "id": "RecognizeRequest",
- "description": "The top-level message sent by the client for the `Recognize` method.",
+ "id": "RecognizeRequest"
+ },
+ "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"
+ }
+ },
+ "id": "ListOperationsResponse",
+ "description": "The response message for Operations.ListOperations.",
"type": "object"
},
"SpeechRecognitionAlternative": {
@@ -397,7 +158,7 @@
"properties": {
"confidence": {
"format": "float",
- "description": "*Output-only* The confidence estimate between 0.0 and 1.0. A higher number\nindicates an estimated greater likelihood that the recognized words are\ncorrect. This field is typically provided only for the top hypothesis, and\nonly for `is_final=true` results. Clients should not rely on the\n`confidence` field as it is not guaranteed to be accurate or consistent.\nThe default of 0.0 is a sentinel value indicating `confidence` was not set.",
+ "description": "*Output-only* The confidence estimate between 0.0 and 1.0. A higher number\nindicates an estimated greater likelihood that the recognized words are\ncorrect. This field is typically provided only for the top hypothesis, and\nonly for `is_final=true` results. Clients should not rely on the\n`confidence` field as it is not guaranteed to be accurate, or even set, in\nany of the results.\nThe default of 0.0 is a sentinel value indicating `confidence` was not set.",
"type": "number"
},
"words": {
@@ -414,24 +175,6 @@
},
"id": "SpeechRecognitionAlternative"
},
- "ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
- "items": {
- "$ref": "Operation"
- },
- "type": "array"
- }
- },
- "id": "ListOperationsResponse"
- },
"SpeechContext": {
"properties": {
"phrases": {
@@ -447,8 +190,6 @@
"type": "object"
},
"SpeechRecognitionResult": {
- "description": "A speech recognition result corresponding to a portion of the audio.",
- "type": "object",
"properties": {
"alternatives": {
"description": "*Output-only* May contain one or more recognition hypotheses (up to the\nmaximum specified in `max_alternatives`).\nThese alternatives are ordered in terms of accuracy, with the top (first)\nalternative being the most probable, as ranked by the recognizer.",
@@ -458,20 +199,22 @@
"type": "array"
}
},
- "id": "SpeechRecognitionResult"
+ "id": "SpeechRecognitionResult",
+ "description": "A speech recognition result corresponding to a portion of the audio.",
+ "type": "object"
},
"RecognitionAudio": {
"description": "Contains audio data in the encoding specified in the `RecognitionConfig`.\nEither `content` or `uri` must be supplied. Supplying both or neither\nreturns google.rpc.Code.INVALID_ARGUMENT. See\n[audio limits](https://cloud.google.com/speech/limits#content).",
"type": "object",
"properties": {
- "uri": {
- "description": "URI that points to a file that contains audio data bytes as specified in\n`RecognitionConfig`. Currently, only Google Cloud Storage URIs are\nsupported, which must be specified in the following format:\n`gs://bucket_name/object_name` (other URI formats return\ngoogle.rpc.Code.INVALID_ARGUMENT). For more information, see\n[Request URIs](https://cloud.google.com/storage/docs/reference-uris).",
- "type": "string"
- },
"content": {
"format": "byte",
"description": "The audio data bytes encoded as specified in\n`RecognitionConfig`. Note: as with all bytes fields, protobuffers use a\npure binary representation, whereas JSON representations use base64.",
"type": "string"
+ },
+ "uri": {
+ "description": "URI that points to a file that contains audio data bytes as specified in\n`RecognitionConfig`. Currently, only Google Cloud Storage URIs are\nsupported, which must be specified in the following format:\n`gs://bucket_name/object_name` (other URI formats return\ngoogle.rpc.Code.INVALID_ARGUMENT). For more information, see\n[Request URIs](https://cloud.google.com/storage/docs/reference-uris).",
+ "type": "string"
}
},
"id": "RecognitionAudio"
@@ -479,12 +222,12 @@
"LongRunningRecognizeRequest": {
"properties": {
"audio": {
- "description": "*Required* The audio data to be recognized.",
- "$ref": "RecognitionAudio"
+ "$ref": "RecognitionAudio",
+ "description": "*Required* The audio data to be recognized."
},
"config": {
- "$ref": "RecognitionConfig",
- "description": "*Required* Provides information to the recognizer that specifies how to\nprocess the request."
+ "description": "*Required* Provides information to the recognizer that specifies how to\nprocess the request.",
+ "$ref": "RecognitionConfig"
}
},
"id": "LongRunningRecognizeRequest",
@@ -512,26 +255,28 @@
"id": "CancelOperationRequest"
},
"Operation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object",
"properties": {
"done": {
"description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
"type": "boolean"
},
"response": {
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
- "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- }
+ },
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object"
},
"name": {
"description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
"type": "string"
},
"error": {
- "description": "The error result of the operation in case of failure or cancellation.",
- "$ref": "Status"
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
"additionalProperties": {
@@ -542,9 +287,7 @@
"type": "object"
}
},
- "id": "Operation",
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object"
+ "id": "Operation"
}
},
"icons": {
@@ -565,5 +308,262 @@
"rootUrl": "https://speech.googleapis.com/",
"ownerDomain": "google.com",
"name": "speech",
- "batchPath": "batch"
+ "batchPath": "batch",
+ "title": "Google Cloud Speech API",
+ "ownerName": "Google",
+ "resources": {
+ "operations": {
+ "methods": {
+ "cancel": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be cancelled.",
+ "type": "string",
+ "required": true,
+ "pattern": "^[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/operations/{operationsId}:cancel",
+ "path": "v1/operations/{+name}:cancel",
+ "id": "speech.operations.cancel",
+ "request": {
+ "$ref": "CancelOperationRequest"
+ },
+ "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`."
+ },
+ "delete": {
+ "flatPath": "v1/operations/{operationsId}",
+ "id": "speech.operations.delete",
+ "path": "v1/operations/{+name}",
+ "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be deleted.",
+ "type": "string",
+ "required": true,
+ "pattern": "^[^/]+$",
+ "location": "path"
+ }
+ }
+ },
+ "get": {
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/operations/{operationsId}",
+ "path": "v1/operations/{+name}",
+ "id": "speech.operations.get"
+ },
+ "list": {
+ "flatPath": "v1/operations",
+ "path": "v1/operations",
+ "id": "speech.operations.list",
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
+ "httpMethod": "GET",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "description": "The name of the operation's parent resource.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer",
+ "location": "query"
+ }
+ }
+ }
+ }
+ },
+ "speech": {
+ "methods": {
+ "longrunningrecognize": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/speech:longrunningrecognize",
+ "id": "speech.speech.longrunningrecognize",
+ "path": "v1/speech:longrunningrecognize",
+ "description": "Performs asynchronous speech recognition: receive results via the\ngoogle.longrunning.Operations interface. Returns either an\n`Operation.error` or an `Operation.response` which contains\na `LongRunningRecognizeResponse` message.",
+ "request": {
+ "$ref": "LongRunningRecognizeRequest"
+ }
+ },
+ "recognize": {
+ "response": {
+ "$ref": "RecognizeResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/speech:recognize",
+ "id": "speech.speech.recognize",
+ "path": "v1/speech:recognize",
+ "description": "Performs synchronous speech recognition: receive results after all audio\nhas been sent and processed.",
+ "request": {
+ "$ref": "RecognizeRequest"
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://speech.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Converts audio to text by applying powerful neural network models.",
+ "servicePath": "",
+ "basePath": ""
}
diff --git a/speech/v1/speech-gen.go b/speech/v1/speech-gen.go
index aa15c73..8aeaebd 100644
--- a/speech/v1/speech-gen.go
+++ b/speech/v1/speech-gen.go
@@ -572,8 +572,9 @@
// hypothesis, and
// only for `is_final=true` results. Clients should not rely on
// the
- // `confidence` field as it is not guaranteed to be accurate or
- // consistent.
+ // `confidence` field as it is not guaranteed to be accurate, or even
+ // set, in
+ // any of the results.
// The default of 0.0 is a sentinel value indicating `confidence` was
// not set.
Confidence float64 `json:"confidence,omitempty"`
diff --git a/speech/v1beta1/speech-api.json b/speech/v1beta1/speech-api.json
index fe5c209..4c0a503 100644
--- a/speech/v1beta1/speech-api.json
+++ b/speech/v1beta1/speech-api.json
@@ -1,120 +1,17 @@
{
- "title": "Google Cloud Speech API",
"ownerName": "Google",
"resources": {
- "speech": {
- "methods": {
- "asyncrecognize": {
- "request": {
- "$ref": "AsyncRecognizeRequest"
- },
- "description": "Performs asynchronous speech recognition: receive results via the\n[google.longrunning.Operations]\n(/speech/reference/rest/v1beta1/operations#Operation)\ninterface. Returns either an\n`Operation.error` or an `Operation.response` which contains\nan `AsyncRecognizeResponse` message.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v1beta1/speech:asyncrecognize",
- "id": "speech.speech.asyncrecognize",
- "path": "v1beta1/speech:asyncrecognize"
- },
- "syncrecognize": {
- "flatPath": "v1beta1/speech:syncrecognize",
- "path": "v1beta1/speech:syncrecognize",
- "id": "speech.speech.syncrecognize",
- "request": {
- "$ref": "SyncRecognizeRequest"
- },
- "description": "Performs synchronous speech recognition: receive results after all audio\nhas been sent and processed.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "SyncRecognizeResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {}
- }
- }
- },
"operations": {
"methods": {
- "get": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The name of the operation resource.",
- "type": "string",
- "required": true,
- "pattern": "^[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/operations/{operationsId}",
- "id": "speech.operations.get",
- "path": "v1beta1/operations/{+name}",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
- },
- "list": {
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "pageSize": {
- "location": "query",
- "format": "int32",
- "description": "The standard list page size.",
- "type": "integer"
- },
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "name": {
- "location": "query",
- "description": "The name of the operation's parent resource.",
- "type": "string"
- }
- },
- "flatPath": "v1beta1/operations",
- "id": "speech.operations.list",
- "path": "v1beta1/operations",
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id."
- },
"cancel": {
"description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
"httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "Empty"
},
+ "parameterOrder": [
+ "name"
+ ],
"parameters": {
"name": {
"pattern": "^[^/]+$",
@@ -132,14 +29,10 @@
"id": "speech.operations.cancel"
},
"delete": {
- "flatPath": "v1beta1/operations/{operationsId}",
- "path": "v1beta1/operations/{+name}",
- "id": "speech.operations.delete",
- "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.",
- "httpMethod": "DELETE",
"parameterOrder": [
"name"
],
+ "httpMethod": "DELETE",
"response": {
"$ref": "Empty"
},
@@ -154,17 +47,170 @@
"type": "string",
"required": true
}
- }
+ },
+ "flatPath": "v1beta1/operations/{operationsId}",
+ "id": "speech.operations.delete",
+ "path": "v1beta1/operations/{+name}",
+ "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`."
+ },
+ "get": {
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1beta1/operations/{operationsId}",
+ "path": "v1beta1/operations/{+name}",
+ "id": "speech.operations.get"
+ },
+ "list": {
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "location": "query",
+ "description": "The name of the operation's parent resource.",
+ "type": "string"
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "The standard list page size.",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/operations",
+ "id": "speech.operations.list",
+ "path": "v1beta1/operations",
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id."
+ }
+ }
+ },
+ "speech": {
+ "methods": {
+ "asyncrecognize": {
+ "request": {
+ "$ref": "AsyncRecognizeRequest"
+ },
+ "description": "Performs asynchronous speech recognition: receive results via the\n[google.longrunning.Operations]\n(/speech/reference/rest/v1beta1/operations#Operation)\ninterface. Returns either an\n`Operation.error` or an `Operation.response` which contains\nan `AsyncRecognizeResponse` message.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1beta1/speech:asyncrecognize",
+ "path": "v1beta1/speech:asyncrecognize",
+ "id": "speech.speech.asyncrecognize"
+ },
+ "syncrecognize": {
+ "id": "speech.speech.syncrecognize",
+ "path": "v1beta1/speech:syncrecognize",
+ "description": "Performs synchronous speech recognition: receive results after all audio\nhas been sent and processed.",
+ "request": {
+ "$ref": "SyncRecognizeRequest"
+ },
+ "response": {
+ "$ref": "SyncRecognizeResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/speech:syncrecognize"
}
}
}
},
"parameters": {
- "upload_protocol": {
+ "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": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string"
},
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
"prettyPrint": {
"location": "query",
"description": "Returns response with indentations and line breaks.",
@@ -172,9 +218,9 @@
"type": "boolean"
},
"fields": {
+ "location": "query",
"description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"uploadType": {
"location": "query",
@@ -182,69 +228,22 @@
"type": "string"
},
"$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query"
},
"callback": {
"description": "JSONP",
"type": "string",
"location": "query"
- },
- "alt": {
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
}
},
"version": "v1beta1",
@@ -253,13 +252,110 @@
"description": "Converts audio to text by applying powerful neural network models.",
"servicePath": "",
"basePath": "",
- "revision": "20171003",
- "documentationLink": "https://cloud.google.com/speech/",
"id": "speech:v1beta1",
+ "revision": "20171010",
+ "documentationLink": "https://cloud.google.com/speech/",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "Status": {
+ "properties": {
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "code": {
+ "format": "int32",
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "type": "integer"
+ }
+ },
+ "id": "Status",
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object"
+ },
+ "SyncRecognizeResponse": {
+ "description": "The only message returned to the client by `SyncRecognize`. method. It\ncontains the result as zero or more sequential `SpeechRecognitionResult`\nmessages.",
+ "type": "object",
+ "properties": {
+ "results": {
+ "description": "*Output-only* Sequential list of transcription results corresponding to\nsequential portions of audio.",
+ "items": {
+ "$ref": "SpeechRecognitionResult"
+ },
+ "type": "array"
+ }
+ },
+ "id": "SyncRecognizeResponse"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
+ },
+ "SpeechRecognitionAlternative": {
+ "description": "Alternative hypotheses (a.k.a. n-best list).",
+ "type": "object",
+ "properties": {
+ "confidence": {
+ "format": "float",
+ "description": "*Output-only* The confidence estimate between 0.0 and 1.0. A higher number\nindicates an estimated greater likelihood that the recognized words are\ncorrect. This field is typically provided only for the top hypothesis, and\nonly for `is_final=true` results. Clients should not rely on the\n`confidence` field as it is not guaranteed to be accurate, or even set, in\nany of the results.\nThe default of 0.0 is a sentinel value indicating `confidence` was not set.",
+ "type": "number"
+ },
+ "transcript": {
+ "description": "*Output-only* Transcript text representing the words that the user spoke.",
+ "type": "string"
+ }
+ },
+ "id": "SpeechRecognitionAlternative"
+ },
+ "SpeechContext": {
+ "properties": {
+ "phrases": {
+ "description": "*Optional* A list of strings containing words and phrases \"hints\" so that\nthe speech recognition is more likely to recognize them. This can be used\nto improve the accuracy for specific words and phrases, for example, if\nspecific commands are typically spoken by the user. This can also be used\nto add additional words to the vocabulary of the recognizer. See\n[usage limits](https://cloud.google.com/speech/limits#content).",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "SpeechContext",
+ "description": "Provides \"hints\" to the speech recognizer to favor specific words and phrases\nin the results.",
+ "type": "object"
+ },
+ "ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
+ "items": {
+ "$ref": "Operation"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListOperationsResponse"
+ },
"SpeechRecognitionResult": {
+ "description": "A speech recognition result corresponding to a portion of the audio.",
+ "type": "object",
"properties": {
"alternatives": {
"description": "*Output-only* May contain one or more recognition hypotheses (up to the\nmaximum specified in `max_alternatives`).",
@@ -269,29 +365,25 @@
"type": "array"
}
},
- "id": "SpeechRecognitionResult",
- "description": "A speech recognition result corresponding to a portion of the audio.",
- "type": "object"
+ "id": "SpeechRecognitionResult"
},
"RecognitionAudio": {
+ "description": "Contains audio data in the encoding specified in the `RecognitionConfig`.\nEither `content` or `uri` must be supplied. Supplying both or neither\nreturns google.rpc.Code.INVALID_ARGUMENT. See\n[audio limits](https://cloud.google.com/speech/limits#content).",
+ "type": "object",
"properties": {
- "uri": {
- "description": "URI that points to a file that contains audio data bytes as specified in\n`RecognitionConfig`. Currently, only Google Cloud Storage URIs are\nsupported, which must be specified in the following format:\n`gs://bucket_name/object_name` (other URI formats return\ngoogle.rpc.Code.INVALID_ARGUMENT). For more information, see\n[Request URIs](https://cloud.google.com/storage/docs/reference-uris).",
- "type": "string"
- },
"content": {
"format": "byte",
"description": "The audio data bytes encoded as specified in\n`RecognitionConfig`. Note: as with all bytes fields, protobuffers use a\npure binary representation, whereas JSON representations use base64.",
"type": "string"
+ },
+ "uri": {
+ "description": "URI that points to a file that contains audio data bytes as specified in\n`RecognitionConfig`. Currently, only Google Cloud Storage URIs are\nsupported, which must be specified in the following format:\n`gs://bucket_name/object_name` (other URI formats return\ngoogle.rpc.Code.INVALID_ARGUMENT). For more information, see\n[Request URIs](https://cloud.google.com/storage/docs/reference-uris).",
+ "type": "string"
}
},
- "id": "RecognitionAudio",
- "description": "Contains audio data in the encoding specified in the `RecognitionConfig`.\nEither `content` or `uri` must be supplied. Supplying both or neither\nreturns google.rpc.Code.INVALID_ARGUMENT. See\n[audio limits](https://cloud.google.com/speech/limits#content).",
- "type": "object"
+ "id": "RecognitionAudio"
},
"AsyncRecognizeRequest": {
- "description": "The top-level message sent by the client for the `AsyncRecognize` method.",
- "type": "object",
"properties": {
"audio": {
"description": "*Required* The audio data to be recognized.",
@@ -302,7 +394,9 @@
"$ref": "RecognitionConfig"
}
},
- "id": "AsyncRecognizeRequest"
+ "id": "AsyncRecognizeRequest",
+ "description": "The top-level message sent by the client for the `AsyncRecognize` method.",
+ "type": "object"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
@@ -329,19 +423,17 @@
"description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
- "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- }
+ },
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object"
}
},
"id": "Operation"
},
"RecognitionConfig": {
- "description": "Provides information to the recognizer that specifies how to process the\nrequest.",
- "type": "object",
"properties": {
"maxAlternatives": {
"format": "int32",
@@ -358,8 +450,6 @@
"type": "string"
},
"encoding": {
- "description": "*Required* Encoding of audio data sent in all `RecognitionAudio` messages.",
- "type": "string",
"enumDescriptions": [
"Not specified. Will return result google.rpc.Code.INVALID_ARGUMENT.",
"Uncompressed 16-bit signed little-endian samples (Linear PCM).\nThis is the only encoding that may be used by `AsyncRecognize`.",
@@ -375,7 +465,9 @@
"MULAW",
"AMR",
"AMR_WB"
- ]
+ ],
+ "description": "*Required* Encoding of audio data sent in all `RecognitionAudio` messages.",
+ "type": "string"
},
"profanityFilter": {
"description": "*Optional* If set to `true`, the server will attempt to filter out\nprofanities, replacing all but the initial character in each filtered word\nwith asterisks, e.g. \"f***\". If set to `false` or omitted, profanities\nwon't be filtered out.",
@@ -386,124 +478,31 @@
"$ref": "SpeechContext"
}
},
- "id": "RecognitionConfig"
+ "id": "RecognitionConfig",
+ "description": "Provides information to the recognizer that specifies how to process the\nrequest.",
+ "type": "object"
},
"SyncRecognizeRequest": {
- "description": "The top-level message sent by the client for the `SyncRecognize` method.",
- "type": "object",
"properties": {
"audio": {
- "description": "*Required* The audio data to be recognized.",
- "$ref": "RecognitionAudio"
+ "$ref": "RecognitionAudio",
+ "description": "*Required* The audio data to be recognized."
},
"config": {
- "description": "*Required* Provides information to the recognizer that specifies how to\nprocess the request.",
- "$ref": "RecognitionConfig"
+ "$ref": "RecognitionConfig",
+ "description": "*Required* Provides information to the recognizer that specifies how to\nprocess the request."
}
},
- "id": "SyncRecognizeRequest"
- },
- "Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- },
- "type": "array"
- },
- "code": {
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- }
- },
- "id": "Status"
- },
- "SyncRecognizeResponse": {
- "properties": {
- "results": {
- "description": "*Output-only* Sequential list of transcription results corresponding to\nsequential portions of audio.",
- "items": {
- "$ref": "SpeechRecognitionResult"
- },
- "type": "array"
- }
- },
- "id": "SyncRecognizeResponse",
- "description": "The only message returned to the client by `SyncRecognize`. method. It\ncontains the result as zero or more sequential `SpeechRecognitionResult`\nmessages.",
- "type": "object"
- },
- "Empty": {
- "properties": {},
- "id": "Empty",
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object"
- },
- "ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
- "properties": {
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
- "items": {
- "$ref": "Operation"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- }
- },
- "id": "ListOperationsResponse"
- },
- "SpeechContext": {
- "properties": {
- "phrases": {
- "description": "*Optional* A list of strings containing words and phrases \"hints\" so that\nthe speech recognition is more likely to recognize them. This can be used\nto improve the accuracy for specific words and phrases, for example, if\nspecific commands are typically spoken by the user. This can also be used\nto add additional words to the vocabulary of the recognizer. See\n[usage limits](https://cloud.google.com/speech/limits#content).",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "SpeechContext",
- "description": "Provides \"hints\" to the speech recognizer to favor specific words and phrases\nin the results.",
- "type": "object"
- },
- "SpeechRecognitionAlternative": {
- "properties": {
- "confidence": {
- "format": "float",
- "description": "*Output-only* The confidence estimate between 0.0 and 1.0. A higher number\nindicates an estimated greater likelihood that the recognized words are\ncorrect. This field is typically provided only for the top hypothesis, and\nonly for `is_final=true` results. Clients should not rely on the\n`confidence` field as it is not guaranteed to be accurate, or even set, in\nany of the results.\nThe default of 0.0 is a sentinel value indicating `confidence` was not set.",
- "type": "number"
- },
- "transcript": {
- "description": "*Output-only* Transcript text representing the words that the user spoke.",
- "type": "string"
- }
- },
- "id": "SpeechRecognitionAlternative",
- "description": "Alternative hypotheses (a.k.a. n-best list).",
+ "id": "SyncRecognizeRequest",
+ "description": "The top-level message sent by the client for the `SyncRecognize` method.",
"type": "object"
}
},
+ "protocol": "rest",
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
- "protocol": "rest",
"canonicalName": "Speech",
"auth": {
"oauth2": {
@@ -517,5 +516,6 @@
"rootUrl": "https://speech.googleapis.com/",
"ownerDomain": "google.com",
"name": "speech",
- "batchPath": "batch"
+ "batchPath": "batch",
+ "title": "Google Cloud Speech API"
}
diff --git a/storagetransfer/v1/storagetransfer-api.json b/storagetransfer/v1/storagetransfer-api.json
index 154d71d..65b473a 100644
--- a/storagetransfer/v1/storagetransfer-api.json
+++ b/storagetransfer/v1/storagetransfer-api.json
@@ -1,4 +1,26 @@
{
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "protocol": "rest",
+ "version": "v1",
+ "baseUrl": "https://storagetransfer.googleapis.com/",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "description": "Transfers data from external data sources to a Google Cloud Storage bucket or between Google Cloud Storage buckets.",
+ "servicePath": "",
+ "kind": "discovery#restDescription",
+ "rootUrl": "https://storagetransfer.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
"name": "storagetransfer",
"batchPath": "batch",
"id": "storagetransfer:v1",
@@ -12,7 +34,6 @@
"googleServiceAccounts": {
"methods": {
"get": {
- "description": "Returns the Google service account that is used by Storage Transfer\nService to access buckets in the project where transfers\nrun or in other projects. Each Google service account is associated\nwith one Google Cloud Platform Console project. Users\nshould add this service account to the Google Cloud Storage bucket\nACLs to grant access to Storage Transfer Service. This service\naccount is created and owned by Storage Transfer Service and can\nonly be used by Storage Transfer Service.",
"response": {
"$ref": "GoogleServiceAccount"
},
@@ -25,115 +46,26 @@
],
"parameters": {
"projectId": {
+ "location": "path",
"description": "The ID of the Google Cloud Platform Console project that the Google service\naccount is associated with.\nRequired.",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
}
},
"flatPath": "v1/googleServiceAccounts/{projectId}",
"id": "storagetransfer.googleServiceAccounts.get",
- "path": "v1/googleServiceAccounts/{projectId}"
+ "path": "v1/googleServiceAccounts/{projectId}",
+ "description": "Returns the Google service account that is used by Storage Transfer\nService to access buckets in the project where transfers\nrun or in other projects. Each Google service account is associated\nwith one Google Cloud Platform Console project. Users\nshould add this service account to the Google Cloud Storage bucket\nACLs to grant access to Storage Transfer Service. This service\naccount is created and owned by Storage Transfer Service and can\nonly be used by Storage Transfer Service."
}
}
},
"transferOperations": {
"methods": {
- "list": {
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "pageToken": {
- "description": "The list page token.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "description": "The value `transferOperations`.",
- "type": "string",
- "required": true,
- "pattern": "^transferOperations$",
- "location": "path"
- },
- "pageSize": {
- "format": "int32",
- "description": "The list page size. The max allowed value is 256.",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "location": "query",
- "description": "A list of query parameters specified as JSON text in the form of {\\\"project_id\\\" : \\\"my_project_id\\\", \\\"job_names\\\" : [\\\"jobid1\\\", \\\"jobid2\\\",...], \\\"operation_names\\\" : [\\\"opid1\\\", \\\"opid2\\\",...], \\\"transfer_statuses\\\":[\\\"status1\\\", \\\"status2\\\",...]}. Since `job_names`, `operation_names`, and `transfer_statuses` support multiple values, they must be specified with array notation. `job_names`, `operation_names`, and `transfer_statuses` are optional.",
- "type": "string"
- }
- },
- "flatPath": "v1/transferOperations",
- "id": "storagetransfer.transferOperations.list",
- "path": "v1/{+name}",
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id."
- },
- "resume": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "type": "string",
- "required": true,
- "pattern": "^transferOperations/.+$",
- "location": "path",
- "description": "The name of the transfer operation.\nRequired."
- }
- },
- "flatPath": "v1/transferOperations/{transferOperationsId}:resume",
- "id": "storagetransfer.transferOperations.resume",
- "path": "v1/{+name}:resume",
- "request": {
- "$ref": "ResumeTransferOperationRequest"
- },
- "description": "Resumes a transfer operation that is paused."
- },
- "cancel": {
- "id": "storagetransfer.transferOperations.cancel",
- "path": "v1/{+name}:cancel",
- "description": "Cancels a transfer. Use the get method to check whether the cancellation succeeded or whether the operation completed despite cancellation.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "type": "string",
- "required": true,
- "pattern": "^transferOperations/.+$",
- "location": "path",
- "description": "The name of the operation resource to be cancelled."
- }
- },
- "flatPath": "v1/transferOperations/{transferOperationsId}:cancel"
- },
"get": {
+ "flatPath": "v1/transferOperations/{transferOperationsId}",
+ "id": "storagetransfer.transferOperations.get",
+ "path": "v1/{+name}",
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
"response": {
"$ref": "Operation"
},
@@ -152,13 +84,107 @@
"location": "path",
"description": "The name of the operation resource."
}
- },
- "flatPath": "v1/transferOperations/{transferOperationsId}",
- "id": "storagetransfer.transferOperations.get",
- "path": "v1/{+name}",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
+ }
},
"pause": {
+ "flatPath": "v1/transferOperations/{transferOperationsId}:pause",
+ "id": "storagetransfer.transferOperations.pause",
+ "path": "v1/{+name}:pause",
+ "request": {
+ "$ref": "PauseTransferOperationRequest"
+ },
+ "description": "Pauses a transfer operation.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the transfer operation.\nRequired.",
+ "type": "string",
+ "required": true,
+ "pattern": "^transferOperations/.+$"
+ }
+ }
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "name": {
+ "type": "string",
+ "required": true,
+ "pattern": "^transferOperations/.+$",
+ "location": "path",
+ "description": "The name of the operation resource to be deleted."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/transferOperations/{transferOperationsId}",
+ "path": "v1/{+name}",
+ "id": "storagetransfer.transferOperations.delete",
+ "description": "This method is not supported and the server returns `UNIMPLEMENTED`."
+ },
+ "list": {
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "The list page token."
+ },
+ "name": {
+ "location": "path",
+ "description": "The value `transferOperations`.",
+ "type": "string",
+ "required": true,
+ "pattern": "^transferOperations$"
+ },
+ "pageSize": {
+ "location": "query",
+ "format": "int32",
+ "description": "The list page size. The max allowed value is 256.",
+ "type": "integer"
+ },
+ "filter": {
+ "location": "query",
+ "description": "A list of query parameters specified as JSON text in the form of {\\\"project_id\\\" : \\\"my_project_id\\\", \\\"job_names\\\" : [\\\"jobid1\\\", \\\"jobid2\\\",...], \\\"operation_names\\\" : [\\\"opid1\\\", \\\"opid2\\\",...], \\\"transfer_statuses\\\":[\\\"status1\\\", \\\"status2\\\",...]}. Since `job_names`, `operation_names`, and `transfer_statuses` support multiple values, they must be specified with array notation. `job_names`, `operation_names`, and `transfer_statuses` are optional.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/transferOperations",
+ "id": "storagetransfer.transferOperations.list",
+ "path": "v1/{+name}"
+ },
+ "resume": {
+ "description": "Resumes a transfer operation that is paused.",
+ "request": {
+ "$ref": "ResumeTransferOperationRequest"
+ },
"response": {
"$ref": "Empty"
},
@@ -168,70 +194,63 @@
"httpMethod": "POST",
"parameters": {
"name": {
- "description": "The name of the transfer operation.\nRequired.",
"type": "string",
"required": true,
"pattern": "^transferOperations/.+$",
- "location": "path"
+ "location": "path",
+ "description": "The name of the transfer operation.\nRequired."
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/transferOperations/{transferOperationsId}:pause",
- "id": "storagetransfer.transferOperations.pause",
- "path": "v1/{+name}:pause",
- "description": "Pauses a transfer operation.",
- "request": {
- "$ref": "PauseTransferOperationRequest"
- }
+ "flatPath": "v1/transferOperations/{transferOperationsId}:resume",
+ "id": "storagetransfer.transferOperations.resume",
+ "path": "v1/{+name}:resume"
},
- "delete": {
- "flatPath": "v1/transferOperations/{transferOperationsId}",
- "id": "storagetransfer.transferOperations.delete",
- "path": "v1/{+name}",
- "description": "This method is not supported and the server returns `UNIMPLEMENTED`.",
+ "cancel": {
+ "description": "Cancels a transfer. Use the get method to check whether the cancellation succeeded or whether the operation completed despite cancellation.",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"name"
],
- "httpMethod": "DELETE",
+ "httpMethod": "POST",
"parameters": {
"name": {
- "description": "The name of the operation resource to be deleted.",
+ "location": "path",
+ "description": "The name of the operation resource to be cancelled.",
"type": "string",
"required": true,
- "pattern": "^transferOperations/.+$",
- "location": "path"
+ "pattern": "^transferOperations/.+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ]
+ ],
+ "flatPath": "v1/transferOperations/{transferOperationsId}:cancel",
+ "id": "storagetransfer.transferOperations.cancel",
+ "path": "v1/{+name}:cancel"
}
}
},
"transferJobs": {
"methods": {
"list": {
- "path": "v1/transferJobs",
- "id": "storagetransfer.transferJobs.list",
- "description": "Lists transfer jobs.",
- "httpMethod": "GET",
- "parameterOrder": [],
"response": {
"$ref": "ListTransferJobsResponse"
},
+ "parameterOrder": [],
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"pageToken": {
- "description": "The list page token.",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "The list page token."
},
"pageSize": {
"location": "query",
@@ -240,14 +259,20 @@
"type": "integer"
},
"filter": {
- "description": "A list of query parameters specified as JSON text in the form of\n{\"project_id\":\"my_project_id\",\n\"job_names\":[\"jobid1\",\"jobid2\",...],\n\"job_statuses\":[\"status1\",\"status2\",...]}.\nSince `job_names` and `job_statuses` support multiple values, their values\nmust be specified with array notation. `project_id` is required. `job_names`\nand `job_statuses` are optional. The valid values for `job_statuses` are\ncase-insensitive: `ENABLED`, `DISABLED`, and `DELETED`.",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "A list of query parameters specified as JSON text in the form of\n{\"project_id\":\"my_project_id\",\n\"job_names\":[\"jobid1\",\"jobid2\",...],\n\"job_statuses\":[\"status1\",\"status2\",...]}.\nSince `job_names` and `job_statuses` support multiple values, their values\nmust be specified with array notation. `project_id` is required. `job_names`\nand `job_statuses` are optional. The valid values for `job_statuses` are\ncase-insensitive: `ENABLED`, `DISABLED`, and `DELETED`."
}
},
- "flatPath": "v1/transferJobs"
+ "flatPath": "v1/transferJobs",
+ "id": "storagetransfer.transferJobs.list",
+ "path": "v1/transferJobs",
+ "description": "Lists transfer jobs."
},
"get": {
+ "flatPath": "v1/transferJobs/{transferJobsId}",
+ "path": "v1/{+jobName}",
+ "id": "storagetransfer.transferJobs.get",
"description": "Gets a transfer job.",
"httpMethod": "GET",
"parameterOrder": [
@@ -266,24 +291,15 @@
"type": "string"
},
"jobName": {
- "pattern": "^transferJobs/.+$",
"location": "path",
"description": "The job to get.\nRequired.",
"type": "string",
- "required": true
+ "required": true,
+ "pattern": "^transferJobs/.+$"
}
- },
- "flatPath": "v1/transferJobs/{transferJobsId}",
- "path": "v1/{+jobName}",
- "id": "storagetransfer.transferJobs.get"
+ }
},
"patch": {
- "id": "storagetransfer.transferJobs.patch",
- "path": "v1/{+jobName}",
- "request": {
- "$ref": "UpdateTransferJobRequest"
- },
- "description": "Updates a transfer job. Updating a job's transfer spec does not affect\ntransfer operations that are running already. Updating the scheduling\nof a job is not allowed.",
"response": {
"$ref": "TransferJob"
},
@@ -296,83 +312,63 @@
],
"parameters": {
"jobName": {
+ "location": "path",
"description": "The name of job to update.\nRequired.",
"type": "string",
"required": true,
- "pattern": "^transferJobs/.+$",
- "location": "path"
+ "pattern": "^transferJobs/.+$"
}
},
- "flatPath": "v1/transferJobs/{transferJobsId}"
+ "flatPath": "v1/transferJobs/{transferJobsId}",
+ "id": "storagetransfer.transferJobs.patch",
+ "path": "v1/{+jobName}",
+ "request": {
+ "$ref": "UpdateTransferJobRequest"
+ },
+ "description": "Updates a transfer job. Updating a job's transfer spec does not affect\ntransfer operations that are running already. Updating the scheduling\nof a job is not allowed."
},
"create": {
"description": "Creates a transfer job that runs periodically.",
"request": {
"$ref": "TransferJob"
},
- "httpMethod": "POST",
- "parameterOrder": [],
"response": {
"$ref": "TransferJob"
},
+ "parameterOrder": [],
+ "httpMethod": "POST",
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/transferJobs",
- "path": "v1/transferJobs",
- "id": "storagetransfer.transferJobs.create"
+ "id": "storagetransfer.transferJobs.create",
+ "path": "v1/transferJobs"
}
}
}
},
"parameters": {
- "alt": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
- },
- "access_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth access token."
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
"quotaUser": {
"location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string"
},
"pp": {
- "description": "Pretty-print response.",
"default": "true",
"type": "boolean",
- "location": "query"
+ "location": "query",
+ "description": "Pretty-print response."
},
"bearer_token": {
+ "location": "query",
"description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user."
},
"upload_protocol": {
"location": "query",
@@ -380,21 +376,21 @@
"type": "string"
},
"prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
"default": "true",
"type": "boolean",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "location": "query",
+ "description": "Returns response with indentations and line breaks."
},
"fields": {
"location": "query",
"description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
"$.xgafv": {
"location": "query",
"enum": [
@@ -409,198 +405,77 @@
]
},
"callback": {
- "description": "JSONP",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "JSONP"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "key": {
+ "type": "string",
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
}
},
"schemas": {
- "ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
+ "Date": {
+ "description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
"type": "object",
"properties": {
- "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"
- }
- },
- "id": "ListOperationsResponse"
- },
- "GoogleServiceAccount": {
- "type": "object",
- "properties": {
- "accountEmail": {
- "description": "Required.",
- "type": "string"
- }
- },
- "id": "GoogleServiceAccount",
- "description": "Google service account"
- },
- "TimeOfDay": {
- "type": "object",
- "properties": {
- "seconds": {
- "format": "int32",
- "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may\nallow the value 60 if it allows leap-seconds.",
- "type": "integer"
- },
- "minutes": {
+ "month": {
"type": "integer",
"format": "int32",
- "description": "Minutes of hour of day. Must be from 0 to 59."
+ "description": "Month of year. Must be from 1 to 12."
},
- "hours": {
- "format": "int32",
- "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose\nto allow the value \"24:00:00\" for scenarios like business closing time.",
- "type": "integer"
- },
- "nanos": {
- "format": "int32",
- "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.",
- "type": "integer"
- }
- },
- "id": "TimeOfDay",
- "description": "Represents a time of day. The date and time zone are either not significant\nor are specified elsewhere. An API may choose to allow leap seconds. Related\ntypes are google.type.Date and `google.protobuf.Timestamp`."
- },
- "ErrorLogEntry": {
- "description": "An entry describing an error that has occurred.",
- "type": "object",
- "properties": {
- "errorDetails": {
- "description": "A list of messages that carry the error details.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "url": {
- "description": "A URL that refers to the target (a data source, a data sink,\nor an object) with which the error is associated.\nRequired.",
- "type": "string"
- }
- },
- "id": "ErrorLogEntry"
- },
- "TransferJob": {
- "description": "This resource represents the configuration of a transfer job that runs\nperiodically.",
- "type": "object",
- "properties": {
- "schedule": {
- "$ref": "Schedule",
- "description": "Schedule specification."
- },
- "name": {
- "description": "A globally unique name assigned by Storage Transfer Service when the\njob is created. This field should be left empty in requests to create a new\ntransfer job; otherwise, the requests result in an `INVALID_ARGUMENT`\nerror.",
- "type": "string"
- },
- "deletionTime": {
- "format": "google-datetime",
- "description": "This field cannot be changed by user requests.",
- "type": "string"
- },
- "lastModificationTime": {
- "format": "google-datetime",
- "description": "This field cannot be changed by user requests.",
- "type": "string"
- },
- "projectId": {
- "description": "The ID of the Google Cloud Platform Console project that owns the job.",
- "type": "string"
- },
- "description": {
- "description": "A description provided by the user for the job. Its max length is 1024\nbytes when Unicode-encoded.",
- "type": "string"
- },
- "transferSpec": {
- "$ref": "TransferSpec",
- "description": "Transfer specification."
- },
- "creationTime": {
- "format": "google-datetime",
- "description": "This field cannot be changed by user requests.",
- "type": "string"
- },
- "status": {
- "enumDescriptions": [
- "Zero is an illegal value.",
- "New transfers will be performed based on the schedule.",
- "New transfers will not be scheduled.",
- "This is a soft delete state. After a transfer job is set to this\nstate, the job and all the transfer executions are subject to\ngarbage collection."
- ],
- "enum": [
- "STATUS_UNSPECIFIED",
- "ENABLED",
- "DISABLED",
- "DELETED"
- ],
- "description": "Status of the job. This value MUST be specified for\n`CreateTransferJobRequests`.\n\nNOTE: The effect of the new job status takes place during a subsequent job\nrun. For example, if you change the job status from `ENABLED` to\n`DISABLED`, and an operation spawned by the transfer is running, the status\nchange would not affect the current operation.",
- "type": "string"
- }
- },
- "id": "TransferJob"
- },
- "Schedule": {
- "id": "Schedule",
- "description": "Transfers can be scheduled to recur or to run just once.",
- "type": "object",
- "properties": {
- "scheduleEndDate": {
- "description": "The last day the recurring transfer will be run. If `scheduleEndDate`\nis the same as `scheduleStartDate`, the transfer will be executed only\nonce.",
- "$ref": "Date"
- },
- "startTimeOfDay": {
- "$ref": "TimeOfDay",
- "description": "The time in UTC at which the transfer will be scheduled to start in a day.\nTransfers may start later than this time. If not specified, recurring and\none-time transfers that are scheduled to run today will run immediately;\nrecurring transfers that are scheduled to run on a future date will start\nat approximately midnight UTC on that date. Note that when configuring a\ntransfer with the Cloud Platform Console, the transfer's start time in a\nday is specified in your local timezone."
- },
- "scheduleStartDate": {
- "$ref": "Date",
- "description": "The first day the recurring transfer is scheduled to run. If\n`scheduleStartDate` is in the past, the transfer will run for the first\ntime on the following day.\nRequired."
- }
- }
- },
- "Date": {
- "properties": {
"day": {
"format": "int32",
"description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.",
"type": "integer"
},
"year": {
+ "type": "integer",
"format": "int32",
- "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
- "type": "integer"
- },
- "month": {
- "format": "int32",
- "description": "Month of year. Must be from 1 to 12.",
- "type": "integer"
+ "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year."
}
},
- "id": "Date",
- "description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
- "type": "object"
+ "id": "Date"
},
"TransferOperation": {
- "description": "A description of the execution of a transfer.",
"type": "object",
"properties": {
"transferJobName": {
- "description": "The name of the transfer job that triggers this transfer operation.",
- "type": "string"
+ "type": "string",
+ "description": "The name of the transfer job that triggers this transfer operation."
},
"transferSpec": {
- "description": "Transfer specification.\nRequired.",
- "$ref": "TransferSpec"
+ "$ref": "TransferSpec",
+ "description": "Transfer specification.\nRequired."
+ },
+ "counters": {
+ "$ref": "TransferCounters",
+ "description": "Information about the progress of the transfer operation."
},
"status": {
+ "type": "string",
"enumDescriptions": [
"Zero is an illegal value.",
"In progress.",
@@ -617,32 +492,27 @@
"FAILED",
"ABORTED"
],
- "description": "Status of the transfer operation.",
- "type": "string"
- },
- "counters": {
- "$ref": "TransferCounters",
- "description": "Information about the progress of the transfer operation."
+ "description": "Status of the transfer operation."
},
"errorBreakdowns": {
- "description": "Summarizes errors encountered with sample error log entries.",
"items": {
"$ref": "ErrorSummary"
},
- "type": "array"
+ "type": "array",
+ "description": "Summarizes errors encountered with sample error log entries."
},
"name": {
"description": "A globally unique ID assigned by the system.",
"type": "string"
},
"projectId": {
- "description": "The ID of the Google Cloud Platform Console project that owns the operation.\nRequired.",
- "type": "string"
+ "type": "string",
+ "description": "The ID of the Google Cloud Platform Console project that owns the operation.\nRequired."
},
"endTime": {
+ "type": "string",
"format": "google-datetime",
- "description": "End time of this transfer execution.",
- "type": "string"
+ "description": "End time of this transfer execution."
},
"startTime": {
"format": "google-datetime",
@@ -650,44 +520,45 @@
"type": "string"
}
},
- "id": "TransferOperation"
+ "id": "TransferOperation",
+ "description": "A description of the execution of a transfer."
},
"AwsS3Data": {
"description": "An AwsS3Data can be a data source, but not a data sink.\nIn an AwsS3Data, an object's name is the S3 object's key name.",
"type": "object",
"properties": {
+ "awsAccessKey": {
+ "$ref": "AwsAccessKey",
+ "description": "AWS access key used to sign the API requests to the AWS S3 bucket.\nPermissions on the bucket must be granted to the access ID of the\nAWS access key.\nRequired."
+ },
"bucketName": {
"description": "S3 Bucket name (see\n[Creating a bucket](http://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-location-example.html)).\nRequired.",
"type": "string"
- },
- "awsAccessKey": {
- "description": "AWS access key used to sign the API requests to the AWS S3 bucket.\nPermissions on the bucket must be granted to the access ID of the\nAWS access key.\nRequired.",
- "$ref": "AwsAccessKey"
}
},
"id": "AwsS3Data"
},
+ "Empty": {
+ "type": "object",
+ "properties": {},
+ "id": "Empty",
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`."
+ },
"AwsAccessKey": {
"type": "object",
"properties": {
"accessKeyId": {
- "type": "string",
- "description": "AWS access key ID.\nRequired."
+ "description": "AWS access key ID.\nRequired.",
+ "type": "string"
},
"secretAccessKey": {
- "description": "AWS secret access key. This field is not returned in RPC responses.\nRequired.",
- "type": "string"
+ "type": "string",
+ "description": "AWS secret access key. This field is not returned in RPC responses.\nRequired."
}
},
"id": "AwsAccessKey",
"description": "AWS access key (see\n[AWS Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html))."
},
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
"PauseTransferOperationRequest": {
"description": "Request passed to PauseTransferOperation.",
"type": "object",
@@ -698,15 +569,35 @@
"description": "A collection of counters that report the progress of a transfer operation.",
"type": "object",
"properties": {
- "objectsDeletedFromSource": {
+ "bytesFromSourceFailed": {
+ "type": "string",
"format": "int64",
- "description": "Objects that are deleted from the data source.",
- "type": "string"
+ "description": "Bytes in the data source that failed during the transfer."
+ },
+ "objectsFromSourceFailed": {
+ "type": "string",
+ "format": "int64",
+ "description": "Objects in the data source that failed during the transfer."
+ },
+ "objectsCopiedToSink": {
+ "type": "string",
+ "format": "int64",
+ "description": "Objects that are copied to the data sink."
+ },
+ "bytesFoundOnlyFromSink": {
+ "type": "string",
+ "format": "int64",
+ "description": "Bytes found only in the data sink that are scheduled to be deleted."
+ },
+ "objectsDeletedFromSource": {
+ "type": "string",
+ "format": "int64",
+ "description": "Objects that are deleted from the data source."
},
"bytesCopiedToSink": {
+ "type": "string",
"format": "int64",
- "description": "Bytes that are copied to the data sink.",
- "type": "string"
+ "description": "Bytes that are copied to the data sink."
},
"objectsFromSourceSkippedBySync": {
"format": "int64",
@@ -724,14 +615,14 @@
"description": "Objects found in the data source that are scheduled to be transferred,\nwhich will be copied, excluded based on conditions, or skipped due to\nfailures."
},
"bytesDeletedFromSource": {
+ "type": "string",
"format": "int64",
- "description": "Bytes that are deleted from the data source.",
- "type": "string"
+ "description": "Bytes that are deleted from the data source."
},
"objectsFailedToDeleteFromSink": {
+ "type": "string",
"format": "int64",
- "description": "Objects that failed to be deleted from the data sink.",
- "type": "string"
+ "description": "Objects that failed to be deleted from the data sink."
},
"objectsFoundOnlyFromSink": {
"format": "int64",
@@ -749,34 +640,14 @@
"type": "string"
},
"bytesFailedToDeleteFromSink": {
+ "type": "string",
"format": "int64",
- "description": "Bytes that failed to be deleted from the data sink.",
- "type": "string"
+ "description": "Bytes that failed to be deleted from the data sink."
},
"bytesDeletedFromSink": {
+ "type": "string",
"format": "int64",
- "description": "Bytes that are deleted from the data sink.",
- "type": "string"
- },
- "bytesFromSourceFailed": {
- "format": "int64",
- "description": "Bytes in the data source that failed during the transfer.",
- "type": "string"
- },
- "objectsFromSourceFailed": {
- "format": "int64",
- "description": "Objects in the data source that failed during the transfer.",
- "type": "string"
- },
- "objectsCopiedToSink": {
- "format": "int64",
- "description": "Objects that are copied to the data sink.",
- "type": "string"
- },
- "bytesFoundOnlyFromSink": {
- "format": "int64",
- "description": "Bytes found only in the data sink that are scheduled to be deleted.",
- "type": "string"
+ "description": "Bytes that are deleted from the data sink."
}
},
"id": "TransferCounters"
@@ -786,6 +657,7 @@
"type": "object",
"properties": {
"errorCode": {
+ "type": "string",
"enumDescriptions": [
"Not an error; returned on success\n\nHTTP Mapping: 200 OK",
"The operation was cancelled, typically by the caller.\n\nHTTP Mapping: 499 Client Closed Request",
@@ -824,20 +696,19 @@
"UNAVAILABLE",
"DATA_LOSS"
],
- "description": "Required.",
- "type": "string"
+ "description": "Required."
},
"errorCount": {
+ "type": "string",
"format": "int64",
- "description": "Count of this type of error.\nRequired.",
- "type": "string"
+ "description": "Count of this type of error.\nRequired."
},
"errorLogEntries": {
- "description": "Error samples.",
"items": {
"$ref": "ErrorLogEntry"
},
- "type": "array"
+ "type": "array",
+ "description": "Error samples."
}
},
"id": "ErrorSummary"
@@ -854,7 +725,6 @@
"description": "An HttpData specifies a list of objects on the web to be transferred over\nHTTP. The information of the objects to be transferred is contained in a\nfile referenced by a URL. The first line in the file must be\n\"TsvHttpData-1.0\", which specifies the format of the file. Subsequent lines\nspecify the information of the list of objects, one object per list entry.\nEach entry has the following tab-delimited fields:\n\n* HTTP URL - The location of the object.\n\n* Length - The size of the object in bytes.\n\n* MD5 - The base64-encoded MD5 hash of the object.\n\nFor an example of a valid TSV file, see\n[Transferring data from URLs](https://cloud.google.com/storage/transfer/create-url-list).\n\nWhen transferring data based on a URL list, keep the following in mind:\n\n* When an object located at `http(s)://hostname:port/\u003cURL-path\u003e` is transferred\nto a data sink, the name of the object at the data sink is\n`\u003chostname\u003e/\u003cURL-path\u003e`.\n\n* If the specified size of an object does not match the actual size of the\nobject fetched, the object will not be transferred.\n\n* If the specified MD5 does not match the MD5 computed from the transferred\nbytes, the object transfer will fail. For more information, see\n[Generating MD5 hashes](https://cloud.google.com/storage/transfer/#md5)\n\n* Ensure that each URL you specify is publicly accessible. For\nexample, in Google Cloud Storage you can\n[share an object publicly]\n(https://cloud.google.com/storage/docs/cloud-console#_sharingdata) and get\na link to it.\n\n* Storage Transfer Service obeys `robots.txt` rules and requires the source\nHTTP server to support `Range` requests and to return a `Content-Length`\nheader in each response.\n\n* [ObjectConditions](#ObjectConditions) have no effect when filtering objects\nto transfer."
},
"GcsData": {
- "description": "In a GcsData, an object's name is the Google Cloud Storage object's name and\nits `lastModificationTime` refers to the object's updated time, which changes\nwhen the content or the metadata of the object is updated.",
"type": "object",
"properties": {
"bucketName": {
@@ -862,10 +732,10 @@
"type": "string"
}
},
- "id": "GcsData"
+ "id": "GcsData",
+ "description": "In a GcsData, an object's name is the Google Cloud Storage object's name and\nits `lastModificationTime` refers to the object's updated time, which changes\nwhen the content or the metadata of the object is updated."
},
"ListTransferJobsResponse": {
- "description": "Response from ListTransferJobs.",
"type": "object",
"properties": {
"nextPageToken": {
@@ -880,77 +750,75 @@
"type": "array"
}
},
- "id": "ListTransferJobsResponse"
+ "id": "ListTransferJobsResponse",
+ "description": "Response from ListTransferJobs."
},
"UpdateTransferJobRequest": {
"description": "Request passed to UpdateTransferJob.",
"type": "object",
"properties": {
- "transferJob": {
- "description": "The job to update. `transferJob` is expected to specify only three fields:\n`description`, `transferSpec`, and `status`. An UpdateTransferJobRequest\nthat specifies other fields will be rejected with an error\n`INVALID_ARGUMENT`.\nRequired.",
- "$ref": "TransferJob"
- },
"projectId": {
- "description": "The ID of the Google Cloud Platform Console project that owns the job.\nRequired.",
- "type": "string"
+ "type": "string",
+ "description": "The ID of the Google Cloud Platform Console project that owns the job.\nRequired."
},
"updateTransferJobFieldMask": {
+ "type": "string",
"format": "google-fieldmask",
- "description": "The field mask of the fields in `transferJob` that are to be updated in\nthis request. Fields in `transferJob` that can be updated are:\n`description`, `transferSpec`, and `status`. To update the `transferSpec`\nof the job, a complete transfer specification has to be provided. An\nincomplete specification which misses any required fields will be rejected\nwith the error `INVALID_ARGUMENT`.",
- "type": "string"
+ "description": "The field mask of the fields in `transferJob` that are to be updated in\nthis request. Fields in `transferJob` that can be updated are:\n`description`, `transferSpec`, and `status`. To update the `transferSpec`\nof the job, a complete transfer specification has to be provided. An\nincomplete specification which misses any required fields will be rejected\nwith the error `INVALID_ARGUMENT`."
+ },
+ "transferJob": {
+ "$ref": "TransferJob",
+ "description": "The job to update. `transferJob` is expected to specify only three fields:\n`description`, `transferSpec`, and `status`. An UpdateTransferJobRequest\nthat specifies other fields will be rejected with an error\n`INVALID_ARGUMENT`.\nRequired."
}
},
"id": "UpdateTransferJobRequest"
},
"ObjectConditions": {
- "description": "Conditions that determine which objects will be transferred.",
"type": "object",
"properties": {
"maxTimeElapsedSinceLastModification": {
+ "type": "string",
"format": "google-duration",
- "description": "`maxTimeElapsedSinceLastModification` is the complement to\n`minTimeElapsedSinceLastModification`.",
- "type": "string"
+ "description": "`maxTimeElapsedSinceLastModification` is the complement to\n`minTimeElapsedSinceLastModification`."
},
"includePrefixes": {
- "description": "If `includePrefixes` is specified, objects that satisfy the object\nconditions must have names that start with one of the `includePrefixes`\nand that do not start with any of the `excludePrefixes`. If `includePrefixes`\nis not specified, all objects except those that have names starting with\none of the `excludePrefixes` must satisfy the object conditions.\n\nRequirements:\n\n * Each include-prefix and exclude-prefix can contain any sequence of\n Unicode characters, of max length 1024 bytes when UTF8-encoded, and\n must not contain Carriage Return or Line Feed characters. Wildcard\n matching and regular expression matching are not supported.\n\n * Each include-prefix and exclude-prefix must omit the leading slash.\n For example, to include the `requests.gz` object in a transfer from\n `s3://my-aws-bucket/logs/y=2015/requests.gz`, specify the include\n prefix as `logs/y=2015/requests.gz`.\n\n * None of the include-prefix or the exclude-prefix values can be empty,\n if specified.\n\n * Each include-prefix must include a distinct portion of the object\n namespace, i.e., no include-prefix may be a prefix of another\n include-prefix.\n\n * Each exclude-prefix must exclude a distinct portion of the object\n namespace, i.e., no exclude-prefix may be a prefix of another\n exclude-prefix.\n\n * If `includePrefixes` is specified, then each exclude-prefix must start\n with the value of a path explicitly included by `includePrefixes`.\n\nThe max size of `includePrefixes` is 1000.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "If `includePrefixes` is specified, objects that satisfy the object\nconditions must have names that start with one of the `includePrefixes`\nand that do not start with any of the `excludePrefixes`. If `includePrefixes`\nis not specified, all objects except those that have names starting with\none of the `excludePrefixes` must satisfy the object conditions.\n\nRequirements:\n\n * Each include-prefix and exclude-prefix can contain any sequence of\n Unicode characters, of max length 1024 bytes when UTF8-encoded, and\n must not contain Carriage Return or Line Feed characters. Wildcard\n matching and regular expression matching are not supported.\n\n * Each include-prefix and exclude-prefix must omit the leading slash.\n For example, to include the `requests.gz` object in a transfer from\n `s3://my-aws-bucket/logs/y=2015/requests.gz`, specify the include\n prefix as `logs/y=2015/requests.gz`.\n\n * None of the include-prefix or the exclude-prefix values can be empty,\n if specified.\n\n * Each include-prefix must include a distinct portion of the object\n namespace, i.e., no include-prefix may be a prefix of another\n include-prefix.\n\n * Each exclude-prefix must exclude a distinct portion of the object\n namespace, i.e., no exclude-prefix may be a prefix of another\n exclude-prefix.\n\n * If `includePrefixes` is specified, then each exclude-prefix must start\n with the value of a path explicitly included by `includePrefixes`.\n\nThe max size of `includePrefixes` is 1000."
+ },
+ "excludePrefixes": {
+ "description": "`excludePrefixes` must follow the requirements described for\n`includePrefixes`.\n\nThe max size of `excludePrefixes` is 1000.",
"items": {
"type": "string"
},
"type": "array"
},
- "excludePrefixes": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "`excludePrefixes` must follow the requirements described for\n`includePrefixes`.\n\nThe max size of `excludePrefixes` is 1000."
- },
"minTimeElapsedSinceLastModification": {
+ "type": "string",
"format": "google-duration",
- "description": "If unspecified, `minTimeElapsedSinceLastModification` takes a zero value\nand `maxTimeElapsedSinceLastModification` takes the maximum possible\nvalue of Duration. Objects that satisfy the object conditions\nmust either have a `lastModificationTime` greater or equal to\n`NOW` - `maxTimeElapsedSinceLastModification` and less than\n`NOW` - `minTimeElapsedSinceLastModification`, or not have a\n`lastModificationTime`.",
- "type": "string"
+ "description": "If unspecified, `minTimeElapsedSinceLastModification` takes a zero value\nand `maxTimeElapsedSinceLastModification` takes the maximum possible\nvalue of Duration. Objects that satisfy the object conditions\nmust either have a `lastModificationTime` greater or equal to\n`NOW` - `maxTimeElapsedSinceLastModification` and less than\n`NOW` - `minTimeElapsedSinceLastModification`, or not have a\n`lastModificationTime`."
}
},
- "id": "ObjectConditions"
+ "id": "ObjectConditions",
+ "description": "Conditions that determine which objects will be transferred."
},
"Operation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"type": "object",
"properties": {
- "error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure or cancellation."
- },
"metadata": {
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
- "description": "Represents the transfer operation object.",
- "type": "object"
+ "description": "Represents the transfer operation 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"
+ "type": "boolean",
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable."
},
"response": {
"additionalProperties": {
@@ -961,12 +829,15 @@
"type": "object"
},
"name": {
- "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `transferOperations/some/unique/name`.",
- "type": "string"
+ "type": "string",
+ "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `transferOperations/some/unique/name`."
+ },
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
}
},
- "id": "Operation",
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call."
+ "id": "Operation"
},
"TransferOptions": {
"description": "TransferOptions uses three boolean parameters to define the actions\nto be performed on objects in a transfer.",
@@ -977,12 +848,12 @@
"type": "boolean"
},
"deleteObjectsFromSourceAfterTransfer": {
- "description": "Whether objects should be deleted from the source after they are\ntransferred to the sink. Note that this option and\n`deleteObjectsUniqueInSink` are mutually exclusive.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "Whether objects should be deleted from the source after they are\ntransferred to the sink. Note that this option and\n`deleteObjectsUniqueInSink` are mutually exclusive."
},
"deleteObjectsUniqueInSink": {
- "description": "Whether objects that exist only in the sink should be deleted. Note that\nthis option and `deleteObjectsFromSourceAfterTransfer` are mutually\nexclusive.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "Whether objects that exist only in the sink should be deleted. Note that\nthis option and `deleteObjectsFromSourceAfterTransfer` are mutually\nexclusive."
}
},
"id": "TransferOptions"
@@ -991,29 +862,29 @@
"description": "Configuration for running a transfer.",
"type": "object",
"properties": {
- "httpDataSource": {
- "description": "An HTTP URL data source.",
- "$ref": "HttpData"
- },
- "objectConditions": {
- "description": "Only objects that satisfy these object conditions are included in the set\nof data source and data sink objects. Object conditions based on\nobjects' `lastModificationTime` do not exclude objects in a data sink.",
- "$ref": "ObjectConditions"
- },
- "gcsDataSink": {
- "$ref": "GcsData",
- "description": "A Google Cloud Storage data sink."
- },
"gcsDataSource": {
"$ref": "GcsData",
"description": "A Google Cloud Storage data source."
},
"transferOptions": {
- "description": "If the option `deleteObjectsUniqueInSink` is `true`, object conditions\nbased on objects' `lastModificationTime` are ignored and do not exclude\nobjects in a data source or a data sink.",
- "$ref": "TransferOptions"
+ "$ref": "TransferOptions",
+ "description": "If the option `deleteObjectsUniqueInSink` is `true`, object conditions\nbased on objects' `lastModificationTime` are ignored and do not exclude\nobjects in a data source or a data sink."
},
"awsS3DataSource": {
- "description": "An AWS S3 data source.",
- "$ref": "AwsS3Data"
+ "$ref": "AwsS3Data",
+ "description": "An AWS S3 data source."
+ },
+ "httpDataSource": {
+ "$ref": "HttpData",
+ "description": "An HTTP URL data source."
+ },
+ "objectConditions": {
+ "$ref": "ObjectConditions",
+ "description": "Only objects that satisfy these object conditions are included in the set\nof data source and data sink objects. Object conditions based on\nobjects' `lastModificationTime` do not exclude objects in a data sink."
+ },
+ "gcsDataSink": {
+ "$ref": "GcsData",
+ "description": "A Google Cloud Storage data sink."
}
},
"id": "TransferSpec"
@@ -1027,8 +898,8 @@
"items": {
"type": "object",
"additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
}
},
"type": "array"
@@ -1046,32 +917,161 @@
"id": "Status"
},
"ResumeTransferOperationRequest": {
- "description": "Request passed to ResumeTransferOperation.",
"type": "object",
"properties": {},
- "id": "ResumeTransferOperationRequest"
- }
- },
- "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://storagetransfer.googleapis.com/",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
+ "id": "ResumeTransferOperationRequest",
+ "description": "Request passed to ResumeTransferOperation."
+ },
+ "ListOperationsResponse": {
+ "type": "object",
+ "properties": {
+ "operations": {
+ "items": {
+ "$ref": "Operation"
+ },
+ "type": "array",
+ "description": "A list of operations that matches the specified filter in the request."
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
}
- }
+ },
+ "id": "ListOperationsResponse",
+ "description": "The response message for Operations.ListOperations."
+ },
+ "GoogleServiceAccount": {
+ "description": "Google service account",
+ "type": "object",
+ "properties": {
+ "accountEmail": {
+ "type": "string",
+ "description": "Required."
+ }
+ },
+ "id": "GoogleServiceAccount"
+ },
+ "TimeOfDay": {
+ "description": "Represents a time of day. The date and time zone are either not significant\nor are specified elsewhere. An API may choose to allow leap seconds. Related\ntypes are google.type.Date and `google.protobuf.Timestamp`.",
+ "type": "object",
+ "properties": {
+ "seconds": {
+ "format": "int32",
+ "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may\nallow the value 60 if it allows leap-seconds.",
+ "type": "integer"
+ },
+ "minutes": {
+ "format": "int32",
+ "description": "Minutes of hour of day. Must be from 0 to 59.",
+ "type": "integer"
+ },
+ "hours": {
+ "format": "int32",
+ "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose\nto allow the value \"24:00:00\" for scenarios like business closing time.",
+ "type": "integer"
+ },
+ "nanos": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999."
+ }
+ },
+ "id": "TimeOfDay"
+ },
+ "ErrorLogEntry": {
+ "description": "An entry describing an error that has occurred.",
+ "type": "object",
+ "properties": {
+ "errorDetails": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "description": "A list of messages that carry the error details."
+ },
+ "url": {
+ "type": "string",
+ "description": "A URL that refers to the target (a data source, a data sink,\nor an object) with which the error is associated.\nRequired."
+ }
+ },
+ "id": "ErrorLogEntry"
+ },
+ "TransferJob": {
+ "description": "This resource represents the configuration of a transfer job that runs\nperiodically.",
+ "type": "object",
+ "properties": {
+ "status": {
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "ENABLED",
+ "DISABLED",
+ "DELETED"
+ ],
+ "description": "Status of the job. This value MUST be specified for\n`CreateTransferJobRequests`.\n\nNOTE: The effect of the new job status takes place during a subsequent job\nrun. For example, if you change the job status from `ENABLED` to\n`DISABLED`, and an operation spawned by the transfer is running, the status\nchange would not affect the current operation.",
+ "type": "string",
+ "enumDescriptions": [
+ "Zero is an illegal value.",
+ "New transfers will be performed based on the schedule.",
+ "New transfers will not be scheduled.",
+ "This is a soft delete state. After a transfer job is set to this\nstate, the job and all the transfer executions are subject to\ngarbage collection."
+ ]
+ },
+ "schedule": {
+ "$ref": "Schedule",
+ "description": "Schedule specification."
+ },
+ "deletionTime": {
+ "format": "google-datetime",
+ "description": "This field cannot be changed by user requests.",
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "description": "A globally unique name assigned by Storage Transfer Service when the\njob is created. This field should be left empty in requests to create a new\ntransfer job; otherwise, the requests result in an `INVALID_ARGUMENT`\nerror."
+ },
+ "lastModificationTime": {
+ "format": "google-datetime",
+ "description": "This field cannot be changed by user requests.",
+ "type": "string"
+ },
+ "projectId": {
+ "type": "string",
+ "description": "The ID of the Google Cloud Platform Console project that owns the job."
+ },
+ "description": {
+ "description": "A description provided by the user for the job. Its max length is 1024\nbytes when Unicode-encoded.",
+ "type": "string"
+ },
+ "creationTime": {
+ "type": "string",
+ "format": "google-datetime",
+ "description": "This field cannot be changed by user requests."
+ },
+ "transferSpec": {
+ "$ref": "TransferSpec",
+ "description": "Transfer specification."
+ }
+ },
+ "id": "TransferJob"
+ },
+ "Schedule": {
+ "type": "object",
+ "properties": {
+ "scheduleStartDate": {
+ "$ref": "Date",
+ "description": "The first day the recurring transfer is scheduled to run. If\n`scheduleStartDate` is in the past, the transfer will run for the first\ntime on the following day.\nRequired."
+ },
+ "scheduleEndDate": {
+ "$ref": "Date",
+ "description": "The last day the recurring transfer will be run. If `scheduleEndDate`\nis the same as `scheduleStartDate`, the transfer will be executed only\nonce."
+ },
+ "startTimeOfDay": {
+ "$ref": "TimeOfDay",
+ "description": "The time in UTC at which the transfer will be scheduled to start in a day.\nTransfers may start later than this time. If not specified, recurring and\none-time transfers that are scheduled to run today will run immediately;\nrecurring transfers that are scheduled to run on a future date will start\nat approximately midnight UTC on that date. Note that when configuring a\ntransfer with the Cloud Platform Console, the transfer's start time in a\nday is specified in your local timezone."
+ }
+ },
+ "id": "Schedule",
+ "description": "Transfers can be scheduled to recur or to run just once."
}
- },
- "kind": "discovery#restDescription",
- "description": "Transfers data from external data sources to a Google Cloud Storage bucket or between Google Cloud Storage buckets.",
- "servicePath": "",
- "rootUrl": "https://storagetransfer.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com"
+ }
}
diff --git a/streetviewpublish/v1/streetviewpublish-api.json b/streetviewpublish/v1/streetviewpublish-api.json
index bc6bb1d..6108e0a 100644
--- a/streetviewpublish/v1/streetviewpublish-api.json
+++ b/streetviewpublish/v1/streetviewpublish-api.json
@@ -1,140 +1,349 @@
{
- "baseUrl": "https://streetviewpublish.googleapis.com/",
- "servicePath": "",
- "kind": "discovery#restDescription",
- "description": "Publishes 360 photos to Google Maps, along with position, orientation, and connectivity metadata. Apps can offer an interface for positioning, connecting, and uploading user-generated Street View images.\n",
- "basePath": "",
- "id": "streetviewpublish:v1",
- "documentationLink": "https://developers.google.com/streetview/publish/",
- "revision": "20171009",
- "discoveryVersion": "v1",
- "version_module": true,
- "schemas": {
- "LatLng": {
- "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.\n\nExample of normalization code in Python:\n\n def NormalizeLongitude(longitude):\n \"\"\"Wraps decimal degrees longitude to [-180.0, 180.0].\"\"\"\n q, r = divmod(longitude, 360.0)\n if r \u003e 180.0 or (r == 180.0 and q \u003c= -1.0):\n return r - 360.0\n return r\n\n def NormalizeLatLng(latitude, longitude):\n \"\"\"Wraps decimal degrees latitude and longitude to\n [-90.0, 90.0] and [-180.0, 180.0], respectively.\"\"\"\n r = latitude % 360.0\n if r \u003c= 90.0:\n return r, NormalizeLongitude(longitude)\n elif r \u003e= 270.0:\n return r - 360, NormalizeLongitude(longitude)\n else:\n return 180 - r, NormalizeLongitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLongitude(181.0)\n assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)\n assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)\n assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)\n assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)\n assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)\n assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)\n assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)\n assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)",
- "type": "object",
- "properties": {
- "latitude": {
- "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
- "format": "double",
- "type": "number"
+ "ownerName": "Google",
+ "resources": {
+ "photos": {
+ "methods": {
+ "batchGet": {
+ "response": {
+ "$ref": "BatchGetPhotosResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "photoIds": {
+ "description": "Required. IDs of the Photos. For HTTP\nGET requests, the URL query parameter should be\n`photoIds=\u003cid1\u003e&photoIds=\u003cid2\u003e&...`.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
+ "view": {
+ "location": "query",
+ "enum": [
+ "BASIC",
+ "INCLUDE_DOWNLOAD_URL"
+ ],
+ "description": "Specifies if a download URL for the photo bytes should be returned in the\nPhoto response.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/streetviewpublish"
+ ],
+ "flatPath": "v1/photos:batchGet",
+ "path": "v1/photos:batchGet",
+ "id": "streetviewpublish.photos.batchGet",
+ "description": "Gets the metadata of the specified\nPhoto batch.\n\nNote that if\nBatchGetPhotos\nfails, either critical fields are missing or there was an authentication\nerror. Even if\nBatchGetPhotos\nsucceeds, there may have been failures for single photos in the batch.\nThese failures will be specified in each\nPhotoResponse.status\nin\nBatchGetPhotosResponse.results.\nSee\nGetPhoto\nfor specific failures that can occur per photo."
},
- "longitude": {
- "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
- "format": "double",
- "type": "number"
- }
- },
- "id": "LatLng"
- },
- "BatchDeletePhotosRequest": {
- "description": "Request to delete multiple Photos.",
- "type": "object",
- "properties": {
- "photoIds": {
- "description": "Required. IDs of the Photos. For HTTP\nGET requests, the URL query parameter should be\n`photoIds=\u003cid1\u003e&photoIds=\u003cid2\u003e&...`.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "BatchDeletePhotosRequest"
- },
- "UpdatePhotoRequest": {
- "type": "object",
- "properties": {
- "updateMask": {
- "description": "Mask that identifies fields on the photo metadata to update.\nIf not present, the old Photo\nmetadata will be entirely replaced with the\nnew Photo metadata in this request.\nThe update fails if invalid fields are specified. Multiple fields can be\nspecified in a comma-delimited list.\n\nThe following fields are valid:\n\n* `pose.heading`\n* `pose.latLngPair`\n* `pose.pitch`\n* `pose.roll`\n* `pose.level`\n* `pose.altitude`\n* `connections`\n* `places`\n\n\n\u003caside class=\"note\"\u003e\u003cb\u003eNote:\u003c/b\u003e Repeated fields in\nupdateMask\nmean the entire set of repeated values will be replaced with the new\ncontents. For example, if\nupdateMask\ncontains `connections` and `UpdatePhotoRequest.photo.connections` is empty,\nall connections will be removed.\u003c/aside\u003e",
- "format": "google-fieldmask",
- "type": "string"
+ "list": {
+ "description": "Lists all the Photos that belong to\nthe user.",
+ "response": {
+ "$ref": "ListPhotosResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/streetviewpublish"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "The\nnextPageToken\nvalue returned from a previous\nListPhotos\nrequest, if any.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The maximum number of photos to return.\n`pageSize` must be non-negative. If `pageSize` is zero or is not provided,\nthe default page size of 100 will be used.\nThe number of photos returned in the response may be less than `pageSize`\nif the number of photos that belong to the user is less than `pageSize`.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "view": {
+ "enum": [
+ "BASIC",
+ "INCLUDE_DOWNLOAD_URL"
+ ],
+ "description": "Specifies if a download URL for the photos bytes should be returned in the\nPhotos response.",
+ "type": "string",
+ "location": "query"
+ },
+ "filter": {
+ "description": "The filter expression. For example: `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`.\n\nThe only filter supported at the moment is `placeId`.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/photos",
+ "path": "v1/photos",
+ "id": "streetviewpublish.photos.list"
},
- "photo": {
- "$ref": "Photo",
- "description": "Required. Photo object containing the\nnew metadata."
- }
- },
- "id": "UpdatePhotoRequest",
- "description": "Request to update the metadata of a\nPhoto. Updating the pixels of a photo\nis not supported."
- },
- "PhotoId": {
- "id": "PhotoId",
- "description": "Identifier for a Photo.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Required. A unique identifier for a photo.",
- "type": "string"
+ "batchUpdate": {
+ "description": "Updates the metadata of Photos, such\nas pose, place association, connections, etc. Changing the pixels of photos\nis not supported.\n\nNote that if\nBatchUpdatePhotos\nfails, either critical fields are missing or there was an authentication\nerror. Even if\nBatchUpdatePhotos\nsucceeds, there may have been failures for single photos in the batch.\nThese failures will be specified in each\nPhotoResponse.status\nin\nBatchUpdatePhotosResponse.results.\nSee\nUpdatePhoto\nfor specific failures that can occur per photo.\n\nOnly the fields specified in\nupdateMask\nfield are used. If `updateMask` is not present, the update applies to all\nfields.\n\n\u003caside class=\"note\"\u003e\u003cb\u003eNote:\u003c/b\u003e To update\nPose.altitude,\nPose.latLngPair has to be\nfilled as well. Otherwise, the request will fail.\u003c/aside\u003e",
+ "request": {
+ "$ref": "BatchUpdatePhotosRequest"
+ },
+ "response": {
+ "$ref": "BatchUpdatePhotosResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/streetviewpublish"
+ ],
+ "parameters": {},
+ "flatPath": "v1/photos:batchUpdate",
+ "path": "v1/photos:batchUpdate",
+ "id": "streetviewpublish.photos.batchUpdate"
+ },
+ "batchDelete": {
+ "path": "v1/photos:batchDelete",
+ "id": "streetviewpublish.photos.batchDelete",
+ "description": "Deletes a list of Photos and their\nmetadata.\n\nNote that if\nBatchDeletePhotos\nfails, either critical fields are missing or there was an authentication\nerror. Even if\nBatchDeletePhotos\nsucceeds, there may have been failures for single photos in the batch.\nThese failures will be specified in each\nPhotoResponse.status\nin\nBatchDeletePhotosResponse.results.\nSee\nDeletePhoto\nfor specific failures that can occur per photo.",
+ "request": {
+ "$ref": "BatchDeletePhotosRequest"
+ },
+ "response": {
+ "$ref": "BatchDeletePhotosResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/streetviewpublish"
+ ],
+ "parameters": {},
+ "flatPath": "v1/photos:batchDelete"
}
}
},
- "Pose": {
- "properties": {
- "latLngPair": {
- "description": "Latitude and longitude pair of the pose, as explained here:\nhttps://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng\nWhen creating a Photo, if the\nlatitude and longitude pair are not provided here, the geolocation from the\nexif header will be used. If the latitude and longitude pair is not\nprovided and cannot be found in the exif header, the create photo process\nwill fail.",
- "$ref": "LatLng"
+ "photo": {
+ "methods": {
+ "delete": {
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "photoId"
+ ],
+ "parameters": {
+ "photoId": {
+ "description": "Required. ID of the Photo.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/streetviewpublish"
+ ],
+ "flatPath": "v1/photo/{photoId}",
+ "id": "streetviewpublish.photo.delete",
+ "path": "v1/photo/{photoId}",
+ "description": "Deletes a Photo and its metadata.\n\nThis method returns the following error codes:\n\n* google.rpc.Code.PERMISSION_DENIED if the requesting user did not\ncreate the requested photo.\n* google.rpc.Code.NOT_FOUND if the photo ID does not exist."
},
- "roll": {
- "description": "Roll, measured in degrees. Value must be \u003e= 0 and \u003c360. A value of 0\nmeans level with the horizon.\nNaN indicates an unmeasured quantity.",
- "format": "double",
- "type": "number"
+ "get": {
+ "description": "Gets the metadata of the specified\nPhoto.\n\nThis method returns the following error codes:\n\n* google.rpc.Code.PERMISSION_DENIED if the requesting user did not\ncreate the requested Photo.\n* google.rpc.Code.NOT_FOUND if the requested\nPhoto does not exist.",
+ "response": {
+ "$ref": "Photo"
+ },
+ "parameterOrder": [
+ "photoId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/streetviewpublish"
+ ],
+ "parameters": {
+ "photoId": {
+ "description": "Required. ID of the Photo.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "view": {
+ "enum": [
+ "BASIC",
+ "INCLUDE_DOWNLOAD_URL"
+ ],
+ "description": "Specifies if a download URL for the photo bytes should be returned in the\nPhoto response.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/photo/{photoId}",
+ "path": "v1/photo/{photoId}",
+ "id": "streetviewpublish.photo.get"
},
- "level": {
- "$ref": "Level",
- "description": "Level (the floor in a building) used to configure vertical navigation."
+ "update": {
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "id"
+ ],
+ "response": {
+ "$ref": "Photo"
+ },
+ "parameters": {
+ "id": {
+ "location": "path",
+ "description": "Required. A unique identifier for a photo.",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Mask that identifies fields on the photo metadata to update.\nIf not present, the old Photo\nmetadata will be entirely replaced with the\nnew Photo metadata in this request.\nThe update fails if invalid fields are specified. Multiple fields can be\nspecified in a comma-delimited list.\n\nThe following fields are valid:\n\n* `pose.heading`\n* `pose.latLngPair`\n* `pose.pitch`\n* `pose.roll`\n* `pose.level`\n* `pose.altitude`\n* `connections`\n* `places`\n\n\n\u003caside class=\"note\"\u003e\u003cb\u003eNote:\u003c/b\u003e Repeated fields in\nupdateMask\nmean the entire set of repeated values will be replaced with the new\ncontents. For example, if\nupdateMask\ncontains `connections` and `UpdatePhotoRequest.photo.connections` is empty,\nall connections will be removed.\u003c/aside\u003e",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/streetviewpublish"
+ ],
+ "flatPath": "v1/photo/{id}",
+ "id": "streetviewpublish.photo.update",
+ "path": "v1/photo/{id}",
+ "request": {
+ "$ref": "Photo"
+ },
+ "description": "Updates the metadata of a Photo, such\nas pose, place association, connections, etc. Changing the pixels of a\nphoto is not supported.\n\nOnly the fields specified in the\nupdateMask\nfield are used. If `updateMask` is not present, the update applies to all\nfields.\n\n\u003caside class=\"note\"\u003e\u003cb\u003eNote:\u003c/b\u003e To update\nPose.altitude,\nPose.latLngPair has to be\nfilled as well. Otherwise, the request will fail.\u003c/aside\u003e\n\nThis method returns the following error codes:\n\n* google.rpc.Code.PERMISSION_DENIED if the requesting user did not\ncreate the requested photo.\n* google.rpc.Code.INVALID_ARGUMENT if the request is malformed.\n* google.rpc.Code.NOT_FOUND if the requested photo does not exist."
},
- "heading": {
- "description": "Compass heading, measured at the center of the photo in degrees clockwise\nfrom North. Value must be \u003e=0 and \u003c360.\nNaN indicates an unmeasured quantity.",
- "format": "double",
- "type": "number"
- },
- "altitude": {
- "description": "Altitude of the pose in meters above ground level (as defined by WGS84).\nNaN indicates an unmeasured quantity.",
- "format": "double",
- "type": "number"
- },
- "pitch": {
- "description": "Pitch, measured at the center of the photo in degrees. Value must be \u003e=-90\nand \u003c= 90. A value of -90 means looking directly down, and a value of 90\nmeans looking directly up.\nNaN indicates an unmeasured quantity.",
- "format": "double",
- "type": "number"
- }
- },
- "id": "Pose",
- "description": "Raw pose measurement for an entity.",
- "type": "object"
- },
- "BatchUpdatePhotosRequest": {
- "type": "object",
- "properties": {
- "updatePhotoRequests": {
- "description": "Required. List of\nUpdatePhotoRequests.",
- "type": "array",
- "items": {
- "$ref": "UpdatePhotoRequest"
- }
- }
- },
- "id": "BatchUpdatePhotosRequest",
- "description": "Request to update the metadata of photos.\nUpdating the pixels of photos is not supported."
- },
- "ListPhotosResponse": {
- "description": "Response to list all photos that belong to a user.",
- "type": "object",
- "properties": {
- "photos": {
- "description": "List of photos. The maximum number of items returned is based on the\npageSize field\nin the request.",
- "type": "array",
- "items": {
+ "create": {
+ "response": {
+ "$ref": "Photo"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/streetviewpublish"
+ ],
+ "parameters": {},
+ "flatPath": "v1/photo",
+ "path": "v1/photo",
+ "id": "streetviewpublish.photo.create",
+ "description": "After the client finishes uploading the photo with the returned\nUploadRef,\nCreatePhoto\npublishes the uploaded Photo to\nStreet View on Google Maps.\n\nCurrently, the only way to set heading, pitch, and roll in CreatePhoto is\nthrough the [Photo Sphere XMP\nmetadata](https://developers.google.com/streetview/spherical-metadata) in\nthe photo bytes. The `pose.heading`, `pose.pitch`, `pose.roll`,\n`pose.altitude`, and `pose.level` fields in Pose are ignored for\nCreatePhoto.\n\nThis method returns the following error codes:\n\n* google.rpc.Code.INVALID_ARGUMENT if the request is malformed.\n* google.rpc.Code.NOT_FOUND if the upload reference does not exist.\n* google.rpc.Code.RESOURCE_EXHAUSTED if the account has reached the\nstorage limit.",
+ "request": {
"$ref": "Photo"
}
},
- "nextPageToken": {
- "description": "Token to retrieve the next page of results, or empty if there are no more\nresults in the list.",
- "type": "string"
+ "startUpload": {
+ "response": {
+ "$ref": "UploadRef"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/streetviewpublish"
+ ],
+ "flatPath": "v1/photo:startUpload",
+ "path": "v1/photo:startUpload",
+ "id": "streetviewpublish.photo.startUpload",
+ "request": {
+ "$ref": "Empty"
+ },
+ "description": "Creates an upload session to start uploading photo bytes. The upload URL of\nthe returned UploadRef is used to\nupload the bytes for the Photo.\n\nIn addition to the photo requirements shown in\nhttps://support.google.com/maps/answer/7012050?hl=en&ref_topic=6275604,\nthe photo must also meet the following requirements:\n\n* Photo Sphere XMP metadata must be included in the photo medadata. See\nhttps://developers.google.com/streetview/spherical-metadata for the\nrequired fields.\n* The pixel size of the photo must meet the size requirements listed in\nhttps://support.google.com/maps/answer/7012050?hl=en&ref_topic=6275604, and\nthe photo must be a full 360 horizontally.\n\nAfter the upload is complete, the\nUploadRef is used with\nCreatePhoto\nto create the Photo object entry."
}
- },
- "id": "ListPhotosResponse"
+ }
+ }
+ },
+ "parameters": {
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
},
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://streetviewpublish.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Publishes 360 photos to Google Maps, along with position, orientation, and connectivity metadata. Apps can offer an interface for positioning, connecting, and uploading user-generated Street View images.\n",
+ "servicePath": "",
+ "basePath": "",
+ "revision": "20171012",
+ "documentationLink": "https://developers.google.com/streetview/publish/",
+ "id": "streetviewpublish:v1",
+ "discoveryVersion": "v1",
+ "version_module": true,
+ "schemas": {
"Photo": {
"description": "Photo is used to store 360 photos along with photo metadata.",
"type": "object",
@@ -149,21 +358,14 @@
"type": "string"
},
"viewCount": {
- "type": "string",
"description": "Output only. View count of the photo.",
- "format": "int64"
+ "format": "int64",
+ "type": "string"
},
"downloadUrl": {
"description": "Output only. The download URL for the photo bytes. This field is set only\nwhen\nGetPhotoRequest.view\nis set to\nPhotoView.INCLUDE_DOWNLOAD_URL.",
"type": "string"
},
- "connections": {
- "description": "Connections to other photos. A connection represents the link from this\nphoto to another photo.",
- "type": "array",
- "items": {
- "$ref": "Connection"
- }
- },
"places": {
"description": "Places where this photo belongs.",
"type": "array",
@@ -171,18 +373,25 @@
"$ref": "Place"
}
},
- "pose": {
- "description": "Pose of the photo.",
- "$ref": "Pose"
- },
- "photoId": {
- "description": "Required when updating a photo. Output only when creating a photo.\nIdentifier for the photo, which is unique among all photos in\nGoogle.",
- "$ref": "PhotoId"
+ "connections": {
+ "description": "Connections to other photos. A connection represents the link from this\nphoto to another photo.",
+ "type": "array",
+ "items": {
+ "$ref": "Connection"
+ }
},
"uploadReference": {
"description": "Required when creating a photo. Input only. The resource URL where the\nphoto bytes are uploaded to.",
"$ref": "UploadRef"
},
+ "pose": {
+ "$ref": "Pose",
+ "description": "Pose of the photo."
+ },
+ "photoId": {
+ "$ref": "PhotoId",
+ "description": "Required when updating a photo. Output only when creating a photo.\nIdentifier for the photo, which is unique among all photos in\nGoogle."
+ },
"shareLink": {
"description": "Output only. The share link for the photo.",
"type": "string"
@@ -229,29 +438,30 @@
"description": "Response payload for a single\nPhoto\nin batch operations including\nBatchGetPhotos\nand\nBatchUpdatePhotos.",
"type": "object",
"properties": {
- "status": {
- "$ref": "Status",
- "description": "The status for the operation to get or update a single photo in the batch\nrequest."
- },
"photo": {
"description": "The Photo resource, if the request\nwas successful.",
"$ref": "Photo"
+ },
+ "status": {
+ "description": "The status for the operation to get or update a single photo in the batch\nrequest.",
+ "$ref": "Status"
}
},
"id": "PhotoResponse"
},
"Connection": {
- "description": "A connection is the link from a source photo to a destination photo.",
- "type": "object",
"properties": {
"target": {
- "$ref": "PhotoId",
- "description": "Required. The destination of the connection from the containing photo to\nanother photo."
+ "description": "Required. The destination of the connection from the containing photo to\nanother photo.",
+ "$ref": "PhotoId"
}
},
- "id": "Connection"
+ "id": "Connection",
+ "description": "A connection is the link from a source photo to a destination photo.",
+ "type": "object"
},
"BatchUpdatePhotosResponse": {
+ "description": "Response to batch update of metadata of one or more\nPhotos.",
"type": "object",
"properties": {
"results": {
@@ -262,13 +472,30 @@
}
}
},
- "id": "BatchUpdatePhotosResponse",
- "description": "Response to batch update of metadata of one or more\nPhotos."
+ "id": "BatchUpdatePhotosResponse"
+ },
+ "BatchDeletePhotosResponse": {
+ "properties": {
+ "status": {
+ "description": "The status for the operation to delete a single\nPhoto in the batch request.",
+ "type": "array",
+ "items": {
+ "$ref": "Status"
+ }
+ }
+ },
+ "id": "BatchDeletePhotosResponse",
+ "description": "Response to batch delete of one or more\nPhotos.",
+ "type": "object"
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"type": "array",
@@ -284,52 +511,55 @@
"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"
},
- "BatchDeletePhotosResponse": {
- "id": "BatchDeletePhotosResponse",
- "description": "Response to batch delete of one or more\nPhotos.",
- "type": "object",
- "properties": {
- "status": {
- "description": "The status for the operation to delete a single\nPhoto in the batch request.",
- "type": "array",
- "items": {
- "$ref": "Status"
- }
- }
- }
+ "Empty": {
+ "properties": {},
+ "id": "Empty",
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object"
},
"Level": {
"description": "Level information containing level number and its corresponding name.",
"type": "object",
"properties": {
+ "name": {
+ "description": "Required. A name assigned to this Level, restricted to 3 characters.\nConsider how the elevator buttons would be labeled for this level if there\nwas an elevator.",
+ "type": "string"
+ },
"number": {
"description": "Floor number, used for ordering. 0 indicates the ground level, 1 indicates\nthe first level above ground level, -1 indicates the first level under\nground level. Non-integer values are OK.",
"format": "double",
"type": "number"
- },
- "name": {
- "description": "Required. A name assigned to this Level, restricted to 3 characters.\nConsider how the elevator buttons would be labeled for this level if there\nwas an elevator.",
- "type": "string"
}
},
"id": "Level"
},
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "UploadRef": {
+ "description": "Upload reference for media files.",
"type": "object",
- "properties": {},
- "id": "Empty"
+ "properties": {
+ "uploadUrl": {
+ "description": "Required. An upload reference should be unique for each user. It follows\nthe form:\n\"https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}\"",
+ "type": "string"
+ }
+ },
+ "id": "UploadRef"
+ },
+ "Place": {
+ "properties": {
+ "placeId": {
+ "description": "Place identifier, as described in\nhttps://developers.google.com/places/place-id.",
+ "type": "string"
+ }
+ },
+ "id": "Place",
+ "description": "Place metadata for an entity.",
+ "type": "object"
},
"BatchGetPhotosResponse": {
- "type": "object",
"properties": {
"results": {
"description": "List of results for each individual\nPhoto requested, in the same order as\nthe requests in\nBatchGetPhotos.",
@@ -340,36 +570,140 @@
}
},
"id": "BatchGetPhotosResponse",
- "description": "Response to batch get of Photos."
+ "description": "Response to batch get of Photos.",
+ "type": "object"
},
- "Place": {
- "description": "Place metadata for an entity.",
- "type": "object",
+ "LatLng": {
"properties": {
- "placeId": {
- "type": "string",
- "description": "Place identifier, as described in\nhttps://developers.google.com/places/place-id."
+ "latitude": {
+ "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
+ "format": "double",
+ "type": "number"
+ },
+ "longitude": {
+ "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
+ "format": "double",
+ "type": "number"
}
},
- "id": "Place"
+ "id": "LatLng",
+ "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.\n\nExample of normalization code in Python:\n\n def NormalizeLongitude(longitude):\n \"\"\"Wraps decimal degrees longitude to [-180.0, 180.0].\"\"\"\n q, r = divmod(longitude, 360.0)\n if r \u003e 180.0 or (r == 180.0 and q \u003c= -1.0):\n return r - 360.0\n return r\n\n def NormalizeLatLng(latitude, longitude):\n \"\"\"Wraps decimal degrees latitude and longitude to\n [-90.0, 90.0] and [-180.0, 180.0], respectively.\"\"\"\n r = latitude % 360.0\n if r \u003c= 90.0:\n return r, NormalizeLongitude(longitude)\n elif r \u003e= 270.0:\n return r - 360, NormalizeLongitude(longitude)\n else:\n return 180 - r, NormalizeLongitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLongitude(181.0)\n assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)\n assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)\n assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)\n assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)\n assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)\n assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)\n assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)\n assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)",
+ "type": "object"
},
- "UploadRef": {
+ "BatchDeletePhotosRequest": {
+ "description": "Request to delete multiple Photos.",
+ "type": "object",
"properties": {
- "uploadUrl": {
- "description": "Required. An upload reference should be unique for each user. It follows\nthe form:\n\"https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}\"",
+ "photoIds": {
+ "description": "Required. IDs of the Photos. For HTTP\nGET requests, the URL query parameter should be\n`photoIds=\u003cid1\u003e&photoIds=\u003cid2\u003e&...`.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "BatchDeletePhotosRequest"
+ },
+ "UpdatePhotoRequest": {
+ "properties": {
+ "updateMask": {
+ "description": "Mask that identifies fields on the photo metadata to update.\nIf not present, the old Photo\nmetadata will be entirely replaced with the\nnew Photo metadata in this request.\nThe update fails if invalid fields are specified. Multiple fields can be\nspecified in a comma-delimited list.\n\nThe following fields are valid:\n\n* `pose.heading`\n* `pose.latLngPair`\n* `pose.pitch`\n* `pose.roll`\n* `pose.level`\n* `pose.altitude`\n* `connections`\n* `places`\n\n\n\u003caside class=\"note\"\u003e\u003cb\u003eNote:\u003c/b\u003e Repeated fields in\nupdateMask\nmean the entire set of repeated values will be replaced with the new\ncontents. For example, if\nupdateMask\ncontains `connections` and `UpdatePhotoRequest.photo.connections` is empty,\nall connections will be removed.\u003c/aside\u003e",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "photo": {
+ "description": "Required. Photo object containing the\nnew metadata.",
+ "$ref": "Photo"
+ }
+ },
+ "id": "UpdatePhotoRequest",
+ "description": "Request to update the metadata of a\nPhoto. Updating the pixels of a photo\nis not supported.",
+ "type": "object"
+ },
+ "PhotoId": {
+ "description": "Identifier for a Photo.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Required. A unique identifier for a photo.",
"type": "string"
}
},
- "id": "UploadRef",
- "description": "Upload reference for media files.",
+ "id": "PhotoId"
+ },
+ "Pose": {
+ "description": "Raw pose measurement for an entity.",
+ "type": "object",
+ "properties": {
+ "level": {
+ "description": "Level (the floor in a building) used to configure vertical navigation.",
+ "$ref": "Level"
+ },
+ "heading": {
+ "description": "Compass heading, measured at the center of the photo in degrees clockwise\nfrom North. Value must be \u003e=0 and \u003c360.\nNaN indicates an unmeasured quantity.",
+ "format": "double",
+ "type": "number"
+ },
+ "altitude": {
+ "description": "Altitude of the pose in meters above ground level (as defined by WGS84).\nNaN indicates an unmeasured quantity.",
+ "format": "double",
+ "type": "number"
+ },
+ "pitch": {
+ "description": "Pitch, measured at the center of the photo in degrees. Value must be \u003e=-90\nand \u003c= 90. A value of -90 means looking directly down, and a value of 90\nmeans looking directly up.\nNaN indicates an unmeasured quantity.",
+ "format": "double",
+ "type": "number"
+ },
+ "latLngPair": {
+ "$ref": "LatLng",
+ "description": "Latitude and longitude pair of the pose, as explained here:\nhttps://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng\nWhen creating a Photo, if the\nlatitude and longitude pair are not provided here, the geolocation from the\nexif header will be used. If the latitude and longitude pair is not\nprovided and cannot be found in the exif header, the create photo process\nwill fail."
+ },
+ "roll": {
+ "description": "Roll, measured in degrees. Value must be \u003e= 0 and \u003c360. A value of 0\nmeans level with the horizon.\nNaN indicates an unmeasured quantity.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "id": "Pose"
+ },
+ "BatchUpdatePhotosRequest": {
+ "properties": {
+ "updatePhotoRequests": {
+ "description": "Required. List of\nUpdatePhotoRequests.",
+ "type": "array",
+ "items": {
+ "$ref": "UpdatePhotoRequest"
+ }
+ }
+ },
+ "id": "BatchUpdatePhotosRequest",
+ "description": "Request to update the metadata of photos.\nUpdating the pixels of photos is not supported.",
"type": "object"
+ },
+ "ListPhotosResponse": {
+ "description": "Response to list all photos that belong to a user.",
+ "type": "object",
+ "properties": {
+ "photos": {
+ "description": "List of photos. The maximum number of items returned is based on the\npageSize field\nin the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Photo"
+ }
+ },
+ "nextPageToken": {
+ "description": "Token to retrieve the next page of results, or empty if there are no more\nresults in the list.",
+ "type": "string"
+ }
+ },
+ "id": "ListPhotosResponse"
}
},
+ "protocol": "rest",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
- "protocol": "rest",
"canonicalName": "Street View Publish",
"auth": {
"oauth2": {
@@ -385,339 +719,5 @@
"name": "streetviewpublish",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
- "title": "Street View Publish API",
- "ownerName": "Google",
- "resources": {
- "photo": {
- "methods": {
- "update": {
- "path": "v1/photo/{id}",
- "id": "streetviewpublish.photo.update",
- "request": {
- "$ref": "Photo"
- },
- "description": "Updates the metadata of a Photo, such\nas pose, place association, connections, etc. Changing the pixels of a\nphoto is not supported.\n\nOnly the fields specified in the\nupdateMask\nfield are used. If `updateMask` is not present, the update applies to all\nfields.\n\n\u003caside class=\"note\"\u003e\u003cb\u003eNote:\u003c/b\u003e To update\nPose.altitude,\nPose.latLngPair has to be\nfilled as well. Otherwise, the request will fail.\u003c/aside\u003e\n\nThis method returns the following error codes:\n\n* google.rpc.Code.PERMISSION_DENIED if the requesting user did not\ncreate the requested photo.\n* google.rpc.Code.INVALID_ARGUMENT if the request is malformed.\n* google.rpc.Code.NOT_FOUND if the requested photo does not exist.",
- "response": {
- "$ref": "Photo"
- },
- "parameterOrder": [
- "id"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "updateMask": {
- "description": "Mask that identifies fields on the photo metadata to update.\nIf not present, the old Photo\nmetadata will be entirely replaced with the\nnew Photo metadata in this request.\nThe update fails if invalid fields are specified. Multiple fields can be\nspecified in a comma-delimited list.\n\nThe following fields are valid:\n\n* `pose.heading`\n* `pose.latLngPair`\n* `pose.pitch`\n* `pose.roll`\n* `pose.level`\n* `pose.altitude`\n* `connections`\n* `places`\n\n\n\u003caside class=\"note\"\u003e\u003cb\u003eNote:\u003c/b\u003e Repeated fields in\nupdateMask\nmean the entire set of repeated values will be replaced with the new\ncontents. For example, if\nupdateMask\ncontains `connections` and `UpdatePhotoRequest.photo.connections` is empty,\nall connections will be removed.\u003c/aside\u003e",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "id": {
- "description": "Required. A unique identifier for a photo.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/streetviewpublish"
- ],
- "flatPath": "v1/photo/{id}"
- },
- "create": {
- "response": {
- "$ref": "Photo"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/streetviewpublish"
- ],
- "parameters": {},
- "flatPath": "v1/photo",
- "path": "v1/photo",
- "id": "streetviewpublish.photo.create",
- "description": "After the client finishes uploading the photo with the returned\nUploadRef,\nCreatePhoto\npublishes the uploaded Photo to\nStreet View on Google Maps.\n\nCurrently, the only way to set heading, pitch, and roll in CreatePhoto is\nthrough the [Photo Sphere XMP\nmetadata](https://developers.google.com/streetview/spherical-metadata) in\nthe photo bytes. The `pose.heading`, `pose.pitch`, `pose.roll`,\n`pose.altitude`, and `pose.level` fields in Pose are ignored for\nCreatePhoto.\n\nThis method returns the following error codes:\n\n* google.rpc.Code.INVALID_ARGUMENT if the request is malformed.\n* google.rpc.Code.NOT_FOUND if the upload reference does not exist.\n* google.rpc.Code.RESOURCE_EXHAUSTED if the account has reached the\nstorage limit.",
- "request": {
- "$ref": "Photo"
- }
- },
- "startUpload": {
- "request": {
- "$ref": "Empty"
- },
- "description": "Creates an upload session to start uploading photo bytes. The upload URL of\nthe returned UploadRef is used to\nupload the bytes for the Photo.\n\nIn addition to the photo requirements shown in\nhttps://support.google.com/maps/answer/7012050?hl=en&ref_topic=6275604,\nthe photo must also meet the following requirements:\n\n* Photo Sphere XMP metadata must be included in the photo medadata. See\nhttps://developers.google.com/streetview/spherical-metadata for the\nrequired fields.\n* The pixel size of the photo must meet the size requirements listed in\nhttps://support.google.com/maps/answer/7012050?hl=en&ref_topic=6275604, and\nthe photo must be a full 360 horizontally.\n\nAfter the upload is complete, the\nUploadRef is used with\nCreatePhoto\nto create the Photo object entry.",
- "response": {
- "$ref": "UploadRef"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/streetviewpublish"
- ],
- "flatPath": "v1/photo:startUpload",
- "path": "v1/photo:startUpload",
- "id": "streetviewpublish.photo.startUpload"
- },
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "photoId"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/streetviewpublish"
- ],
- "parameters": {
- "photoId": {
- "description": "Required. ID of the Photo.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/photo/{photoId}",
- "id": "streetviewpublish.photo.delete",
- "path": "v1/photo/{photoId}",
- "description": "Deletes a Photo and its metadata.\n\nThis method returns the following error codes:\n\n* google.rpc.Code.PERMISSION_DENIED if the requesting user did not\ncreate the requested photo.\n* google.rpc.Code.NOT_FOUND if the photo ID does not exist."
- },
- "get": {
- "flatPath": "v1/photo/{photoId}",
- "path": "v1/photo/{photoId}",
- "id": "streetviewpublish.photo.get",
- "description": "Gets the metadata of the specified\nPhoto.\n\nThis method returns the following error codes:\n\n* google.rpc.Code.PERMISSION_DENIED if the requesting user did not\ncreate the requested Photo.\n* google.rpc.Code.NOT_FOUND if the requested\nPhoto does not exist.",
- "response": {
- "$ref": "Photo"
- },
- "parameterOrder": [
- "photoId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "photoId": {
- "location": "path",
- "description": "Required. ID of the Photo.",
- "required": true,
- "type": "string"
- },
- "view": {
- "enum": [
- "BASIC",
- "INCLUDE_DOWNLOAD_URL"
- ],
- "description": "Specifies if a download URL for the photo bytes should be returned in the\nPhoto response.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/streetviewpublish"
- ]
- }
- }
- },
- "photos": {
- "methods": {
- "batchGet": {
- "response": {
- "$ref": "BatchGetPhotosResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/streetviewpublish"
- ],
- "parameters": {
- "photoIds": {
- "location": "query",
- "description": "Required. IDs of the Photos. For HTTP\nGET requests, the URL query parameter should be\n`photoIds=\u003cid1\u003e&photoIds=\u003cid2\u003e&...`.",
- "type": "string",
- "repeated": true
- },
- "view": {
- "type": "string",
- "location": "query",
- "enum": [
- "BASIC",
- "INCLUDE_DOWNLOAD_URL"
- ],
- "description": "Specifies if a download URL for the photo bytes should be returned in the\nPhoto response."
- }
- },
- "flatPath": "v1/photos:batchGet",
- "path": "v1/photos:batchGet",
- "id": "streetviewpublish.photos.batchGet",
- "description": "Gets the metadata of the specified\nPhoto batch.\n\nNote that if\nBatchGetPhotos\nfails, either critical fields are missing or there was an authentication\nerror. Even if\nBatchGetPhotos\nsucceeds, there may have been failures for single photos in the batch.\nThese failures will be specified in each\nPhotoResponse.status\nin\nBatchGetPhotosResponse.results.\nSee\nGetPhoto\nfor specific failures that can occur per photo."
- },
- "list": {
- "scopes": [
- "https://www.googleapis.com/auth/streetviewpublish"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "The\nnextPageToken\nvalue returned from a previous\nListPhotos\nrequest, if any.",
- "type": "string"
- },
- "pageSize": {
- "description": "The maximum number of photos to return.\n`pageSize` must be non-negative. If `pageSize` is zero or is not provided,\nthe default page size of 100 will be used.\nThe number of photos returned in the response may be less than `pageSize`\nif the number of photos that belong to the user is less than `pageSize`.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "view": {
- "enum": [
- "BASIC",
- "INCLUDE_DOWNLOAD_URL"
- ],
- "description": "Specifies if a download URL for the photos bytes should be returned in the\nPhotos response.",
- "type": "string",
- "location": "query"
- },
- "filter": {
- "description": "The filter expression. For example: `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`.\n\nThe only filter supported at the moment is `placeId`.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1/photos",
- "path": "v1/photos",
- "id": "streetviewpublish.photos.list",
- "description": "Lists all the Photos that belong to\nthe user.",
- "response": {
- "$ref": "ListPhotosResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET"
- },
- "batchUpdate": {
- "scopes": [
- "https://www.googleapis.com/auth/streetviewpublish"
- ],
- "parameters": {},
- "flatPath": "v1/photos:batchUpdate",
- "path": "v1/photos:batchUpdate",
- "id": "streetviewpublish.photos.batchUpdate",
- "description": "Updates the metadata of Photos, such\nas pose, place association, connections, etc. Changing the pixels of photos\nis not supported.\n\nNote that if\nBatchUpdatePhotos\nfails, either critical fields are missing or there was an authentication\nerror. Even if\nBatchUpdatePhotos\nsucceeds, there may have been failures for single photos in the batch.\nThese failures will be specified in each\nPhotoResponse.status\nin\nBatchUpdatePhotosResponse.results.\nSee\nUpdatePhoto\nfor specific failures that can occur per photo.\n\nOnly the fields specified in\nupdateMask\nfield are used. If `updateMask` is not present, the update applies to all\nfields.\n\n\u003caside class=\"note\"\u003e\u003cb\u003eNote:\u003c/b\u003e To update\nPose.altitude,\nPose.latLngPair has to be\nfilled as well. Otherwise, the request will fail.\u003c/aside\u003e",
- "request": {
- "$ref": "BatchUpdatePhotosRequest"
- },
- "response": {
- "$ref": "BatchUpdatePhotosResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST"
- },
- "batchDelete": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "BatchDeletePhotosResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/streetviewpublish"
- ],
- "parameters": {},
- "flatPath": "v1/photos:batchDelete",
- "id": "streetviewpublish.photos.batchDelete",
- "path": "v1/photos:batchDelete",
- "description": "Deletes a list of Photos and their\nmetadata.\n\nNote that if\nBatchDeletePhotos\nfails, either critical fields are missing or there was an authentication\nerror. Even if\nBatchDeletePhotos\nsucceeds, there may have been failures for single photos in the batch.\nThese failures will be specified in each\nPhotoResponse.status\nin\nBatchDeletePhotosResponse.results.\nSee\nDeletePhoto\nfor specific failures that can occur per photo.",
- "request": {
- "$ref": "BatchDeletePhotosRequest"
- }
- }
- }
- }
- },
- "parameters": {
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "type": "string",
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
- },
- "prettyPrint": {
- "type": "boolean",
- "default": "true",
- "location": "query",
- "description": "Returns response with indentations and line breaks."
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "type": "string",
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "alt": {
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- }
- },
- "version": "v1"
+ "title": "Street View Publish API"
}
diff --git a/testing/v1/testing-api.json b/testing/v1/testing-api.json
index 8530d82..51d6525 100644
--- a/testing/v1/testing-api.json
+++ b/testing/v1/testing-api.json
@@ -1,43 +1,15 @@
{
+ "ownerName": "Google",
+ "discoveryVersion": "v1",
"resources": {
"projects": {
"resources": {
"testMatrices": {
"methods": {
- "create": {
- "id": "testing.projects.testMatrices.create",
- "path": "v1/projects/{projectId}/testMatrices",
- "request": {
- "$ref": "TestMatrix"
- },
- "description": "Request to run a matrix of tests according to the given specifications.\nUnsupported environments will be returned in the state UNSUPPORTED.\nMatrices are limited to at most 200 supported executions.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to write to project\n- INVALID_ARGUMENT - if the request is malformed or if the matrix expands\n to more than 200 supported executions",
- "response": {
- "$ref": "TestMatrix"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The GCE project under which this job will run.",
- "type": "string",
- "required": true
- },
- "requestId": {
- "type": "string",
- "location": "query",
- "description": "A string id used to detect duplicated requests.\nIds are automatically scoped to a project, so\nusers should ensure the ID is unique per-project.\nA UUID is recommended.\n\nOptional, but strongly recommended."
- }
- },
- "flatPath": "v1/projects/{projectId}/testMatrices"
- },
"cancel": {
- "httpMethod": "POST",
+ "id": "testing.projects.testMatrices.cancel",
+ "path": "v1/projects/{projectId}/testMatrices/{testMatrixId}:cancel",
+ "description": "Cancels unfinished test executions in a test matrix.\nThis call returns immediately and cancellation proceeds asychronously.\nIf the matrix is already final, this operation will have no effect.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to read project\n- INVALID_ARGUMENT - if the request is malformed\n- NOT_FOUND - if the Test Matrix does not exist",
"response": {
"$ref": "CancelTestMatrixResponse"
},
@@ -45,29 +17,29 @@
"projectId",
"testMatrixId"
],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "Cloud project that owns the test.",
- "type": "string",
- "required": true
- },
- "testMatrixId": {
- "description": "Test matrix that will be canceled.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectId}/testMatrices/{testMatrixId}:cancel",
- "path": "v1/projects/{projectId}/testMatrices/{testMatrixId}:cancel",
- "id": "testing.projects.testMatrices.cancel",
- "description": "Cancels unfinished test executions in a test matrix.\nThis call returns immediately and cancellation proceeds asychronously.\nIf the matrix is already final, this operation will have no effect.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to read project\n- INVALID_ARGUMENT - if the request is malformed\n- NOT_FOUND - if the Test Matrix does not exist"
+ "parameters": {
+ "projectId": {
+ "description": "Cloud project that owns the test.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "testMatrixId": {
+ "location": "path",
+ "description": "Test matrix that will be canceled.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/testMatrices/{testMatrixId}:cancel"
},
"get": {
+ "path": "v1/projects/{projectId}/testMatrices/{testMatrixId}",
+ "id": "testing.projects.testMatrices.get",
"description": "Check the status of a test matrix.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to read project\n- INVALID_ARGUMENT - if the request is malformed\n- NOT_FOUND - if the Test Matrix does not exist",
"httpMethod": "GET",
"response": {
@@ -77,6 +49,10 @@
"projectId",
"testMatrixId"
],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"parameters": {
"testMatrixId": {
"location": "path",
@@ -85,19 +61,45 @@
"required": true
},
"projectId": {
+ "location": "path",
"description": "Cloud project that owns the test matrix.",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/testMatrices/{testMatrixId}"
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "TestMatrix"
+ },
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The GCE project under which this job will run.",
+ "type": "string",
+ "required": true
+ },
+ "requestId": {
+ "location": "query",
+ "description": "A string id used to detect duplicated requests.\nIds are automatically scoped to a project, so\nusers should ensure the ID is unique per-project.\nA UUID is recommended.\n\nOptional, but strongly recommended.",
+ "type": "string"
}
},
"scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
+ "https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectId}/testMatrices/{testMatrixId}",
- "path": "v1/projects/{projectId}/testMatrices/{testMatrixId}",
- "id": "testing.projects.testMatrices.get"
+ "flatPath": "v1/projects/{projectId}/testMatrices",
+ "path": "v1/projects/{projectId}/testMatrices",
+ "id": "testing.projects.testMatrices.create",
+ "description": "Request to run a matrix of tests according to the given specifications.\nUnsupported environments will be returned in the state UNSUPPORTED.\nMatrices are limited to at most 200 supported executions.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to write to project\n- INVALID_ARGUMENT - if the request is malformed or if the matrix expands\n to more than 200 supported executions",
+ "request": {
+ "$ref": "TestMatrix"
+ }
}
}
}
@@ -107,21 +109,20 @@
"methods": {
"get": {
"description": "Get the catalog of supported test environments.\n\nMay return any of the following canonical error codes:\n\n- INVALID_ARGUMENT - if the request is malformed\n- NOT_FOUND - if the environment type does not exist\n- INTERNAL - if an internal error occurred",
- "response": {
- "$ref": "TestEnvironmentCatalog"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"environmentType"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "TestEnvironmentCatalog"
+ },
"parameters": {
"projectId": {
+ "location": "query",
"description": "For authorization, the cloud project requesting the TestEnvironmentCatalog.\nOptional",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"environmentType": {
- "location": "path",
"enum": [
"ENVIRONMENT_TYPE_UNSPECIFIED",
"ANDROID",
@@ -129,7 +130,8 @@
],
"description": "The type of environment that should be listed.\nRequired",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path"
}
},
"scopes": [
@@ -137,65 +139,42 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1/testEnvironmentCatalog/{environmentType}",
- "id": "testing.testEnvironmentCatalog.get",
- "path": "v1/testEnvironmentCatalog/{environmentType}"
+ "path": "v1/testEnvironmentCatalog/{environmentType}",
+ "id": "testing.testEnvironmentCatalog.get"
}
}
}
},
"parameters": {
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "upload_protocol": {
- "type": "string",
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
- },
- "prettyPrint": {
- "default": "true",
- "type": "boolean",
- "location": "query",
- "description": "Returns response with indentations and line breaks."
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
"callback": {
+ "location": "query",
"description": "JSONP",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query"
},
"alt": {
- "description": "Data format for response.",
- "default": "json",
"enum": [
"json",
"media",
@@ -207,7 +186,9 @@
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
- "location": "query"
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
},
"access_token": {
"location": "query",
@@ -215,128 +196,60 @@
"type": "string"
},
"key": {
+ "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"quotaUser": {
+ "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pp": {
"location": "query",
"description": "Pretty-print response.",
"default": "true",
"type": "boolean"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
}
},
"schemas": {
- "AndroidDeviceCatalog": {
- "description": "The currently supported Android devices.",
- "type": "object",
+ "TestMatrix": {
"properties": {
- "models": {
- "description": "The set of supported Android device models.\n@OutputOnly",
- "items": {
- "$ref": "AndroidModel"
- },
- "type": "array"
- },
- "runtimeConfiguration": {
- "$ref": "AndroidRuntimeConfiguration",
- "description": "The set of supported runtime configurations.\n@OutputOnly"
- },
- "versions": {
- "description": "The set of supported Android OS versions.\n@OutputOnly",
- "items": {
- "$ref": "AndroidVersion"
- },
- "type": "array"
- }
- },
- "id": "AndroidDeviceCatalog"
- },
- "GoogleAuto": {
- "type": "object",
- "properties": {},
- "id": "GoogleAuto",
- "description": "Enables automatic Google account login.\nIf set, the service will automatically generate a Google test account and add\nit to the device, before executing the test. Note that test accounts might be\nreused.\nMany applications show their full set of functionalities when an account is\npresent on the device. Logging into the device with these generated accounts\nallows testing more functionalities."
- },
- "AndroidDeviceList": {
- "id": "AndroidDeviceList",
- "description": "A list of Android device configurations in which the test is to be executed.",
- "type": "object",
- "properties": {
- "androidDevices": {
- "description": "A list of Android devices\nRequired",
- "items": {
- "$ref": "AndroidDevice"
- },
- "type": "array"
- }
- }
- },
- "ClientInfo": {
- "description": "Information about the client which invoked the test.",
- "type": "object",
- "properties": {
- "clientInfoDetails": {
- "description": "The list of detailed information about client.",
- "items": {
- "$ref": "ClientInfoDetail"
- },
- "type": "array"
- },
- "name": {
- "description": "Client name, such as gcloud.\nRequired",
- "type": "string"
- }
- },
- "id": "ClientInfo"
- },
- "EnvironmentMatrix": {
- "description": "The matrix of environments in which the test is to be executed.",
- "type": "object",
- "properties": {
- "androidMatrix": {
- "description": "A matrix of Android devices.",
- "$ref": "AndroidMatrix"
- },
- "androidDeviceList": {
- "$ref": "AndroidDeviceList",
- "description": "A list of Android devices; the test will be run only on the specified\ndevices."
- }
- },
- "id": "EnvironmentMatrix"
- },
- "Date": {
- "id": "Date",
- "description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
- "type": "object",
- "properties": {
- "day": {
- "format": "int32",
- "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.",
- "type": "integer"
- },
- "year": {
- "format": "int32",
- "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
- "type": "integer"
- },
- "month": {
- "format": "int32",
- "description": "Month of year. Must be from 1 to 12.",
- "type": "integer"
- }
- }
- },
- "CancelTestMatrixResponse": {
- "description": "Response containing the current state of the specified test matrix.",
- "type": "object",
- "properties": {
- "testState": {
+ "state": {
+ "enumDescriptions": [
+ "Do not use. For proto versioning only.",
+ "The execution or matrix is being validated.",
+ "The execution or matrix is waiting for resources to become available.",
+ "The execution is currently being processed.\n\nCan only be set on an execution.",
+ "The execution or matrix has terminated normally.\n\nOn a matrix this means that the matrix level processing completed normally,\nbut individual executions may be in an ERROR state.",
+ "The execution or matrix has stopped because it encountered an\ninfrastructure failure.",
+ "The execution was not run because it corresponds to a unsupported\nenvironment.\n\nCan only be set on an execution.",
+ "The execution was not run because the provided inputs are incompatible with\nthe requested environment.\n\nExample: requested AndroidVersion is lower than APK's minSdkVersion\n\nCan only be set on an execution.",
+ "The execution was not run because the provided inputs are incompatible with\nthe requested architecture.\n\nExample: requested device does not support running the native code in\nthe supplied APK\n\nCan only be set on an execution.",
+ "The user cancelled the execution.\n\nCan only be set on an execution.",
+ "The execution or matrix was not run because the provided inputs are not\nvalid.\n\nExamples: input file is not of the expected type, is malformed/corrupt, or\nwas flagged as malware"
+ ],
"enum": [
"TEST_STATE_UNSPECIFIED",
"VALIDATING",
@@ -350,642 +263,46 @@
"CANCELLED",
"INVALID"
],
- "description": "The current rolled-up state of the test matrix.\nIf this state is already final, then the cancelation request will\nhave no effect.",
- "type": "string",
- "enumDescriptions": [
- "Do not use. For proto versioning only.",
- "The execution or matrix is being validated.",
- "The execution or matrix is waiting for resources to become available.",
- "The execution is currently being processed.\n\nCan only be set on an execution.",
- "The execution or matrix has terminated normally.\n\nOn a matrix this means that the matrix level processing completed normally,\nbut individual executions may be in an ERROR state.",
- "The execution or matrix has stopped because it encountered an\ninfrastructure failure.",
- "The execution was not run because it corresponds to a unsupported\nenvironment.\n\nCan only be set on an execution.",
- "The execution was not run because the provided inputs are incompatible with\nthe requested environment.\n\nExample: requested AndroidVersion is lower than APK's minSdkVersion\n\nCan only be set on an execution.",
- "The execution was not run because the provided inputs are incompatible with\nthe requested architecture.\n\nExample: requested device does not support running the native code in\nthe supplied APK\n\nCan only be set on an execution.",
- "The user cancelled the execution.\n\nCan only be set on an execution.",
- "The execution or matrix was not run because the provided inputs are not\nvalid.\n\nExamples: input file is not of the expected type, is malformed/corrupt, or\nwas flagged as malware"
- ]
- }
- },
- "id": "CancelTestMatrixResponse"
- },
- "Account": {
- "description": "Identifies an account and how to log into it",
- "type": "object",
- "properties": {
- "googleAuto": {
- "$ref": "GoogleAuto",
- "description": "An automatic google login account"
- }
- },
- "id": "Account"
- },
- "TestEnvironmentCatalog": {
- "description": "A description of a test environment.",
- "type": "object",
- "properties": {
- "androidDeviceCatalog": {
- "$ref": "AndroidDeviceCatalog",
- "description": "Android devices suitable for running Android Instrumentation Tests."
- },
- "networkConfigurationCatalog": {
- "$ref": "NetworkConfigurationCatalog",
- "description": "Supported network configurations"
- }
- },
- "id": "TestEnvironmentCatalog"
- },
- "Locale": {
- "type": "object",
- "properties": {
- "name": {
- "description": "A human-friendly name for this language/locale.\nExample: \"English\"\n@OutputOnly",
- "type": "string"
- },
- "tags": {
- "description": "Tags for this dimension.\nExamples: \"default\"",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "id": {
- "description": "The id for this locale.\nExample: \"en_US\"\n@OutputOnly",
- "type": "string"
- },
- "region": {
- "description": "A human-friendy string representing the region for this locale.\nExample: \"United States\"\nNot present for every locale.\n@OutputOnly",
- "type": "string"
- }
- },
- "id": "Locale",
- "description": "A location/region designation for language."
- },
- "ObbFile": {
- "type": "object",
- "properties": {
- "obb": {
- "$ref": "FileReference",
- "description": "Opaque Binary Blob (OBB) file(s) to install on the device\nRequired"
- },
- "obbFileName": {
- "description": "OBB file name which must conform to the format as specified by\nAndroid\ne.g. [main|patch].0300110.com.example.android.obb\nwhich will be installed into\n \u003cshared-storage\u003e/Android/obb/\u003cpackage-name\u003e/\non the device\nRequired",
- "type": "string"
- }
- },
- "id": "ObbFile",
- "description": "An opaque binary blob file to install on the device before the test starts"
- },
- "AndroidRuntimeConfiguration": {
- "properties": {
- "orientations": {
- "description": "The set of available orientations.\n@OutputOnly",
- "items": {
- "$ref": "Orientation"
- },
- "type": "array"
- },
- "locales": {
- "description": "The set of available locales.\n@OutputOnly",
- "items": {
- "$ref": "Locale"
- },
- "type": "array"
- }
- },
- "id": "AndroidRuntimeConfiguration",
- "description": "Configuration that can be selected at the time a test is run.",
- "type": "object"
- },
- "AndroidDevice": {
- "type": "object",
- "properties": {
- "orientation": {
- "description": "How the device is oriented during the test.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired",
- "type": "string"
- },
- "locale": {
- "description": "The locale the test device used for testing.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired",
- "type": "string"
- },
- "androidVersionId": {
- "description": "The id of the Android OS version to be used.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired",
- "type": "string"
- },
- "androidModelId": {
- "description": "The id of the Android device to be used.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired",
- "type": "string"
- }
- },
- "id": "AndroidDevice",
- "description": "A single Android device."
- },
- "NetworkConfiguration": {
- "type": "object",
- "properties": {
- "id": {
- "description": "The unique opaque id for this network traffic configuration\n@OutputOnly",
- "type": "string"
- },
- "upRule": {
- "description": "The emulation rule applying to the upload traffic",
- "$ref": "TrafficRule"
- },
- "downRule": {
- "description": "The emulation rule applying to the download traffic",
- "$ref": "TrafficRule"
- }
- },
- "id": "NetworkConfiguration"
- },
- "ToolResultsStep": {
- "description": "Represents a tool results step resource.\n\nThis has the results of a TestExecution.",
- "type": "object",
- "properties": {
- "executionId": {
- "description": "A tool results execution ID.\n@OutputOnly",
- "type": "string"
- },
- "stepId": {
- "description": "A tool results step ID.\n@OutputOnly",
- "type": "string"
- },
- "historyId": {
- "description": "A tool results history ID.\n@OutputOnly",
+ "description": "Indicates the current progress of the test matrix (e.g., FINISHED)\n@OutputOnly",
"type": "string"
},
"projectId": {
- "description": "The cloud project that owns the tool results step.\n@OutputOnly",
+ "description": "The cloud project that owns the test matrix.\n@OutputOnly",
"type": "string"
- }
- },
- "id": "ToolResultsStep"
- },
- "TrafficRule": {
- "description": "Network emulation parameters",
- "type": "object",
- "properties": {
- "bandwidth": {
- "format": "float",
- "description": "Bandwidth in kbits/second",
- "type": "number"
- },
- "packetDuplicationRatio": {
- "format": "float",
- "description": "Packet duplication ratio (0.0 - 1.0)",
- "type": "number"
- },
- "delay": {
- "format": "google-duration",
- "description": "Packet delay, must be \u003e= 0",
- "type": "string"
- },
- "packetLossRatio": {
- "type": "number",
- "format": "float",
- "description": "Packet loss ratio (0.0 - 1.0)"
- },
- "burst": {
- "format": "float",
- "description": "Burst size in kbits",
- "type": "number"
- }
- },
- "id": "TrafficRule"
- },
- "AndroidInstrumentationTest": {
- "properties": {
- "orchestratorOption": {
- "description": "The option of whether running each test within its own invocation of\ninstrumentation with Android Test Orchestrator or not.\n** Orchestrator is only compatible with AndroidJUnitRunner version 1.0 or\nhigher! **\nOrchestrator offers the following benefits:\n - No shared state\n - Crashes are isolated\n - Logs are scoped per test\n\nSee\n\u003chttps://developer.android.com/training/testing/junit-runner.html#using-android-test-orchestrator\u003e\nfor more information about Android Test Orchestrator.\n\nOptional, if empty, test will be run without orchestrator.",
- "type": "string",
- "enumDescriptions": [
- "This means that the server should choose the mode. And test will be run\nwithout orchestrator.\nUsing orchestrator is highly encouraged because of all the benefits it\noffers. And in the future, all instrumentation tests will be run with\norchestrator by default if preference unspecified.",
- "Run test using orchestrator.\n** Only compatible with AndroidJUnitRunner version 1.0 or higher! **\nRecommended.",
- "Run test without using orchestrator."
- ],
- "enum": [
- "ORCHESTRATOR_OPTION_UNSPECIFIED",
- "USE_ORCHESTRATOR",
- "DO_NOT_USE_ORCHESTRATOR"
- ]
- },
- "testTargets": {
- "description": "Each target must be fully qualified with the package name or class name,\nin one of these formats:\n - \"package package_name\"\n - \"class package_name.class_name\"\n - \"class package_name.class_name#method_name\"\n\nOptional, if empty, all targets in the module will be run.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "testApk": {
- "$ref": "FileReference",
- "description": "The APK containing the test code to be executed.\nRequired"
- },
- "testRunnerClass": {
- "description": "The InstrumentationTestRunner class.\nOptional, default is determined by examining the application's manifest.",
- "type": "string"
- },
- "testPackageId": {
- "description": "The java package for the test to be executed.\nOptional, default is determined by examining the application's manifest.",
- "type": "string"
- },
- "appPackageId": {
- "description": "The java package for the application under test.\nOptional, default is determined by examining the application's manifest.",
- "type": "string"
- },
- "appApk": {
- "description": "The APK for the application under test.\nRequired",
- "$ref": "FileReference"
- }
- },
- "id": "AndroidInstrumentationTest",
- "description": "A test of an Android application that can control an Android component\nindependently of its normal lifecycle.\nAndroid instrumentation tests run an application APK and test APK inside the\nsame process on a virtual or physical AndroidDevice. They also specify\na test runner class, such as com.google.GoogleTestRunner, which can vary\non the specific instrumentation framework chosen.\n\nSee \u003chttp://developer.android.com/tools/testing/testing_android.html\u003e for\nmore information on types of Android tests.",
- "type": "object"
- },
- "DeviceFile": {
- "description": "A single device file description.",
- "type": "object",
- "properties": {
- "obbFile": {
- "description": "A reference to an opaque binary blob file",
- "$ref": "ObbFile"
- }
- },
- "id": "DeviceFile"
- },
- "ClientInfoDetail": {
- "description": "Key-value pair of detailed information about the client which invoked the\ntest. For example {'Version', '1.0'}, {'Release Track', 'BETA'}",
- "type": "object",
- "properties": {
- "key": {
- "description": "The key of detailed client information.\nRequired",
- "type": "string"
- },
- "value": {
- "description": "The value of detailed client information.\nRequired",
- "type": "string"
- }
- },
- "id": "ClientInfoDetail"
- },
- "EnvironmentVariable": {
- "description": "A key-value pair passed as an environment variable to the test",
- "type": "object",
- "properties": {
- "value": {
- "type": "string",
- "description": "Value for the environment variable"
- },
- "key": {
- "description": "Key for the environment variable",
- "type": "string"
- }
- },
- "id": "EnvironmentVariable"
- },
- "Environment": {
- "description": "The environment in which the test is run.",
- "type": "object",
- "properties": {
- "androidDevice": {
- "$ref": "AndroidDevice",
- "description": "An Android device which must be used with an Android test."
- }
- },
- "id": "Environment"
- },
- "TestExecution": {
- "description": "Specifies a single test to be executed in a single environment.",
- "type": "object",
- "properties": {
- "environment": {
- "$ref": "Environment",
- "description": "How the host machine(s) are configured.\n@OutputOnly"
- },
- "state": {
- "type": "string",
- "enumDescriptions": [
- "Do not use. For proto versioning only.",
- "The execution or matrix is being validated.",
- "The execution or matrix is waiting for resources to become available.",
- "The execution is currently being processed.\n\nCan only be set on an execution.",
- "The execution or matrix has terminated normally.\n\nOn a matrix this means that the matrix level processing completed normally,\nbut individual executions may be in an ERROR state.",
- "The execution or matrix has stopped because it encountered an\ninfrastructure failure.",
- "The execution was not run because it corresponds to a unsupported\nenvironment.\n\nCan only be set on an execution.",
- "The execution was not run because the provided inputs are incompatible with\nthe requested environment.\n\nExample: requested AndroidVersion is lower than APK's minSdkVersion\n\nCan only be set on an execution.",
- "The execution was not run because the provided inputs are incompatible with\nthe requested architecture.\n\nExample: requested device does not support running the native code in\nthe supplied APK\n\nCan only be set on an execution.",
- "The user cancelled the execution.\n\nCan only be set on an execution.",
- "The execution or matrix was not run because the provided inputs are not\nvalid.\n\nExamples: input file is not of the expected type, is malformed/corrupt, or\nwas flagged as malware"
- ],
- "enum": [
- "TEST_STATE_UNSPECIFIED",
- "VALIDATING",
- "PENDING",
- "RUNNING",
- "FINISHED",
- "ERROR",
- "UNSUPPORTED_ENVIRONMENT",
- "INCOMPATIBLE_ENVIRONMENT",
- "INCOMPATIBLE_ARCHITECTURE",
- "CANCELLED",
- "INVALID"
- ],
- "description": "Indicates the current progress of the test execution (e.g., FINISHED).\n@OutputOnly"
- },
- "toolResultsStep": {
- "$ref": "ToolResultsStep",
- "description": "Where the results for this execution are written.\n@OutputOnly"
},
"testSpecification": {
- "$ref": "TestSpecification",
- "description": "How to run the test.\n@OutputOnly"
+ "description": "How to run the test.\nRequired",
+ "$ref": "TestSpecification"
},
- "projectId": {
- "description": "The cloud project that owns the test execution.\n@OutputOnly",
- "type": "string"
+ "clientInfo": {
+ "$ref": "ClientInfo",
+ "description": "Information about the client which invoked the test.\nOptional"
},
- "id": {
- "description": "Unique id set by the backend.\n@OutputOnly",
- "type": "string"
+ "testExecutions": {
+ "description": "The list of test executions that the service creates for this matrix.\n@OutputOnly",
+ "items": {
+ "$ref": "TestExecution"
+ },
+ "type": "array"
},
"timestamp": {
"format": "google-datetime",
- "description": "The time this test execution was initially created.\n@OutputOnly",
+ "description": "The time this test matrix was initially created.\n@OutputOnly",
"type": "string"
},
- "matrixId": {
- "description": "Id of the containing TestMatrix.\n@OutputOnly",
- "type": "string"
- },
- "testDetails": {
- "description": "Additional details about the running test.\n@OutputOnly",
- "$ref": "TestDetails"
- }
- },
- "id": "TestExecution"
- },
- "GoogleCloudStorage": {
- "description": "A storage location within Google cloud storage (GCS).",
- "type": "object",
- "properties": {
- "gcsPath": {
- "type": "string",
- "description": "The path to a directory in GCS that will\neventually contain the results for this test.\nThe requesting user must have write access on the bucket in the supplied\npath.\nRequired"
- }
- },
- "id": "GoogleCloudStorage"
- },
- "RoboDirective": {
- "description": "Directs Robo to interact with a specific UI element if it is encountered\nduring the crawl. Currently, Robo can perform text entry or element click.",
- "type": "object",
- "properties": {
- "actionType": {
- "enumDescriptions": [
- "DO NOT USE. For proto versioning only.",
- "Direct Robo to click on the specified element. No-op if specified element\nis not clickable.",
- "Direct Robo to enter text on the specified element. No-op if specified\nelement is not enabled or does not allow text entry."
- ],
- "enum": [
- "ACTION_TYPE_UNSPECIFIED",
- "SINGLE_CLICK",
- "ENTER_TEXT"
- ],
- "description": "The type of action that Robo should perform on the specified element.\nRequired.",
- "type": "string"
- },
- "inputText": {
- "description": "The text that Robo is directed to set. If left empty, the directive will be\ntreated as a CLICK on the element matching the resource_name.\nOptional",
- "type": "string"
- },
- "resourceName": {
- "description": "The android resource name of the target UI element\nFor example,\n in Java: R.string.foo\n in xml: @string/foo\nOnly the “foo” part is needed.\nReference doc:\nhttps://developer.android.com/guide/topics/resources/accessing-resources.html\nRequired",
- "type": "string"
- }
- },
- "id": "RoboDirective"
- },
- "AndroidMatrix": {
- "properties": {
- "orientations": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "description": "The set of orientations to test with.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired"
- },
- "locales": {
- "description": "The set of locales the test device will enable for testing.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "androidVersionIds": {
- "description": "The ids of the set of Android OS version to be used.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "androidModelIds": {
- "description": "The ids of the set of Android device to be used.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "AndroidMatrix",
- "description": "A set of Android device configuration permutations is defined by the\nthe cross-product of the given axes. Internally, the given AndroidMatrix\nwill be expanded into a set of AndroidDevices.\n\nOnly supported permutations will be instantiated. Invalid permutations\n(e.g., incompatible models/versions) are ignored.",
- "type": "object"
- },
- "AndroidModel": {
- "description": "A description of an Android device tests may be run on.",
- "type": "object",
- "properties": {
- "codename": {
- "description": "The name of the industrial design.\nThis corresponds to android.os.Build.DEVICE\n@OutputOnly",
- "type": "string"
- },
- "screenY": {
- "format": "int32",
- "description": "Screen size in the vertical (Y) dimension measured in pixels.\n@OutputOnly",
- "type": "integer"
- },
- "form": {
- "type": "string",
- "enumDescriptions": [
- "Do not use. For proto versioning only.",
- "A software stack that simulates the device",
- "Actual hardware"
- ],
- "enum": [
- "DEVICE_FORM_UNSPECIFIED",
- "VIRTUAL",
- "PHYSICAL"
- ],
- "description": "Whether this device is virtual or physical.\n@OutputOnly"
- },
- "screenDensity": {
- "format": "int32",
- "description": "Screen density in DPI.\nThis corresponds to ro.sf.lcd_density\n@OutputOnly",
- "type": "integer"
- },
- "supportedVersionIds": {
- "description": "The set of Android versions this device supports.\n@OutputOnly",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "supportedAbis": {
- "description": "The list of supported ABIs for this device.\nThis corresponds to either android.os.Build.SUPPORTED_ABIS (for API level\n21 and above) or android.os.Build.CPU_ABI/CPU_ABI2.\nThe most preferred ABI is the first element in the list.\n\nElements are optionally prefixed by \"version_id:\" (where version_id is\nthe id of an AndroidVersion), denoting an ABI that is supported only on\na particular version.\n@OutputOnly",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "name": {
- "description": "The human-readable marketing name for this device model.\nExamples: \"Nexus 5\", \"Galaxy S5\"\n@OutputOnly",
- "type": "string"
- },
- "tags": {
- "description": "Tags for this dimension.\nExamples: \"default\", \"preview\", \"deprecated\"",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "id": {
- "description": "The unique opaque id for this model.\nUse this for invoking the TestExecutionService.\n@OutputOnly",
- "type": "string"
- },
- "manufacturer": {
- "description": "The manufacturer of this device.\n@OutputOnly",
- "type": "string"
- },
- "brand": {
- "description": "The company that this device is branded with.\nExample: \"Google\", \"Samsung\"\n@OutputOnly",
- "type": "string"
- },
- "screenX": {
- "format": "int32",
- "description": "Screen size in the horizontal (X) dimension measured in pixels.\n@OutputOnly",
- "type": "integer"
- }
- },
- "id": "AndroidModel"
- },
- "TestSetup": {
- "description": "A description of how to set up the device prior to running the test",
- "type": "object",
- "properties": {
- "directoriesToPull": {
- "description": "The directories on the device to upload to GCS at the end of the test;\nthey must be absolute, whitelisted paths.\nRefer to RegularFile for whitelisted paths.\nOptional",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "filesToPush": {
- "description": "Optional",
- "items": {
- "$ref": "DeviceFile"
- },
- "type": "array"
- },
- "networkProfile": {
- "description": "The network traffic profile used for running the test.\nOptional",
- "type": "string"
- },
- "environmentVariables": {
- "description": "Environment variables to set for the test (only applicable for\ninstrumentation tests).",
- "items": {
- "$ref": "EnvironmentVariable"
- },
- "type": "array"
- },
- "account": {
- "description": "The device will be logged in on this account for the duration of the test.\nOptional",
- "$ref": "Account"
- }
- },
- "id": "TestSetup"
- },
- "TestSpecification": {
- "description": "A description of how to run the test.",
- "type": "object",
- "properties": {
- "testTimeout": {
- "format": "google-duration",
- "description": "Max time a test execution is allowed to run before it is\nautomatically cancelled.\nOptional, default is 5 min.",
- "type": "string"
- },
- "autoGoogleLogin": {
- "description": "Enables automatic Google account login.\nIf set, the service will automatically generate a Google test account and\nadd it to the device, before executing the test. Note that test accounts\nmight be reused.\nMany applications show their full set of functionalities when an account is\npresent on the device. Logging into the device with these generated\naccounts allows testing more functionalities.\nDefault is false.\nOptional",
- "type": "boolean"
- },
- "androidTestLoop": {
- "$ref": "AndroidTestLoop",
- "description": "An Android Application with a Test Loop"
- },
- "testSetup": {
- "$ref": "TestSetup",
- "description": "Test setup requirements e.g. files to install, bootstrap scripts\nOptional"
- },
- "androidRoboTest": {
- "$ref": "AndroidRoboTest",
- "description": "An Android robo test."
- },
- "androidInstrumentationTest": {
- "$ref": "AndroidInstrumentationTest",
- "description": "An Android instrumentation test."
- },
- "disablePerformanceMetrics": {
- "description": "Disables performance metrics recording; may reduce test latency.",
- "type": "boolean"
- },
- "disableVideoRecording": {
- "description": "Disables video recording; may reduce test latency.",
- "type": "boolean"
- }
- },
- "id": "TestSpecification"
- },
- "TestMatrix": {
- "description": "A group of one or more TestExecutions, built by taking a\nproduct of values over a pre-defined set of axes.",
- "type": "object",
- "properties": {
- "resultStorage": {
- "$ref": "ResultStorage",
- "description": "Where the results for the matrix are written.\nRequired"
+ "environmentMatrix": {
+ "description": "How the host machine(s) are configured.\nRequired",
+ "$ref": "EnvironmentMatrix"
},
"testMatrixId": {
"description": "Unique id set by the service.\n@OutputOnly",
"type": "string"
},
+ "resultStorage": {
+ "description": "Where the results for the matrix are written.\nRequired",
+ "$ref": "ResultStorage"
+ },
"invalidMatrixDetails": {
- "enumDescriptions": [
- "Do not use. For proto versioning only.",
- "The matrix is INVALID, but there are no further details available.",
- "The input app APK could not be parsed.",
- "The input test APK could not be parsed.",
- "The AndroidManifest.xml could not be found.",
- "The APK manifest does not declare a package name.",
- "The test package and app package are the same.",
- "The test apk does not declare an instrumentation.",
- "The input app apk does not have a signature.",
- "The test runner class specified by user or in the test APK's manifest file\nis not compatible with Android Test Orchestrator.\nOrchestrator is only compatible with AndroidJUnitRunner version 1.0 or\nhigher.\nOrchestrator can be disabled by using DO_NOT_USE_ORCHESTRATOR\nOrchestratorOption.",
- "The test APK does not contain the test runner class specified by user or in\nthe manifest file.\nThis can be caused by either of the following reasons:\n- the user provided a runner class name that's incorrect, or\n- the test runner isn't built into the test APK (might be in the app APK\ninstead).",
- "A main launcher activity could not be found.",
- "The app declares one or more permissions that are not allowed.",
- "There is a conflict in the provided robo_directives.",
- "There there is no test loop intent filter, or the one that is given is\nnot formatted correctly.",
- "The request contains a scenario label that was not declared in the\nmanifest.",
- "There was an error when parsing a label's value.",
- "The request contains a scenario number that was not declared in the\nmanifest.",
- "Device administrator applications are not allowed.",
- "The APK is marked as \"testOnly\"."
- ],
"enum": [
"INVALID_MATRIX_DETAILS_UNSPECIFIED",
"DETAILS_UNAVAILABLE",
@@ -1009,77 +326,39 @@
"TEST_ONLY_APK"
],
"description": "Describes why the matrix is considered invalid.\nOnly useful for matrices in the INVALID state.\n@OutputOnly",
- "type": "string"
- },
- "state": {
"type": "string",
"enumDescriptions": [
- "Do not use. For proto versioning only.",
- "The execution or matrix is being validated.",
- "The execution or matrix is waiting for resources to become available.",
- "The execution is currently being processed.\n\nCan only be set on an execution.",
- "The execution or matrix has terminated normally.\n\nOn a matrix this means that the matrix level processing completed normally,\nbut individual executions may be in an ERROR state.",
- "The execution or matrix has stopped because it encountered an\ninfrastructure failure.",
- "The execution was not run because it corresponds to a unsupported\nenvironment.\n\nCan only be set on an execution.",
- "The execution was not run because the provided inputs are incompatible with\nthe requested environment.\n\nExample: requested AndroidVersion is lower than APK's minSdkVersion\n\nCan only be set on an execution.",
- "The execution was not run because the provided inputs are incompatible with\nthe requested architecture.\n\nExample: requested device does not support running the native code in\nthe supplied APK\n\nCan only be set on an execution.",
- "The user cancelled the execution.\n\nCan only be set on an execution.",
- "The execution or matrix was not run because the provided inputs are not\nvalid.\n\nExamples: input file is not of the expected type, is malformed/corrupt, or\nwas flagged as malware"
- ],
- "enum": [
- "TEST_STATE_UNSPECIFIED",
- "VALIDATING",
- "PENDING",
- "RUNNING",
- "FINISHED",
- "ERROR",
- "UNSUPPORTED_ENVIRONMENT",
- "INCOMPATIBLE_ENVIRONMENT",
- "INCOMPATIBLE_ARCHITECTURE",
- "CANCELLED",
- "INVALID"
- ],
- "description": "Indicates the current progress of the test matrix (e.g., FINISHED)\n@OutputOnly"
- },
- "projectId": {
- "description": "The cloud project that owns the test matrix.\n@OutputOnly",
- "type": "string"
- },
- "testSpecification": {
- "$ref": "TestSpecification",
- "description": "How to run the test.\nRequired"
- },
- "clientInfo": {
- "$ref": "ClientInfo",
- "description": "Information about the client which invoked the test.\nOptional"
- },
- "testExecutions": {
- "description": "The list of test executions that the service creates for this matrix.\n@OutputOnly",
- "items": {
- "$ref": "TestExecution"
- },
- "type": "array"
- },
- "timestamp": {
- "type": "string",
- "format": "google-datetime",
- "description": "The time this test matrix was initially created.\n@OutputOnly"
- },
- "environmentMatrix": {
- "description": "How the host machine(s) are configured.\nRequired",
- "$ref": "EnvironmentMatrix"
+ "Do not use. For proto versioning only.",
+ "The matrix is INVALID, but there are no further details available.",
+ "The input app APK could not be parsed.",
+ "The input test APK could not be parsed.",
+ "The AndroidManifest.xml could not be found.",
+ "The APK manifest does not declare a package name.",
+ "The test package and app package are the same.",
+ "The test apk does not declare an instrumentation.",
+ "The input app apk does not have a signature.",
+ "The test runner class specified by user or in the test APK's manifest file\nis not compatible with Android Test Orchestrator.\nOrchestrator is only compatible with AndroidJUnitRunner version 1.0 or\nhigher.\nOrchestrator can be disabled by using DO_NOT_USE_ORCHESTRATOR\nOrchestratorOption.",
+ "The test APK does not contain the test runner class specified by user or in\nthe manifest file.\nThis can be caused by either of the following reasons:\n- the user provided a runner class name that's incorrect, or\n- the test runner isn't built into the test APK (might be in the app APK\ninstead).",
+ "A main launcher activity could not be found.",
+ "The app declares one or more permissions that are not allowed.",
+ "There is a conflict in the provided robo_directives.",
+ "There there is no test loop intent filter, or the one that is given is\nnot formatted correctly.",
+ "The request contains a scenario label that was not declared in the\nmanifest.",
+ "There was an error when parsing a label's value.",
+ "The request contains a scenario number that was not declared in the\nmanifest.",
+ "Device administrator applications are not allowed.",
+ "The APK is marked as \"testOnly\"."
+ ]
}
},
- "id": "TestMatrix"
+ "id": "TestMatrix",
+ "description": "A group of one or more TestExecutions, built by taking a\nproduct of values over a pre-defined set of axes.",
+ "type": "object"
},
"ResultStorage": {
"description": "Locations where the results of running the test are stored.",
"type": "object",
"properties": {
- "toolResultsExecution": {
- "description": "The tool results execution that results are written to.\n@OutputOnly",
- "$ref": "ToolResultsExecution"
- },
"toolResultsHistory": {
"description": "The tool results history that contains the tool results execution that\nresults are written to.\n\nOptional, if not provided the service will choose an appropriate value.",
"$ref": "ToolResultsHistory"
@@ -1087,6 +366,10 @@
"googleCloudStorage": {
"$ref": "GoogleCloudStorage",
"description": "Required."
+ },
+ "toolResultsExecution": {
+ "$ref": "ToolResultsExecution",
+ "description": "The tool results execution that results are written to.\n@OutputOnly"
}
},
"id": "ResultStorage"
@@ -1103,8 +386,6 @@
"id": "FileReference"
},
"AndroidVersion": {
- "description": "A version of the Android OS",
- "type": "object",
"properties": {
"apiLevel": {
"format": "int32",
@@ -1112,8 +393,8 @@
"type": "integer"
},
"distribution": {
- "$ref": "Distribution",
- "description": "Market share for this version.\n@OutputOnly"
+ "description": "Market share for this version.\n@OutputOnly",
+ "$ref": "Distribution"
},
"tags": {
"description": "Tags for this dimension.\nExamples: \"default\", \"preview\", \"deprecated\"",
@@ -1135,11 +416,13 @@
"type": "string"
},
"codeName": {
- "type": "string",
- "description": "The code name for this Android version.\nExamples: \"JellyBean\", \"KitKat\"\n@OutputOnly"
+ "description": "The code name for this Android version.\nExamples: \"JellyBean\", \"KitKat\"\n@OutputOnly",
+ "type": "string"
}
},
- "id": "AndroidVersion"
+ "id": "AndroidVersion",
+ "description": "A version of the Android OS",
+ "type": "object"
},
"TestDetails": {
"description": "Additional details about the progress of the running test.",
@@ -1160,8 +443,11 @@
"id": "TestDetails"
},
"ToolResultsExecution": {
- "type": "object",
"properties": {
+ "executionId": {
+ "description": "A tool results execution ID.\n@OutputOnly",
+ "type": "string"
+ },
"historyId": {
"description": "A tool results history ID.\n@OutputOnly",
"type": "string"
@@ -1169,17 +455,13 @@
"projectId": {
"description": "The cloud project that owns the tool results execution.\n@OutputOnly",
"type": "string"
- },
- "executionId": {
- "description": "A tool results execution ID.\n@OutputOnly",
- "type": "string"
}
},
"id": "ToolResultsExecution",
- "description": "Represents a tool results execution resource.\n\nThis has the results of a TestMatrix."
+ "description": "Represents a tool results execution resource.\n\nThis has the results of a TestMatrix.",
+ "type": "object"
},
"Distribution": {
- "type": "object",
"properties": {
"marketShare": {
"format": "double",
@@ -1193,11 +475,10 @@
}
},
"id": "Distribution",
- "description": "Data about the relative number of devices running a\ngiven configuration of the Android platform."
+ "description": "Data about the relative number of devices running a\ngiven configuration of the Android platform.",
+ "type": "object"
},
"AndroidRoboTest": {
- "description": "A test of an android application that explores the application on a virtual\nor physical Android Device, finding culprits and crashes as it goes.",
- "type": "object",
"properties": {
"appApk": {
"$ref": "FileReference",
@@ -1207,21 +488,21 @@
"description": "The java package for the application under test.\nOptional, default is determined by examining the application's manifest.",
"type": "string"
},
- "appInitialActivity": {
- "description": "The initial activity that should be used to start the app.\nOptional",
- "type": "string"
- },
"maxSteps": {
"format": "int32",
"description": "The max number of steps Robo can execute.\nDefault is no limit.\nOptional",
"type": "integer"
},
+ "appInitialActivity": {
+ "description": "The initial activity that should be used to start the app.\nOptional",
+ "type": "string"
+ },
"roboDirectives": {
+ "description": "A set of directives Robo should apply during the crawl.\nThis allows users to customize the crawl. For example, the username and\npassword for a test account can be provided.\nOptional",
"items": {
"$ref": "RoboDirective"
},
- "type": "array",
- "description": "A set of directives Robo should apply during the crawl.\nThis allows users to customize the crawl. For example, the username and\npassword for a test account can be provided.\nOptional"
+ "type": "array"
},
"maxDepth": {
"format": "int32",
@@ -1229,7 +510,9 @@
"type": "integer"
}
},
- "id": "AndroidRoboTest"
+ "id": "AndroidRoboTest",
+ "description": "A test of an android application that explores the application on a virtual\nor physical Android Device, finding culprits and crashes as it goes.",
+ "type": "object"
},
"ToolResultsHistory": {
"description": "Represents a tool results history resource.",
@@ -1247,8 +530,6 @@
"id": "ToolResultsHistory"
},
"Orientation": {
- "description": "Screen orientation of the device.",
- "type": "object",
"properties": {
"tags": {
"description": "Tags for this dimension.\nExamples: \"default\"",
@@ -1266,7 +547,21 @@
"type": "string"
}
},
- "id": "Orientation"
+ "id": "Orientation",
+ "description": "Screen orientation of the device.",
+ "type": "object"
+ },
+ "NetworkConfigurationCatalog": {
+ "type": "object",
+ "properties": {
+ "configurations": {
+ "items": {
+ "$ref": "NetworkConfiguration"
+ },
+ "type": "array"
+ }
+ },
+ "id": "NetworkConfigurationCatalog"
},
"AndroidTestLoop": {
"description": "A test of an Android Application with a Test Loop.\nThe intent \u003cintent-name\u003e will be implicitly added, since Games is the only\nuser of this api, for the time being.",
@@ -1292,28 +587,735 @@
"type": "string"
},
"appApk": {
- "description": "The APK for the application under test.\nRequired",
- "$ref": "FileReference"
+ "$ref": "FileReference",
+ "description": "The APK for the application under test.\nRequired"
}
},
"id": "AndroidTestLoop"
},
- "NetworkConfigurationCatalog": {
+ "GoogleAuto": {
+ "description": "Enables automatic Google account login.\nIf set, the service will automatically generate a Google test account and add\nit to the device, before executing the test. Note that test accounts might be\nreused.\nMany applications show their full set of functionalities when an account is\npresent on the device. Logging into the device with these generated accounts\nallows testing more functionalities.",
+ "type": "object",
+ "properties": {},
+ "id": "GoogleAuto"
+ },
+ "AndroidDeviceCatalog": {
+ "description": "The currently supported Android devices.",
"type": "object",
"properties": {
- "configurations": {
+ "models": {
+ "description": "The set of supported Android device models.\n@OutputOnly",
"items": {
- "$ref": "NetworkConfiguration"
+ "$ref": "AndroidModel"
+ },
+ "type": "array"
+ },
+ "runtimeConfiguration": {
+ "description": "The set of supported runtime configurations.\n@OutputOnly",
+ "$ref": "AndroidRuntimeConfiguration"
+ },
+ "versions": {
+ "description": "The set of supported Android OS versions.\n@OutputOnly",
+ "items": {
+ "$ref": "AndroidVersion"
},
"type": "array"
}
},
- "id": "NetworkConfigurationCatalog"
+ "id": "AndroidDeviceCatalog"
+ },
+ "AndroidDeviceList": {
+ "description": "A list of Android device configurations in which the test is to be executed.",
+ "type": "object",
+ "properties": {
+ "androidDevices": {
+ "description": "A list of Android devices\nRequired",
+ "items": {
+ "$ref": "AndroidDevice"
+ },
+ "type": "array"
+ }
+ },
+ "id": "AndroidDeviceList"
+ },
+ "ClientInfo": {
+ "description": "Information about the client which invoked the test.",
+ "type": "object",
+ "properties": {
+ "clientInfoDetails": {
+ "description": "The list of detailed information about client.",
+ "items": {
+ "$ref": "ClientInfoDetail"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "Client name, such as gcloud.\nRequired",
+ "type": "string"
+ }
+ },
+ "id": "ClientInfo"
+ },
+ "EnvironmentMatrix": {
+ "properties": {
+ "androidDeviceList": {
+ "$ref": "AndroidDeviceList",
+ "description": "A list of Android devices; the test will be run only on the specified\ndevices."
+ },
+ "androidMatrix": {
+ "$ref": "AndroidMatrix",
+ "description": "A matrix of Android devices."
+ }
+ },
+ "id": "EnvironmentMatrix",
+ "description": "The matrix of environments in which the test is to be executed.",
+ "type": "object"
+ },
+ "CancelTestMatrixResponse": {
+ "properties": {
+ "testState": {
+ "enumDescriptions": [
+ "Do not use. For proto versioning only.",
+ "The execution or matrix is being validated.",
+ "The execution or matrix is waiting for resources to become available.",
+ "The execution is currently being processed.\n\nCan only be set on an execution.",
+ "The execution or matrix has terminated normally.\n\nOn a matrix this means that the matrix level processing completed normally,\nbut individual executions may be in an ERROR state.",
+ "The execution or matrix has stopped because it encountered an\ninfrastructure failure.",
+ "The execution was not run because it corresponds to a unsupported\nenvironment.\n\nCan only be set on an execution.",
+ "The execution was not run because the provided inputs are incompatible with\nthe requested environment.\n\nExample: requested AndroidVersion is lower than APK's minSdkVersion\n\nCan only be set on an execution.",
+ "The execution was not run because the provided inputs are incompatible with\nthe requested architecture.\n\nExample: requested device does not support running the native code in\nthe supplied APK\n\nCan only be set on an execution.",
+ "The user cancelled the execution.\n\nCan only be set on an execution.",
+ "The execution or matrix was not run because the provided inputs are not\nvalid.\n\nExamples: input file is not of the expected type, is malformed/corrupt, or\nwas flagged as malware"
+ ],
+ "enum": [
+ "TEST_STATE_UNSPECIFIED",
+ "VALIDATING",
+ "PENDING",
+ "RUNNING",
+ "FINISHED",
+ "ERROR",
+ "UNSUPPORTED_ENVIRONMENT",
+ "INCOMPATIBLE_ENVIRONMENT",
+ "INCOMPATIBLE_ARCHITECTURE",
+ "CANCELLED",
+ "INVALID"
+ ],
+ "description": "The current rolled-up state of the test matrix.\nIf this state is already final, then the cancelation request will\nhave no effect.",
+ "type": "string"
+ }
+ },
+ "id": "CancelTestMatrixResponse",
+ "description": "Response containing the current state of the specified test matrix.",
+ "type": "object"
+ },
+ "Date": {
+ "description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
+ "type": "object",
+ "properties": {
+ "day": {
+ "format": "int32",
+ "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.",
+ "type": "integer"
+ },
+ "year": {
+ "format": "int32",
+ "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
+ "type": "integer"
+ },
+ "month": {
+ "format": "int32",
+ "description": "Month of year. Must be from 1 to 12.",
+ "type": "integer"
+ }
+ },
+ "id": "Date"
+ },
+ "Account": {
+ "properties": {
+ "googleAuto": {
+ "$ref": "GoogleAuto",
+ "description": "An automatic google login account"
+ }
+ },
+ "id": "Account",
+ "description": "Identifies an account and how to log into it",
+ "type": "object"
+ },
+ "TestEnvironmentCatalog": {
+ "description": "A description of a test environment.",
+ "type": "object",
+ "properties": {
+ "androidDeviceCatalog": {
+ "description": "Android devices suitable for running Android Instrumentation Tests.",
+ "$ref": "AndroidDeviceCatalog"
+ },
+ "networkConfigurationCatalog": {
+ "description": "Supported network configurations",
+ "$ref": "NetworkConfigurationCatalog"
+ }
+ },
+ "id": "TestEnvironmentCatalog"
+ },
+ "Locale": {
+ "description": "A location/region designation for language.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "A human-friendly name for this language/locale.\nExample: \"English\"\n@OutputOnly",
+ "type": "string"
+ },
+ "tags": {
+ "description": "Tags for this dimension.\nExamples: \"default\"",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "The id for this locale.\nExample: \"en_US\"\n@OutputOnly",
+ "type": "string"
+ },
+ "region": {
+ "description": "A human-friendy string representing the region for this locale.\nExample: \"United States\"\nNot present for every locale.\n@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "Locale"
+ },
+ "ObbFile": {
+ "description": "An opaque binary blob file to install on the device before the test starts",
+ "type": "object",
+ "properties": {
+ "obbFileName": {
+ "description": "OBB file name which must conform to the format as specified by\nAndroid\ne.g. [main|patch].0300110.com.example.android.obb\nwhich will be installed into\n \u003cshared-storage\u003e/Android/obb/\u003cpackage-name\u003e/\non the device\nRequired",
+ "type": "string"
+ },
+ "obb": {
+ "description": "Opaque Binary Blob (OBB) file(s) to install on the device\nRequired",
+ "$ref": "FileReference"
+ }
+ },
+ "id": "ObbFile"
+ },
+ "AndroidRuntimeConfiguration": {
+ "properties": {
+ "orientations": {
+ "description": "The set of available orientations.\n@OutputOnly",
+ "items": {
+ "$ref": "Orientation"
+ },
+ "type": "array"
+ },
+ "locales": {
+ "description": "The set of available locales.\n@OutputOnly",
+ "items": {
+ "$ref": "Locale"
+ },
+ "type": "array"
+ }
+ },
+ "id": "AndroidRuntimeConfiguration",
+ "description": "Configuration that can be selected at the time a test is run.",
+ "type": "object"
+ },
+ "AndroidDevice": {
+ "properties": {
+ "locale": {
+ "description": "The locale the test device used for testing.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired",
+ "type": "string"
+ },
+ "androidVersionId": {
+ "description": "The id of the Android OS version to be used.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired",
+ "type": "string"
+ },
+ "androidModelId": {
+ "description": "The id of the Android device to be used.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired",
+ "type": "string"
+ },
+ "orientation": {
+ "description": "How the device is oriented during the test.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired",
+ "type": "string"
+ }
+ },
+ "id": "AndroidDevice",
+ "description": "A single Android device.",
+ "type": "object"
+ },
+ "NetworkConfiguration": {
+ "properties": {
+ "id": {
+ "description": "The unique opaque id for this network traffic configuration\n@OutputOnly",
+ "type": "string"
+ },
+ "upRule": {
+ "$ref": "TrafficRule",
+ "description": "The emulation rule applying to the upload traffic"
+ },
+ "downRule": {
+ "$ref": "TrafficRule",
+ "description": "The emulation rule applying to the download traffic"
+ }
+ },
+ "id": "NetworkConfiguration",
+ "type": "object"
+ },
+ "ToolResultsStep": {
+ "properties": {
+ "executionId": {
+ "description": "A tool results execution ID.\n@OutputOnly",
+ "type": "string"
+ },
+ "stepId": {
+ "description": "A tool results step ID.\n@OutputOnly",
+ "type": "string"
+ },
+ "historyId": {
+ "description": "A tool results history ID.\n@OutputOnly",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The cloud project that owns the tool results step.\n@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "ToolResultsStep",
+ "description": "Represents a tool results step resource.\n\nThis has the results of a TestExecution.",
+ "type": "object"
+ },
+ "TrafficRule": {
+ "description": "Network emulation parameters",
+ "type": "object",
+ "properties": {
+ "burst": {
+ "format": "float",
+ "description": "Burst size in kbits",
+ "type": "number"
+ },
+ "bandwidth": {
+ "format": "float",
+ "description": "Bandwidth in kbits/second",
+ "type": "number"
+ },
+ "packetDuplicationRatio": {
+ "format": "float",
+ "description": "Packet duplication ratio (0.0 - 1.0)",
+ "type": "number"
+ },
+ "delay": {
+ "format": "google-duration",
+ "description": "Packet delay, must be \u003e= 0",
+ "type": "string"
+ },
+ "packetLossRatio": {
+ "format": "float",
+ "description": "Packet loss ratio (0.0 - 1.0)",
+ "type": "number"
+ }
+ },
+ "id": "TrafficRule"
+ },
+ "AndroidInstrumentationTest": {
+ "properties": {
+ "testRunnerClass": {
+ "description": "The InstrumentationTestRunner class.\nOptional, default is determined by examining the application's manifest.",
+ "type": "string"
+ },
+ "testPackageId": {
+ "description": "The java package for the test to be executed.\nOptional, default is determined by examining the application's manifest.",
+ "type": "string"
+ },
+ "appPackageId": {
+ "description": "The java package for the application under test.\nOptional, default is determined by examining the application's manifest.",
+ "type": "string"
+ },
+ "appApk": {
+ "description": "The APK for the application under test.\nRequired",
+ "$ref": "FileReference"
+ },
+ "orchestratorOption": {
+ "enumDescriptions": [
+ "This means that the server should choose the mode. And test will be run\nwithout orchestrator.\nUsing orchestrator is highly encouraged because of all the benefits it\noffers. And in the future, all instrumentation tests will be run with\norchestrator by default if preference unspecified.",
+ "Run test using orchestrator.\n** Only compatible with AndroidJUnitRunner version 1.0 or higher! **\nRecommended.",
+ "Run test without using orchestrator."
+ ],
+ "enum": [
+ "ORCHESTRATOR_OPTION_UNSPECIFIED",
+ "USE_ORCHESTRATOR",
+ "DO_NOT_USE_ORCHESTRATOR"
+ ],
+ "description": "The option of whether running each test within its own invocation of\ninstrumentation with Android Test Orchestrator or not.\n** Orchestrator is only compatible with AndroidJUnitRunner version 1.0 or\nhigher! **\nOrchestrator offers the following benefits:\n - No shared state\n - Crashes are isolated\n - Logs are scoped per test\n\nSee\n\u003chttps://developer.android.com/training/testing/junit-runner.html#using-android-test-orchestrator\u003e\nfor more information about Android Test Orchestrator.\n\nOptional, if empty, test will be run without orchestrator.",
+ "type": "string"
+ },
+ "testTargets": {
+ "description": "Each target must be fully qualified with the package name or class name,\nin one of these formats:\n - \"package package_name\"\n - \"class package_name.class_name\"\n - \"class package_name.class_name#method_name\"\n\nOptional, if empty, all targets in the module will be run.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "testApk": {
+ "$ref": "FileReference",
+ "description": "The APK containing the test code to be executed.\nRequired"
+ }
+ },
+ "id": "AndroidInstrumentationTest",
+ "description": "A test of an Android application that can control an Android component\nindependently of its normal lifecycle.\nAndroid instrumentation tests run an application APK and test APK inside the\nsame process on a virtual or physical AndroidDevice. They also specify\na test runner class, such as com.google.GoogleTestRunner, which can vary\non the specific instrumentation framework chosen.\n\nSee \u003chttp://developer.android.com/tools/testing/testing_android.html\u003e for\nmore information on types of Android tests.",
+ "type": "object"
+ },
+ "DeviceFile": {
+ "properties": {
+ "obbFile": {
+ "description": "A reference to an opaque binary blob file",
+ "$ref": "ObbFile"
+ }
+ },
+ "id": "DeviceFile",
+ "description": "A single device file description.",
+ "type": "object"
+ },
+ "ClientInfoDetail": {
+ "description": "Key-value pair of detailed information about the client which invoked the\ntest. For example {'Version', '1.0'}, {'Release Track', 'BETA'}",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The value of detailed client information.\nRequired",
+ "type": "string"
+ },
+ "key": {
+ "description": "The key of detailed client information.\nRequired",
+ "type": "string"
+ }
+ },
+ "id": "ClientInfoDetail"
+ },
+ "EnvironmentVariable": {
+ "description": "A key-value pair passed as an environment variable to the test",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Value for the environment variable",
+ "type": "string"
+ },
+ "key": {
+ "description": "Key for the environment variable",
+ "type": "string"
+ }
+ },
+ "id": "EnvironmentVariable"
+ },
+ "Environment": {
+ "description": "The environment in which the test is run.",
+ "type": "object",
+ "properties": {
+ "androidDevice": {
+ "$ref": "AndroidDevice",
+ "description": "An Android device which must be used with an Android test."
+ }
+ },
+ "id": "Environment"
+ },
+ "GoogleCloudStorage": {
+ "properties": {
+ "gcsPath": {
+ "description": "The path to a directory in GCS that will\neventually contain the results for this test.\nThe requesting user must have write access on the bucket in the supplied\npath.\nRequired",
+ "type": "string"
+ }
+ },
+ "id": "GoogleCloudStorage",
+ "description": "A storage location within Google cloud storage (GCS).",
+ "type": "object"
+ },
+ "TestExecution": {
+ "description": "Specifies a single test to be executed in a single environment.",
+ "type": "object",
+ "properties": {
+ "environment": {
+ "description": "How the host machine(s) are configured.\n@OutputOnly",
+ "$ref": "Environment"
+ },
+ "state": {
+ "enum": [
+ "TEST_STATE_UNSPECIFIED",
+ "VALIDATING",
+ "PENDING",
+ "RUNNING",
+ "FINISHED",
+ "ERROR",
+ "UNSUPPORTED_ENVIRONMENT",
+ "INCOMPATIBLE_ENVIRONMENT",
+ "INCOMPATIBLE_ARCHITECTURE",
+ "CANCELLED",
+ "INVALID"
+ ],
+ "description": "Indicates the current progress of the test execution (e.g., FINISHED).\n@OutputOnly",
+ "type": "string",
+ "enumDescriptions": [
+ "Do not use. For proto versioning only.",
+ "The execution or matrix is being validated.",
+ "The execution or matrix is waiting for resources to become available.",
+ "The execution is currently being processed.\n\nCan only be set on an execution.",
+ "The execution or matrix has terminated normally.\n\nOn a matrix this means that the matrix level processing completed normally,\nbut individual executions may be in an ERROR state.",
+ "The execution or matrix has stopped because it encountered an\ninfrastructure failure.",
+ "The execution was not run because it corresponds to a unsupported\nenvironment.\n\nCan only be set on an execution.",
+ "The execution was not run because the provided inputs are incompatible with\nthe requested environment.\n\nExample: requested AndroidVersion is lower than APK's minSdkVersion\n\nCan only be set on an execution.",
+ "The execution was not run because the provided inputs are incompatible with\nthe requested architecture.\n\nExample: requested device does not support running the native code in\nthe supplied APK\n\nCan only be set on an execution.",
+ "The user cancelled the execution.\n\nCan only be set on an execution.",
+ "The execution or matrix was not run because the provided inputs are not\nvalid.\n\nExamples: input file is not of the expected type, is malformed/corrupt, or\nwas flagged as malware"
+ ]
+ },
+ "toolResultsStep": {
+ "$ref": "ToolResultsStep",
+ "description": "Where the results for this execution are written.\n@OutputOnly"
+ },
+ "projectId": {
+ "description": "The cloud project that owns the test execution.\n@OutputOnly",
+ "type": "string"
+ },
+ "testSpecification": {
+ "description": "How to run the test.\n@OutputOnly",
+ "$ref": "TestSpecification"
+ },
+ "id": {
+ "description": "Unique id set by the backend.\n@OutputOnly",
+ "type": "string"
+ },
+ "timestamp": {
+ "format": "google-datetime",
+ "description": "The time this test execution was initially created.\n@OutputOnly",
+ "type": "string"
+ },
+ "testDetails": {
+ "$ref": "TestDetails",
+ "description": "Additional details about the running test.\n@OutputOnly"
+ },
+ "matrixId": {
+ "description": "Id of the containing TestMatrix.\n@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "TestExecution"
+ },
+ "RoboDirective": {
+ "description": "Directs Robo to interact with a specific UI element if it is encountered\nduring the crawl. Currently, Robo can perform text entry or element click.",
+ "type": "object",
+ "properties": {
+ "inputText": {
+ "description": "The text that Robo is directed to set. If left empty, the directive will be\ntreated as a CLICK on the element matching the resource_name.\nOptional",
+ "type": "string"
+ },
+ "resourceName": {
+ "description": "The android resource name of the target UI element\nFor example,\n in Java: R.string.foo\n in xml: @string/foo\nOnly the “foo” part is needed.\nReference doc:\nhttps://developer.android.com/guide/topics/resources/accessing-resources.html\nRequired",
+ "type": "string"
+ },
+ "actionType": {
+ "enum": [
+ "ACTION_TYPE_UNSPECIFIED",
+ "SINGLE_CLICK",
+ "ENTER_TEXT"
+ ],
+ "description": "The type of action that Robo should perform on the specified element.\nRequired.",
+ "type": "string",
+ "enumDescriptions": [
+ "DO NOT USE. For proto versioning only.",
+ "Direct Robo to click on the specified element. No-op if specified element\nis not clickable.",
+ "Direct Robo to enter text on the specified element. No-op if specified\nelement is not enabled or does not allow text entry."
+ ]
+ }
+ },
+ "id": "RoboDirective"
+ },
+ "AndroidMatrix": {
+ "description": "A set of Android device configuration permutations is defined by the\nthe cross-product of the given axes. Internally, the given AndroidMatrix\nwill be expanded into a set of AndroidDevices.\n\nOnly supported permutations will be instantiated. Invalid permutations\n(e.g., incompatible models/versions) are ignored.",
+ "type": "object",
+ "properties": {
+ "androidModelIds": {
+ "description": "The ids of the set of Android device to be used.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "orientations": {
+ "description": "The set of orientations to test with.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "locales": {
+ "description": "The set of locales the test device will enable for testing.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "androidVersionIds": {
+ "description": "The ids of the set of Android OS version to be used.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "id": "AndroidMatrix"
+ },
+ "AndroidModel": {
+ "properties": {
+ "brand": {
+ "description": "The company that this device is branded with.\nExample: \"Google\", \"Samsung\"\n@OutputOnly",
+ "type": "string"
+ },
+ "screenX": {
+ "format": "int32",
+ "description": "Screen size in the horizontal (X) dimension measured in pixels.\n@OutputOnly",
+ "type": "integer"
+ },
+ "codename": {
+ "description": "The name of the industrial design.\nThis corresponds to android.os.Build.DEVICE\n@OutputOnly",
+ "type": "string"
+ },
+ "screenY": {
+ "format": "int32",
+ "description": "Screen size in the vertical (Y) dimension measured in pixels.\n@OutputOnly",
+ "type": "integer"
+ },
+ "form": {
+ "enumDescriptions": [
+ "Do not use. For proto versioning only.",
+ "A software stack that simulates the device",
+ "Actual hardware"
+ ],
+ "enum": [
+ "DEVICE_FORM_UNSPECIFIED",
+ "VIRTUAL",
+ "PHYSICAL"
+ ],
+ "description": "Whether this device is virtual or physical.\n@OutputOnly",
+ "type": "string"
+ },
+ "screenDensity": {
+ "format": "int32",
+ "description": "Screen density in DPI.\nThis corresponds to ro.sf.lcd_density\n@OutputOnly",
+ "type": "integer"
+ },
+ "supportedVersionIds": {
+ "description": "The set of Android versions this device supports.\n@OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "supportedAbis": {
+ "description": "The list of supported ABIs for this device.\nThis corresponds to either android.os.Build.SUPPORTED_ABIS (for API level\n21 and above) or android.os.Build.CPU_ABI/CPU_ABI2.\nThe most preferred ABI is the first element in the list.\n\nElements are optionally prefixed by \"version_id:\" (where version_id is\nthe id of an AndroidVersion), denoting an ABI that is supported only on\na particular version.\n@OutputOnly",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "The human-readable marketing name for this device model.\nExamples: \"Nexus 5\", \"Galaxy S5\"\n@OutputOnly",
+ "type": "string"
+ },
+ "id": {
+ "description": "The unique opaque id for this model.\nUse this for invoking the TestExecutionService.\n@OutputOnly",
+ "type": "string"
+ },
+ "tags": {
+ "description": "Tags for this dimension.\nExamples: \"default\", \"preview\", \"deprecated\"",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "manufacturer": {
+ "description": "The manufacturer of this device.\n@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "AndroidModel",
+ "description": "A description of an Android device tests may be run on.",
+ "type": "object"
+ },
+ "TestSetup": {
+ "description": "A description of how to set up the device prior to running the test",
+ "type": "object",
+ "properties": {
+ "networkProfile": {
+ "description": "The network traffic profile used for running the test.\nOptional",
+ "type": "string"
+ },
+ "environmentVariables": {
+ "description": "Environment variables to set for the test (only applicable for\ninstrumentation tests).",
+ "items": {
+ "$ref": "EnvironmentVariable"
+ },
+ "type": "array"
+ },
+ "account": {
+ "description": "The device will be logged in on this account for the duration of the test.\nOptional",
+ "$ref": "Account"
+ },
+ "directoriesToPull": {
+ "description": "List of directories on the device to upload to GCS at the end of the test;\nthey must be absolute paths under /sdcard or /data/local/tmp.\nPath names are restricted to characters a-z A-Z 0-9 _ - . + and /\n\nNote: The paths /sdcard and /data will be made available and treated as\nimplicit path substitutions. E.g. if /sdcard on a particular device does\nnot map to external storage, the system will replace it with the external\nstorage path prefix for that device.\n\nOptional",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "filesToPush": {
+ "description": "List of files to push to the device before starting the test.\n\nOptional",
+ "items": {
+ "$ref": "DeviceFile"
+ },
+ "type": "array"
+ }
+ },
+ "id": "TestSetup"
+ },
+ "TestSpecification": {
+ "properties": {
+ "disableVideoRecording": {
+ "description": "Disables video recording; may reduce test latency.",
+ "type": "boolean"
+ },
+ "testTimeout": {
+ "format": "google-duration",
+ "description": "Max time a test execution is allowed to run before it is\nautomatically cancelled.\nOptional, default is 5 min.",
+ "type": "string"
+ },
+ "autoGoogleLogin": {
+ "description": "Enables automatic Google account login.\nIf set, the service will automatically generate a Google test account and\nadd it to the device, before executing the test. Note that test accounts\nmight be reused.\nMany applications show their full set of functionalities when an account is\npresent on the device. Logging into the device with these generated\naccounts allows testing more functionalities.\nDefault is false.\nOptional",
+ "type": "boolean"
+ },
+ "testSetup": {
+ "description": "Test setup requirements e.g. files to install, bootstrap scripts\nOptional",
+ "$ref": "TestSetup"
+ },
+ "androidRoboTest": {
+ "$ref": "AndroidRoboTest",
+ "description": "An Android robo test."
+ },
+ "androidTestLoop": {
+ "$ref": "AndroidTestLoop",
+ "description": "An Android Application with a Test Loop"
+ },
+ "androidInstrumentationTest": {
+ "description": "An Android instrumentation test.",
+ "$ref": "AndroidInstrumentationTest"
+ },
+ "disablePerformanceMetrics": {
+ "description": "Disables performance metrics recording; may reduce test latency.",
+ "type": "boolean"
+ }
+ },
+ "id": "TestSpecification",
+ "description": "A description of how to run the test.",
+ "type": "object"
}
},
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"protocol": "rest",
"version": "v1",
@@ -1321,11 +1323,11 @@
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
"https://www.googleapis.com/auth/cloud-platform.read-only": {
"description": "View your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
}
}
}
@@ -1340,8 +1342,6 @@
"batchPath": "batch",
"id": "testing:v1",
"documentationLink": "https://developers.google.com/cloud-test-lab/",
- "revision": "20171002",
- "title": "Google Cloud Testing API",
- "ownerName": "Google",
- "discoveryVersion": "v1"
+ "revision": "20171012",
+ "title": "Google Cloud Testing API"
}
diff --git a/testing/v1/testing-gen.go b/testing/v1/testing-gen.go
index 60a6a23..aae64d7 100644
--- a/testing/v1/testing-gen.go
+++ b/testing/v1/testing-gen.go
@@ -1864,10 +1864,20 @@
// Optional
Account *Account `json:"account,omitempty"`
- // DirectoriesToPull: The directories on the device to upload to GCS at
- // the end of the test;
- // they must be absolute, whitelisted paths.
- // Refer to RegularFile for whitelisted paths.
+ // DirectoriesToPull: List of directories on the device to upload to GCS
+ // at the end of the test;
+ // they must be absolute paths under /sdcard or /data/local/tmp.
+ // Path names are restricted to characters a-z A-Z 0-9 _ - . + and
+ // /
+ //
+ // Note: The paths /sdcard and /data will be made available and treated
+ // as
+ // implicit path substitutions. E.g. if /sdcard on a particular device
+ // does
+ // not map to external storage, the system will replace it with the
+ // external
+ // storage path prefix for that device.
+ //
// Optional
DirectoriesToPull []string `json:"directoriesToPull,omitempty"`
@@ -1876,7 +1886,10 @@
// instrumentation tests).
EnvironmentVariables []*EnvironmentVariable `json:"environmentVariables,omitempty"`
- // FilesToPush: Optional
+ // FilesToPush: List of files to push to the device before starting the
+ // test.
+ //
+ // Optional
FilesToPush []*DeviceFile `json:"filesToPush,omitempty"`
// NetworkProfile: The network traffic profile used for running the
diff --git a/translate/v2/translate-api.json b/translate/v2/translate-api.json
index b901c03..8c9f9b3 100644
--- a/translate/v2/translate-api.json
+++ b/translate/v2/translate-api.json
@@ -1,27 +1,13 @@
{
- "servicePath": "language/translate/",
- "description": "The Google Cloud Translation API lets websites and programs integrate with\n Google Translate programmatically.",
"kind": "discovery#restDescription",
+ "description": "The Google Cloud Translation API lets websites and programs integrate with\n Google Translate programmatically.",
+ "servicePath": "language/translate/",
"basePath": "/language/translate/",
"documentationLink": "https://code.google.com/apis/language/translate/v2/getting_started.html",
"revision": "20170525",
"id": "translate:v2",
"discoveryVersion": "v1",
"schemas": {
- "DetectLanguageRequest": {
- "type": "object",
- "properties": {
- "q": {
- "description": "The input text upon which to perform language detection. Repeat this\nparameter to perform language detection on multiple text inputs.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "id": "DetectLanguageRequest",
- "description": "The request message for language detection."
- },
"LanguagesResource": {
"type": "object",
"properties": {
@@ -37,28 +23,28 @@
"id": "LanguagesResource"
},
"DetectionsListResponse": {
+ "type": "object",
"properties": {
"detections": {
+ "description": "A detections contains detection results of several text",
"items": {
"$ref": "DetectionsResource"
},
- "type": "array",
- "description": "A detections contains detection results of several text"
+ "type": "array"
}
},
- "id": "DetectionsListResponse",
- "type": "object"
+ "id": "DetectionsListResponse"
},
"GetSupportedLanguagesRequest": {
- "id": "GetSupportedLanguagesRequest",
- "description": "The request message for discovering supported languages.",
- "type": "object",
"properties": {
"target": {
"description": "The language to use to return localized, human readable names of supported\nlanguages.",
"type": "string"
}
- }
+ },
+ "id": "GetSupportedLanguagesRequest",
+ "description": "The request message for discovering supported languages.",
+ "type": "object"
},
"LanguagesListResponse": {
"type": "object",
@@ -73,6 +59,24 @@
},
"id": "LanguagesListResponse"
},
+ "TranslationsResource": {
+ "type": "object",
+ "properties": {
+ "model": {
+ "description": "The `model` type used for this translation. Valid values are\nlisted in public documentation. Can be different from requested `model`.\nPresent only if specific model type was explicitly requested.",
+ "type": "string"
+ },
+ "translatedText": {
+ "description": "Text translated into the target language.",
+ "type": "string"
+ },
+ "detectedSourceLanguage": {
+ "description": "The source language of the initial request, detected automatically, if\nno source language was passed within the initial request. If the\nsource language was passed, auto-detection of the language will not\noccur and this field will be empty.",
+ "type": "string"
+ }
+ },
+ "id": "TranslationsResource"
+ },
"DetectionsResource": {
"description": "An array of languages which we detect for the given text The most likely language list first.",
"items": {
@@ -84,38 +88,19 @@
"type": "number"
},
"language": {
- "description": "The language we detected.",
- "type": "string"
+ "type": "string",
+ "description": "The language we detected."
},
"isReliable": {
- "type": "boolean",
- "description": "A boolean to indicate is the language detection result reliable."
+ "description": "A boolean to indicate is the language detection result reliable.",
+ "type": "boolean"
}
}
},
"type": "array",
"id": "DetectionsResource"
},
- "TranslationsResource": {
- "type": "object",
- "properties": {
- "detectedSourceLanguage": {
- "description": "The source language of the initial request, detected automatically, if\nno source language was passed within the initial request. If the\nsource language was passed, auto-detection of the language will not\noccur and this field will be empty.",
- "type": "string"
- },
- "model": {
- "description": "The `model` type used for this translation. Valid values are\nlisted in public documentation. Can be different from requested `model`.\nPresent only if specific model type was explicitly requested.",
- "type": "string"
- },
- "translatedText": {
- "description": "Text translated into the target language.",
- "type": "string"
- }
- },
- "id": "TranslationsResource"
- },
"TranslationsListResponse": {
- "description": "The main language translation response message.",
"type": "object",
"properties": {
"translations": {
@@ -126,16 +111,14 @@
"type": "array"
}
},
- "id": "TranslationsListResponse"
+ "id": "TranslationsListResponse",
+ "description": "The main language translation response message."
},
"TranslateTextRequest": {
+ "id": "TranslateTextRequest",
"description": "The main translation request message for the Cloud Translation API.",
"type": "object",
"properties": {
- "model": {
- "description": "The `model` type requested for this translation. Valid values are\nlisted in public documentation.",
- "type": "string"
- },
"target": {
"description": "The language to use for translation of the input text, set to one of the\nlanguage codes listed in Language Support.",
"type": "string"
@@ -145,24 +128,41 @@
"type": "string"
},
"q": {
+ "description": "The input text to translate. Repeat this parameter to perform translation\noperations on multiple text inputs.",
"items": {
"type": "string"
},
- "type": "array",
- "description": "The input text to translate. Repeat this parameter to perform translation\noperations on multiple text inputs."
+ "type": "array"
},
"source": {
"description": "The language of the source text, set to one of the language codes listed in\nLanguage Support. If the source language is not specified, the API will\nattempt to identify the source language automatically and return it within\nthe response.",
"type": "string"
+ },
+ "model": {
+ "description": "The `model` type requested for this translation. Valid values are\nlisted in public documentation.",
+ "type": "string"
}
- },
- "id": "TranslateTextRequest"
+ }
+ },
+ "DetectLanguageRequest": {
+ "id": "DetectLanguageRequest",
+ "description": "The request message for language detection.",
+ "type": "object",
+ "properties": {
+ "q": {
+ "description": "The input text upon which to perform language detection. Repeat this\nparameter to perform language detection on multiple text inputs.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ }
}
},
"protocol": "rest",
"icons": {
- "x16": "https://www.google.com/images/icons/product/translate-16.png",
- "x32": "https://www.google.com/images/icons/product/translate-32.png"
+ "x32": "https://www.google.com/images/icons/product/translate-32.png",
+ "x16": "https://www.google.com/images/icons/product/translate-16.png"
},
"canonicalName": "Translate",
"auth": {
@@ -187,128 +187,9 @@
],
"ownerName": "Google",
"resources": {
- "languages": {
- "methods": {
- "list": {
- "id": "language.languages.list",
- "path": "v2/languages",
- "description": "Returns a list of supported languages for translation.",
- "response": {
- "$ref": "LanguagesListResponse"
- },
- "httpMethod": "GET",
- "parameters": {
- "target": {
- "description": "The language to use to return localized, human readable names of supported\nlanguages.",
- "type": "string",
- "location": "query"
- },
- "model": {
- "location": "query",
- "description": "The model type for which supported languages should be returned.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-translation",
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- }
- },
- "translations": {
- "methods": {
- "translate": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-translation",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "path": "v2",
- "id": "language.translations.translate",
- "description": "Translates input text, returning translated text.",
- "request": {
- "$ref": "TranslateTextRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "TranslationsListResponse"
- }
- },
- "list": {
- "id": "language.translations.list",
- "path": "v2",
- "description": "Translates input text, returning translated text.",
- "response": {
- "$ref": "TranslationsListResponse"
- },
- "parameterOrder": [
- "q",
- "target"
- ],
- "httpMethod": "GET",
- "parameters": {
- "format": {
- "enumDescriptions": [
- "Specifies the input is in HTML",
- "Specifies the input is in plain textual format"
- ],
- "location": "query",
- "enum": [
- "html",
- "text"
- ],
- "description": "The format of the source text, in either HTML (default) or plain-text. A\nvalue of \"html\" indicates HTML and a value of \"text\" indicates plain-text.",
- "type": "string"
- },
- "model": {
- "location": "query",
- "description": "The `model` type requested for this translation. Valid values are\nlisted in public documentation.",
- "type": "string"
- },
- "q": {
- "description": "The input text to translate. Repeat this parameter to perform translation\noperations on multiple text inputs.",
- "required": true,
- "type": "string",
- "repeated": true,
- "location": "query"
- },
- "source": {
- "description": "The language of the source text, set to one of the language codes listed in\nLanguage Support. If the source language is not specified, the API will\nattempt to identify the source language automatically and return it within\nthe response.",
- "type": "string",
- "location": "query"
- },
- "cid": {
- "repeated": true,
- "location": "query",
- "description": "The customization id for translate",
- "type": "string"
- },
- "target": {
- "location": "query",
- "description": "The language to use for translation of the input text, set to one of the\nlanguage codes listed in Language Support.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-translation",
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- }
- },
"detections": {
"methods": {
"detect": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-translation",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "id": "language.detections.detect",
- "path": "v2/detect",
"description": "Detects the language of text within a request.",
"request": {
"$ref": "DetectLanguageRequest"
@@ -317,17 +198,23 @@
"$ref": "DetectionsListResponse"
},
"parameterOrder": [],
- "httpMethod": "POST"
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-translation",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "id": "language.detections.detect",
+ "path": "v2/detect"
},
"list": {
- "description": "Detects the language of text within a request.",
+ "httpMethod": "GET",
"response": {
"$ref": "DetectionsListResponse"
},
"parameterOrder": [
"q"
],
- "httpMethod": "GET",
"parameters": {
"q": {
"description": "The input text upon which to perform language detection. Repeat this\nparameter to perform language detection on multiple text inputs.",
@@ -341,61 +228,180 @@
"https://www.googleapis.com/auth/cloud-translation",
"https://www.googleapis.com/auth/cloud-platform"
],
+ "path": "v2/detect",
"id": "language.detections.list",
- "path": "v2/detect"
+ "description": "Detects the language of text within a request."
+ }
+ }
+ },
+ "languages": {
+ "methods": {
+ "list": {
+ "id": "language.languages.list",
+ "path": "v2/languages",
+ "description": "Returns a list of supported languages for translation.",
+ "response": {
+ "$ref": "LanguagesListResponse"
+ },
+ "httpMethod": "GET",
+ "parameters": {
+ "model": {
+ "location": "query",
+ "description": "The model type for which supported languages should be returned.",
+ "type": "string"
+ },
+ "target": {
+ "type": "string",
+ "location": "query",
+ "description": "The language to use to return localized, human readable names of supported\nlanguages."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-translation",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ },
+ "translations": {
+ "methods": {
+ "list": {
+ "description": "Translates input text, returning translated text.",
+ "response": {
+ "$ref": "TranslationsListResponse"
+ },
+ "parameterOrder": [
+ "q",
+ "target"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-translation",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "target": {
+ "description": "The language to use for translation of the input text, set to one of the\nlanguage codes listed in Language Support.",
+ "required": true,
+ "type": "string",
+ "location": "query"
+ },
+ "format": {
+ "location": "query",
+ "enum": [
+ "html",
+ "text"
+ ],
+ "description": "The format of the source text, in either HTML (default) or plain-text. A\nvalue of \"html\" indicates HTML and a value of \"text\" indicates plain-text.",
+ "type": "string",
+ "enumDescriptions": [
+ "Specifies the input is in HTML",
+ "Specifies the input is in plain textual format"
+ ]
+ },
+ "model": {
+ "description": "The `model` type requested for this translation. Valid values are\nlisted in public documentation.",
+ "type": "string",
+ "location": "query"
+ },
+ "q": {
+ "location": "query",
+ "description": "The input text to translate. Repeat this parameter to perform translation\noperations on multiple text inputs.",
+ "required": true,
+ "type": "string",
+ "repeated": true
+ },
+ "source": {
+ "type": "string",
+ "location": "query",
+ "description": "The language of the source text, set to one of the language codes listed in\nLanguage Support. If the source language is not specified, the API will\nattempt to identify the source language automatically and return it within\nthe response."
+ },
+ "cid": {
+ "location": "query",
+ "description": "The customization id for translate",
+ "type": "string",
+ "repeated": true
+ }
+ },
+ "id": "language.translations.list",
+ "path": "v2"
+ },
+ "translate": {
+ "request": {
+ "$ref": "TranslateTextRequest"
+ },
+ "description": "Translates input text, returning translated text.",
+ "response": {
+ "$ref": "TranslationsListResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-translation",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "id": "language.translations.translate",
+ "path": "v2"
}
}
}
},
"parameters": {
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
+ },
"bearer_token": {
- "description": "OAuth bearer token.",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "OAuth bearer token."
},
"oauth_token": {
- "location": "query",
"description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
"location": "query"
},
+ "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.",
"default": "true",
"type": "boolean"
},
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
"uploadType": {
- "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
},
"callback": {
+ "description": "JSONP",
"type": "string",
- "location": "query",
- "description": "JSONP"
+ "location": "query"
},
"$.xgafv": {
+ "enum": [
+ "1",
+ "2"
+ ],
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
+ "location": "query"
},
"alt": {
"enumDescriptions": [
@@ -414,25 +420,19 @@
"type": "string"
},
"key": {
+ "type": "string",
"location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
},
"access_token": {
- "description": "OAuth access token.",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "OAuth access token."
},
"quotaUser": {
"location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
"type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
- "location": "query"
}
},
"version": "v2",
diff --git a/vault/v1/vault-api.json b/vault/v1/vault-api.json
index 6153871..90e3cf0 100644
--- a/vault/v1/vault-api.json
+++ b/vault/v1/vault-api.json
@@ -1,472 +1,391 @@
{
- "resources": {
- "matters": {
- "methods": {
- "reopen": {
- "description": "Reopens the specified matter. Returns matter with updated state.",
- "request": {
- "$ref": "ReopenMatterRequest"
- },
- "response": {
- "$ref": "ReopenMatterResponse"
- },
- "parameterOrder": [
- "matterId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "matterId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The matter ID."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/ediscovery"
- ],
- "flatPath": "v1/matters/{matterId}:reopen",
- "id": "vault.matters.reopen",
- "path": "v1/matters/{matterId}:reopen"
- },
- "removePermissions": {
- "flatPath": "v1/matters/{matterId}:removePermissions",
- "id": "vault.matters.removePermissions",
- "path": "v1/matters/{matterId}:removePermissions",
- "description": "Removes an account as a matter collaborator.",
- "request": {
- "$ref": "RemoveMatterPermissionsRequest"
- },
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "matterId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "matterId": {
- "description": "The matter ID.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/ediscovery"
- ]
- },
- "close": {
- "httpMethod": "POST",
- "parameterOrder": [
- "matterId"
- ],
- "response": {
- "$ref": "CloseMatterResponse"
- },
- "parameters": {
- "matterId": {
- "description": "The matter ID.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/ediscovery"
- ],
- "flatPath": "v1/matters/{matterId}:close",
- "path": "v1/matters/{matterId}:close",
- "id": "vault.matters.close",
- "description": "Closes the specified matter. Returns matter with updated state.",
- "request": {
- "$ref": "CloseMatterRequest"
- }
- },
- "undelete": {
- "response": {
- "$ref": "Matter"
- },
- "parameterOrder": [
- "matterId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "matterId": {
- "location": "path",
- "description": "The matter ID.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/ediscovery"
- ],
- "flatPath": "v1/matters/{matterId}:undelete",
- "id": "vault.matters.undelete",
- "path": "v1/matters/{matterId}:undelete",
- "description": "Undeletes the specified matter. Returns matter with updated state.",
- "request": {
- "$ref": "UndeleteMatterRequest"
- }
- },
- "get": {
- "parameterOrder": [
- "matterId"
- ],
- "httpMethod": "GET",
- "response": {
- "$ref": "Matter"
- },
- "scopes": [
- "https://www.googleapis.com/auth/ediscovery",
- "https://www.googleapis.com/auth/ediscovery.readonly"
- ],
- "parameters": {
- "matterId": {
- "description": "The matter ID.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "view": {
- "location": "query",
- "enum": [
- "VIEW_UNSPECIFIED",
- "BASIC",
- "FULL"
- ],
- "description": "Specifies which parts of the Matter to return in the response.",
- "type": "string"
- }
- },
- "flatPath": "v1/matters/{matterId}",
- "id": "vault.matters.get",
- "path": "v1/matters/{matterId}",
- "description": "Gets the specified matter."
- },
- "update": {
- "response": {
- "$ref": "Matter"
- },
- "parameterOrder": [
- "matterId"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/ediscovery"
- ],
- "parameters": {
- "matterId": {
- "description": "The matter ID.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/matters/{matterId}",
- "id": "vault.matters.update",
- "path": "v1/matters/{matterId}",
- "request": {
- "$ref": "Matter"
- },
- "description": "Updates the specified matter.\nThis updates only the name and description of the matter, identified by\nmatter id. Changes to any other fields are ignored.\nReturns the default view of the matter."
- },
- "delete": {
- "description": "Deletes the specified matter. Returns matter with updated state.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "matterId"
- ],
- "response": {
- "$ref": "Matter"
- },
- "scopes": [
- "https://www.googleapis.com/auth/ediscovery"
- ],
- "parameters": {
- "matterId": {
- "location": "path",
- "description": "The matter ID",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/matters/{matterId}",
- "path": "v1/matters/{matterId}",
- "id": "vault.matters.delete"
- },
- "list": {
- "response": {
- "$ref": "ListMattersResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "pageSize": {
- "format": "int32",
- "description": "The number of matters to return in the response.\nDefault and maximum are 100.",
- "type": "integer",
- "location": "query"
- },
- "view": {
- "location": "query",
- "enum": [
- "VIEW_UNSPECIFIED",
- "BASIC",
- "FULL"
- ],
- "description": "Specifies which parts of the matter to return in response.",
- "type": "string"
- },
- "state": {
- "description": "If set, list only matters with that specific state. The default is listing\nmatters of all states.",
- "type": "string",
- "location": "query",
- "enum": [
- "STATE_UNSPECIFIED",
- "OPEN",
- "CLOSED",
- "DELETED"
- ]
- },
- "pageToken": {
- "description": "The pagination token as returned in the response.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/ediscovery",
- "https://www.googleapis.com/auth/ediscovery.readonly"
- ],
- "flatPath": "v1/matters",
- "id": "vault.matters.list",
- "path": "v1/matters",
- "description": "Lists matters the user has access to."
- },
- "addPermissions": {
- "request": {
- "$ref": "AddMatterPermissionsRequest"
- },
- "description": "Adds an account as a matter collaborator.",
- "httpMethod": "POST",
- "parameterOrder": [
- "matterId"
- ],
- "response": {
- "$ref": "MatterPermission"
- },
- "scopes": [
- "https://www.googleapis.com/auth/ediscovery"
- ],
- "parameters": {
- "matterId": {
- "location": "path",
- "description": "The matter ID.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/matters/{matterId}:addPermissions",
- "path": "v1/matters/{matterId}:addPermissions",
- "id": "vault.matters.addPermissions"
- },
- "create": {
- "flatPath": "v1/matters",
- "id": "vault.matters.create",
- "path": "v1/matters",
- "request": {
- "$ref": "Matter"
- },
- "description": "Creates a new matter with the given name and description. The initial state\nis open, and the owner is the method caller. Returns the created matter\nwith default view.",
- "response": {
- "$ref": "Matter"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/ediscovery"
- ],
- "parameters": {}
+ "basePath": "",
+ "id": "vault:v1",
+ "documentationLink": "https://developers.google.com/vault",
+ "revision": "20170812",
+ "discoveryVersion": "v1",
+ "version_module": true,
+ "schemas": {
+ "CloseMatterResponse": {
+ "id": "CloseMatterResponse",
+ "description": "Response to a CloseMatterRequest.",
+ "type": "object",
+ "properties": {
+ "matter": {
+ "$ref": "Matter",
+ "description": "The updated matter, with state CLOSED."
+ }
+ }
+ },
+ "HeldDriveQuery": {
+ "description": "Query options for drive holds.",
+ "type": "object",
+ "properties": {
+ "includeTeamDriveFiles": {
+ "description": "If true, include files in Team Drives in the hold.",
+ "type": "boolean"
}
},
+ "id": "HeldDriveQuery"
+ },
+ "HeldGroupsQuery": {
+ "description": "Query options for group holds.",
+ "type": "object",
+ "properties": {
+ "endTime": {
+ "format": "google-datetime",
+ "description": "The end date range for the search query. These timestamps are in GMT and\nrounded down to the start of the given date.",
+ "type": "string"
+ },
+ "startTime": {
+ "format": "google-datetime",
+ "description": "The start date range for the search query. These timestamps are in GMT and\nrounded down to the start of the given date.",
+ "type": "string"
+ },
+ "terms": {
+ "description": "The search terms for the hold.",
+ "type": "string"
+ }
+ },
+ "id": "HeldGroupsQuery"
+ },
+ "HeldOrgUnit": {
+ "type": "object",
+ "properties": {
+ "orgUnitId": {
+ "description": "The org unit's immutable ID as provided by the admin SDK.",
+ "type": "string"
+ },
+ "holdTime": {
+ "format": "google-datetime",
+ "description": "When the org unit was put on hold. This property is immutable.",
+ "type": "string"
+ }
+ },
+ "id": "HeldOrgUnit",
+ "description": "A organizational unit being held in a particular hold.\nThis structure is immutable."
+ },
+ "AddMatterPermissionsRequest": {
+ "type": "object",
+ "properties": {
+ "matterPermission": {
+ "$ref": "MatterPermission",
+ "description": "The MatterPermission to add."
+ },
+ "ccMe": {
+ "description": "Only relevant if send_emails is true.\nTrue to CC requestor in the email message.\nFalse to not CC requestor.",
+ "type": "boolean"
+ },
+ "sendEmails": {
+ "description": "True to send notification email to the added account.\nFalse to not send notification email.",
+ "type": "boolean"
+ }
+ },
+ "id": "AddMatterPermissionsRequest",
+ "description": "Add an account with the permission specified. The role cannot be owner.\nIf an account already has a role in the matter, it will be\noverwritten."
+ },
+ "Matter": {
+ "description": "Represents a matter.",
+ "type": "object",
+ "properties": {
+ "matterId": {
+ "description": "The matter ID which is generated by the server.\nShould be blank when creating a new matter.",
+ "type": "string"
+ },
+ "state": {
+ "type": "string",
+ "enumDescriptions": [
+ "The matter has no specified state.",
+ "This matter is open.",
+ "This matter is closed.",
+ "This matter is deleted."
+ ],
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "OPEN",
+ "CLOSED",
+ "DELETED"
+ ],
+ "description": "The state of the matter."
+ },
+ "matterPermissions": {
+ "items": {
+ "$ref": "MatterPermission"
+ },
+ "type": "array",
+ "description": "List of users and access to the matter. Currently there is no programmer\ndefined limit on the number of permissions a matter can have."
+ },
+ "name": {
+ "description": "The name of the matter.",
+ "type": "string"
+ },
+ "description": {
+ "description": "The description of the matter.",
+ "type": "string"
+ }
+ },
+ "id": "Matter"
+ },
+ "HeldAccount": {
+ "description": "An account being held in a particular hold. This structure is immutable.\nThis can be either a single user or a google group, depending on the corpus.",
+ "type": "object",
+ "properties": {
+ "holdTime": {
+ "format": "google-datetime",
+ "description": "When the account was put on hold.",
+ "type": "string"
+ },
+ "accountId": {
+ "description": "The account's ID as provided by the\n\u003ca href=\"https://developers.google.com/admin-sdk/\"\u003eAdmin SDK\u003c/a\u003e.",
+ "type": "string"
+ }
+ },
+ "id": "HeldAccount"
+ },
+ "ReopenMatterResponse": {
+ "id": "ReopenMatterResponse",
+ "description": "Response to a ReopenMatterRequest.",
+ "type": "object",
+ "properties": {
+ "matter": {
+ "description": "The updated matter, with state OPEN.",
+ "$ref": "Matter"
+ }
+ }
+ },
+ "CorpusQuery": {
+ "description": "Corpus specific queries.",
+ "type": "object",
+ "properties": {
+ "groupsQuery": {
+ "$ref": "HeldGroupsQuery",
+ "description": "Details pertaining to Groups holds. If set, corpus must be Groups."
+ },
+ "mailQuery": {
+ "$ref": "HeldMailQuery",
+ "description": "Details pertaining to mail holds. If set, corpus must be mail."
+ },
+ "driveQuery": {
+ "$ref": "HeldDriveQuery",
+ "description": "Details pertaining to Drive holds. If set, corpus must be Drive."
+ }
+ },
+ "id": "CorpusQuery"
+ },
+ "Hold": {
+ "description": "Represents a hold within Vault. A hold restricts purging of\nartifacts based on the combination of the query and accounts restrictions.\nA hold can be configured to either apply to an explicitly configured set\nof accounts, or can be applied to all members of an organizational unit.",
+ "type": "object",
+ "properties": {
+ "accounts": {
+ "description": "If set, the hold applies to the enumerated accounts and org_unit must be\nempty.",
+ "items": {
+ "$ref": "HeldAccount"
+ },
+ "type": "array"
+ },
+ "query": {
+ "$ref": "CorpusQuery",
+ "description": "The corpus-specific query. If set, the corpusQuery must match corpus\ntype."
+ },
+ "orgUnit": {
+ "$ref": "HeldOrgUnit",
+ "description": "If set, the hold applies to all members of the organizational unit and\naccounts must be empty. This property is mutable. For groups holds,\nset the accounts field."
+ },
+ "corpus": {
+ "enum": [
+ "CORPUS_TYPE_UNSPECIFIED",
+ "DRIVE",
+ "MAIL",
+ "GROUPS"
+ ],
+ "description": "The corpus to be searched.",
+ "type": "string",
+ "enumDescriptions": [
+ "No corpus specified.",
+ "Drive.",
+ "Mail.",
+ "Groups."
+ ]
+ },
+ "updateTime": {
+ "format": "google-datetime",
+ "description": "The last time this hold was modified.",
+ "type": "string"
+ },
+ "holdId": {
+ "description": "The unique immutable ID of the hold. Assigned during creation.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the hold.",
+ "type": "string"
+ }
+ },
+ "id": "Hold"
+ },
+ "ListHoldsResponse": {
+ "description": "The holds for a matter.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Page token to retrieve the next page of results in the list.\nIf this is empty, then there are no more holds to list.",
+ "type": "string"
+ },
+ "holds": {
+ "description": "The list of holds.",
+ "items": {
+ "$ref": "Hold"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListHoldsResponse"
+ },
+ "ListHeldAccountsResponse": {
+ "description": "Returns a list of held accounts for a hold.",
+ "type": "object",
+ "properties": {
+ "accounts": {
+ "description": "The held accounts on a hold.",
+ "items": {
+ "$ref": "HeldAccount"
+ },
+ "type": "array"
+ }
+ },
+ "id": "ListHeldAccountsResponse"
+ },
+ "UndeleteMatterRequest": {
+ "description": "Undelete a matter by ID.",
+ "type": "object",
+ "properties": {},
+ "id": "UndeleteMatterRequest"
+ },
+ "Empty": {
+ "type": "object",
+ "properties": {},
+ "id": "Empty",
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`."
+ },
+ "CloseMatterRequest": {
+ "description": "Close a matter by ID.",
+ "type": "object",
+ "properties": {},
+ "id": "CloseMatterRequest"
+ },
+ "ReopenMatterRequest": {
+ "type": "object",
+ "properties": {},
+ "id": "ReopenMatterRequest",
+ "description": "Reopen a matter by ID."
+ },
+ "RemoveMatterPermissionsRequest": {
+ "id": "RemoveMatterPermissionsRequest",
+ "description": "Remove an account as a matter collaborator.",
+ "type": "object",
+ "properties": {
+ "accountId": {
+ "description": "The account ID.",
+ "type": "string"
+ }
+ }
+ },
+ "MatterPermission": {
+ "description": "Currently each matter only has one owner, and all others are collaborators.\nWhen an account is purged, its corresponding MatterPermission resources\ncease to exist.",
+ "type": "object",
+ "properties": {
+ "role": {
+ "enumDescriptions": [
+ "No role assigned.",
+ "A collaborator to the matter.",
+ "The owner of the matter."
+ ],
+ "enum": [
+ "ROLE_UNSPECIFIED",
+ "COLLABORATOR",
+ "OWNER"
+ ],
+ "description": "The user's role in this matter.",
+ "type": "string"
+ },
+ "accountId": {
+ "description": "The account id, as provided by \u003ca href=\"https://developers.google.com/admin-sdk/\"\u003eAdmin SDK\u003c/a\u003e.",
+ "type": "string"
+ }
+ },
+ "id": "MatterPermission"
+ },
+ "ListMattersResponse": {
+ "id": "ListMattersResponse",
+ "description": "Provides the list of matters.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Page token to retrieve the next page of results in the list.",
+ "type": "string"
+ },
+ "matters": {
+ "description": "List of matters.",
+ "items": {
+ "$ref": "Matter"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "HeldMailQuery": {
+ "id": "HeldMailQuery",
+ "description": "Query options for mail holds.",
+ "type": "object",
+ "properties": {
+ "endTime": {
+ "format": "google-datetime",
+ "description": "The end date range for the search query. These timestamps are in GMT and\nrounded down to the start of the given date.",
+ "type": "string"
+ },
+ "startTime": {
+ "format": "google-datetime",
+ "description": "The start date range for the search query. These timestamps are in GMT and\nrounded down to the start of the given date.",
+ "type": "string"
+ },
+ "terms": {
+ "description": "The search terms for the hold.",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "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": "Vault",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/ediscovery.readonly": {
+ "description": "View your eDiscovery data"
+ },
+ "https://www.googleapis.com/auth/ediscovery": {
+ "description": "Manage your eDiscovery data"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://vault.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "vault",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Google Vault API",
+ "ownerName": "Google",
+ "resources": {
+ "matters": {
"resources": {
"holds": {
- "resources": {
- "accounts": {
- "methods": {
- "create": {
- "response": {
- "$ref": "HeldAccount"
- },
- "parameterOrder": [
- "matterId",
- "holdId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "holdId": {
- "location": "path",
- "description": "The hold ID.",
- "type": "string",
- "required": true
- },
- "matterId": {
- "description": "The matter ID.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/ediscovery"
- ],
- "flatPath": "v1/matters/{matterId}/holds/{holdId}/accounts",
- "id": "vault.matters.holds.accounts.create",
- "path": "v1/matters/{matterId}/holds/{holdId}/accounts",
- "description": "Adds a HeldAccount to a hold. Accounts can only be added to a hold that\nhas no held_org_unit set. Attempting to add an account to an OU-based\nhold will result in an error.",
- "request": {
- "$ref": "HeldAccount"
- }
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "matterId",
- "holdId",
- "accountId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/ediscovery"
- ],
- "parameters": {
- "holdId": {
- "location": "path",
- "description": "The hold ID.",
- "type": "string",
- "required": true
- },
- "accountId": {
- "location": "path",
- "description": "The ID of the account to remove from the hold.",
- "type": "string",
- "required": true
- },
- "matterId": {
- "description": "The matter ID.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "flatPath": "v1/matters/{matterId}/holds/{holdId}/accounts/{accountId}",
- "id": "vault.matters.holds.accounts.delete",
- "path": "v1/matters/{matterId}/holds/{holdId}/accounts/{accountId}",
- "description": "Removes a HeldAccount from a hold. If this request leaves the hold with\nno held accounts, the hold will not apply to any accounts."
- },
- "list": {
- "response": {
- "$ref": "ListHeldAccountsResponse"
- },
- "parameterOrder": [
- "matterId",
- "holdId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "matterId": {
- "location": "path",
- "description": "The matter ID.",
- "type": "string",
- "required": true
- },
- "holdId": {
- "description": "The hold ID.",
- "type": "string",
- "required": true,
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/ediscovery",
- "https://www.googleapis.com/auth/ediscovery.readonly"
- ],
- "flatPath": "v1/matters/{matterId}/holds/{holdId}/accounts",
- "id": "vault.matters.holds.accounts.list",
- "path": "v1/matters/{matterId}/holds/{holdId}/accounts",
- "description": "Lists HeldAccounts for a hold. This will only list individually specified\nheld accounts. If the hold is on an OU, then use\n\u003ca href=\"https://developers.google.com/admin-sdk/\"\u003eAdmin SDK\u003c/a\u003e\nto enumerate its members."
- }
- }
- }
- },
"methods": {
- "update": {
- "httpMethod": "PUT",
- "parameterOrder": [
- "matterId",
- "holdId"
- ],
- "response": {
- "$ref": "Hold"
- },
- "scopes": [
- "https://www.googleapis.com/auth/ediscovery"
- ],
- "parameters": {
- "holdId": {
- "description": "The ID of the hold.",
- "type": "string",
- "required": true,
- "location": "path"
- },
- "matterId": {
- "location": "path",
- "description": "The matter ID.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/matters/{matterId}/holds/{holdId}",
- "path": "v1/matters/{matterId}/holds/{holdId}",
- "id": "vault.matters.holds.update",
- "request": {
- "$ref": "Hold"
- },
- "description": "Updates the OU and/or query parameters of a hold. You cannot add accounts\nto a hold that covers an OU, nor can you add OUs to a hold that covers\nindividual accounts. Accounts listed in the hold will be ignored."
- },
- "create": {
- "path": "v1/matters/{matterId}/holds",
- "id": "vault.matters.holds.create",
- "request": {
- "$ref": "Hold"
- },
- "description": "Creates a hold in the given matter.",
- "httpMethod": "POST",
- "parameterOrder": [
- "matterId"
- ],
- "response": {
- "$ref": "Hold"
- },
- "scopes": [
- "https://www.googleapis.com/auth/ediscovery"
- ],
- "parameters": {
- "matterId": {
- "location": "path",
- "description": "The matter ID.",
- "type": "string",
- "required": true
- }
- },
- "flatPath": "v1/matters/{matterId}/holds"
- },
"delete": {
- "description": "Removes a hold by ID. This will release any HeldAccounts on this Hold.",
"httpMethod": "DELETE",
"parameterOrder": [
"matterId",
@@ -494,16 +413,22 @@
],
"flatPath": "v1/matters/{matterId}/holds/{holdId}",
"path": "v1/matters/{matterId}/holds/{holdId}",
- "id": "vault.matters.holds.delete"
+ "id": "vault.matters.holds.delete",
+ "description": "Removes a hold by ID. This will release any HeldAccounts on this Hold."
},
"list": {
+ "description": "Lists holds within a matter. An empty page token in ListHoldsResponse\ndenotes no more holds to list.",
+ "httpMethod": "GET",
"response": {
"$ref": "ListHoldsResponse"
},
"parameterOrder": [
"matterId"
],
- "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/ediscovery",
+ "https://www.googleapis.com/auth/ediscovery.readonly"
+ ],
"parameters": {
"pageSize": {
"format": "int32",
@@ -512,10 +437,10 @@
"location": "query"
},
"matterId": {
+ "location": "path",
"description": "The matter ID.",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
},
"pageToken": {
"location": "query",
@@ -523,18 +448,11 @@
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/ediscovery",
- "https://www.googleapis.com/auth/ediscovery.readonly"
- ],
"flatPath": "v1/matters/{matterId}/holds",
- "id": "vault.matters.holds.list",
"path": "v1/matters/{matterId}/holds",
- "description": "Lists holds within a matter. An empty page token in ListHoldsResponse\ndenotes no more holds to list."
+ "id": "vault.matters.holds.list"
},
"get": {
- "id": "vault.matters.holds.get",
- "path": "v1/matters/{matterId}/holds/{holdId}",
"description": "Gets a hold by ID.",
"response": {
"$ref": "Hold"
@@ -544,25 +462,488 @@
"holdId"
],
"httpMethod": "GET",
+ "parameters": {
+ "holdId": {
+ "description": "The hold ID.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "matterId": {
+ "description": "The matter ID.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/ediscovery",
"https://www.googleapis.com/auth/ediscovery.readonly"
],
+ "flatPath": "v1/matters/{matterId}/holds/{holdId}",
+ "id": "vault.matters.holds.get",
+ "path": "v1/matters/{matterId}/holds/{holdId}"
+ },
+ "update": {
+ "flatPath": "v1/matters/{matterId}/holds/{holdId}",
+ "path": "v1/matters/{matterId}/holds/{holdId}",
+ "id": "vault.matters.holds.update",
+ "request": {
+ "$ref": "Hold"
+ },
+ "description": "Updates the OU and/or query parameters of a hold. You cannot add accounts\nto a hold that covers an OU, nor can you add OUs to a hold that covers\nindividual accounts. Accounts listed in the hold will be ignored.",
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "matterId",
+ "holdId"
+ ],
+ "response": {
+ "$ref": "Hold"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ediscovery"
+ ],
"parameters": {
+ "holdId": {
+ "description": "The ID of the hold.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
"matterId": {
"location": "path",
"description": "The matter ID.",
"type": "string",
"required": true
- },
- "holdId": {
+ }
+ }
+ },
+ "create": {
+ "response": {
+ "$ref": "Hold"
+ },
+ "parameterOrder": [
+ "matterId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/ediscovery"
+ ],
+ "parameters": {
+ "matterId": {
"type": "string",
"required": true,
"location": "path",
- "description": "The hold ID."
+ "description": "The matter ID."
}
},
- "flatPath": "v1/matters/{matterId}/holds/{holdId}"
+ "flatPath": "v1/matters/{matterId}/holds",
+ "id": "vault.matters.holds.create",
+ "path": "v1/matters/{matterId}/holds",
+ "request": {
+ "$ref": "Hold"
+ },
+ "description": "Creates a hold in the given matter."
+ }
+ },
+ "resources": {
+ "accounts": {
+ "methods": {
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "matterId",
+ "holdId",
+ "accountId"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "matterId": {
+ "description": "The matter ID.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "holdId": {
+ "description": "The hold ID.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "accountId": {
+ "location": "path",
+ "description": "The ID of the account to remove from the hold.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ediscovery"
+ ],
+ "flatPath": "v1/matters/{matterId}/holds/{holdId}/accounts/{accountId}",
+ "path": "v1/matters/{matterId}/holds/{holdId}/accounts/{accountId}",
+ "id": "vault.matters.holds.accounts.delete",
+ "description": "Removes a HeldAccount from a hold. If this request leaves the hold with\nno held accounts, the hold will not apply to any accounts."
+ },
+ "list": {
+ "description": "Lists HeldAccounts for a hold. This will only list individually specified\nheld accounts. If the hold is on an OU, then use\n\u003ca href=\"https://developers.google.com/admin-sdk/\"\u003eAdmin SDK\u003c/a\u003e\nto enumerate its members.",
+ "response": {
+ "$ref": "ListHeldAccountsResponse"
+ },
+ "parameterOrder": [
+ "matterId",
+ "holdId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "holdId": {
+ "description": "The hold ID.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "matterId": {
+ "description": "The matter ID.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ediscovery",
+ "https://www.googleapis.com/auth/ediscovery.readonly"
+ ],
+ "flatPath": "v1/matters/{matterId}/holds/{holdId}/accounts",
+ "id": "vault.matters.holds.accounts.list",
+ "path": "v1/matters/{matterId}/holds/{holdId}/accounts"
+ },
+ "create": {
+ "request": {
+ "$ref": "HeldAccount"
+ },
+ "description": "Adds a HeldAccount to a hold. Accounts can only be added to a hold that\nhas no held_org_unit set. Attempting to add an account to an OU-based\nhold will result in an error.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "matterId",
+ "holdId"
+ ],
+ "response": {
+ "$ref": "HeldAccount"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ediscovery"
+ ],
+ "parameters": {
+ "holdId": {
+ "location": "path",
+ "description": "The hold ID.",
+ "type": "string",
+ "required": true
+ },
+ "matterId": {
+ "location": "path",
+ "description": "The matter ID.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/matters/{matterId}/holds/{holdId}/accounts",
+ "path": "v1/matters/{matterId}/holds/{holdId}/accounts",
+ "id": "vault.matters.holds.accounts.create"
+ }
+ }
+ }
+ }
+ }
+ },
+ "methods": {
+ "addPermissions": {
+ "path": "v1/matters/{matterId}:addPermissions",
+ "id": "vault.matters.addPermissions",
+ "request": {
+ "$ref": "AddMatterPermissionsRequest"
+ },
+ "description": "Adds an account as a matter collaborator.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "matterId"
+ ],
+ "response": {
+ "$ref": "MatterPermission"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ediscovery"
+ ],
+ "parameters": {
+ "matterId": {
+ "location": "path",
+ "description": "The matter ID.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/matters/{matterId}:addPermissions"
+ },
+ "list": {
+ "path": "v1/matters",
+ "id": "vault.matters.list",
+ "description": "Lists matters the user has access to.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListMattersResponse"
+ },
+ "parameterOrder": [],
+ "scopes": [
+ "https://www.googleapis.com/auth/ediscovery",
+ "https://www.googleapis.com/auth/ediscovery.readonly"
+ ],
+ "parameters": {
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "format": "int32",
+ "description": "The number of matters to return in the response.\nDefault and maximum are 100."
+ },
+ "view": {
+ "description": "Specifies which parts of the matter to return in response.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "VIEW_UNSPECIFIED",
+ "BASIC",
+ "FULL"
+ ]
+ },
+ "state": {
+ "description": "If set, list only matters with that specific state. The default is listing\nmatters of all states.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "OPEN",
+ "CLOSED",
+ "DELETED"
+ ]
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The pagination token as returned in the response.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/matters"
+ },
+ "create": {
+ "request": {
+ "$ref": "Matter"
+ },
+ "description": "Creates a new matter with the given name and description. The initial state\nis open, and the owner is the method caller. Returns the created matter\nwith default view.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Matter"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ediscovery"
+ ],
+ "parameters": {},
+ "flatPath": "v1/matters",
+ "path": "v1/matters",
+ "id": "vault.matters.create"
+ },
+ "removePermissions": {
+ "request": {
+ "$ref": "RemoveMatterPermissionsRequest"
+ },
+ "description": "Removes an account as a matter collaborator.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "matterId"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ediscovery"
+ ],
+ "parameters": {
+ "matterId": {
+ "description": "The matter ID.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/matters/{matterId}:removePermissions",
+ "path": "v1/matters/{matterId}:removePermissions",
+ "id": "vault.matters.removePermissions"
+ },
+ "reopen": {
+ "flatPath": "v1/matters/{matterId}:reopen",
+ "path": "v1/matters/{matterId}:reopen",
+ "id": "vault.matters.reopen",
+ "description": "Reopens the specified matter. Returns matter with updated state.",
+ "request": {
+ "$ref": "ReopenMatterRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "matterId"
+ ],
+ "response": {
+ "$ref": "ReopenMatterResponse"
+ },
+ "parameters": {
+ "matterId": {
+ "location": "path",
+ "description": "The matter ID.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ediscovery"
+ ]
+ },
+ "close": {
+ "scopes": [
+ "https://www.googleapis.com/auth/ediscovery"
+ ],
+ "parameters": {
+ "matterId": {
+ "location": "path",
+ "description": "The matter ID.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "flatPath": "v1/matters/{matterId}:close",
+ "id": "vault.matters.close",
+ "path": "v1/matters/{matterId}:close",
+ "request": {
+ "$ref": "CloseMatterRequest"
+ },
+ "description": "Closes the specified matter. Returns matter with updated state.",
+ "response": {
+ "$ref": "CloseMatterResponse"
+ },
+ "parameterOrder": [
+ "matterId"
+ ],
+ "httpMethod": "POST"
+ },
+ "get": {
+ "flatPath": "v1/matters/{matterId}",
+ "path": "v1/matters/{matterId}",
+ "id": "vault.matters.get",
+ "description": "Gets the specified matter.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Matter"
+ },
+ "parameterOrder": [
+ "matterId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/ediscovery",
+ "https://www.googleapis.com/auth/ediscovery.readonly"
+ ],
+ "parameters": {
+ "view": {
+ "location": "query",
+ "enum": [
+ "VIEW_UNSPECIFIED",
+ "BASIC",
+ "FULL"
+ ],
+ "description": "Specifies which parts of the Matter to return in the response.",
+ "type": "string"
+ },
+ "matterId": {
+ "location": "path",
+ "description": "The matter ID.",
+ "type": "string",
+ "required": true
+ }
+ }
+ },
+ "undelete": {
+ "response": {
+ "$ref": "Matter"
+ },
+ "parameterOrder": [
+ "matterId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "matterId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The matter ID."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ediscovery"
+ ],
+ "flatPath": "v1/matters/{matterId}:undelete",
+ "id": "vault.matters.undelete",
+ "path": "v1/matters/{matterId}:undelete",
+ "description": "Undeletes the specified matter. Returns matter with updated state.",
+ "request": {
+ "$ref": "UndeleteMatterRequest"
+ }
+ },
+ "update": {
+ "response": {
+ "$ref": "Matter"
+ },
+ "parameterOrder": [
+ "matterId"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "matterId": {
+ "description": "The matter ID.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ediscovery"
+ ],
+ "flatPath": "v1/matters/{matterId}",
+ "id": "vault.matters.update",
+ "path": "v1/matters/{matterId}",
+ "description": "Updates the specified matter.\nThis updates only the name and description of the matter, identified by\nmatter id. Changes to any other fields are ignored.\nReturns the default view of the matter.",
+ "request": {
+ "$ref": "Matter"
+ }
+ },
+ "delete": {
+ "flatPath": "v1/matters/{matterId}",
+ "path": "v1/matters/{matterId}",
+ "id": "vault.matters.delete",
+ "description": "Deletes the specified matter. Returns matter with updated state.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "matterId"
+ ],
+ "response": {
+ "$ref": "Matter"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ediscovery"
+ ],
+ "parameters": {
+ "matterId": {
+ "location": "path",
+ "description": "The matter ID",
+ "type": "string",
+ "required": true
}
}
}
@@ -570,48 +951,25 @@
}
},
"parameters": {
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
- },
- "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",
- "description": "JSONP"
+ "location": "query"
},
"$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
+ "type": "string"
},
"alt": {
- "description": "Data format for response.",
- "default": "json",
"enum": [
"json",
"media",
@@ -623,424 +981,66 @@
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
- "location": "query"
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
},
"key": {
- "type": "string",
"location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
},
"access_token": {
+ "location": "query",
"description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string",
"location": "query"
},
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
"pp": {
- "default": "true",
- "type": "boolean",
"location": "query",
- "description": "Pretty-print response."
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean"
},
"oauth_token": {
- "location": "query",
"description": "OAuth 2.0 token for the current user.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"bearer_token": {
"location": "query",
"description": "OAuth bearer token.",
"type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "type": "boolean",
+ "location": "query",
+ "description": "Returns response with indentations and line breaks."
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
}
},
"version": "v1",
"baseUrl": "https://vault.googleapis.com/",
"kind": "discovery#restDescription",
"description": "Archiving and eDiscovery for G Suite.",
- "servicePath": "",
- "basePath": "",
- "revision": "20170812",
- "documentationLink": "https://developers.google.com/vault",
- "id": "vault:v1",
- "discoveryVersion": "v1",
- "version_module": true,
- "schemas": {
- "MatterPermission": {
- "id": "MatterPermission",
- "description": "Currently each matter only has one owner, and all others are collaborators.\nWhen an account is purged, its corresponding MatterPermission resources\ncease to exist.",
- "type": "object",
- "properties": {
- "accountId": {
- "type": "string",
- "description": "The account id, as provided by \u003ca href=\"https://developers.google.com/admin-sdk/\"\u003eAdmin SDK\u003c/a\u003e."
- },
- "role": {
- "enum": [
- "ROLE_UNSPECIFIED",
- "COLLABORATOR",
- "OWNER"
- ],
- "description": "The user's role in this matter.",
- "type": "string",
- "enumDescriptions": [
- "No role assigned.",
- "A collaborator to the matter.",
- "The owner of the matter."
- ]
- }
- }
- },
- "ListMattersResponse": {
- "description": "Provides the list of matters.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "Page token to retrieve the next page of results in the list."
- },
- "matters": {
- "description": "List of matters.",
- "items": {
- "$ref": "Matter"
- },
- "type": "array"
- }
- },
- "id": "ListMattersResponse"
- },
- "HeldMailQuery": {
- "description": "Query options for mail holds.",
- "type": "object",
- "properties": {
- "startTime": {
- "format": "google-datetime",
- "description": "The start date range for the search query. These timestamps are in GMT and\nrounded down to the start of the given date.",
- "type": "string"
- },
- "terms": {
- "description": "The search terms for the hold.",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "The end date range for the search query. These timestamps are in GMT and\nrounded down to the start of the given date.",
- "type": "string"
- }
- },
- "id": "HeldMailQuery"
- },
- "CloseMatterResponse": {
- "description": "Response to a CloseMatterRequest.",
- "type": "object",
- "properties": {
- "matter": {
- "$ref": "Matter",
- "description": "The updated matter, with state CLOSED."
- }
- },
- "id": "CloseMatterResponse"
- },
- "HeldDriveQuery": {
- "properties": {
- "includeTeamDriveFiles": {
- "description": "If true, include files in Team Drives in the hold.",
- "type": "boolean"
- }
- },
- "id": "HeldDriveQuery",
- "description": "Query options for drive holds.",
- "type": "object"
- },
- "HeldGroupsQuery": {
- "description": "Query options for group holds.",
- "type": "object",
- "properties": {
- "terms": {
- "description": "The search terms for the hold.",
- "type": "string"
- },
- "endTime": {
- "format": "google-datetime",
- "description": "The end date range for the search query. These timestamps are in GMT and\nrounded down to the start of the given date.",
- "type": "string"
- },
- "startTime": {
- "format": "google-datetime",
- "description": "The start date range for the search query. These timestamps are in GMT and\nrounded down to the start of the given date.",
- "type": "string"
- }
- },
- "id": "HeldGroupsQuery"
- },
- "HeldOrgUnit": {
- "description": "A organizational unit being held in a particular hold.\nThis structure is immutable.",
- "type": "object",
- "properties": {
- "holdTime": {
- "format": "google-datetime",
- "description": "When the org unit was put on hold. This property is immutable.",
- "type": "string"
- },
- "orgUnitId": {
- "description": "The org unit's immutable ID as provided by the admin SDK.",
- "type": "string"
- }
- },
- "id": "HeldOrgUnit"
- },
- "AddMatterPermissionsRequest": {
- "description": "Add an account with the permission specified. The role cannot be owner.\nIf an account already has a role in the matter, it will be\noverwritten.",
- "type": "object",
- "properties": {
- "sendEmails": {
- "description": "True to send notification email to the added account.\nFalse to not send notification email.",
- "type": "boolean"
- },
- "matterPermission": {
- "description": "The MatterPermission to add.",
- "$ref": "MatterPermission"
- },
- "ccMe": {
- "description": "Only relevant if send_emails is true.\nTrue to CC requestor in the email message.\nFalse to not CC requestor.",
- "type": "boolean"
- }
- },
- "id": "AddMatterPermissionsRequest"
- },
- "Matter": {
- "type": "object",
- "properties": {
- "state": {
- "description": "The state of the matter.",
- "type": "string",
- "enumDescriptions": [
- "The matter has no specified state.",
- "This matter is open.",
- "This matter is closed.",
- "This matter is deleted."
- ],
- "enum": [
- "STATE_UNSPECIFIED",
- "OPEN",
- "CLOSED",
- "DELETED"
- ]
- },
- "matterPermissions": {
- "description": "List of users and access to the matter. Currently there is no programmer\ndefined limit on the number of permissions a matter can have.",
- "items": {
- "$ref": "MatterPermission"
- },
- "type": "array"
- },
- "name": {
- "description": "The name of the matter.",
- "type": "string"
- },
- "description": {
- "description": "The description of the matter.",
- "type": "string"
- },
- "matterId": {
- "type": "string",
- "description": "The matter ID which is generated by the server.\nShould be blank when creating a new matter."
- }
- },
- "id": "Matter",
- "description": "Represents a matter."
- },
- "HeldAccount": {
- "description": "An account being held in a particular hold. This structure is immutable.\nThis can be either a single user or a google group, depending on the corpus.",
- "type": "object",
- "properties": {
- "accountId": {
- "description": "The account's ID as provided by the\n\u003ca href=\"https://developers.google.com/admin-sdk/\"\u003eAdmin SDK\u003c/a\u003e.",
- "type": "string"
- },
- "holdTime": {
- "type": "string",
- "format": "google-datetime",
- "description": "When the account was put on hold."
- }
- },
- "id": "HeldAccount"
- },
- "ReopenMatterResponse": {
- "description": "Response to a ReopenMatterRequest.",
- "type": "object",
- "properties": {
- "matter": {
- "$ref": "Matter",
- "description": "The updated matter, with state OPEN."
- }
- },
- "id": "ReopenMatterResponse"
- },
- "CorpusQuery": {
- "description": "Corpus specific queries.",
- "type": "object",
- "properties": {
- "groupsQuery": {
- "$ref": "HeldGroupsQuery",
- "description": "Details pertaining to Groups holds. If set, corpus must be Groups."
- },
- "mailQuery": {
- "$ref": "HeldMailQuery",
- "description": "Details pertaining to mail holds. If set, corpus must be mail."
- },
- "driveQuery": {
- "description": "Details pertaining to Drive holds. If set, corpus must be Drive.",
- "$ref": "HeldDriveQuery"
- }
- },
- "id": "CorpusQuery"
- },
- "Hold": {
- "description": "Represents a hold within Vault. A hold restricts purging of\nartifacts based on the combination of the query and accounts restrictions.\nA hold can be configured to either apply to an explicitly configured set\nof accounts, or can be applied to all members of an organizational unit.",
- "type": "object",
- "properties": {
- "corpus": {
- "description": "The corpus to be searched.",
- "type": "string",
- "enumDescriptions": [
- "No corpus specified.",
- "Drive.",
- "Mail.",
- "Groups."
- ],
- "enum": [
- "CORPUS_TYPE_UNSPECIFIED",
- "DRIVE",
- "MAIL",
- "GROUPS"
- ]
- },
- "updateTime": {
- "format": "google-datetime",
- "description": "The last time this hold was modified.",
- "type": "string"
- },
- "name": {
- "description": "The name of the hold.",
- "type": "string"
- },
- "holdId": {
- "type": "string",
- "description": "The unique immutable ID of the hold. Assigned during creation."
- },
- "accounts": {
- "description": "If set, the hold applies to the enumerated accounts and org_unit must be\nempty.",
- "items": {
- "$ref": "HeldAccount"
- },
- "type": "array"
- },
- "orgUnit": {
- "$ref": "HeldOrgUnit",
- "description": "If set, the hold applies to all members of the organizational unit and\naccounts must be empty. This property is mutable. For groups holds,\nset the accounts field."
- },
- "query": {
- "description": "The corpus-specific query. If set, the corpusQuery must match corpus\ntype.",
- "$ref": "CorpusQuery"
- }
- },
- "id": "Hold"
- },
- "ListHoldsResponse": {
- "id": "ListHoldsResponse",
- "description": "The holds for a matter.",
- "type": "object",
- "properties": {
- "holds": {
- "description": "The list of holds.",
- "items": {
- "$ref": "Hold"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "Page token to retrieve the next page of results in the list.\nIf this is empty, then there are no more holds to list.",
- "type": "string"
- }
- }
- },
- "ListHeldAccountsResponse": {
- "id": "ListHeldAccountsResponse",
- "description": "Returns a list of held accounts for a hold.",
- "type": "object",
- "properties": {
- "accounts": {
- "description": "The held accounts on a hold.",
- "items": {
- "$ref": "HeldAccount"
- },
- "type": "array"
- }
- }
- },
- "UndeleteMatterRequest": {
- "description": "Undelete a matter by ID.",
- "type": "object",
- "properties": {},
- "id": "UndeleteMatterRequest"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "CloseMatterRequest": {
- "description": "Close a matter by ID.",
- "type": "object",
- "properties": {},
- "id": "CloseMatterRequest"
- },
- "ReopenMatterRequest": {
- "description": "Reopen a matter by ID.",
- "type": "object",
- "properties": {},
- "id": "ReopenMatterRequest"
- },
- "RemoveMatterPermissionsRequest": {
- "id": "RemoveMatterPermissionsRequest",
- "description": "Remove an account as a matter collaborator.",
- "type": "object",
- "properties": {
- "accountId": {
- "description": "The account ID.",
- "type": "string"
- }
- }
- }
- },
- "protocol": "rest",
- "icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
- "canonicalName": "Vault",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/ediscovery": {
- "description": "Manage your eDiscovery data"
- },
- "https://www.googleapis.com/auth/ediscovery.readonly": {
- "description": "View your eDiscovery data"
- }
- }
- }
- },
- "rootUrl": "https://vault.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "vault",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Google Vault API",
- "ownerName": "Google"
+ "servicePath": ""
}
diff --git a/videointelligence/v1beta1/videointelligence-api.json b/videointelligence/v1beta1/videointelligence-api.json
index 458aa56..be7e5e2 100644
--- a/videointelligence/v1beta1/videointelligence-api.json
+++ b/videointelligence/v1beta1/videointelligence-api.json
@@ -1,28 +1,70 @@
{
+ "basePath": "",
+ "revision": "20171004",
+ "documentationLink": "https://cloud.google.com/video-intelligence/docs/",
+ "id": "videointelligence:v1beta1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "GoogleCloudVideointelligenceV1beta1_AnnotateVideoProgress": {
+ "description": "Video annotation progress. Included in the `metadata`\nfield of the `Operation` returned by the `GetOperation`\ncall of the `google::longrunning::Operations` service.",
+ "type": "object",
+ "properties": {
+ "annotationProgress": {
+ "description": "Progress metadata for all videos specified in `AnnotateVideoRequest`.",
+ "items": {
+ "$ref": "GoogleCloudVideointelligenceV1beta1_VideoAnnotationProgress"
+ },
+ "type": "array"
+ }
+ },
+ "id": "GoogleCloudVideointelligenceV1beta1_AnnotateVideoProgress"
+ },
+ "GoogleCloudVideointelligenceV1beta2_Entity": {
+ "description": "Detected entity from video analysis.",
+ "type": "object",
+ "properties": {
+ "entityId": {
+ "type": "string",
+ "description": "Opaque entity ID. Some IDs may be available in\n[Google Knowledge Graph Search\nAPI](https://developers.google.com/knowledge-graph/)."
+ },
+ "description": {
+ "description": "Textual description, e.g. `Fixed-gear bicycle`.",
+ "type": "string"
+ },
+ "languageCode": {
+ "type": "string",
+ "description": "Language code for `description` in BCP-47 format."
+ }
+ },
+ "id": "GoogleCloudVideointelligenceV1beta2_Entity"
+ },
"GoogleCloudVideointelligenceV1beta2_VideoSegment": {
"description": "Video segment.",
"type": "object",
"properties": {
"endTimeOffset": {
- "format": "google-duration",
- "description": "Time-offset, relative to the beginning of the video,\ncorresponding to the end of the segment (inclusive).",
- "type": "string"
- },
- "startTimeOffset": {
"type": "string",
"format": "google-duration",
- "description": "Time-offset, relative to the beginning of the video,\ncorresponding to the start of the segment (inclusive)."
+ "description": "Time-offset, relative to the beginning of the video,\ncorresponding to the end of the segment (inclusive)."
+ },
+ "startTimeOffset": {
+ "format": "google-duration",
+ "description": "Time-offset, relative to the beginning of the video,\ncorresponding to the start of the segment (inclusive).",
+ "type": "string"
}
},
"id": "GoogleCloudVideointelligenceV1beta2_VideoSegment"
},
"GoogleCloudVideointelligenceV1_VideoAnnotationResults": {
- "description": "Annotation results for a single video.",
- "type": "object",
"properties": {
+ "labelAnnotations": {
+ "description": "Label annotations. There is exactly one element for each unique label.",
+ "items": {
+ "$ref": "GoogleCloudVideointelligenceV1_LabelAnnotation"
+ },
+ "type": "array"
+ },
"error": {
"$ref": "GoogleRpc_Status",
"description": "If set, indicates an error. Note that for a single `AnnotateVideoRequest`\nsome videos may succeed and some may fail."
@@ -35,29 +77,27 @@
"type": "array"
},
"safeSearchAnnotations": {
+ "description": "Safe search annotations.",
"items": {
"$ref": "GoogleCloudVideointelligenceV1_SafeSearchAnnotation"
},
- "type": "array",
- "description": "Safe search annotations."
+ "type": "array"
},
"inputUri": {
"description": "Video file location in\n[Google Cloud Storage](https://cloud.google.com/storage/).",
"type": "string"
- },
- "labelAnnotations": {
- "description": "Label annotations. There is exactly one element for each unique label.",
- "items": {
- "$ref": "GoogleCloudVideointelligenceV1_LabelAnnotation"
- },
- "type": "array"
}
},
- "id": "GoogleCloudVideointelligenceV1_VideoAnnotationResults"
+ "id": "GoogleCloudVideointelligenceV1_VideoAnnotationResults",
+ "description": "Annotation results for a single video.",
+ "type": "object"
},
"GoogleCloudVideointelligenceV1_LabelLocation": {
- "type": "object",
"properties": {
+ "segment": {
+ "$ref": "GoogleCloudVideointelligenceV1_VideoSegment",
+ "description": "Video segment. Unset for video-level labels.\nSet to a frame timestamp for frame-level labels.\nOtherwise, corresponds to one of `AnnotateSpec.segments`\n(if specified) or to shot boundaries (if requested)."
+ },
"level": {
"enumDescriptions": [
"Unspecified.",
@@ -80,38 +120,30 @@
"format": "float",
"description": "Confidence that the label is accurate. Range: [0, 1].",
"type": "number"
- },
- "segment": {
- "$ref": "GoogleCloudVideointelligenceV1_VideoSegment",
- "description": "Video segment. Unset for video-level labels.\nSet to a frame timestamp for frame-level labels.\nOtherwise, corresponds to one of `AnnotateSpec.segments`\n(if specified) or to shot boundaries (if requested)."
}
},
"id": "GoogleCloudVideointelligenceV1_LabelLocation",
- "description": "Label location."
+ "description": "Label location.",
+ "type": "object"
},
"GoogleCloudVideointelligenceV1beta2_AnnotateVideoResponse": {
- "description": "Video annotation response. Included in the `response`\nfield of the `Operation` returned by the `GetOperation`\ncall of the `google::longrunning::Operations` service.",
"type": "object",
"properties": {
"annotationResults": {
+ "description": "Annotation results for all videos specified in `AnnotateVideoRequest`.",
"items": {
"$ref": "GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults"
},
- "type": "array",
- "description": "Annotation results for all videos specified in `AnnotateVideoRequest`."
+ "type": "array"
}
},
- "id": "GoogleCloudVideointelligenceV1beta2_AnnotateVideoResponse"
+ "id": "GoogleCloudVideointelligenceV1beta2_AnnotateVideoResponse",
+ "description": "Video annotation response. Included in the `response`\nfield of the `Operation` returned by the `GetOperation`\ncall of the `google::longrunning::Operations` service."
},
"GoogleCloudVideointelligenceV1beta1_LabelAnnotation": {
- "id": "GoogleCloudVideointelligenceV1beta1_LabelAnnotation",
"description": "Label annotation.",
"type": "object",
"properties": {
- "description": {
- "type": "string",
- "description": "Textual description, e.g. `Fixed-gear bicycle`."
- },
"locations": {
"description": "Where the label was detected and with what confidence.",
"items": {
@@ -120,37 +152,44 @@
"type": "array"
},
"languageCode": {
- "type": "string",
- "description": "Language code for `description` in BCP-47 format."
- }
- }
- },
- "GoogleCloudVideointelligenceV1_LabelAnnotation": {
- "description": "Label annotation.",
- "type": "object",
- "properties": {
- "languageCode": {
"description": "Language code for `description` in BCP-47 format.",
"type": "string"
},
"description": {
- "description": "Textual description, e.g. `Fixed-gear bicycle`.",
- "type": "string"
- },
- "locations": {
- "items": {
- "$ref": "GoogleCloudVideointelligenceV1_LabelLocation"
- },
- "type": "array",
- "description": "Where the label was detected and with what confidence."
+ "type": "string",
+ "description": "Textual description, e.g. `Fixed-gear bicycle`."
}
},
- "id": "GoogleCloudVideointelligenceV1_LabelAnnotation"
+ "id": "GoogleCloudVideointelligenceV1beta1_LabelAnnotation"
},
"GoogleCloudVideointelligenceV1beta1_VideoContext": {
"description": "Video context and/or feature-specific parameters.",
"type": "object",
"properties": {
+ "labelDetectionMode": {
+ "enumDescriptions": [
+ "Unspecified.",
+ "Detect shot-level labels.",
+ "Detect frame-level labels.",
+ "Detect both shot-level and frame-level labels."
+ ],
+ "enum": [
+ "LABEL_DETECTION_MODE_UNSPECIFIED",
+ "SHOT_MODE",
+ "FRAME_MODE",
+ "SHOT_AND_FRAME_MODE"
+ ],
+ "description": "If label detection has been requested, what labels should be detected\nin addition to video-level labels or segment-level labels. If unspecified,\ndefaults to `SHOT_MODE`.",
+ "type": "string"
+ },
+ "stationaryCamera": {
+ "description": "Whether the video has been shot from a stationary (i.e. non-moving) camera.\nWhen set to true, might improve detection accuracy for moving objects.",
+ "type": "boolean"
+ },
+ "safeSearchDetectionModel": {
+ "description": "Model to use for safe search detection.\nSupported values: \"latest\" and \"stable\" (the default).",
+ "type": "string"
+ },
"segments": {
"description": "Video segments to annotate. The segments may overlap and are not required\nto be contiguous or span the whole video. If unspecified, each video\nis treated as a single segment.",
"items": {
@@ -159,44 +198,53 @@
"type": "array"
},
"labelDetectionModel": {
- "description": "Model to use for label detection.\nSupported values: \"latest\" and \"stable\" (the default).",
- "type": "string"
+ "type": "string",
+ "description": "Model to use for label detection.\nSupported values: \"latest\" and \"stable\" (the default)."
},
"shotChangeDetectionModel": {
"description": "Model to use for shot change detection.\nSupported values: \"latest\" and \"stable\" (the default).",
"type": "string"
- },
- "labelDetectionMode": {
- "enum": [
- "LABEL_DETECTION_MODE_UNSPECIFIED",
- "SHOT_MODE",
- "FRAME_MODE",
- "SHOT_AND_FRAME_MODE"
- ],
- "description": "If label detection has been requested, what labels should be detected\nin addition to video-level labels or segment-level labels. If unspecified,\ndefaults to `SHOT_MODE`.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified.",
- "Detect shot-level labels.",
- "Detect frame-level labels.",
- "Detect both shot-level and frame-level labels."
- ]
- },
- "stationaryCamera": {
- "type": "boolean",
- "description": "Whether the video has been shot from a stationary (i.e. non-moving) camera.\nWhen set to true, might improve detection accuracy for moving objects."
- },
- "safeSearchDetectionModel": {
- "description": "Model to use for safe search detection.\nSupported values: \"latest\" and \"stable\" (the default).",
- "type": "string"
}
},
"id": "GoogleCloudVideointelligenceV1beta1_VideoContext"
},
+ "GoogleCloudVideointelligenceV1_LabelAnnotation": {
+ "id": "GoogleCloudVideointelligenceV1_LabelAnnotation",
+ "description": "Label annotation.",
+ "type": "object",
+ "properties": {
+ "locations": {
+ "description": "Where the label was detected and with what confidence.",
+ "items": {
+ "$ref": "GoogleCloudVideointelligenceV1_LabelLocation"
+ },
+ "type": "array"
+ },
+ "languageCode": {
+ "description": "Language code for `description` in BCP-47 format.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Textual description, e.g. `Fixed-gear bicycle`.",
+ "type": "string"
+ }
+ }
+ },
"GoogleRpc_Status": {
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
+ "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"
+ },
"code": {
"format": "int32",
"description": "The status code, which should be an enum value of google.rpc.Code.",
@@ -205,17 +253,6 @@
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
"type": "string"
- },
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "items": {
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
- },
- "type": "object"
- },
- "type": "array"
}
},
"id": "GoogleRpc_Status"
@@ -241,17 +278,6 @@
"description": "Annotation results for a single video.",
"type": "object",
"properties": {
- "error": {
- "description": "If set, indicates an error. Note that for a single `AnnotateVideoRequest`\nsome videos may succeed and some may fail.",
- "$ref": "GoogleRpc_Status"
- },
- "frameLabelAnnotations": {
- "description": "Label annotations on frame level.\nThere is exactly one element for each unique label.",
- "items": {
- "$ref": "GoogleCloudVideointelligenceV1beta2_LabelAnnotation"
- },
- "type": "array"
- },
"inputUri": {
"description": "Video file location in\n[Google Cloud Storage](https://cloud.google.com/storage/).",
"type": "string"
@@ -268,11 +294,11 @@
"description": "Explicit content annotation."
},
"shotAnnotations": {
- "description": "Shot annotations. Each shot is represented as a video segment.",
"items": {
"$ref": "GoogleCloudVideointelligenceV1beta2_VideoSegment"
},
- "type": "array"
+ "type": "array",
+ "description": "Shot annotations. Each shot is represented as a video segment."
},
"shotLabelAnnotations": {
"description": "Label annotations on shot level.\nThere is exactly one element for each unique label.",
@@ -280,29 +306,32 @@
"$ref": "GoogleCloudVideointelligenceV1beta2_LabelAnnotation"
},
"type": "array"
+ },
+ "error": {
+ "description": "If set, indicates an error. Note that for a single `AnnotateVideoRequest`\nsome videos may succeed and some may fail.",
+ "$ref": "GoogleRpc_Status"
+ },
+ "frameLabelAnnotations": {
+ "description": "Label annotations on frame level.\nThere is exactly one element for each unique label.",
+ "items": {
+ "$ref": "GoogleCloudVideointelligenceV1beta2_LabelAnnotation"
+ },
+ "type": "array"
}
},
"id": "GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults"
},
- "GoogleCloudVideointelligenceV1beta2_ExplicitContentAnnotation": {
- "id": "GoogleCloudVideointelligenceV1beta2_ExplicitContentAnnotation",
- "description": "Explicit content annotation (based on per-frame visual signals only).\nIf no explicit content has been detected in a frame, no annotations are\npresent for that frame.",
- "type": "object",
- "properties": {
- "frames": {
- "description": "All video frames where explicit content was detected.",
- "items": {
- "$ref": "GoogleCloudVideointelligenceV1beta2_ExplicitContentFrame"
- },
- "type": "array"
- }
- }
- },
"GoogleCloudVideointelligenceV1beta1_LabelLocation": {
"description": "Label location.",
"type": "object",
"properties": {
+ "segment": {
+ "$ref": "GoogleCloudVideointelligenceV1beta1_VideoSegment",
+ "description": "Video segment. Set to [-1, -1] for video-level labels.\nSet to [timestamp, timestamp] for frame-level labels.\nOtherwise, corresponds to one of `AnnotateSpec.segments`\n(if specified) or to shot boundaries (if requested)."
+ },
"level": {
+ "description": "Label level.",
+ "type": "string",
"enumDescriptions": [
"Unspecified.",
"Video-level. Corresponds to the whole video.",
@@ -316,22 +345,30 @@
"SEGMENT_LEVEL",
"SHOT_LEVEL",
"FRAME_LEVEL"
- ],
- "description": "Label level.",
- "type": "string"
+ ]
},
"confidence": {
"format": "float",
"description": "Confidence that the label is accurate. Range: [0, 1].",
"type": "number"
- },
- "segment": {
- "$ref": "GoogleCloudVideointelligenceV1beta1_VideoSegment",
- "description": "Video segment. Set to [-1, -1] for video-level labels.\nSet to [timestamp, timestamp] for frame-level labels.\nOtherwise, corresponds to one of `AnnotateSpec.segments`\n(if specified) or to shot boundaries (if requested)."
}
},
"id": "GoogleCloudVideointelligenceV1beta1_LabelLocation"
},
+ "GoogleCloudVideointelligenceV1beta2_ExplicitContentAnnotation": {
+ "description": "Explicit content annotation (based on per-frame visual signals only).\nIf no explicit content has been detected in a frame, no annotations are\npresent for that frame.",
+ "type": "object",
+ "properties": {
+ "frames": {
+ "description": "All video frames where explicit content was detected.",
+ "items": {
+ "$ref": "GoogleCloudVideointelligenceV1beta2_ExplicitContentFrame"
+ },
+ "type": "array"
+ }
+ },
+ "id": "GoogleCloudVideointelligenceV1beta2_ExplicitContentAnnotation"
+ },
"GoogleCloudVideointelligenceV1beta2_LabelFrame": {
"description": "Video frame level annotation results for label detection.",
"type": "object",
@@ -354,11 +391,11 @@
"type": "object",
"properties": {
"annotationProgress": {
+ "description": "Progress metadata for all videos specified in `AnnotateVideoRequest`.",
"items": {
"$ref": "GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress"
},
- "type": "array",
- "description": "Progress metadata for all videos specified in `AnnotateVideoRequest`."
+ "type": "array"
}
},
"id": "GoogleCloudVideointelligenceV1beta2_AnnotateVideoProgress"
@@ -367,6 +404,15 @@
"description": "Annotation progress for a single video.",
"type": "object",
"properties": {
+ "inputUri": {
+ "description": "Video file location in\n[Google Cloud Storage](https://cloud.google.com/storage/).",
+ "type": "string"
+ },
+ "progressPercent": {
+ "format": "int32",
+ "description": "Approximate percentage processed thus far.\nGuaranteed to be 100 when fully processed.",
+ "type": "integer"
+ },
"updateTime": {
"format": "google-datetime",
"description": "Time of the most recent update.",
@@ -376,15 +422,6 @@
"type": "string",
"format": "google-datetime",
"description": "Time when the request was received."
- },
- "inputUri": {
- "description": "Video file location in\n[Google Cloud Storage](https://cloud.google.com/storage/).",
- "type": "string"
- },
- "progressPercent": {
- "format": "int32",
- "description": "Approximate percentage processed thus far.\nGuaranteed to be 100 when fully processed.",
- "type": "integer"
}
},
"id": "GoogleCloudVideointelligenceV1_VideoAnnotationProgress"
@@ -404,26 +441,16 @@
"id": "GoogleCloudVideointelligenceV1_AnnotateVideoProgress"
},
"GoogleLongrunning_Operation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object",
"properties": {
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- },
- "response": {
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
"name": {
"description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
"type": "string"
},
"error": {
- "description": "The error result of the operation in case of failure or cancellation.",
- "$ref": "GoogleRpc_Status"
+ "$ref": "GoogleRpc_Status",
+ "description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
"additionalProperties": {
@@ -432,26 +459,62 @@
},
"description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
"type": "object"
+ },
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ },
+ "response": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`."
}
},
- "id": "GoogleLongrunning_Operation",
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object"
+ "id": "GoogleLongrunning_Operation"
+ },
+ "GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress": {
+ "description": "Annotation progress for a single video.",
+ "type": "object",
+ "properties": {
+ "inputUri": {
+ "description": "Video file location in\n[Google Cloud Storage](https://cloud.google.com/storage/).",
+ "type": "string"
+ },
+ "progressPercent": {
+ "format": "int32",
+ "description": "Approximate percentage processed thus far.\nGuaranteed to be 100 when fully processed.",
+ "type": "integer"
+ },
+ "updateTime": {
+ "format": "google-datetime",
+ "description": "Time of the most recent update.",
+ "type": "string"
+ },
+ "startTime": {
+ "format": "google-datetime",
+ "description": "Time when the request was received.",
+ "type": "string"
+ }
+ },
+ "id": "GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress"
},
"GoogleCloudVideointelligenceV1beta1_VideoAnnotationResults": {
"description": "Annotation results for a single video.",
"type": "object",
"properties": {
"error": {
- "$ref": "GoogleRpc_Status",
- "description": "If set, indicates an error. Note that for a single `AnnotateVideoRequest`\nsome videos may succeed and some may fail."
+ "description": "If set, indicates an error. Note that for a single `AnnotateVideoRequest`\nsome videos may succeed and some may fail.",
+ "$ref": "GoogleRpc_Status"
},
"shotAnnotations": {
+ "description": "Shot annotations. Each shot is represented as a video segment.",
"items": {
"$ref": "GoogleCloudVideointelligenceV1beta1_VideoSegment"
},
- "type": "array",
- "description": "Shot annotations. Each shot is represented as a video segment."
+ "type": "array"
},
"safeSearchAnnotations": {
"description": "Safe search annotations.",
@@ -474,7 +537,35 @@
},
"id": "GoogleCloudVideointelligenceV1beta1_VideoAnnotationResults"
},
- "GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress": {
+ "GoogleCloudVideointelligenceV1_AnnotateVideoResponse": {
+ "properties": {
+ "annotationResults": {
+ "description": "Annotation results for all videos specified in `AnnotateVideoRequest`.",
+ "items": {
+ "$ref": "GoogleCloudVideointelligenceV1_VideoAnnotationResults"
+ },
+ "type": "array"
+ }
+ },
+ "id": "GoogleCloudVideointelligenceV1_AnnotateVideoResponse",
+ "description": "Video annotation response. Included in the `response`\nfield of the `Operation` returned by the `GetOperation`\ncall of the `google::longrunning::Operations` service.",
+ "type": "object"
+ },
+ "GoogleCloudVideointelligenceV1beta1_AnnotateVideoResponse": {
+ "id": "GoogleCloudVideointelligenceV1beta1_AnnotateVideoResponse",
+ "description": "Video annotation response. Included in the `response`\nfield of the `Operation` returned by the `GetOperation`\ncall of the `google::longrunning::Operations` service.",
+ "type": "object",
+ "properties": {
+ "annotationResults": {
+ "description": "Annotation results for all videos specified in `AnnotateVideoRequest`.",
+ "items": {
+ "$ref": "GoogleCloudVideointelligenceV1beta1_VideoAnnotationResults"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "GoogleCloudVideointelligenceV1beta1_VideoAnnotationProgress": {
"description": "Annotation progress for a single video.",
"type": "object",
"properties": {
@@ -483,9 +574,9 @@
"type": "string"
},
"progressPercent": {
- "type": "integer",
"format": "int32",
- "description": "Approximate percentage processed thus far.\nGuaranteed to be 100 when fully processed."
+ "description": "Approximate percentage processed thus far.\nGuaranteed to be 100 when fully processed.",
+ "type": "integer"
},
"updateTime": {
"format": "google-datetime",
@@ -498,67 +589,22 @@
"type": "string"
}
},
- "id": "GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress"
- },
- "GoogleCloudVideointelligenceV1_AnnotateVideoResponse": {
- "id": "GoogleCloudVideointelligenceV1_AnnotateVideoResponse",
- "description": "Video annotation response. Included in the `response`\nfield of the `Operation` returned by the `GetOperation`\ncall of the `google::longrunning::Operations` service.",
- "type": "object",
- "properties": {
- "annotationResults": {
- "description": "Annotation results for all videos specified in `AnnotateVideoRequest`.",
- "items": {
- "$ref": "GoogleCloudVideointelligenceV1_VideoAnnotationResults"
- },
- "type": "array"
- }
- }
- },
- "GoogleCloudVideointelligenceV1beta1_AnnotateVideoResponse": {
- "properties": {
- "annotationResults": {
- "description": "Annotation results for all videos specified in `AnnotateVideoRequest`.",
- "items": {
- "$ref": "GoogleCloudVideointelligenceV1beta1_VideoAnnotationResults"
- },
- "type": "array"
- }
- },
- "id": "GoogleCloudVideointelligenceV1beta1_AnnotateVideoResponse",
- "description": "Video annotation response. Included in the `response`\nfield of the `Operation` returned by the `GetOperation`\ncall of the `google::longrunning::Operations` service.",
- "type": "object"
- },
- "GoogleCloudVideointelligenceV1beta1_VideoAnnotationProgress": {
- "description": "Annotation progress for a single video.",
- "type": "object",
- "properties": {
- "inputUri": {
- "type": "string",
- "description": "Video file location in\n[Google Cloud Storage](https://cloud.google.com/storage/)."
- },
- "progressPercent": {
- "format": "int32",
- "description": "Approximate percentage processed thus far.\nGuaranteed to be 100 when fully processed.",
- "type": "integer"
- },
- "updateTime": {
- "type": "string",
- "format": "google-datetime",
- "description": "Time of the most recent update."
- },
- "startTime": {
- "format": "google-datetime",
- "description": "Time when the request was received.",
- "type": "string"
- }
- },
"id": "GoogleCloudVideointelligenceV1beta1_VideoAnnotationProgress"
},
"GoogleCloudVideointelligenceV1beta2_ExplicitContentFrame": {
+ "id": "GoogleCloudVideointelligenceV1beta2_ExplicitContentFrame",
"description": "Video frame level annotation results for explicit content.",
"type": "object",
"properties": {
"pornographyLikelihood": {
+ "enumDescriptions": [
+ "Unspecified likelihood.",
+ "Very unlikely.",
+ "Unlikely.",
+ "Possible.",
+ "Likely.",
+ "Very likely."
+ ],
"enum": [
"LIKELIHOOD_UNSPECIFIED",
"VERY_UNLIKELY",
@@ -568,26 +614,16 @@
"VERY_LIKELY"
],
"description": "Likelihood of the pornography content..",
- "type": "string",
- "enumDescriptions": [
- "Unspecified likelihood.",
- "Very unlikely.",
- "Unlikely.",
- "Possible.",
- "Likely.",
- "Very likely."
- ]
+ "type": "string"
},
"timeOffset": {
"format": "google-duration",
"description": "Time-offset, relative to the beginning of the video, corresponding to the\nvideo frame for this location.",
"type": "string"
}
- },
- "id": "GoogleCloudVideointelligenceV1beta2_ExplicitContentFrame"
+ }
},
"GoogleCloudVideointelligenceV1beta1_AnnotateVideoRequest": {
- "id": "GoogleCloudVideointelligenceV1beta1_AnnotateVideoRequest",
"description": "Video annotation request.",
"type": "object",
"properties": {
@@ -599,10 +635,6 @@
"description": "The video data bytes. Encoding: base64. If unset, the input video(s)\nshould be specified via `input_uri`. If set, `input_uri` should be unset.",
"type": "string"
},
- "outputUri": {
- "description": "Optional location where the output (in JSON format) should be stored.\nCurrently, only [Google Cloud Storage](https://cloud.google.com/storage/)\nURIs are supported, which must be specified in the following format:\n`gs://bucket-id/object-id` (other URI formats return\ngoogle.rpc.Code.INVALID_ARGUMENT). For more information, see\n[Request URIs](/storage/docs/reference-uris).",
- "type": "string"
- },
"features": {
"description": "Requested video annotation features.",
"items": {
@@ -622,6 +654,10 @@
"Safe search detection."
]
},
+ "outputUri": {
+ "type": "string",
+ "description": "Optional location where the output (in JSON format) should be stored.\nCurrently, only [Google Cloud Storage](https://cloud.google.com/storage/)\nURIs are supported, which must be specified in the following format:\n`gs://bucket-id/object-id` (other URI formats return\ngoogle.rpc.Code.INVALID_ARGUMENT). For more information, see\n[Request URIs](/storage/docs/reference-uris)."
+ },
"videoContext": {
"description": "Additional video context and/or feature-specific parameters.",
"$ref": "GoogleCloudVideointelligenceV1beta1_VideoContext"
@@ -630,9 +666,11 @@
"description": "Optional cloud region where annotation should take place. Supported cloud\nregions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region\nis specified, a region will be determined based on video file location.",
"type": "string"
}
- }
+ },
+ "id": "GoogleCloudVideointelligenceV1beta1_AnnotateVideoRequest"
},
"GoogleCloudVideointelligenceV1beta1_VideoSegment": {
+ "description": "Video segment.",
"type": "object",
"properties": {
"endTimeOffset": {
@@ -641,13 +679,12 @@
"type": "string"
},
"startTimeOffset": {
- "type": "string",
"format": "int64",
- "description": "Start offset in microseconds (inclusive). Unset means 0."
+ "description": "Start offset in microseconds (inclusive). Unset means 0.",
+ "type": "string"
}
},
- "id": "GoogleCloudVideointelligenceV1beta1_VideoSegment",
- "description": "Video segment."
+ "id": "GoogleCloudVideointelligenceV1beta1_VideoSegment"
},
"GoogleCloudVideointelligenceV1beta2_LabelSegment": {
"description": "Video segment level annotation results for label detection.",
@@ -666,6 +703,9 @@
"id": "GoogleCloudVideointelligenceV1beta2_LabelSegment"
},
"GoogleCloudVideointelligenceV1_SafeSearchAnnotation": {
+ "id": "GoogleCloudVideointelligenceV1_SafeSearchAnnotation",
+ "description": "Safe search annotation (based on per-frame visual signals only).\nIf no unsafe content has been detected in a frame, no annotations\nare present for that frame.",
+ "type": "object",
"properties": {
"time": {
"format": "google-duration",
@@ -673,6 +713,14 @@
"type": "string"
},
"adult": {
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "Very unlikely.",
+ "Unlikely.",
+ "Possible.",
+ "Likely.",
+ "Very likely."
+ ],
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
@@ -682,23 +730,11 @@
"VERY_LIKELY"
],
"description": "Likelihood of adult content.",
- "type": "string",
- "enumDescriptions": [
- "Unknown likelihood.",
- "Very unlikely.",
- "Unlikely.",
- "Possible.",
- "Likely.",
- "Very likely."
- ]
+ "type": "string"
}
- },
- "id": "GoogleCloudVideointelligenceV1_SafeSearchAnnotation",
- "description": "Safe search annotation (based on per-frame visual signals only).\nIf no unsafe content has been detected in a frame, no annotations\nare present for that frame.",
- "type": "object"
+ }
},
"GoogleCloudVideointelligenceV1beta2_LabelAnnotation": {
- "description": "Label annotation.",
"type": "object",
"properties": {
"segments": {
@@ -716,8 +752,8 @@
"type": "array"
},
"entity": {
- "$ref": "GoogleCloudVideointelligenceV1beta2_Entity",
- "description": "Detected entity."
+ "description": "Detected entity.",
+ "$ref": "GoogleCloudVideointelligenceV1beta2_Entity"
},
"frames": {
"description": "All video frames where a label was detected.",
@@ -727,18 +763,66 @@
"type": "array"
}
},
- "id": "GoogleCloudVideointelligenceV1beta2_LabelAnnotation"
+ "id": "GoogleCloudVideointelligenceV1beta2_LabelAnnotation",
+ "description": "Label annotation."
},
"GoogleCloudVideointelligenceV1beta1_SafeSearchAnnotation": {
- "description": "Safe search annotation (based on per-frame visual signals only).\nIf no unsafe content has been detected in a frame, no annotations\nare present for that frame. If only some types of unsafe content\nhave been detected in a frame, the likelihood is set to `UNKNOWN`\nfor all other types of unsafe content.",
"type": "object",
"properties": {
+ "adult": {
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "Very unlikely.",
+ "Unlikely.",
+ "Possible.",
+ "Likely.",
+ "Very likely."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Likelihood of adult content."
+ },
+ "racy": {
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "Very unlikely.",
+ "Unlikely.",
+ "Possible.",
+ "Likely.",
+ "Very likely."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Likelihood of racy content."
+ },
"timeOffset": {
"format": "int64",
"description": "Video time offset in microseconds.",
"type": "string"
},
"spoof": {
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "Very unlikely.",
+ "Unlikely.",
+ "Possible.",
+ "Likely.",
+ "Very likely."
+ ],
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
@@ -748,17 +832,11 @@
"VERY_LIKELY"
],
"description": "Likelihood that an obvious modification was made to the original\nversion to make it appear funny or offensive.",
- "type": "string",
- "enumDescriptions": [
- "Unknown likelihood.",
- "Very unlikely.",
- "Unlikely.",
- "Possible.",
- "Likely.",
- "Very likely."
- ]
+ "type": "string"
},
"violent": {
+ "description": "Likelihood of violent content.",
+ "type": "string",
"enumDescriptions": [
"Unknown likelihood.",
"Very unlikely.",
@@ -774,9 +852,7 @@
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
- ],
- "description": "Likelihood of violent content.",
- "type": "string"
+ ]
},
"medical": {
"enumDescriptions": [
@@ -797,82 +873,10 @@
],
"description": "Likelihood of medical content.",
"type": "string"
- },
- "adult": {
- "description": "Likelihood of adult content.",
- "type": "string",
- "enumDescriptions": [
- "Unknown likelihood.",
- "Very unlikely.",
- "Unlikely.",
- "Possible.",
- "Likely.",
- "Very likely."
- ],
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ]
- },
- "racy": {
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Likelihood of racy content.",
- "type": "string",
- "enumDescriptions": [
- "Unknown likelihood.",
- "Very unlikely.",
- "Unlikely.",
- "Possible.",
- "Likely.",
- "Very likely."
- ]
}
},
- "id": "GoogleCloudVideointelligenceV1beta1_SafeSearchAnnotation"
- },
- "GoogleCloudVideointelligenceV1beta1_AnnotateVideoProgress": {
- "description": "Video annotation progress. Included in the `metadata`\nfield of the `Operation` returned by the `GetOperation`\ncall of the `google::longrunning::Operations` service.",
- "type": "object",
- "properties": {
- "annotationProgress": {
- "description": "Progress metadata for all videos specified in `AnnotateVideoRequest`.",
- "items": {
- "$ref": "GoogleCloudVideointelligenceV1beta1_VideoAnnotationProgress"
- },
- "type": "array"
- }
- },
- "id": "GoogleCloudVideointelligenceV1beta1_AnnotateVideoProgress"
- },
- "GoogleCloudVideointelligenceV1beta2_Entity": {
- "description": "Detected entity from video analysis.",
- "type": "object",
- "properties": {
- "description": {
- "description": "Textual description, e.g. `Fixed-gear bicycle`.",
- "type": "string"
- },
- "languageCode": {
- "description": "Language code for `description` in BCP-47 format.",
- "type": "string"
- },
- "entityId": {
- "description": "Opaque entity ID. Some IDs may be available in\n[Google Knowledge Graph Search\nAPI](https://developers.google.com/knowledge-graph/).",
- "type": "string"
- }
- },
- "id": "GoogleCloudVideointelligenceV1beta2_Entity"
+ "id": "GoogleCloudVideointelligenceV1beta1_SafeSearchAnnotation",
+ "description": "Safe search annotation (based on per-frame visual signals only).\nIf no unsafe content has been detected in a frame, no annotations\nare present for that frame. If only some types of unsafe content\nhave been detected in a frame, the likelihood is set to `UNKNOWN`\nfor all other types of unsafe content."
}
},
"icons": {
@@ -900,102 +904,37 @@
"videos": {
"methods": {
"annotate": {
- "flatPath": "v1beta1/videos:annotate",
- "path": "v1beta1/videos:annotate",
- "id": "videointelligence.videos.annotate",
- "description": "Performs asynchronous video annotation. Progress and results can be\nretrieved through the `google.longrunning.Operations` interface.\n`Operation.metadata` contains `AnnotateVideoProgress` (progress).\n`Operation.response` contains `AnnotateVideoResponse` (results).",
"request": {
"$ref": "GoogleCloudVideointelligenceV1beta1_AnnotateVideoRequest"
},
+ "description": "Performs asynchronous video annotation. Progress and results can be\nretrieved through the `google.longrunning.Operations` interface.\n`Operation.metadata` contains `AnnotateVideoProgress` (progress).\n`Operation.response` contains `AnnotateVideoResponse` (results).",
"httpMethod": "POST",
"parameterOrder": [],
"response": {
"$ref": "GoogleLongrunning_Operation"
},
- "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ]
+ ],
+ "parameters": {},
+ "flatPath": "v1beta1/videos:annotate",
+ "path": "v1beta1/videos:annotate",
+ "id": "videointelligence.videos.annotate"
}
}
}
},
"parameters": {
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "upload_protocol": {
+ "access_token": {
"type": "string",
"location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "type": "boolean"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "alt": {
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
+ "description": "OAuth access token."
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string",
"location": "query"
},
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
"quotaUser": {
"location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
@@ -1006,15 +945,76 @@
"description": "Pretty-print response.",
"default": "true",
"type": "boolean"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
}
},
"version": "v1beta1",
"baseUrl": "https://videointelligence.googleapis.com/",
- "servicePath": "",
- "description": "Cloud Video Intelligence API.",
"kind": "discovery#restDescription",
- "basePath": "",
- "revision": "20171004",
- "id": "videointelligence:v1beta1",
- "documentationLink": "https://cloud.google.com/video-intelligence/docs/"
+ "description": "Cloud Video Intelligence API.",
+ "servicePath": ""
}
diff --git a/vision/v1/vision-api.json b/vision/v1/vision-api.json
index fb1ec4d..f29e438 100644
--- a/vision/v1/vision-api.json
+++ b/vision/v1/vision-api.json
@@ -1,731 +1,12 @@
{
- "version": "v1",
- "baseUrl": "https://vision.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.",
- "servicePath": "",
"basePath": "",
- "revision": "20171003",
+ "revision": "20171012",
"documentationLink": "https://cloud.google.com/vision/",
"id": "vision:v1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "Status": {
- "properties": {
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- },
- "type": "array"
- },
- "code": {
- "format": "int32",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- }
- },
- "id": "Status",
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object"
- },
- "Symbol": {
- "description": "A single symbol representation.",
- "type": "object",
- "properties": {
- "property": {
- "description": "Additional information detected for the symbol.",
- "$ref": "TextProperty"
- },
- "boundingBox": {
- "$ref": "BoundingPoly",
- "description": "The bounding box for the symbol.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3)."
- },
- "text": {
- "description": "The actual UTF-8 representation of the symbol.",
- "type": "string"
- }
- },
- "id": "Symbol"
- },
- "LatLongRect": {
- "description": "Rectangle determined by min and max `LatLng` pairs.",
- "type": "object",
- "properties": {
- "maxLatLng": {
- "$ref": "LatLng",
- "description": "Max lat/long pair."
- },
- "minLatLng": {
- "description": "Min lat/long pair.",
- "$ref": "LatLng"
- }
- },
- "id": "LatLongRect"
- },
- "CropHintsAnnotation": {
- "description": "Set of crop hints that are used to generate new crops when serving images.",
- "type": "object",
- "properties": {
- "cropHints": {
- "description": "Crop hint results.",
- "items": {
- "$ref": "CropHint"
- },
- "type": "array"
- }
- },
- "id": "CropHintsAnnotation"
- },
- "LatLng": {
- "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.\n\nExample of normalization code in Python:\n\n def NormalizeLongitude(longitude):\n \"\"\"Wraps decimal degrees longitude to [-180.0, 180.0].\"\"\"\n q, r = divmod(longitude, 360.0)\n if r \u003e 180.0 or (r == 180.0 and q \u003c= -1.0):\n return r - 360.0\n return r\n\n def NormalizeLatLng(latitude, longitude):\n \"\"\"Wraps decimal degrees latitude and longitude to\n [-90.0, 90.0] and [-180.0, 180.0], respectively.\"\"\"\n r = latitude % 360.0\n if r \u003c= 90.0:\n return r, NormalizeLongitude(longitude)\n elif r \u003e= 270.0:\n return r - 360, NormalizeLongitude(longitude)\n else:\n return 180 - r, NormalizeLongitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLongitude(181.0)\n assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)\n assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)\n assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)\n assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)\n assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)\n assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)\n assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)\n assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)",
- "type": "object",
- "properties": {
- "latitude": {
- "format": "double",
- "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
- "type": "number"
- },
- "longitude": {
- "format": "double",
- "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
- "type": "number"
- }
- },
- "id": "LatLng"
- },
- "Color": {
- "description": "Represents a color in the RGBA color space. This representation is designed\nfor simplicity of conversion to/from color representations in various\nlanguages over compactness; for example, the fields of this representation\ncan be trivially provided to the constructor of \"java.awt.Color\" in Java; it\ncan also be trivially provided to UIColor's \"+colorWithRed:green:blue:alpha\"\nmethod in iOS; and, with just a little work, it can be easily formatted into\na CSS \"rgba()\" string in JavaScript, as well. Here are some examples:\n\nExample (Java):\n\n import com.google.type.Color;\n\n // ...\n public static java.awt.Color fromProto(Color protocolor) {\n float alpha = protocolor.hasAlpha()\n ? protocolor.getAlpha().getValue()\n : 1.0;\n\n return new java.awt.Color(\n protocolor.getRed(),\n protocolor.getGreen(),\n protocolor.getBlue(),\n alpha);\n }\n\n public static Color toProto(java.awt.Color color) {\n float red = (float) color.getRed();\n float green = (float) color.getGreen();\n float blue = (float) color.getBlue();\n float denominator = 255.0;\n Color.Builder resultBuilder =\n Color\n .newBuilder()\n .setRed(red / denominator)\n .setGreen(green / denominator)\n .setBlue(blue / denominator);\n int alpha = color.getAlpha();\n if (alpha != 255) {\n result.setAlpha(\n FloatValue\n .newBuilder()\n .setValue(((float) alpha) / denominator)\n .build());\n }\n return resultBuilder.build();\n }\n // ...\n\nExample (iOS / Obj-C):\n\n // ...\n static UIColor* fromProto(Color* protocolor) {\n float red = [protocolor red];\n float green = [protocolor green];\n float blue = [protocolor blue];\n FloatValue* alpha_wrapper = [protocolor alpha];\n float alpha = 1.0;\n if (alpha_wrapper != nil) {\n alpha = [alpha_wrapper value];\n }\n return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];\n }\n\n static Color* toProto(UIColor* color) {\n CGFloat red, green, blue, alpha;\n if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {\n return nil;\n }\n Color* result = [Color alloc] init];\n [result setRed:red];\n [result setGreen:green];\n [result setBlue:blue];\n if (alpha \u003c= 0.9999) {\n [result setAlpha:floatWrapperWithValue(alpha)];\n }\n [result autorelease];\n return result;\n }\n // ...\n\n Example (JavaScript):\n\n // ...\n\n var protoToCssColor = function(rgb_color) {\n var redFrac = rgb_color.red || 0.0;\n var greenFrac = rgb_color.green || 0.0;\n var blueFrac = rgb_color.blue || 0.0;\n var red = Math.floor(redFrac * 255);\n var green = Math.floor(greenFrac * 255);\n var blue = Math.floor(blueFrac * 255);\n\n if (!('alpha' in rgb_color)) {\n return rgbToCssColor_(red, green, blue);\n }\n\n var alphaFrac = rgb_color.alpha.value || 0.0;\n var rgbParams = [red, green, blue].join(',');\n return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');\n };\n\n var rgbToCssColor_ = function(red, green, blue) {\n var rgbNumber = new Number((red \u003c\u003c 16) | (green \u003c\u003c 8) | blue);\n var hexString = rgbNumber.toString(16);\n var missingZeros = 6 - hexString.length;\n var resultBuilder = ['#'];\n for (var i = 0; i \u003c missingZeros; i++) {\n resultBuilder.push('0');\n }\n resultBuilder.push(hexString);\n return resultBuilder.join('');\n };\n\n // ...",
- "type": "object",
- "properties": {
- "red": {
- "format": "float",
- "description": "The amount of red in the color as a value in the interval [0, 1].",
- "type": "number"
- },
- "alpha": {
- "format": "float",
- "description": "The fraction of this color that should be applied to the pixel. That is,\nthe final pixel color is defined by the equation:\n\n pixel color = alpha * (this color) + (1.0 - alpha) * (background color)\n\nThis means that a value of 1.0 corresponds to a solid color, whereas\na value of 0.0 corresponds to a completely transparent color. This\nuses a wrapper message rather than a simple float scalar so that it is\npossible to distinguish between a default value and the value being unset.\nIf omitted, this color object is to be rendered as a solid color\n(as if the alpha value had been explicitly given with a value of 1.0).",
- "type": "number"
- },
- "blue": {
- "format": "float",
- "description": "The amount of blue in the color as a value in the interval [0, 1].",
- "type": "number"
- },
- "green": {
- "format": "float",
- "description": "The amount of green in the color as a value in the interval [0, 1].",
- "type": "number"
- }
- },
- "id": "Color"
- },
- "Feature": {
- "properties": {
- "maxResults": {
- "format": "int32",
- "description": "Maximum number of results of this type.",
- "type": "integer"
- },
- "type": {
- "enumDescriptions": [
- "Unspecified feature type.",
- "Run face detection.",
- "Run landmark detection.",
- "Run logo detection.",
- "Run label detection.",
- "Run OCR.",
- "Run dense text document OCR. Takes precedence when both\nDOCUMENT_TEXT_DETECTION and TEXT_DETECTION are present.",
- "Run computer vision models to compute image safe-search properties.",
- "Compute a set of image properties, such as the image's dominant colors.",
- "Run crop hints.",
- "Run web detection."
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "FACE_DETECTION",
- "LANDMARK_DETECTION",
- "LOGO_DETECTION",
- "LABEL_DETECTION",
- "TEXT_DETECTION",
- "DOCUMENT_TEXT_DETECTION",
- "SAFE_SEARCH_DETECTION",
- "IMAGE_PROPERTIES",
- "CROP_HINTS",
- "WEB_DETECTION"
- ],
- "description": "The feature type.",
- "type": "string"
- }
- },
- "id": "Feature",
- "description": "Users describe the type of Google Cloud Vision API tasks to perform over\nimages by using *Feature*s. Each Feature indicates a type of image\ndetection task to perform. Features encode the Cloud Vision API\nvertical to operate on and the number of top-scoring results to return.",
- "type": "object"
- },
- "ImageProperties": {
- "properties": {
- "dominantColors": {
- "$ref": "DominantColorsAnnotation",
- "description": "If present, dominant colors completed successfully."
- }
- },
- "id": "ImageProperties",
- "description": "Stores image properties, such as dominant colors.",
- "type": "object"
- },
- "SafeSearchAnnotation": {
- "description": "Set of features pertaining to the image, computed by computer vision\nmethods over safe-search verticals (for example, adult, spoof, medical,\nviolence).",
- "type": "object",
- "properties": {
- "violence": {
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Likelihood that this image contains violent content.",
- "type": "string",
- "enumDescriptions": [
- "Unknown likelihood.",
- "It is very unlikely that the image belongs to the specified vertical.",
- "It is unlikely that the image belongs to the specified vertical.",
- "It is possible that the image belongs to the specified vertical.",
- "It is likely that the image belongs to the specified vertical.",
- "It is very likely that the image belongs to the specified vertical."
- ]
- },
- "adult": {
- "enumDescriptions": [
- "Unknown likelihood.",
- "It is very unlikely that the image belongs to the specified vertical.",
- "It is unlikely that the image belongs to the specified vertical.",
- "It is possible that the image belongs to the specified vertical.",
- "It is likely that the image belongs to the specified vertical.",
- "It is very likely that the image belongs to the specified vertical."
- ],
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Represents the adult content likelihood for the image. Adult content may\ncontain elements such as nudity, pornographic images or cartoons, or\nsexual activities.",
- "type": "string"
- },
- "spoof": {
- "enumDescriptions": [
- "Unknown likelihood.",
- "It is very unlikely that the image belongs to the specified vertical.",
- "It is unlikely that the image belongs to the specified vertical.",
- "It is possible that the image belongs to the specified vertical.",
- "It is likely that the image belongs to the specified vertical.",
- "It is very likely that the image belongs to the specified vertical."
- ],
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Spoof likelihood. The likelihood that an modification\nwas made to the image's canonical version to make it appear\nfunny or offensive.",
- "type": "string"
- },
- "medical": {
- "enumDescriptions": [
- "Unknown likelihood.",
- "It is very unlikely that the image belongs to the specified vertical.",
- "It is unlikely that the image belongs to the specified vertical.",
- "It is possible that the image belongs to the specified vertical.",
- "It is likely that the image belongs to the specified vertical.",
- "It is very likely that the image belongs to the specified vertical."
- ],
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Likelihood that this is a medical image.",
- "type": "string"
- }
- },
- "id": "SafeSearchAnnotation"
- },
- "DominantColorsAnnotation": {
- "properties": {
- "colors": {
- "description": "RGB color values with their score and pixel fraction.",
- "items": {
- "$ref": "ColorInfo"
- },
- "type": "array"
- }
- },
- "id": "DominantColorsAnnotation",
- "description": "Set of dominant colors and their corresponding scores.",
- "type": "object"
- },
- "TextAnnotation": {
- "description": "TextAnnotation contains a structured representation of OCR extracted text.\nThe hierarchy of an OCR extracted text structure is like this:\n TextAnnotation -\u003e Page -\u003e Block -\u003e Paragraph -\u003e Word -\u003e Symbol\nEach structural component, starting from Page, may further have their own\nproperties. Properties describe detected languages, breaks etc.. Please\nrefer to the google.cloud.vision.v1.TextAnnotation.TextProperty message\ndefinition below for more detail.",
- "type": "object",
- "properties": {
- "pages": {
- "description": "List of pages detected by OCR.",
- "items": {
- "$ref": "Page"
- },
- "type": "array"
- },
- "text": {
- "description": "UTF-8 text detected on the pages.",
- "type": "string"
- }
- },
- "id": "TextAnnotation"
- },
- "DetectedLanguage": {
- "properties": {
- "confidence": {
- "format": "float",
- "description": "Confidence of detected language. Range [0, 1].",
- "type": "number"
- },
- "languageCode": {
- "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.",
- "type": "string"
- }
- },
- "id": "DetectedLanguage",
- "description": "Detected language for a structural component.",
- "type": "object"
- },
- "Vertex": {
- "description": "A vertex represents a 2D point in the image.\nNOTE: the vertex coordinates are in the same scale as the original image.",
- "type": "object",
- "properties": {
- "y": {
- "format": "int32",
- "description": "Y coordinate.",
- "type": "integer"
- },
- "x": {
- "format": "int32",
- "description": "X coordinate.",
- "type": "integer"
- }
- },
- "id": "Vertex"
- },
- "BoundingPoly": {
- "description": "A bounding polygon for the detected image annotation.",
- "type": "object",
- "properties": {
- "vertices": {
- "description": "The bounding polygon vertices.",
- "items": {
- "$ref": "Vertex"
- },
- "type": "array"
- }
- },
- "id": "BoundingPoly"
- },
- "WebEntity": {
- "properties": {
- "entityId": {
- "description": "Opaque entity ID.",
- "type": "string"
- },
- "description": {
- "description": "Canonical description of the entity, in English.",
- "type": "string"
- },
- "score": {
- "format": "float",
- "description": "Overall relevancy score for the entity.\nNot normalized and not comparable across different image queries.",
- "type": "number"
- }
- },
- "id": "WebEntity",
- "description": "Entity deduced from similar images on the Internet.",
- "type": "object"
- },
- "TextProperty": {
- "properties": {
- "detectedBreak": {
- "description": "Detected start or end of a text segment.",
- "$ref": "DetectedBreak"
- },
- "detectedLanguages": {
- "description": "A list of detected languages together with confidence.",
- "items": {
- "$ref": "DetectedLanguage"
- },
- "type": "array"
- }
- },
- "id": "TextProperty",
- "description": "Additional information detected on the structural component.",
- "type": "object"
- },
- "AnnotateImageResponse": {
- "properties": {
- "landmarkAnnotations": {
- "description": "If present, landmark detection has completed successfully.",
- "items": {
- "$ref": "EntityAnnotation"
- },
- "type": "array"
- },
- "textAnnotations": {
- "description": "If present, text (OCR) detection has completed successfully.",
- "items": {
- "$ref": "EntityAnnotation"
- },
- "type": "array"
- },
- "imagePropertiesAnnotation": {
- "description": "If present, image properties were extracted successfully.",
- "$ref": "ImageProperties"
- },
- "faceAnnotations": {
- "description": "If present, face detection has completed successfully.",
- "items": {
- "$ref": "FaceAnnotation"
- },
- "type": "array"
- },
- "logoAnnotations": {
- "description": "If present, logo detection has completed successfully.",
- "items": {
- "$ref": "EntityAnnotation"
- },
- "type": "array"
- },
- "webDetection": {
- "description": "If present, web detection has completed successfully.",
- "$ref": "WebDetection"
- },
- "cropHintsAnnotation": {
- "description": "If present, crop hints have completed successfully.",
- "$ref": "CropHintsAnnotation"
- },
- "safeSearchAnnotation": {
- "$ref": "SafeSearchAnnotation",
- "description": "If present, safe-search annotation has completed successfully."
- },
- "labelAnnotations": {
- "description": "If present, label detection has completed successfully.",
- "items": {
- "$ref": "EntityAnnotation"
- },
- "type": "array"
- },
- "error": {
- "$ref": "Status",
- "description": "If set, represents the error message for the operation.\nNote that filled-in image annotations are guaranteed to be\ncorrect, even when `error` is set."
- },
- "fullTextAnnotation": {
- "description": "If present, text (OCR) detection or document (OCR) text detection has\ncompleted successfully.\nThis annotation provides the structural hierarchy for the OCR detected\ntext.",
- "$ref": "TextAnnotation"
- }
- },
- "id": "AnnotateImageResponse",
- "description": "Response to an image annotation request.",
- "type": "object"
- },
- "CropHintsParams": {
- "description": "Parameters for crop hints annotation request.",
- "type": "object",
- "properties": {
- "aspectRatios": {
- "description": "Aspect ratios in floats, representing the ratio of the width to the height\nof the image. For example, if the desired aspect ratio is 4/3, the\ncorresponding float value should be 1.33333. If not specified, the\nbest possible crop is returned. The number of provided aspect ratios is\nlimited to a maximum of 16; any aspect ratios provided after the 16th are\nignored.",
- "items": {
- "format": "float",
- "type": "number"
- },
- "type": "array"
- }
- },
- "id": "CropHintsParams"
- },
- "Block": {
- "description": "Logical element on the page.",
- "type": "object",
- "properties": {
- "property": {
- "description": "Additional information detected for the block.",
- "$ref": "TextProperty"
- },
- "blockType": {
- "enum": [
- "UNKNOWN",
- "TEXT",
- "TABLE",
- "PICTURE",
- "RULER",
- "BARCODE"
- ],
- "description": "Detected block type (text, image etc) for this block.",
- "type": "string",
- "enumDescriptions": [
- "Unknown block type.",
- "Regular text block.",
- "Table block.",
- "Image block.",
- "Horizontal/vertical line box.",
- "Barcode block."
- ]
- },
- "boundingBox": {
- "$ref": "BoundingPoly",
- "description": "The bounding box for the block.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3)."
- },
- "paragraphs": {
- "description": "List of paragraphs in this block (if this blocks is of type text).",
- "items": {
- "$ref": "Paragraph"
- },
- "type": "array"
- }
- },
- "id": "Block"
- },
- "WebDetection": {
- "properties": {
- "visuallySimilarImages": {
- "description": "The visually similar image results.",
- "items": {
- "$ref": "WebImage"
- },
- "type": "array"
- },
- "partialMatchingImages": {
- "description": "Partial matching images from the Internet.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its crops.",
- "items": {
- "$ref": "WebImage"
- },
- "type": "array"
- },
- "fullMatchingImages": {
- "description": "Fully matching images from the Internet.\nCan include resized copies of the query image.",
- "items": {
- "$ref": "WebImage"
- },
- "type": "array"
- },
- "webEntities": {
- "description": "Deduced entities from similar images on the Internet.",
- "items": {
- "$ref": "WebEntity"
- },
- "type": "array"
- },
- "pagesWithMatchingImages": {
- "description": "Web pages containing the matching images from the Internet.",
- "items": {
- "$ref": "WebPage"
- },
- "type": "array"
- }
- },
- "id": "WebDetection",
- "description": "Relevant information for the image from the Internet.",
- "type": "object"
- },
- "BatchAnnotateImagesResponse": {
- "properties": {
- "responses": {
- "description": "Individual responses to image annotation requests within the batch.",
- "items": {
- "$ref": "AnnotateImageResponse"
- },
- "type": "array"
- }
- },
- "id": "BatchAnnotateImagesResponse",
- "description": "Response to a batch image annotation request.",
- "type": "object"
- },
- "Property": {
- "properties": {
- "uint64Value": {
- "format": "uint64",
- "description": "Value of numeric properties.",
- "type": "string"
- },
- "name": {
- "description": "Name of the property.",
- "type": "string"
- },
- "value": {
- "description": "Value of the property.",
- "type": "string"
- }
- },
- "id": "Property",
- "description": "A `Property` consists of a user-supplied name/value pair.",
- "type": "object"
- },
- "LocationInfo": {
- "description": "Detected entity location information.",
- "type": "object",
- "properties": {
- "latLng": {
- "$ref": "LatLng",
- "description": "lat/long location coordinates."
- }
- },
- "id": "LocationInfo"
- },
- "ImageSource": {
- "properties": {
- "gcsImageUri": {
- "description": "NOTE: For new code `image_uri` below is preferred.\nGoogle Cloud Storage image URI, which must be in the following form:\n`gs://bucket_name/object_name` (for details, see\n[Google Cloud Storage Request\nURIs](https://cloud.google.com/storage/docs/reference-uris)).\nNOTE: Cloud Storage object versioning is not supported.",
- "type": "string"
- },
- "imageUri": {
- "description": "Image URI which supports:\n1) Google Cloud Storage image URI, which must be in the following form:\n`gs://bucket_name/object_name` (for details, see\n[Google Cloud Storage Request\nURIs](https://cloud.google.com/storage/docs/reference-uris)).\nNOTE: Cloud Storage object versioning is not supported.\n2) Publicly accessible image HTTP/HTTPS URL.\nThis is preferred over the legacy `gcs_image_uri` above. When both\n`gcs_image_uri` and `image_uri` are specified, `image_uri` takes\nprecedence.",
- "type": "string"
- }
- },
- "id": "ImageSource",
- "description": "External image source (Google Cloud Storage image location).",
- "type": "object"
- },
- "Position": {
- "description": "A 3D position in the image, used primarily for Face detection landmarks.\nA valid Position must have both x and y coordinates.\nThe position coordinates are in the same scale as the original image.",
- "type": "object",
- "properties": {
- "y": {
- "format": "float",
- "description": "Y coordinate.",
- "type": "number"
- },
- "z": {
- "format": "float",
- "description": "Z coordinate (or depth).",
- "type": "number"
- },
- "x": {
- "format": "float",
- "description": "X coordinate.",
- "type": "number"
- }
- },
- "id": "Position"
- },
- "WebPage": {
- "properties": {
- "url": {
- "description": "The result web page URL.",
- "type": "string"
- },
- "score": {
- "format": "float",
- "description": "(Deprecated) Overall relevancy score for the web page.",
- "type": "number"
- }
- },
- "id": "WebPage",
- "description": "Metadata for web pages.",
- "type": "object"
- },
- "ColorInfo": {
- "description": "Color information consists of RGB channels, score, and the fraction of\nthe image that the color occupies in the image.",
- "type": "object",
- "properties": {
- "pixelFraction": {
- "format": "float",
- "description": "The fraction of pixels the color occupies in the image.\nValue in range [0, 1].",
- "type": "number"
- },
- "color": {
- "$ref": "Color",
- "description": "RGB components of the color."
- },
- "score": {
- "format": "float",
- "description": "Image-specific score for this color. Value in range [0, 1].",
- "type": "number"
- }
- },
- "id": "ColorInfo"
- },
- "EntityAnnotation": {
- "description": "Set of detected entity features.",
- "type": "object",
- "properties": {
- "confidence": {
- "format": "float",
- "description": "The accuracy of the entity detection in an image.\nFor example, for an image in which the \"Eiffel Tower\" entity is detected,\nthis field represents the confidence that there is a tower in the query\nimage. Range [0, 1].",
- "type": "number"
- },
- "boundingPoly": {
- "description": "Image region to which this entity belongs. Not produced\nfor `LABEL_DETECTION` features.",
- "$ref": "BoundingPoly"
- },
- "locale": {
- "description": "The language code for the locale in which the entity textual\n`description` is expressed.",
- "type": "string"
- },
- "topicality": {
- "format": "float",
- "description": "The relevancy of the ICA (Image Content Annotation) label to the\nimage. For example, the relevancy of \"tower\" is likely higher to an image\ncontaining the detected \"Eiffel Tower\" than to an image containing a\ndetected distant towering building, even though the confidence that\nthere is a tower in each image may be the same. Range [0, 1].",
- "type": "number"
- },
- "description": {
- "description": "Entity textual description, expressed in its `locale` language.",
- "type": "string"
- },
- "properties": {
- "description": "Some entities may have optional user-supplied `Property` (name/value)\nfields, such a score or string that qualifies the entity.",
- "items": {
- "$ref": "Property"
- },
- "type": "array"
- },
- "score": {
- "format": "float",
- "description": "Overall score of the result. Range [0, 1].",
- "type": "number"
- },
- "locations": {
- "description": "The location information for the detected entity. Multiple\n`LocationInfo` elements can be present because one location may\nindicate the location of the scene in the image, and another location\nmay indicate the location of the place where the image was taken.\nLocation information is usually present for landmarks.",
- "items": {
- "$ref": "LocationInfo"
- },
- "type": "array"
- },
- "mid": {
- "description": "Opaque entity ID. Some IDs may be available in\n[Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).",
- "type": "string"
- }
- },
- "id": "EntityAnnotation"
- },
"CropHint": {
- "description": "Single crop hint that is used to generate a new crop when serving an image.",
- "type": "object",
"properties": {
"importanceFraction": {
"format": "float",
@@ -738,17 +19,56 @@
"type": "number"
},
"boundingPoly": {
- "$ref": "BoundingPoly",
- "description": "The bounding polygon for the crop region. The coordinates of the bounding\nbox are in the original image's scale, as returned in `ImageParams`."
+ "description": "The bounding polygon for the crop region. The coordinates of the bounding\nbox are in the original image's scale, as returned in `ImageParams`.",
+ "$ref": "BoundingPoly"
}
},
- "id": "CropHint"
+ "id": "CropHint",
+ "description": "Single crop hint that is used to generate a new crop when serving an image.",
+ "type": "object"
},
"Landmark": {
"description": "A face-specific landmark (for example, a face feature).\nLandmark positions may fall outside the bounds of the image\nif the face is near one or more edges of the image.\nTherefore it is NOT guaranteed that `0 \u003c= x \u003c width` or\n`0 \u003c= y \u003c height`.",
"type": "object",
"properties": {
"type": {
+ "enumDescriptions": [
+ "Unknown face landmark detected. Should not be filled.",
+ "Left eye.",
+ "Right eye.",
+ "Left of left eyebrow.",
+ "Right of left eyebrow.",
+ "Left of right eyebrow.",
+ "Right of right eyebrow.",
+ "Midpoint between eyes.",
+ "Nose tip.",
+ "Upper lip.",
+ "Lower lip.",
+ "Mouth left.",
+ "Mouth right.",
+ "Mouth center.",
+ "Nose, bottom right.",
+ "Nose, bottom left.",
+ "Nose, bottom center.",
+ "Left eye, top boundary.",
+ "Left eye, right corner.",
+ "Left eye, bottom boundary.",
+ "Left eye, left corner.",
+ "Right eye, top boundary.",
+ "Right eye, right corner.",
+ "Right eye, bottom boundary.",
+ "Right eye, left corner.",
+ "Left eyebrow, upper midpoint.",
+ "Right eyebrow, upper midpoint.",
+ "Left ear tragion.",
+ "Right ear tragion.",
+ "Left eye pupil.",
+ "Right eye pupil.",
+ "Forehead glabella.",
+ "Chin gnathion.",
+ "Chin left gonion.",
+ "Chin right gonion."
+ ],
"enum": [
"UNKNOWN_LANDMARK",
"LEFT_EYE",
@@ -787,55 +107,16 @@
"CHIN_RIGHT_GONION"
],
"description": "Face landmark type.",
- "type": "string",
- "enumDescriptions": [
- "Unknown face landmark detected. Should not be filled.",
- "Left eye.",
- "Right eye.",
- "Left of left eyebrow.",
- "Right of left eyebrow.",
- "Left of right eyebrow.",
- "Right of right eyebrow.",
- "Midpoint between eyes.",
- "Nose tip.",
- "Upper lip.",
- "Lower lip.",
- "Mouth left.",
- "Mouth right.",
- "Mouth center.",
- "Nose, bottom right.",
- "Nose, bottom left.",
- "Nose, bottom center.",
- "Left eye, top boundary.",
- "Left eye, right corner.",
- "Left eye, bottom boundary.",
- "Left eye, left corner.",
- "Right eye, top boundary.",
- "Right eye, right corner.",
- "Right eye, bottom boundary.",
- "Right eye, left corner.",
- "Left eyebrow, upper midpoint.",
- "Right eyebrow, upper midpoint.",
- "Left ear tragion.",
- "Right ear tragion.",
- "Left eye pupil.",
- "Right eye pupil.",
- "Forehead glabella.",
- "Chin gnathion.",
- "Chin left gonion.",
- "Chin right gonion."
- ]
+ "type": "string"
},
"position": {
- "description": "Face landmark position.",
- "$ref": "Position"
+ "$ref": "Position",
+ "description": "Face landmark position."
}
},
"id": "Landmark"
},
"WebImage": {
- "description": "Metadata for online images.",
- "type": "object",
"properties": {
"score": {
"format": "float",
@@ -847,15 +128,17 @@
"type": "string"
}
},
- "id": "WebImage"
+ "id": "WebImage",
+ "description": "Metadata for online images.",
+ "type": "object"
},
"Word": {
"description": "A word representation.",
"type": "object",
"properties": {
"boundingBox": {
- "$ref": "BoundingPoly",
- "description": "The bounding box for the word.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3)."
+ "description": "The bounding box for the word.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3).",
+ "$ref": "BoundingPoly"
},
"symbols": {
"description": "List of symbols in the word.\nThe order of the symbols follows the natural reading order.",
@@ -873,6 +156,10 @@
},
"Paragraph": {
"properties": {
+ "property": {
+ "$ref": "TextProperty",
+ "description": "Additional information detected for the paragraph."
+ },
"boundingBox": {
"$ref": "BoundingPoly",
"description": "The bounding box for the paragraph.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3)."
@@ -883,10 +170,6 @@
"$ref": "Word"
},
"type": "array"
- },
- "property": {
- "description": "Additional information detected for the paragraph.",
- "$ref": "TextProperty"
}
},
"id": "Paragraph",
@@ -894,6 +177,8 @@
"type": "object"
},
"Image": {
+ "description": "Client image to perform Google Cloud Vision API tasks over.",
+ "type": "object",
"properties": {
"source": {
"description": "Google Cloud Storage image location. If both `content` and `source`\nare provided for an image, `content` takes precedence and is\nused to perform the image annotation request.",
@@ -905,65 +190,20 @@
"type": "string"
}
},
- "id": "Image",
- "description": "Client image to perform Google Cloud Vision API tasks over.",
- "type": "object"
+ "id": "Image"
},
"FaceAnnotation": {
"properties": {
- "landmarks": {
- "description": "Detected face landmarks.",
- "items": {
- "$ref": "Landmark"
- },
- "type": "array"
+ "boundingPoly": {
+ "$ref": "BoundingPoly",
+ "description": "The bounding polygon around the face. The coordinates of the bounding box\nare in the original image's scale, as returned in `ImageParams`.\nThe bounding box is computed to \"frame\" the face in accordance with human\nexpectations. It is based on the landmarker results.\nNote that one or more x and/or y coordinates may not be generated in the\n`BoundingPoly` (the polygon will be unbounded) if only a partial face\nappears in the image to be annotated."
},
- "angerLikelihood": {
- "enumDescriptions": [
- "Unknown likelihood.",
- "It is very unlikely that the image belongs to the specified vertical.",
- "It is unlikely that the image belongs to the specified vertical.",
- "It is possible that the image belongs to the specified vertical.",
- "It is likely that the image belongs to the specified vertical.",
- "It is very likely that the image belongs to the specified vertical."
- ],
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Anger likelihood.",
- "type": "string"
- },
- "surpriseLikelihood": {
- "enumDescriptions": [
- "Unknown likelihood.",
- "It is very unlikely that the image belongs to the specified vertical.",
- "It is unlikely that the image belongs to the specified vertical.",
- "It is possible that the image belongs to the specified vertical.",
- "It is likely that the image belongs to the specified vertical.",
- "It is very likely that the image belongs to the specified vertical."
- ],
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Surprise likelihood.",
- "type": "string"
- },
- "landmarkingConfidence": {
+ "rollAngle": {
"format": "float",
- "description": "Face landmarking confidence. Range [0, 1].",
+ "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation\nof the face relative to the image vertical about the axis perpendicular to\nthe face. Range [-180,180].",
"type": "number"
},
- "joyLikelihood": {
+ "sorrowLikelihood": {
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
@@ -972,7 +212,7 @@
"LIKELY",
"VERY_LIKELY"
],
- "description": "Joy likelihood.",
+ "description": "Sorrow likelihood.",
"type": "string",
"enumDescriptions": [
"Unknown likelihood.",
@@ -983,6 +223,87 @@
"It is very likely that the image belongs to the specified vertical."
]
},
+ "tiltAngle": {
+ "format": "float",
+ "description": "Pitch angle, which indicates the upwards/downwards angle that the face is\npointing relative to the image's horizontal plane. Range [-180,180].",
+ "type": "number"
+ },
+ "fdBoundingPoly": {
+ "$ref": "BoundingPoly",
+ "description": "The `fd_bounding_poly` bounding polygon is tighter than the\n`boundingPoly`, and encloses only the skin part of the face. Typically, it\nis used to eliminate the face from any image analysis that detects the\n\"amount of skin\" visible in an image. It is not based on the\nlandmarker results, only on the initial face detection, hence\nthe \u003ccode\u003efd\u003c/code\u003e (face detection) prefix."
+ },
+ "surpriseLikelihood": {
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Surprise likelihood.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "It is very unlikely that the image belongs to the specified vertical.",
+ "It is unlikely that the image belongs to the specified vertical.",
+ "It is possible that the image belongs to the specified vertical.",
+ "It is likely that the image belongs to the specified vertical.",
+ "It is very likely that the image belongs to the specified vertical."
+ ]
+ },
+ "landmarks": {
+ "description": "Detected face landmarks.",
+ "items": {
+ "$ref": "Landmark"
+ },
+ "type": "array"
+ },
+ "angerLikelihood": {
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Anger likelihood.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "It is very unlikely that the image belongs to the specified vertical.",
+ "It is unlikely that the image belongs to the specified vertical.",
+ "It is possible that the image belongs to the specified vertical.",
+ "It is likely that the image belongs to the specified vertical.",
+ "It is very likely that the image belongs to the specified vertical."
+ ]
+ },
+ "landmarkingConfidence": {
+ "format": "float",
+ "description": "Face landmarking confidence. Range [0, 1].",
+ "type": "number"
+ },
+ "joyLikelihood": {
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "It is very unlikely that the image belongs to the specified vertical.",
+ "It is unlikely that the image belongs to the specified vertical.",
+ "It is possible that the image belongs to the specified vertical.",
+ "It is likely that the image belongs to the specified vertical.",
+ "It is very likely that the image belongs to the specified vertical."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Joy likelihood.",
+ "type": "string"
+ },
"underExposedLikelihood": {
"enum": [
"UNKNOWN",
@@ -1034,14 +355,6 @@
"type": "string"
},
"headwearLikelihood": {
- "enumDescriptions": [
- "Unknown likelihood.",
- "It is very unlikely that the image belongs to the specified vertical.",
- "It is unlikely that the image belongs to the specified vertical.",
- "It is possible that the image belongs to the specified vertical.",
- "It is likely that the image belongs to the specified vertical.",
- "It is very likely that the image belongs to the specified vertical."
- ],
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
@@ -1051,27 +364,6 @@
"VERY_LIKELY"
],
"description": "Headwear likelihood.",
- "type": "string"
- },
- "boundingPoly": {
- "description": "The bounding polygon around the face. The coordinates of the bounding box\nare in the original image's scale, as returned in `ImageParams`.\nThe bounding box is computed to \"frame\" the face in accordance with human\nexpectations. It is based on the landmarker results.\nNote that one or more x and/or y coordinates may not be generated in the\n`BoundingPoly` (the polygon will be unbounded) if only a partial face\nappears in the image to be annotated.",
- "$ref": "BoundingPoly"
- },
- "rollAngle": {
- "format": "float",
- "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation\nof the face relative to the image vertical about the axis perpendicular to\nthe face. Range [-180,180].",
- "type": "number"
- },
- "sorrowLikelihood": {
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Sorrow likelihood.",
"type": "string",
"enumDescriptions": [
"Unknown likelihood.",
@@ -1081,15 +373,6 @@
"It is likely that the image belongs to the specified vertical.",
"It is very likely that the image belongs to the specified vertical."
]
- },
- "tiltAngle": {
- "format": "float",
- "description": "Pitch angle, which indicates the upwards/downwards angle that the face is\npointing relative to the image's horizontal plane. Range [-180,180].",
- "type": "number"
- },
- "fdBoundingPoly": {
- "$ref": "BoundingPoly",
- "description": "The `fd_bounding_poly` bounding polygon is tighter than the\n`boundingPoly`, and encloses only the skin part of the face. Typically, it\nis used to eliminate the face from any image analysis that detects the\n\"amount of skin\" visible in an image. It is not based on the\nlandmarker results, only on the initial face detection, hence\nthe \u003ccode\u003efd\u003c/code\u003e (face detection) prefix."
}
},
"id": "FaceAnnotation",
@@ -1097,8 +380,6 @@
"type": "object"
},
"BatchAnnotateImagesRequest": {
- "description": "Multiple image annotation requests are batched into a single service call.",
- "type": "object",
"properties": {
"requests": {
"description": "Individual image annotation requests for this batch.",
@@ -1108,10 +389,16 @@
"type": "array"
}
},
- "id": "BatchAnnotateImagesRequest"
+ "id": "BatchAnnotateImagesRequest",
+ "description": "Multiple image annotation requests are batched into a single service call.",
+ "type": "object"
},
"DetectedBreak": {
"properties": {
+ "isPrefix": {
+ "description": "True if break prepends the element.",
+ "type": "boolean"
+ },
"type": {
"enum": [
"UNKNOWN",
@@ -1131,10 +418,6 @@
"End-line hyphen that is not present in text; does not co-occur with\n`SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.",
"Line break that ends a paragraph."
]
- },
- "isPrefix": {
- "description": "True if break prepends the element.",
- "type": "boolean"
}
},
"id": "DetectedBreak",
@@ -1142,31 +425,34 @@
"type": "object"
},
"ImageContext": {
+ "description": "Image context and/or feature-specific parameters.",
+ "type": "object",
"properties": {
+ "latLongRect": {
+ "description": "lat/long rectangle that specifies the location of the image.",
+ "$ref": "LatLongRect"
+ },
+ "cropHintsParams": {
+ "description": "Parameters for crop hints annotation request.",
+ "$ref": "CropHintsParams"
+ },
"languageHints": {
"description": "List of languages to use for TEXT_DETECTION. In most cases, an empty value\nyields the best results since it enables automatic language detection. For\nlanguages based on the Latin alphabet, setting `language_hints` is not\nneeded. In rare cases, when the language of the text in the image is known,\nsetting a hint will help get better results (although it will be a\nsignificant hindrance if the hint is wrong). Text detection returns an\nerror if one or more of the specified languages is not one of the\n[supported languages](/vision/docs/languages).",
"items": {
"type": "string"
},
"type": "array"
- },
- "latLongRect": {
- "$ref": "LatLongRect",
- "description": "lat/long rectangle that specifies the location of the image."
- },
- "cropHintsParams": {
- "description": "Parameters for crop hints annotation request.",
- "$ref": "CropHintsParams"
}
},
- "id": "ImageContext",
- "description": "Image context and/or feature-specific parameters.",
- "type": "object"
+ "id": "ImageContext"
},
"Page": {
- "description": "Detected page from OCR.",
- "type": "object",
"properties": {
+ "height": {
+ "format": "int32",
+ "description": "Page height in pixels.",
+ "type": "integer"
+ },
"width": {
"format": "int32",
"description": "Page width in pixels.",
@@ -1180,19 +466,20 @@
"type": "array"
},
"property": {
- "description": "Additional information detected on the page.",
- "$ref": "TextProperty"
- },
- "height": {
- "format": "int32",
- "description": "Page height in pixels.",
- "type": "integer"
+ "$ref": "TextProperty",
+ "description": "Additional information detected on the page."
}
},
- "id": "Page"
+ "id": "Page",
+ "description": "Detected page from OCR.",
+ "type": "object"
},
"AnnotateImageRequest": {
"properties": {
+ "imageContext": {
+ "description": "Additional context that may accompany the image.",
+ "$ref": "ImageContext"
+ },
"features": {
"description": "Requested features.",
"items": {
@@ -1201,17 +488,725 @@
"type": "array"
},
"image": {
- "description": "The image to be processed.",
- "$ref": "Image"
- },
- "imageContext": {
- "description": "Additional context that may accompany the image.",
- "$ref": "ImageContext"
+ "$ref": "Image",
+ "description": "The image to be processed."
}
},
"id": "AnnotateImageRequest",
"description": "Request for performing Google Cloud Vision API tasks over a user-provided\nimage, with user-requested features.",
"type": "object"
+ },
+ "Status": {
+ "properties": {
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "code": {
+ "format": "int32",
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "type": "integer"
+ }
+ },
+ "id": "Status",
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object"
+ },
+ "Symbol": {
+ "properties": {
+ "property": {
+ "description": "Additional information detected for the symbol.",
+ "$ref": "TextProperty"
+ },
+ "boundingBox": {
+ "description": "The bounding box for the symbol.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3).",
+ "$ref": "BoundingPoly"
+ },
+ "text": {
+ "description": "The actual UTF-8 representation of the symbol.",
+ "type": "string"
+ }
+ },
+ "id": "Symbol",
+ "description": "A single symbol representation.",
+ "type": "object"
+ },
+ "LatLongRect": {
+ "properties": {
+ "minLatLng": {
+ "description": "Min lat/long pair.",
+ "$ref": "LatLng"
+ },
+ "maxLatLng": {
+ "$ref": "LatLng",
+ "description": "Max lat/long pair."
+ }
+ },
+ "id": "LatLongRect",
+ "description": "Rectangle determined by min and max `LatLng` pairs.",
+ "type": "object"
+ },
+ "CropHintsAnnotation": {
+ "description": "Set of crop hints that are used to generate new crops when serving images.",
+ "type": "object",
+ "properties": {
+ "cropHints": {
+ "description": "Crop hint results.",
+ "items": {
+ "$ref": "CropHint"
+ },
+ "type": "array"
+ }
+ },
+ "id": "CropHintsAnnotation"
+ },
+ "LatLng": {
+ "properties": {
+ "latitude": {
+ "format": "double",
+ "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
+ "type": "number"
+ },
+ "longitude": {
+ "format": "double",
+ "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
+ "type": "number"
+ }
+ },
+ "id": "LatLng",
+ "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.\n\nExample of normalization code in Python:\n\n def NormalizeLongitude(longitude):\n \"\"\"Wraps decimal degrees longitude to [-180.0, 180.0].\"\"\"\n q, r = divmod(longitude, 360.0)\n if r \u003e 180.0 or (r == 180.0 and q \u003c= -1.0):\n return r - 360.0\n return r\n\n def NormalizeLatLng(latitude, longitude):\n \"\"\"Wraps decimal degrees latitude and longitude to\n [-90.0, 90.0] and [-180.0, 180.0], respectively.\"\"\"\n r = latitude % 360.0\n if r \u003c= 90.0:\n return r, NormalizeLongitude(longitude)\n elif r \u003e= 270.0:\n return r - 360, NormalizeLongitude(longitude)\n else:\n return 180 - r, NormalizeLongitude(longitude + 180.0)\n\n assert 180.0 == NormalizeLongitude(180.0)\n assert -180.0 == NormalizeLongitude(-180.0)\n assert -179.0 == NormalizeLongitude(181.0)\n assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)\n assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)\n assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)\n assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)\n assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)\n assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)\n assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)\n assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)\n assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)",
+ "type": "object"
+ },
+ "Color": {
+ "properties": {
+ "red": {
+ "format": "float",
+ "description": "The amount of red in the color as a value in the interval [0, 1].",
+ "type": "number"
+ },
+ "alpha": {
+ "format": "float",
+ "description": "The fraction of this color that should be applied to the pixel. That is,\nthe final pixel color is defined by the equation:\n\n pixel color = alpha * (this color) + (1.0 - alpha) * (background color)\n\nThis means that a value of 1.0 corresponds to a solid color, whereas\na value of 0.0 corresponds to a completely transparent color. This\nuses a wrapper message rather than a simple float scalar so that it is\npossible to distinguish between a default value and the value being unset.\nIf omitted, this color object is to be rendered as a solid color\n(as if the alpha value had been explicitly given with a value of 1.0).",
+ "type": "number"
+ },
+ "blue": {
+ "format": "float",
+ "description": "The amount of blue in the color as a value in the interval [0, 1].",
+ "type": "number"
+ },
+ "green": {
+ "format": "float",
+ "description": "The amount of green in the color as a value in the interval [0, 1].",
+ "type": "number"
+ }
+ },
+ "id": "Color",
+ "description": "Represents a color in the RGBA color space. This representation is designed\nfor simplicity of conversion to/from color representations in various\nlanguages over compactness; for example, the fields of this representation\ncan be trivially provided to the constructor of \"java.awt.Color\" in Java; it\ncan also be trivially provided to UIColor's \"+colorWithRed:green:blue:alpha\"\nmethod in iOS; and, with just a little work, it can be easily formatted into\na CSS \"rgba()\" string in JavaScript, as well. Here are some examples:\n\nExample (Java):\n\n import com.google.type.Color;\n\n // ...\n public static java.awt.Color fromProto(Color protocolor) {\n float alpha = protocolor.hasAlpha()\n ? protocolor.getAlpha().getValue()\n : 1.0;\n\n return new java.awt.Color(\n protocolor.getRed(),\n protocolor.getGreen(),\n protocolor.getBlue(),\n alpha);\n }\n\n public static Color toProto(java.awt.Color color) {\n float red = (float) color.getRed();\n float green = (float) color.getGreen();\n float blue = (float) color.getBlue();\n float denominator = 255.0;\n Color.Builder resultBuilder =\n Color\n .newBuilder()\n .setRed(red / denominator)\n .setGreen(green / denominator)\n .setBlue(blue / denominator);\n int alpha = color.getAlpha();\n if (alpha != 255) {\n result.setAlpha(\n FloatValue\n .newBuilder()\n .setValue(((float) alpha) / denominator)\n .build());\n }\n return resultBuilder.build();\n }\n // ...\n\nExample (iOS / Obj-C):\n\n // ...\n static UIColor* fromProto(Color* protocolor) {\n float red = [protocolor red];\n float green = [protocolor green];\n float blue = [protocolor blue];\n FloatValue* alpha_wrapper = [protocolor alpha];\n float alpha = 1.0;\n if (alpha_wrapper != nil) {\n alpha = [alpha_wrapper value];\n }\n return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];\n }\n\n static Color* toProto(UIColor* color) {\n CGFloat red, green, blue, alpha;\n if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {\n return nil;\n }\n Color* result = [Color alloc] init];\n [result setRed:red];\n [result setGreen:green];\n [result setBlue:blue];\n if (alpha \u003c= 0.9999) {\n [result setAlpha:floatWrapperWithValue(alpha)];\n }\n [result autorelease];\n return result;\n }\n // ...\n\n Example (JavaScript):\n\n // ...\n\n var protoToCssColor = function(rgb_color) {\n var redFrac = rgb_color.red || 0.0;\n var greenFrac = rgb_color.green || 0.0;\n var blueFrac = rgb_color.blue || 0.0;\n var red = Math.floor(redFrac * 255);\n var green = Math.floor(greenFrac * 255);\n var blue = Math.floor(blueFrac * 255);\n\n if (!('alpha' in rgb_color)) {\n return rgbToCssColor_(red, green, blue);\n }\n\n var alphaFrac = rgb_color.alpha.value || 0.0;\n var rgbParams = [red, green, blue].join(',');\n return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');\n };\n\n var rgbToCssColor_ = function(red, green, blue) {\n var rgbNumber = new Number((red \u003c\u003c 16) | (green \u003c\u003c 8) | blue);\n var hexString = rgbNumber.toString(16);\n var missingZeros = 6 - hexString.length;\n var resultBuilder = ['#'];\n for (var i = 0; i \u003c missingZeros; i++) {\n resultBuilder.push('0');\n }\n resultBuilder.push(hexString);\n return resultBuilder.join('');\n };\n\n // ...",
+ "type": "object"
+ },
+ "ImageProperties": {
+ "properties": {
+ "dominantColors": {
+ "description": "If present, dominant colors completed successfully.",
+ "$ref": "DominantColorsAnnotation"
+ }
+ },
+ "id": "ImageProperties",
+ "description": "Stores image properties, such as dominant colors.",
+ "type": "object"
+ },
+ "Feature": {
+ "description": "Users describe the type of Google Cloud Vision API tasks to perform over\nimages by using *Feature*s. Each Feature indicates a type of image\ndetection task to perform. Features encode the Cloud Vision API\nvertical to operate on and the number of top-scoring results to return.",
+ "type": "object",
+ "properties": {
+ "maxResults": {
+ "format": "int32",
+ "description": "Maximum number of results of this type.",
+ "type": "integer"
+ },
+ "type": {
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "FACE_DETECTION",
+ "LANDMARK_DETECTION",
+ "LOGO_DETECTION",
+ "LABEL_DETECTION",
+ "TEXT_DETECTION",
+ "DOCUMENT_TEXT_DETECTION",
+ "SAFE_SEARCH_DETECTION",
+ "IMAGE_PROPERTIES",
+ "CROP_HINTS",
+ "WEB_DETECTION"
+ ],
+ "description": "The feature type.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified feature type.",
+ "Run face detection.",
+ "Run landmark detection.",
+ "Run logo detection.",
+ "Run label detection.",
+ "Run OCR.",
+ "Run dense text document OCR. Takes precedence when both\nDOCUMENT_TEXT_DETECTION and TEXT_DETECTION are present.",
+ "Run computer vision models to compute image safe-search properties.",
+ "Compute a set of image properties, such as the image's dominant colors.",
+ "Run crop hints.",
+ "Run web detection."
+ ]
+ }
+ },
+ "id": "Feature"
+ },
+ "SafeSearchAnnotation": {
+ "description": "Set of features pertaining to the image, computed by computer vision\nmethods over safe-search verticals (for example, adult, spoof, medical,\nviolence).",
+ "type": "object",
+ "properties": {
+ "spoof": {
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "It is very unlikely that the image belongs to the specified vertical.",
+ "It is unlikely that the image belongs to the specified vertical.",
+ "It is possible that the image belongs to the specified vertical.",
+ "It is likely that the image belongs to the specified vertical.",
+ "It is very likely that the image belongs to the specified vertical."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Spoof likelihood. The likelihood that an modification\nwas made to the image's canonical version to make it appear\nfunny or offensive.",
+ "type": "string"
+ },
+ "medical": {
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "It is very unlikely that the image belongs to the specified vertical.",
+ "It is unlikely that the image belongs to the specified vertical.",
+ "It is possible that the image belongs to the specified vertical.",
+ "It is likely that the image belongs to the specified vertical.",
+ "It is very likely that the image belongs to the specified vertical."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Likelihood that this is a medical image.",
+ "type": "string"
+ },
+ "violence": {
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "It is very unlikely that the image belongs to the specified vertical.",
+ "It is unlikely that the image belongs to the specified vertical.",
+ "It is possible that the image belongs to the specified vertical.",
+ "It is likely that the image belongs to the specified vertical.",
+ "It is very likely that the image belongs to the specified vertical."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Likelihood that this image contains violent content.",
+ "type": "string"
+ },
+ "adult": {
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "It is very unlikely that the image belongs to the specified vertical.",
+ "It is unlikely that the image belongs to the specified vertical.",
+ "It is possible that the image belongs to the specified vertical.",
+ "It is likely that the image belongs to the specified vertical.",
+ "It is very likely that the image belongs to the specified vertical."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Represents the adult content likelihood for the image. Adult content may\ncontain elements such as nudity, pornographic images or cartoons, or\nsexual activities.",
+ "type": "string"
+ }
+ },
+ "id": "SafeSearchAnnotation"
+ },
+ "DominantColorsAnnotation": {
+ "properties": {
+ "colors": {
+ "description": "RGB color values with their score and pixel fraction.",
+ "items": {
+ "$ref": "ColorInfo"
+ },
+ "type": "array"
+ }
+ },
+ "id": "DominantColorsAnnotation",
+ "description": "Set of dominant colors and their corresponding scores.",
+ "type": "object"
+ },
+ "TextAnnotation": {
+ "description": "TextAnnotation contains a structured representation of OCR extracted text.\nThe hierarchy of an OCR extracted text structure is like this:\n TextAnnotation -\u003e Page -\u003e Block -\u003e Paragraph -\u003e Word -\u003e Symbol\nEach structural component, starting from Page, may further have their own\nproperties. Properties describe detected languages, breaks etc.. Please\nrefer to the google.cloud.vision.v1.TextAnnotation.TextProperty message\ndefinition below for more detail.",
+ "type": "object",
+ "properties": {
+ "pages": {
+ "description": "List of pages detected by OCR.",
+ "items": {
+ "$ref": "Page"
+ },
+ "type": "array"
+ },
+ "text": {
+ "description": "UTF-8 text detected on the pages.",
+ "type": "string"
+ }
+ },
+ "id": "TextAnnotation"
+ },
+ "DetectedLanguage": {
+ "properties": {
+ "languageCode": {
+ "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.",
+ "type": "string"
+ },
+ "confidence": {
+ "format": "float",
+ "description": "Confidence of detected language. Range [0, 1].",
+ "type": "number"
+ }
+ },
+ "id": "DetectedLanguage",
+ "description": "Detected language for a structural component.",
+ "type": "object"
+ },
+ "Vertex": {
+ "properties": {
+ "y": {
+ "format": "int32",
+ "description": "Y coordinate.",
+ "type": "integer"
+ },
+ "x": {
+ "format": "int32",
+ "description": "X coordinate.",
+ "type": "integer"
+ }
+ },
+ "id": "Vertex",
+ "description": "A vertex represents a 2D point in the image.\nNOTE: the vertex coordinates are in the same scale as the original image.",
+ "type": "object"
+ },
+ "TextProperty": {
+ "properties": {
+ "detectedLanguages": {
+ "description": "A list of detected languages together with confidence.",
+ "items": {
+ "$ref": "DetectedLanguage"
+ },
+ "type": "array"
+ },
+ "detectedBreak": {
+ "$ref": "DetectedBreak",
+ "description": "Detected start or end of a text segment."
+ }
+ },
+ "id": "TextProperty",
+ "description": "Additional information detected on the structural component.",
+ "type": "object"
+ },
+ "BoundingPoly": {
+ "description": "A bounding polygon for the detected image annotation.",
+ "type": "object",
+ "properties": {
+ "vertices": {
+ "description": "The bounding polygon vertices.",
+ "items": {
+ "$ref": "Vertex"
+ },
+ "type": "array"
+ }
+ },
+ "id": "BoundingPoly"
+ },
+ "WebEntity": {
+ "description": "Entity deduced from similar images on the Internet.",
+ "type": "object",
+ "properties": {
+ "entityId": {
+ "description": "Opaque entity ID.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Canonical description of the entity, in English.",
+ "type": "string"
+ },
+ "score": {
+ "format": "float",
+ "description": "Overall relevancy score for the entity.\nNot normalized and not comparable across different image queries.",
+ "type": "number"
+ }
+ },
+ "id": "WebEntity"
+ },
+ "AnnotateImageResponse": {
+ "properties": {
+ "fullTextAnnotation": {
+ "description": "If present, text (OCR) detection or document (OCR) text detection has\ncompleted successfully.\nThis annotation provides the structural hierarchy for the OCR detected\ntext.",
+ "$ref": "TextAnnotation"
+ },
+ "landmarkAnnotations": {
+ "description": "If present, landmark detection has completed successfully.",
+ "items": {
+ "$ref": "EntityAnnotation"
+ },
+ "type": "array"
+ },
+ "textAnnotations": {
+ "description": "If present, text (OCR) detection has completed successfully.",
+ "items": {
+ "$ref": "EntityAnnotation"
+ },
+ "type": "array"
+ },
+ "faceAnnotations": {
+ "description": "If present, face detection has completed successfully.",
+ "items": {
+ "$ref": "FaceAnnotation"
+ },
+ "type": "array"
+ },
+ "imagePropertiesAnnotation": {
+ "$ref": "ImageProperties",
+ "description": "If present, image properties were extracted successfully."
+ },
+ "logoAnnotations": {
+ "description": "If present, logo detection has completed successfully.",
+ "items": {
+ "$ref": "EntityAnnotation"
+ },
+ "type": "array"
+ },
+ "webDetection": {
+ "$ref": "WebDetection",
+ "description": "If present, web detection has completed successfully."
+ },
+ "cropHintsAnnotation": {
+ "$ref": "CropHintsAnnotation",
+ "description": "If present, crop hints have completed successfully."
+ },
+ "safeSearchAnnotation": {
+ "description": "If present, safe-search annotation has completed successfully.",
+ "$ref": "SafeSearchAnnotation"
+ },
+ "labelAnnotations": {
+ "description": "If present, label detection has completed successfully.",
+ "items": {
+ "$ref": "EntityAnnotation"
+ },
+ "type": "array"
+ },
+ "error": {
+ "$ref": "Status",
+ "description": "If set, represents the error message for the operation.\nNote that filled-in image annotations are guaranteed to be\ncorrect, even when `error` is set."
+ }
+ },
+ "id": "AnnotateImageResponse",
+ "description": "Response to an image annotation request.",
+ "type": "object"
+ },
+ "CropHintsParams": {
+ "properties": {
+ "aspectRatios": {
+ "description": "Aspect ratios in floats, representing the ratio of the width to the height\nof the image. For example, if the desired aspect ratio is 4/3, the\ncorresponding float value should be 1.33333. If not specified, the\nbest possible crop is returned. The number of provided aspect ratios is\nlimited to a maximum of 16; any aspect ratios provided after the 16th are\nignored.",
+ "items": {
+ "format": "float",
+ "type": "number"
+ },
+ "type": "array"
+ }
+ },
+ "id": "CropHintsParams",
+ "description": "Parameters for crop hints annotation request.",
+ "type": "object"
+ },
+ "Block": {
+ "properties": {
+ "boundingBox": {
+ "$ref": "BoundingPoly",
+ "description": "The bounding box for the block.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3)."
+ },
+ "paragraphs": {
+ "description": "List of paragraphs in this block (if this blocks is of type text).",
+ "items": {
+ "$ref": "Paragraph"
+ },
+ "type": "array"
+ },
+ "property": {
+ "description": "Additional information detected for the block.",
+ "$ref": "TextProperty"
+ },
+ "blockType": {
+ "enum": [
+ "UNKNOWN",
+ "TEXT",
+ "TABLE",
+ "PICTURE",
+ "RULER",
+ "BARCODE"
+ ],
+ "description": "Detected block type (text, image etc) for this block.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown block type.",
+ "Regular text block.",
+ "Table block.",
+ "Image block.",
+ "Horizontal/vertical line box.",
+ "Barcode block."
+ ]
+ }
+ },
+ "id": "Block",
+ "description": "Logical element on the page.",
+ "type": "object"
+ },
+ "Property": {
+ "description": "A `Property` consists of a user-supplied name/value pair.",
+ "type": "object",
+ "properties": {
+ "uint64Value": {
+ "format": "uint64",
+ "description": "Value of numeric properties.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the property.",
+ "type": "string"
+ },
+ "value": {
+ "description": "Value of the property.",
+ "type": "string"
+ }
+ },
+ "id": "Property"
+ },
+ "LocationInfo": {
+ "description": "Detected entity location information.",
+ "type": "object",
+ "properties": {
+ "latLng": {
+ "description": "lat/long location coordinates.",
+ "$ref": "LatLng"
+ }
+ },
+ "id": "LocationInfo"
+ },
+ "ImageSource": {
+ "description": "External image source (Google Cloud Storage image location).",
+ "type": "object",
+ "properties": {
+ "gcsImageUri": {
+ "description": "NOTE: For new code `image_uri` below is preferred.\nGoogle Cloud Storage image URI, which must be in the following form:\n`gs://bucket_name/object_name` (for details, see\n[Google Cloud Storage Request\nURIs](https://cloud.google.com/storage/docs/reference-uris)).\nNOTE: Cloud Storage object versioning is not supported.",
+ "type": "string"
+ },
+ "imageUri": {
+ "description": "Image URI which supports:\n1) Google Cloud Storage image URI, which must be in the following form:\n`gs://bucket_name/object_name` (for details, see\n[Google Cloud Storage Request\nURIs](https://cloud.google.com/storage/docs/reference-uris)).\nNOTE: Cloud Storage object versioning is not supported.\n2) Publicly accessible image HTTP/HTTPS URL.\nThis is preferred over the legacy `gcs_image_uri` above. When both\n`gcs_image_uri` and `image_uri` are specified, `image_uri` takes\nprecedence.",
+ "type": "string"
+ }
+ },
+ "id": "ImageSource"
+ },
+ "BatchAnnotateImagesResponse": {
+ "properties": {
+ "responses": {
+ "description": "Individual responses to image annotation requests within the batch.",
+ "items": {
+ "$ref": "AnnotateImageResponse"
+ },
+ "type": "array"
+ }
+ },
+ "id": "BatchAnnotateImagesResponse",
+ "description": "Response to a batch image annotation request.",
+ "type": "object"
+ },
+ "WebDetection": {
+ "description": "Relevant information for the image from the Internet.",
+ "type": "object",
+ "properties": {
+ "fullMatchingImages": {
+ "description": "Fully matching images from the Internet.\nCan include resized copies of the query image.",
+ "items": {
+ "$ref": "WebImage"
+ },
+ "type": "array"
+ },
+ "webEntities": {
+ "description": "Deduced entities from similar images on the Internet.",
+ "items": {
+ "$ref": "WebEntity"
+ },
+ "type": "array"
+ },
+ "pagesWithMatchingImages": {
+ "description": "Web pages containing the matching images from the Internet.",
+ "items": {
+ "$ref": "WebPage"
+ },
+ "type": "array"
+ },
+ "visuallySimilarImages": {
+ "description": "The visually similar image results.",
+ "items": {
+ "$ref": "WebImage"
+ },
+ "type": "array"
+ },
+ "partialMatchingImages": {
+ "description": "Partial matching images from the Internet.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its crops.",
+ "items": {
+ "$ref": "WebImage"
+ },
+ "type": "array"
+ }
+ },
+ "id": "WebDetection"
+ },
+ "Position": {
+ "properties": {
+ "y": {
+ "format": "float",
+ "description": "Y coordinate.",
+ "type": "number"
+ },
+ "z": {
+ "format": "float",
+ "description": "Z coordinate (or depth).",
+ "type": "number"
+ },
+ "x": {
+ "format": "float",
+ "description": "X coordinate.",
+ "type": "number"
+ }
+ },
+ "id": "Position",
+ "description": "A 3D position in the image, used primarily for Face detection landmarks.\nA valid Position must have both x and y coordinates.\nThe position coordinates are in the same scale as the original image.",
+ "type": "object"
+ },
+ "ColorInfo": {
+ "properties": {
+ "pixelFraction": {
+ "format": "float",
+ "description": "The fraction of pixels the color occupies in the image.\nValue in range [0, 1].",
+ "type": "number"
+ },
+ "color": {
+ "$ref": "Color",
+ "description": "RGB components of the color."
+ },
+ "score": {
+ "format": "float",
+ "description": "Image-specific score for this color. Value in range [0, 1].",
+ "type": "number"
+ }
+ },
+ "id": "ColorInfo",
+ "description": "Color information consists of RGB channels, score, and the fraction of\nthe image that the color occupies in the image.",
+ "type": "object"
+ },
+ "WebPage": {
+ "description": "Metadata for web pages.",
+ "type": "object",
+ "properties": {
+ "score": {
+ "format": "float",
+ "description": "(Deprecated) Overall relevancy score for the web page.",
+ "type": "number"
+ },
+ "url": {
+ "description": "The result web page URL.",
+ "type": "string"
+ }
+ },
+ "id": "WebPage"
+ },
+ "EntityAnnotation": {
+ "properties": {
+ "confidence": {
+ "format": "float",
+ "description": "The accuracy of the entity detection in an image.\nFor example, for an image in which the \"Eiffel Tower\" entity is detected,\nthis field represents the confidence that there is a tower in the query\nimage. Range [0, 1].",
+ "type": "number"
+ },
+ "locale": {
+ "description": "The language code for the locale in which the entity textual\n`description` is expressed.",
+ "type": "string"
+ },
+ "boundingPoly": {
+ "$ref": "BoundingPoly",
+ "description": "Image region to which this entity belongs. Not produced\nfor `LABEL_DETECTION` features."
+ },
+ "topicality": {
+ "format": "float",
+ "description": "The relevancy of the ICA (Image Content Annotation) label to the\nimage. For example, the relevancy of \"tower\" is likely higher to an image\ncontaining the detected \"Eiffel Tower\" than to an image containing a\ndetected distant towering building, even though the confidence that\nthere is a tower in each image may be the same. Range [0, 1].",
+ "type": "number"
+ },
+ "description": {
+ "description": "Entity textual description, expressed in its `locale` language.",
+ "type": "string"
+ },
+ "properties": {
+ "description": "Some entities may have optional user-supplied `Property` (name/value)\nfields, such a score or string that qualifies the entity.",
+ "items": {
+ "$ref": "Property"
+ },
+ "type": "array"
+ },
+ "score": {
+ "format": "float",
+ "description": "Overall score of the result. Range [0, 1].",
+ "type": "number"
+ },
+ "locations": {
+ "description": "The location information for the detected entity. Multiple\n`LocationInfo` elements can be present because one location may\nindicate the location of the scene in the image, and another location\nmay indicate the location of the place where the image was taken.\nLocation information is usually present for landmarks.",
+ "items": {
+ "$ref": "LocationInfo"
+ },
+ "type": "array"
+ },
+ "mid": {
+ "description": "Opaque entity ID. Some IDs may be available in\n[Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).",
+ "type": "string"
+ }
+ },
+ "id": "EntityAnnotation",
+ "description": "Set of detected entity features.",
+ "type": "object"
}
},
"icons": {
@@ -1223,11 +1218,11 @@
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/cloud-vision": {
- "description": "Apply machine learning models to understand and label images"
- },
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/cloud-vision": {
+ "description": "Apply machine learning models to understand and label images"
}
}
}
@@ -1242,42 +1237,63 @@
"images": {
"methods": {
"annotate": {
+ "path": "v1/images:annotate",
+ "id": "vision.images.annotate",
+ "description": "Run image detection and annotation for a batch of images.",
"request": {
"$ref": "BatchAnnotateImagesRequest"
},
- "description": "Run image detection and annotation for a batch of images.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
"response": {
"$ref": "BatchAnnotateImagesResponse"
},
- "parameterOrder": [],
- "httpMethod": "POST",
+ "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
- "parameters": {},
- "flatPath": "v1/images:annotate",
- "id": "vision.images.annotate",
- "path": "v1/images:annotate"
+ "flatPath": "v1/images:annotate"
}
}
}
},
"parameters": {
- "fields": {
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
"location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
+ "description": "OAuth bearer token.",
"type": "string"
},
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
"uploadType": {
+ "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
"callback": {
- "location": "query",
"description": "JSONP",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"$.xgafv": {
"enumDescriptions": [
@@ -1293,6 +1309,12 @@
"type": "string"
},
"alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -1300,13 +1322,7 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
+ "default": "json"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
@@ -1319,36 +1335,20 @@
"type": "string"
},
"quotaUser": {
- "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pp": {
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
"location": "query",
- "description": "Returns response with indentations and line breaks.",
+ "description": "Pretty-print response.",
"default": "true",
"type": "boolean"
}
- }
+ },
+ "version": "v1",
+ "baseUrl": "https://vision.googleapis.com/",
+ "description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.",
+ "kind": "discovery#restDescription",
+ "servicePath": ""
}
diff --git a/youtubereporting/v1/youtubereporting-api.json b/youtubereporting/v1/youtubereporting-api.json
index 94bce72..d79d43d 100644
--- a/youtubereporting/v1/youtubereporting-api.json
+++ b/youtubereporting/v1/youtubereporting-api.json
@@ -1,11 +1,13 @@
{
- "title": "YouTube Reporting API",
- "discoveryVersion": "v1",
- "ownerName": "Google",
"resources": {
"media": {
"methods": {
"download": {
+ "flatPath": "v1/media/{mediaId}",
+ "id": "youtubereporting.media.download",
+ "path": "v1/media/{+resourceName}",
+ "description": "Method for media download. Download is supported\non the URI `/v1/media/{+name}?alt=media`.",
+ "supportsMediaDownload": true,
"response": {
"$ref": "Media"
},
@@ -13,75 +15,201 @@
"resourceName"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
- "https://www.googleapis.com/auth/yt-analytics.readonly"
- ],
"parameters": {
"resourceName": {
- "location": "path",
"description": "Name of the media that is being downloaded. See\nReadRequest.resource_name.",
"type": "string",
"required": true,
- "pattern": "^.+$"
+ "pattern": "^.+$",
+ "location": "path"
}
},
- "flatPath": "v1/media/{mediaId}",
- "id": "youtubereporting.media.download",
- "path": "v1/media/{+resourceName}",
- "description": "Method for media download. Download is supported\non the URI `/v1/media/{+name}?alt=media`.",
- "supportsMediaDownload": true
+ "scopes": [
+ "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
+ "https://www.googleapis.com/auth/yt-analytics.readonly"
+ ]
}
}
},
"jobs": {
+ "resources": {
+ "reports": {
+ "methods": {
+ "get": {
+ "flatPath": "v1/jobs/{jobId}/reports/{reportId}",
+ "id": "youtubereporting.jobs.reports.get",
+ "path": "v1/jobs/{jobId}/reports/{reportId}",
+ "description": "Gets the metadata of a specific report.",
+ "response": {
+ "$ref": "Report"
+ },
+ "parameterOrder": [
+ "jobId",
+ "reportId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "jobId": {
+ "description": "The ID of the job.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "onBehalfOfContentOwner": {
+ "type": "string",
+ "location": "query",
+ "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel)."
+ },
+ "reportId": {
+ "location": "path",
+ "description": "The ID of the report to retrieve.",
+ "type": "string",
+ "required": true
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
+ "https://www.googleapis.com/auth/yt-analytics.readonly"
+ ]
+ },
+ "list": {
+ "description": "Lists reports created by a specific job.\nReturns NOT_FOUND if the job does not exist.",
+ "response": {
+ "$ref": "ListReportsResponse"
+ },
+ "parameterOrder": [
+ "jobId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "jobId": {
+ "location": "path",
+ "description": "The ID of the job.",
+ "type": "string",
+ "required": true
+ },
+ "createdAfter": {
+ "type": "string",
+ "location": "query",
+ "format": "google-datetime",
+ "description": "If set, only reports created after the specified date/time are returned."
+ },
+ "startTimeAtOrAfter": {
+ "format": "google-datetime",
+ "description": "If set, only reports whose start time is greater than or equal the\nspecified date/time are returned.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "A token identifying a page of results the server should return. Typically,\nthis is the value of\nListReportsResponse.next_page_token\nreturned in response to the previous call to the `ListReports` method."
+ },
+ "pageSize": {
+ "format": "int32",
+ "description": "Requested page size. Server may return fewer report types than requested.\nIf unspecified, server will pick an appropriate default.",
+ "type": "integer",
+ "location": "query"
+ },
+ "onBehalfOfContentOwner": {
+ "location": "query",
+ "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
+ "type": "string"
+ },
+ "startTimeBefore": {
+ "location": "query",
+ "format": "google-datetime",
+ "description": "If set, only reports whose start time is smaller than the specified\ndate/time are returned.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
+ "https://www.googleapis.com/auth/yt-analytics.readonly"
+ ],
+ "flatPath": "v1/jobs/{jobId}/reports",
+ "id": "youtubereporting.jobs.reports.list",
+ "path": "v1/jobs/{jobId}/reports"
+ }
+ }
+ }
+ },
"methods": {
- "get": {
- "response": {
- "$ref": "Job"
+ "delete": {
+ "scopes": [
+ "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
+ "https://www.googleapis.com/auth/yt-analytics.readonly"
+ ],
+ "parameters": {
+ "jobId": {
+ "description": "The ID of the job to delete.",
+ "type": "string",
+ "required": true,
+ "location": "path"
+ },
+ "onBehalfOfContentOwner": {
+ "location": "query",
+ "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
+ "type": "string"
+ }
},
+ "flatPath": "v1/jobs/{jobId}",
+ "path": "v1/jobs/{jobId}",
+ "id": "youtubereporting.jobs.delete",
+ "description": "Deletes a job.",
+ "httpMethod": "DELETE",
"parameterOrder": [
"jobId"
],
+ "response": {
+ "$ref": "Empty"
+ }
+ },
+ "get": {
+ "description": "Gets a job.",
"httpMethod": "GET",
- "parameters": {
- "jobId": {
- "location": "path",
- "description": "The ID of the job to retrieve.",
- "type": "string",
- "required": true
- },
- "onBehalfOfContentOwner": {
- "type": "string",
- "location": "query",
- "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel)."
- }
+ "parameterOrder": [
+ "jobId"
+ ],
+ "response": {
+ "$ref": "Job"
},
"scopes": [
"https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
"https://www.googleapis.com/auth/yt-analytics.readonly"
],
+ "parameters": {
+ "onBehalfOfContentOwner": {
+ "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
+ "type": "string",
+ "location": "query"
+ },
+ "jobId": {
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "The ID of the job to retrieve."
+ }
+ },
"flatPath": "v1/jobs/{jobId}",
- "id": "youtubereporting.jobs.get",
"path": "v1/jobs/{jobId}",
- "description": "Gets a job."
+ "id": "youtubereporting.jobs.get"
},
"list": {
+ "httpMethod": "GET",
"response": {
"$ref": "ListJobsResponse"
},
"parameterOrder": [],
- "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
+ "https://www.googleapis.com/auth/yt-analytics.readonly"
+ ],
"parameters": {
- "onBehalfOfContentOwner": {
- "location": "query",
- "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
- "type": "string"
- },
"includeSystemManaged": {
- "location": "query",
"description": "If set to true, also system-managed jobs will be returned; otherwise only\nuser-created jobs will be returned. System-managed jobs can neither be\nmodified nor deleted.",
- "type": "boolean"
+ "type": "boolean",
+ "location": "query"
},
"pageToken": {
"location": "query",
@@ -89,22 +217,27 @@
"type": "string"
},
"pageSize": {
- "type": "integer",
"location": "query",
"format": "int32",
- "description": "Requested page size. Server may return fewer jobs than requested.\nIf unspecified, server will pick an appropriate default."
+ "description": "Requested page size. Server may return fewer jobs than requested.\nIf unspecified, server will pick an appropriate default.",
+ "type": "integer"
+ },
+ "onBehalfOfContentOwner": {
+ "location": "query",
+ "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
+ "type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
- "https://www.googleapis.com/auth/yt-analytics.readonly"
- ],
"flatPath": "v1/jobs",
- "id": "youtubereporting.jobs.list",
"path": "v1/jobs",
+ "id": "youtubereporting.jobs.list",
"description": "Lists jobs."
},
"create": {
+ "request": {
+ "$ref": "Job"
+ },
+ "description": "Creates a job and returns it.",
"response": {
"$ref": "Job"
},
@@ -116,228 +249,71 @@
],
"parameters": {
"onBehalfOfContentOwner": {
- "location": "query",
"description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
- "type": "string"
+ "type": "string",
+ "location": "query"
}
},
"flatPath": "v1/jobs",
"id": "youtubereporting.jobs.create",
- "path": "v1/jobs",
- "request": {
- "$ref": "Job"
- },
- "description": "Creates a job and returns it."
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "jobId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "jobId": {
- "location": "path",
- "description": "The ID of the job to delete.",
- "type": "string",
- "required": true
- },
- "onBehalfOfContentOwner": {
- "location": "query",
- "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
- "https://www.googleapis.com/auth/yt-analytics.readonly"
- ],
- "flatPath": "v1/jobs/{jobId}",
- "id": "youtubereporting.jobs.delete",
- "path": "v1/jobs/{jobId}",
- "description": "Deletes a job."
- }
- },
- "resources": {
- "reports": {
- "methods": {
- "get": {
- "description": "Gets the metadata of a specific report.",
- "httpMethod": "GET",
- "parameterOrder": [
- "jobId",
- "reportId"
- ],
- "response": {
- "$ref": "Report"
- },
- "scopes": [
- "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
- "https://www.googleapis.com/auth/yt-analytics.readonly"
- ],
- "parameters": {
- "jobId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The ID of the job."
- },
- "onBehalfOfContentOwner": {
- "location": "query",
- "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
- "type": "string"
- },
- "reportId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The ID of the report to retrieve."
- }
- },
- "flatPath": "v1/jobs/{jobId}/reports/{reportId}",
- "path": "v1/jobs/{jobId}/reports/{reportId}",
- "id": "youtubereporting.jobs.reports.get"
- },
- "list": {
- "response": {
- "$ref": "ListReportsResponse"
- },
- "parameterOrder": [
- "jobId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "jobId": {
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The ID of the job."
- },
- "createdAfter": {
- "location": "query",
- "format": "google-datetime",
- "description": "If set, only reports created after the specified date/time are returned.",
- "type": "string"
- },
- "startTimeAtOrAfter": {
- "type": "string",
- "location": "query",
- "format": "google-datetime",
- "description": "If set, only reports whose start time is greater than or equal the\nspecified date/time are returned."
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "A token identifying a page of results the server should return. Typically,\nthis is the value of\nListReportsResponse.next_page_token\nreturned in response to the previous call to the `ListReports` method."
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "format": "int32",
- "description": "Requested page size. Server may return fewer report types than requested.\nIf unspecified, server will pick an appropriate default."
- },
- "onBehalfOfContentOwner": {
- "location": "query",
- "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
- "type": "string"
- },
- "startTimeBefore": {
- "type": "string",
- "location": "query",
- "format": "google-datetime",
- "description": "If set, only reports whose start time is smaller than the specified\ndate/time are returned."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
- "https://www.googleapis.com/auth/yt-analytics.readonly"
- ],
- "flatPath": "v1/jobs/{jobId}/reports",
- "id": "youtubereporting.jobs.reports.list",
- "path": "v1/jobs/{jobId}/reports",
- "description": "Lists reports created by a specific job.\nReturns NOT_FOUND if the job does not exist."
- }
- }
+ "path": "v1/jobs"
}
}
},
"reportTypes": {
"methods": {
"list": {
- "httpMethod": "GET",
- "parameterOrder": [],
+ "flatPath": "v1/reportTypes",
+ "id": "youtubereporting.reportTypes.list",
+ "path": "v1/reportTypes",
+ "description": "Lists report types.",
"response": {
"$ref": "ListReportTypesResponse"
},
+ "parameterOrder": [],
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
"https://www.googleapis.com/auth/yt-analytics.readonly"
],
"parameters": {
- "includeSystemManaged": {
- "type": "boolean",
- "location": "query",
- "description": "If set to true, also system-managed report types will be returned;\notherwise only the report types that can be used to create new reporting\njobs will be returned."
- },
- "pageToken": {
- "location": "query",
- "description": "A token identifying a page of results the server should return. Typically,\nthis is the value of\nListReportTypesResponse.next_page_token\nreturned in response to the previous call to the `ListReportTypes` method.",
- "type": "string"
- },
"pageSize": {
- "type": "integer",
"location": "query",
"format": "int32",
- "description": "Requested page size. Server may return fewer report types than requested.\nIf unspecified, server will pick an appropriate default."
+ "description": "Requested page size. Server may return fewer report types than requested.\nIf unspecified, server will pick an appropriate default.",
+ "type": "integer"
},
"onBehalfOfContentOwner": {
- "location": "query",
"description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
- "type": "string"
+ "type": "string",
+ "location": "query"
+ },
+ "includeSystemManaged": {
+ "description": "If set to true, also system-managed report types will be returned;\notherwise only the report types that can be used to create new reporting\njobs will be returned.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "A token identifying a page of results the server should return. Typically,\nthis is the value of\nListReportTypesResponse.next_page_token\nreturned in response to the previous call to the `ListReportTypes` method."
}
- },
- "flatPath": "v1/reportTypes",
- "path": "v1/reportTypes",
- "id": "youtubereporting.reportTypes.list",
- "description": "Lists report types."
+ }
}
}
}
},
"parameters": {
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "default": "true",
- "type": "boolean"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
"upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
+ "location": "query"
},
"prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
"default": "true",
"type": "boolean",
- "location": "query",
- "description": "Returns response with indentations and line breaks."
+ "location": "query"
},
"uploadType": {
"location": "query",
@@ -345,17 +321,11 @@
"type": "string"
},
"fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
"type": "string",
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response."
- },
- "callback": {
- "type": "string",
- "location": "query",
- "description": "JSONP"
+ "location": "query"
},
"$.xgafv": {
- "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -365,71 +335,67 @@
"1",
"2"
],
- "description": "V1 error format."
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
},
"alt": {
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
- "description": "Data format for response."
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
"type": "string"
},
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
"key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "quotaUser": {
"type": "string",
"location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "default": "true",
+ "type": "boolean",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
}
},
"schemas": {
- "ListJobsResponse": {
- "description": "Response message for ReportingService.ListJobs.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "A token to retrieve next page of results.\nPass this value in the\nListJobsRequest.page_token\nfield in the subsequent call to `ListJobs` method to retrieve the next\npage of results."
- },
- "jobs": {
- "description": "The list of jobs.",
- "items": {
- "$ref": "Job"
- },
- "type": "array"
- }
- },
- "id": "ListJobsResponse"
- },
"Job": {
"description": "A job creating reports of a specific type.",
"type": "object",
"properties": {
- "reportTypeId": {
- "type": "string",
- "description": "The type of reports this job creates. Corresponds to the ID of a\nReportType."
- },
- "expireTime": {
- "format": "google-datetime",
- "description": "The date/time when this job will expire/expired. After a job expired, no\nnew reports are generated.",
- "type": "string"
- },
- "name": {
- "description": "The name of the job (max. 100 characters).",
- "type": "string"
- },
"systemManaged": {
"description": "True if this a system-managed job that cannot be modified by the user;\notherwise false.",
"type": "boolean"
@@ -439,9 +405,22 @@
"description": "The server-generated ID of the job (max. 40 characters)."
},
"createTime": {
- "type": "string",
"format": "google-datetime",
- "description": "The creation date/time of the job."
+ "description": "The creation date/time of the job.",
+ "type": "string"
+ },
+ "reportTypeId": {
+ "description": "The type of reports this job creates. Corresponds to the ID of a\nReportType.",
+ "type": "string"
+ },
+ "expireTime": {
+ "format": "google-datetime",
+ "description": "The date/time when this job will expire/expired. After a job expired, no\nnew reports are generated.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the job (max. 100 characters).",
+ "type": "string"
}
},
"id": "Job"
@@ -449,63 +428,84 @@
"ListReportsResponse": {
"type": "object",
"properties": {
- "nextPageToken": {
- "type": "string",
- "description": "A token to retrieve next page of results.\nPass this value in the\nListReportsRequest.page_token\nfield in the subsequent call to `ListReports` method to retrieve the next\npage of results."
- },
"reports": {
+ "description": "The list of report types.",
"items": {
"$ref": "Report"
},
- "type": "array",
- "description": "The list of report types."
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve next page of results.\nPass this value in the\nListReportsRequest.page_token\nfield in the subsequent call to `ListReports` method to retrieve the next\npage of results.",
+ "type": "string"
}
},
"id": "ListReportsResponse",
"description": "Response message for ReportingService.ListReports."
},
"Media": {
+ "description": "Media resource.",
"type": "object",
"properties": {
"resourceName": {
- "type": "string",
- "description": "Name of the media resource."
- }
- },
- "id": "Media",
- "description": "Media resource."
- },
- "ReportType": {
- "type": "object",
- "properties": {
- "systemManaged": {
- "description": "True if this a system-managed report type; otherwise false. Reporting jobs\nfor system-managed report types are created automatically and can thus not\nbe used in the `CreateJob` method.",
- "type": "boolean"
- },
- "id": {
- "type": "string",
- "description": "The ID of the report type (max. 100 characters)."
- },
- "deprecateTime": {
- "type": "string",
- "format": "google-datetime",
- "description": "The date/time when this report type was/will be deprecated."
- },
- "name": {
- "description": "The name of the report type (max. 100 characters).",
+ "description": "Name of the media resource.",
"type": "string"
}
},
- "id": "ReportType",
- "description": "A report type."
+ "id": "Media"
+ },
+ "Report": {
+ "description": "A report's metadata including the URL from which the report itself can be\ndownloaded.",
+ "type": "object",
+ "properties": {
+ "createTime": {
+ "format": "google-datetime",
+ "description": "The date/time when this report was created.",
+ "type": "string"
+ },
+ "jobId": {
+ "description": "The ID of the job that created this report.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The server-generated ID of the report.",
+ "type": "string"
+ },
+ "jobExpireTime": {
+ "format": "google-datetime",
+ "description": "The date/time when the job this report belongs to will expire/expired.",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "google-datetime",
+ "description": "The end of the time period that the report instance covers. The value is\nexclusive.",
+ "type": "string"
+ },
+ "downloadUrl": {
+ "description": "The URL from which the report can be downloaded (max. 1000 characters).",
+ "type": "string"
+ },
+ "startTime": {
+ "format": "google-datetime",
+ "description": "The start of the time period that the report instance covers. The value is\ninclusive.",
+ "type": "string"
+ }
+ },
+ "id": "Report"
+ },
+ "Empty": {
+ "id": "Empty",
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object",
+ "properties": {}
},
"ListReportTypesResponse": {
"description": "Response message for ReportingService.ListReportTypes.",
"type": "object",
"properties": {
"nextPageToken": {
- "type": "string",
- "description": "A token to retrieve next page of results.\nPass this value in the\nListReportTypesRequest.page_token\nfield in the subsequent call to `ListReportTypes` method to retrieve the next\npage of results."
+ "description": "A token to retrieve next page of results.\nPass this value in the\nListReportTypesRequest.page_token\nfield in the subsequent call to `ListReportTypes` method to retrieve the next\npage of results.",
+ "type": "string"
},
"reportTypes": {
"description": "The list of report types.",
@@ -517,56 +517,53 @@
},
"id": "ListReportTypesResponse"
},
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\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"
- },
- "Report": {
+ "ReportType": {
"type": "object",
"properties": {
- "jobId": {
- "description": "The ID of the job that created this report.",
+ "name": {
+ "description": "The name of the report type (max. 100 characters).",
"type": "string"
},
+ "systemManaged": {
+ "type": "boolean",
+ "description": "True if this a system-managed report type; otherwise false. Reporting jobs\nfor system-managed report types are created automatically and can thus not\nbe used in the `CreateJob` method."
+ },
"id": {
- "type": "string",
- "description": "The server-generated ID of the report."
- },
- "jobExpireTime": {
- "type": "string",
- "format": "google-datetime",
- "description": "The date/time when the job this report belongs to will expire/expired."
- },
- "endTime": {
- "type": "string",
- "format": "google-datetime",
- "description": "The end of the time period that the report instance covers. The value is\nexclusive."
- },
- "downloadUrl": {
- "description": "The URL from which the report can be downloaded (max. 1000 characters).",
+ "description": "The ID of the report type (max. 100 characters).",
"type": "string"
},
- "startTime": {
+ "deprecateTime": {
"format": "google-datetime",
- "description": "The start of the time period that the report instance covers. The value is\ninclusive.",
+ "description": "The date/time when this report type was/will be deprecated.",
"type": "string"
- },
- "createTime": {
- "type": "string",
- "format": "google-datetime",
- "description": "The date/time when this report was created."
}
},
- "id": "Report",
- "description": "A report's metadata including the URL from which the report itself can be\ndownloaded."
+ "id": "ReportType",
+ "description": "A report type."
+ },
+ "ListJobsResponse": {
+ "description": "Response message for ReportingService.ListJobs.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "A token to retrieve next page of results.\nPass this value in the\nListJobsRequest.page_token\nfield in the subsequent call to `ListJobs` method to retrieve the next\npage of results.",
+ "type": "string"
+ },
+ "jobs": {
+ "items": {
+ "$ref": "Job"
+ },
+ "type": "array",
+ "description": "The list of jobs."
+ }
+ },
+ "id": "ListJobsResponse"
}
},
"protocol": "rest",
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"version": "v1",
"baseUrl": "https://youtubereporting.googleapis.com/",
@@ -591,7 +588,10 @@
"ownerDomain": "google.com",
"name": "youtubereporting",
"batchPath": "batch",
- "id": "youtubereporting:v1",
+ "revision": "20171009",
"documentationLink": "https://developers.google.com/youtube/reporting/v1/reports/",
- "revision": "20171009"
+ "id": "youtubereporting:v1",
+ "title": "YouTube Reporting API",
+ "ownerName": "Google",
+ "discoveryVersion": "v1"
}
